com.interpss.dstab

Interface BaseDStabBus<TGen extends DStabGen,TLoad extends DStabLoad>

All Superinterfaces:

BaseAclfBus<TGen,TLoad>, BaseAcscBus<TGen,TLoad>, Bus, com.hazelcast.nio.serialization.DataSerializable, org.eclipse.emf.ecore.EObject, ExtensionElement, IAclfBus, IAclfBusAdaptation, IAclfBusAdjustment, IAclfBusFunc, IAclfBusZeroZFunc, IDynamicSimulation, NameTag, NetworkedElement, org.eclipse.emf.common.notify.Notifier

All Known Subinterfaces:

DStabBus

All Known Implementing Classes:

BaseDStabBusImpl, DStabBusImpl

public interface BaseDStabBus<TGen extends DStabGen,TLoad extends DStabLoad>
extends BaseAcscBus<TGen,TLoad>, IDynamicSimulation

A representation of the model object 'DStab Bus'. Bus class for hosting bus stability study information.

The following features are supported:

• Init Load
• Init Volt Mag
• Load Model Switched
• Freq
• Bus Freq Measure Block
• Dynamic Event
• Info Only Dyn Model
• Dynamic Bus Device List

See Also:

DstabPackage.getBaseDStabBus()

Method Summary

Modifier and Type	Method and Description
void	addDynamicBusDevice(DynamicBusDevice device) Get the machine object identified by the machine id.
void	addDynamicLoadModel(DynLoadModel dynLoad)
org.apache.commons.math3.complex.Complex	calDStabLoad(StaticLoadModel loadModel, double switchVoltage) Deprecated.
org.apache.commons.math3.complex.Complex	calStaticLoad() calculate the total static load power at the current time step
org.apache.commons.math3.complex.Complex	calTotalLoad() calculate the total (static + dynamic) load power at the current time step
double	getAccumulatedLoadChangeFactor()
StaticLoadModel	getActiveStaticLoadModel() get the bus level Static Load Model for the active power portion
ICMLControlBlock	getBusFreqMeasureBlock() Returns the value of the 'Bus Freq Measure Block' attribute.
DynamicBusDevice	getDynamicBusDevice(java.lang.String machId) Get the machine object identified by the machine id.
org.eclipse.emf.common.util.EList<DynamicBusDevice>	getDynamicBusDeviceList() Returns the value of the 'Dynamic Bus Device List' containment reference list.
BusDynamicEvent	getDynamicEvent() Returns the value of the 'Dynamic Event' reference.
DynLoadModel	getDynamicLoadModel(java.lang.String dynLoadId)
java.util.List<DynLoadModel>	getDynLoadModelList() Return the dynamic load model list
double	getFreq() Returns the value of the 'Freq' attribute.
DynamicBusDevice	getInfoOnlyDynModel() Returns the value of the 'Info Only Dyn Model' containment reference.
org.apache.commons.math3.complex.Complex	getInitConstIStaticLoad()
org.apache.commons.math3.complex.Complex	getInitConstPStaticLoad()
org.apache.commons.math3.complex.Complex	getInitConstZStaticLoad()
org.apache.commons.math3.complex.Complex	getInitLoad() Returns the value of the 'Init Load' attribute.
double	getInitVoltMag() Returns the value of the 'Init Volt Mag' attribute.
Machine	getMachine() get machine connect to this bus.
Machine	getMachine(java.lang.String machId) get machine connect to this bus using the machine Id.
StaticLoadModel	getReactiveStaticLoadModeel() get the bus level Static Load Model for the reactive power portion
ScriptDynamicBusDevice	getScriptDynamicBusDevice() get scripted dynamic device connect to this bus.
org.apache.commons.math3.complex.Complex	injCurDynamic(StaticLoadModel loadModel, double loadSwitchVolt, double switchDeadZone) Calculate bus dynamic inject current, including machine Igen plus Load injection current if it is modeled as constant power load.
boolean	isLoadModelSwitched() Returns the value of the 'Load Model Switched' attribute.
boolean	isMachineBus() check if the bus is a machine bus.
void	processInitLoad() process bus init load and set to bus as Z
void	setAccumulatedLoadChangeFactor(double value)
void	setActiveStaticLoadModel(StaticLoadModel value) set the bus level Static Load Model for the active power portion
void	setBusFreqMeasureBlock(ICMLControlBlock value) Sets the value of the 'Bus Freq Measure Block' attribute.
void	setDynamicEvent(BusDynamicEvent value) Sets the value of the 'Dynamic Event' reference.
void	setFreq(double value) Sets the value of the 'Freq' attribute.
void	setInfoOnlyDynModel(DynamicBusDevice value) Sets the value of the 'Info Only Dyn Model' containment reference.
void	setInitConstIStaticLoad(org.apache.commons.math3.complex.Complex value)
void	setInitConstPStaticLoad(org.apache.commons.math3.complex.Complex value)
void	setInitConstZStaticLoad(org.apache.commons.math3.complex.Complex value)
void	setInitLoad(org.apache.commons.math3.complex.Complex value) Sets the value of the 'Init Load' attribute.
void	setInitVoltMag(double value) Sets the value of the 'Init Volt Mag' attribute.
void	setLoadModelSwitched(boolean value) Sets the value of the 'Load Model Switched' attribute.
void	setNetLoadResults(org.apache.commons.math3.complex.Complex newNetLoadPQ) update or reset bus loadflow result - bus Load value
void	setReactiveStaticLoadModel(StaticLoadModel value) set the bus level Static Load Model for the reactive power portion
void	updateDynamicAttributes(boolean netChange) Call updateAttributes() of all dynamic devices connected to the bus.

Methods inherited from interface com.interpss.core.acsc.BaseAcscBus

calYScii, getEquivZ0, getEquivZ1, getEquivZ2, getGrounding, getScCode, getScFixedShuntY0, getScGenZ0, getScGenZ1, getScGenZ2, getScLoadShuntY0, getScLoadShuntY1, getScLoadShuntY2, getScSwitchedShuntY0, getThreeSeqVoltage, initSeqEquivLoad, resetSeqEquivLoad, setGrounding, setScCode, setScFixedShuntY0, setScGenZ, setScGenZ, setScGenZ, setScGenZ0, setScGenZ1, setScGenZ2, setScLoadShuntY0, setScLoadShuntY1, setScLoadShuntY2, setScSwitchedShuntY0, setThreeSeqVoltage

Methods inherited from interface com.interpss.core.aclf.BaseAclfBus

acCurrentIntoNet, b11ii, b1ii, calLossPFactor, calNetGenResults, calNetLoadResults, calNetPQResults, getBusControl, getCompensator, getCompensatorList, getContributeGen, getContributeGenList, getContributeLoad, getContributeLoadList, getDesiredVoltAng, getDesiredVoltMag, getExpLoadP, getExpLoadQ, getExternalPowerIntoNet, getFunctionLoad, getGenCode, getGenP, getGenQ, getJii, getLoadCode, getLoadP, getLoadP, getLoadQ, getLoadQ, getLossCumTDPath, getPGenLimit, getQGenLimit, getRemoteQControlGroup, getShuntY, getSwitchedShuntList, getVLimit, getVoltageAng, getVoltageMag, mismatch, powerIntoNet, setBusControl, setDesiredVoltAng, setDesiredVoltMag, setExpLoadP, setExpLoadQ, setExternalPowerIntoNet, setFunctionLoad, setGenCode, setGenP, setGenQ, setLoadCode, setLoadP, setLoadQ, setLossCumTDPath, setPGenLimit, setQGenLimit, setRemoteQControlGroup, setShuntY, setVLimit, setVoltageAng, setVoltageMag, yii

Methods inherited from interface com.interpss.core.net.Bus

getBaseVoltage, getBranchList, getConnectedBranch, getFromBranchList, getMerge2BusId, getNetwork, getSubAreaFlag, getSubstation, getSubstationId, getToBranchList, isIslandBus, nActiveBranchConnected, nBranchConnected, nBranchConnected, nNonGroundBranchConnected, setAttributes, setAttributes, setBaseVoltage, setBaseVoltage, setMerge2BusId, setNetwork, setSubAreaFlag, setSubstation, setSubstationId, toString

Methods inherited from interface com.interpss.core.net.ExtensionElement

getExtensionObject, setExtensionObject

Methods inherited from interface com.interpss.core.net.NetworkedElement

getArea, getAreaId, getExtSeqNumber, getIntFlag, getOwner, getOwnerId, getSortNumber, getWeight, getZone, getZoneId, isBooleanFlag, setArea, setAreaId, setBooleanFlag, setExtSeqNumber, setIntFlag, setOwner, setOwnerId, setSortNumber, setWeight, setZone, setZoneId

Methods inherited from interface com.interpss.core.net.NameTag

checkData, checkData, getDesc, getId, getName, getNumber, getStatusChangeInfo, hzCopy, isActive, isStatus, jsonCopy, setDesc, setId, setName, setNumber, setStatus, setStatusChangeInfo

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface com.hazelcast.nio.serialization.DataSerializable

readData, writeData

Methods inherited from interface com.interpss.core.aclf.IAclfBus

getVoltage, getVoltage, getVoltageAng, getVoltageMag, isCapacitor, isConstILoad, isConstPLoad, isConstZLoad, isGen, isGenPQ, isGenPV, isLoad, isLoadPV, isNonContribute, isPV, isRefBus, isSwing, setVoltage, setVoltage, setVoltage, updateVoltage, updateVoltageAng, updateVoltageMag

Methods inherited from interface com.interpss.core.aclf.IAclfBusFunc

allocateContributeGenQ, code2String, distributeLoad, initContributeGen, initContributeLoad, noConnectedBranch, voltageViolation

Methods inherited from interface com.interpss.core.aclf.IAclfBusZeroZFunc

findZeroZPathBuses, getNoConnectedZbr, hasZbrLoop, isConnect2ZeroZBranch

Methods inherited from interface com.interpss.core.aclf.IAclfBusAdaptation

toCapacitorBus, toGenBus, toLoadBus, toPQBus, toPVBus, toSwingBus

Methods inherited from interface com.interpss.core.aclf.IAclfBusAdjustment

getPQBusLimit, getPVBusLimit, getRemoteQBus, getStaticVarCompensator, getSwitchedShunt, isFunctionLoad, isPQBusLimit, isPVBusLimit, isRemoteQBus, isRemoteQControlGroup, isStaticVarCompensator, isSwitchedShunt

Methods inherited from interface com.interpss.dstab.algo.IDynamicSimulation

afterStep, getOutput, getOutput, getOutputList, getOutputObject, getStates, getStates, initStates, initStates, initStates, nextStep, nextStep, nextStepElectrical, nextStepMechanical, updateAttributes

Method Detail

getInitLoad

org.apache.commons.math3.complex.Complex getInitLoad()

Returns the value of the 'Init Load' attribute.

If the meaning of the 'Init Load' attribute isn't clear, there really should be more of a description here...

Holding of initial load for transient statbility simulation.

Returns:

the value of the 'Init Load' attribute.

See Also:

setInitLoad(Complex), DstabPackage.getBaseDStabBus_InitLoad()

setInitLoad

void setInitLoad(org.apache.commons.math3.complex.Complex value)

Sets the value of the 'Init Load' attribute.

Parameters:

value - the new value of the 'Init Load' attribute.

See Also:

getInitLoad()

getInitVoltMag

double getInitVoltMag()

Returns the value of the 'Init Volt Mag' attribute.

If the meaning of the 'Init Volt Mag' attribute isn't clear, there really should be more of a description here...

Holding of initial bus voltage for transient statbility simulation

Returns:

the value of the 'Init Volt Mag' attribute.

See Also:

setInitVoltMag(double), DstabPackage.getBaseDStabBus_InitVoltMag()

setInitVoltMag

void setInitVoltMag(double value)

Sets the value of the 'Init Volt Mag' attribute.

Parameters:

value - the new value of the 'Init Volt Mag' attribute.

See Also:

getInitVoltMag()

isLoadModelSwitched

boolean isLoadModelSwitched()

Returns the value of the 'Load Model Switched' attribute. The default value is "false".

If the meaning of the 'Load Model Switched' attribute isn't clear, there really should be more of a description here...

attribute indicating bus load model switched

Returns:

the value of the 'Load Model Switched' attribute.

See Also:

setLoadModelSwitched(boolean), DstabPackage.getBaseDStabBus_LoadModelSwitched()

setLoadModelSwitched

void setLoadModelSwitched(boolean value)

Sets the value of the 'Load Model Switched' attribute.

Parameters:

value - the new value of the 'Load Model Switched' attribute.

See Also:

isLoadModelSwitched()

getFreq

double getFreq()

Returns the value of the 'Freq' attribute. The default value is "1.0".

If the meaning of the 'Freq' attribute isn't clear, there really should be more of a description here...

Holding of bus frequency for transient statbility simulation

Returns:

the value of the 'Freq' attribute.

See Also:

setFreq(double), DstabPackage.getBaseDStabBus_Freq()

setFreq

void setFreq(double value)

Sets the value of the 'Freq' attribute.

Parameters:

value - the new value of the 'Freq' attribute.

See Also:

getFreq()

getBusFreqMeasureBlock

ICMLControlBlock getBusFreqMeasureBlock()

Returns the value of the 'Bus Freq Measure Block' attribute.

If the meaning of the 'Bus Freq Measure Block' attribute isn't clear, there really should be more of a description here...

Holding of bus frequency for transient statbility simulation

Returns:

the value of the 'Bus Freq Measure Block' attribute.

See Also:

setBusFreqMeasureBlock(ICMLControlBlock), DstabPackage.getBaseDStabBus_BusFreqMeasureBlock()

setBusFreqMeasureBlock

void setBusFreqMeasureBlock(ICMLControlBlock value)

Sets the value of the 'Bus Freq Measure Block' attribute.

Parameters:

value - the new value of the 'Bus Freq Measure Block' attribute.

See Also:

getBusFreqMeasureBlock()

getDynamicEvent

BusDynamicEvent getDynamicEvent()

Returns the value of the 'Dynamic Event' reference.

If the meaning of the 'Dynamic Event' reference isn't clear, there really should be more of a description here...

bi-direction reference to bus dynamic event object.

Returns:

the value of the 'Dynamic Event' reference.

See Also:

setDynamicEvent(BusDynamicEvent), DstabPackage.getBaseDStabBus_DynamicEvent()

setDynamicEvent

void setDynamicEvent(BusDynamicEvent value)

Sets the value of the 'Dynamic Event' reference.

Parameters:

value - the new value of the 'Dynamic Event' reference.

See Also:

getDynamicEvent()

getInfoOnlyDynModel

DynamicBusDevice getInfoOnlyDynModel()

Returns the value of the 'Info Only Dyn Model' containment reference. Info only dynamic model is for define the composite load model, which itself does not fit the dynamicDevice concept, rather it is a "container" of static and dynamic devices/components. For composite load model (CMPLDW), it consists of an equivalent feeder model and several dynamic load components including three-phase induction motors, single-phase induction motor, ZIP loads. For more information, please refer to https://www.wecc.biz/Reliability/WECC%20Composite%20Load%20Model%20Specifications%2001-27-2015.docx

Returns:

the value of the 'Info Only Dyn Model' containment reference.

See Also:

setInfoOnlyDynModel(DynamicBusDevice), DstabPackage.getBaseDStabBus_InfoOnlyDynModel()

setInfoOnlyDynModel

void setInfoOnlyDynModel(DynamicBusDevice value)

Sets the value of the 'Info Only Dyn Model' containment reference.

Parameters:

value - the new value of the 'Info Only Dyn Model' containment reference.

See Also:

getInfoOnlyDynModel()

getDynamicBusDeviceList

org.eclipse.emf.common.util.EList<DynamicBusDevice> getDynamicBusDeviceList()

Returns the value of the 'Dynamic Bus Device List' containment reference list. The list contents are of type DynamicBusDevice. It is bidirectional and its opposite is 'DStab Bus'.

If the meaning of the 'Dynamic Bus Device List' containment reference list isn't clear, there really should be more of a description here...

bus dynamic device list

Returns:

the value of the 'Dynamic Bus Device List' containment reference list.

See Also:

DstabPackage.getBaseDStabBus_DynamicBusDeviceList(), DynamicBusDevice.getDStabBus()

getDynLoadModelList

java.util.List<DynLoadModel> getDynLoadModelList()

Return the dynamic load model list

getMachine

Machine getMachine(java.lang.String machId)

get machine connect to this bus using the machine Id.

getMachine

Machine getMachine()

get machine connect to this bus.

isMachineBus

boolean isMachineBus()

check if the bus is a machine bus.

getScriptDynamicBusDevice

ScriptDynamicBusDevice getScriptDynamicBusDevice()

get scripted dynamic device connect to this bus. It is used for extension

calDStabLoad

@Deprecated
org.apache.commons.math3.complex.Complex calDStabLoad(StaticLoadModel loadModel,
                                                                  double switchVoltage)

Deprecated.

Calculate bus transient statbility eq load

calStaticLoad

org.apache.commons.math3.complex.Complex calStaticLoad()

calculate the total static load power at the current time step

Returns:

calTotalLoad

org.apache.commons.math3.complex.Complex calTotalLoad()

calculate the total (static + dynamic) load power at the current time step

Returns:

getInitConstZStaticLoad

org.apache.commons.math3.complex.Complex getInitConstZStaticLoad()

setInitConstZStaticLoad

void setInitConstZStaticLoad(org.apache.commons.math3.complex.Complex value)

getInitConstIStaticLoad

org.apache.commons.math3.complex.Complex getInitConstIStaticLoad()

setInitConstIStaticLoad

void setInitConstIStaticLoad(org.apache.commons.math3.complex.Complex value)

getInitConstPStaticLoad

org.apache.commons.math3.complex.Complex getInitConstPStaticLoad()

setInitConstPStaticLoad

void setInitConstPStaticLoad(org.apache.commons.math3.complex.Complex value)

getActiveStaticLoadModel

StaticLoadModel getActiveStaticLoadModel()

get the bus level Static Load Model for the active power portion

Returns:

setActiveStaticLoadModel

void setActiveStaticLoadModel(StaticLoadModel value)

set the bus level Static Load Model for the active power portion

getReactiveStaticLoadModeel

StaticLoadModel getReactiveStaticLoadModeel()

get the bus level Static Load Model for the reactive power portion

Returns:

setReactiveStaticLoadModel

void setReactiveStaticLoadModel(StaticLoadModel value)

set the bus level Static Load Model for the reactive power portion

getAccumulatedLoadChangeFactor

double getAccumulatedLoadChangeFactor()

setAccumulatedLoadChangeFactor

void setAccumulatedLoadChangeFactor(double value)

processInitLoad

void processInitLoad()

process bus init load and set to bus as Z

injCurDynamic

org.apache.commons.math3.complex.Complex injCurDynamic(StaticLoadModel loadModel,
                                                       double loadSwitchVolt,
                                                       double switchDeadZone)
                                                throws InterpssException

Calculate bus dynamic inject current, including machine Igen plus Load injection current if it is modeled as constant power load.

Throws:

InterpssException

updateDynamicAttributes

void updateDynamicAttributes(boolean netChange)
                      throws InterpssException

Call updateAttributes() of all dynamic devices connected to the bus.

Throws:

InterpssException

getDynamicBusDevice

DynamicBusDevice getDynamicBusDevice(java.lang.String machId)

Get the machine object identified by the machine id.

Parameters:

machId - machine id

addDynamicBusDevice

void addDynamicBusDevice(DynamicBusDevice device)

Get the machine object identified by the machine id.

addDynamicLoadModel

void addDynamicLoadModel(DynLoadModel dynLoad)

getDynamicLoadModel

DynLoadModel getDynamicLoadModel(java.lang.String dynLoadId)

setNetLoadResults

void setNetLoadResults(org.apache.commons.math3.complex.Complex newNetLoadPQ)

update or reset bus loadflow result - bus Load value