com.interpss.core.aclf

Interface BaseAclfNetwork<TBus extends BaseAclfBus<? extends AclfGen,? extends AclfLoad>,TBranch extends AclfBranch>

All Superinterfaces:

com.hazelcast.nio.serialization.DataSerializable, org.eclipse.emf.ecore.EObject, IAclfAreaZone, IAclfNetAdjustment, IAclfNetElement, IAclfNetFormMatrix, IAclfNetFunc, IAdaptable, IMultiNet, INet3WXfrElement, INetBranchElement<TBus,TBranch>, INetBusElement<TBus>, INetworkElement, NameTag, Network<TBus,TBranch>, org.eclipse.emf.common.notify.Notifier

All Known Subinterfaces:

AclfNetwork, AcscNetwork, BaseAcscNetwork<TBus,TBranch>, BaseDStabNetwork<TBus,TBra>, BaseOpfNetwork, DclfOpfNetwork, DStab3PNetwork, DStabilityNetwork, Dynamic3PNetwork, OpfNetwork, Steady3PNetwork

All Known Implementing Classes:

AclfNetworkImpl, AcscNetworkImpl, BaseAclfNetworkImpl, BaseAcscNetworkImpl, BaseDStabNetworkImpl, BaseOpfNetworkImpl, DclfOpfNetworkImpl, DStabilityNetworkImpl, Dynamic3PNetworkImpl, OpfNetworkImpl, Steady3PNetworkImpl

public interface BaseAclfNetwork<TBus extends BaseAclfBus<? extends AclfGen,? extends AclfLoad>,TBranch extends AclfBranch>
extends Network<TBus,TBranch>, IAclfNetFunc, IAclfNetAdjustment, INet3WXfrElement, IAclfNetElement, IAclfAreaZone, IAclfNetFormMatrix

A representation of the model object 'Base Aclf Network'. Base AclfNetwork class is for storing network information for implementing AC loadflow analysis.

The following features are supported:

• Network Type
• Sensitivity Calculated
• Lf Data Loaded
• Lf Converged
• Zero ZBranch Threshold
• Xfr ZAdjust Side
• Default Voltage Limit
• Zero ZBranch Processed
• Aclf Net Adjust
• Xfr ZTable
• Ps Xfr PControl List
• Tap Control List
• Remote QBus List
• Svc List
• Special Branch List

See Also:

AclfPackage.getBaseAclfNetwork()

Method Summary

Modifier and Type	Method and Description
void	adjustXfrZ() adjust Xfr Z per the Xfr Z Adjustment Table
boolean	allocateContributeGenQ(double tolerance) Allocate PV Bus reactive power to individual contribution generators in multi-contribution generator situation.
AclfNetAdjustment	getAclfNetAdjust() Returns the value of the 'Aclf Net Adjust' containment reference.
LimitType	getDefaultVoltageLimit() Returns the value of the 'Default Voltage Limit' attribute.
NetworkType	getNetworkType() Returns the value of the 'Network Type' attribute.
org.eclipse.emf.common.util.EList<PSXfrPControl>	getPsXfrPControlList() Returns the value of the 'Ps Xfr PControl List' reference list.
org.eclipse.emf.common.util.EList<RemoteQBus>	getRemoteQBusList() Returns the value of the 'Remote QBus List' reference list.
org.eclipse.emf.common.util.EList<Branch>	getSpecialBranchList() Returns the value of the 'Special Branch List' reference list.
org.eclipse.emf.common.util.EList<StaticVarCompensator>	getSvcList() Returns the value of the 'Svc List' reference list.
org.eclipse.emf.common.util.EList<TapControl>	getTapControlList() Returns the value of the 'Tap Control List' reference list.
BranchBusSide	getXfrZAdjustSide() Returns the value of the 'Xfr ZAdjust Side' attribute.
org.eclipse.emf.common.util.EList<XfrZTableEntry>	getXfrZTable() Returns the value of the 'Xfr ZTable' containment reference list.
XfrZTableEntry	getXfrZTableEntry(int number) get xfr Z table entry by the number
ISparseEqnComplex	getYMatrix()
double	getZeroZBranchThreshold() Returns the value of the 'Zero ZBranch Threshold' attribute.
void	initBusVoltage() AclfNetwork initialization for Loadflow run, including Bus Voltage initialization.
void	initBusWithSchedVolt() initialize with scheduled/desired voltage
void	initContributeGenLoad() Initialization multi-contribution genertaors/loads for Loadflow run by consolidating multi-contribution generators/loads to an equiv-gen/load.
boolean	isLfConverged() Returns the value of the 'Lf Converged' attribute.
boolean	isLfDataLoaded() Returns the value of the 'Lf Data Loaded' attribute.
boolean	isSensitivityCalculated() Returns the value of the 'Sensitivity Calculated' attribute.
boolean	isZeroZBranchProcessed() Returns the value of the 'Zero ZBranch Processed' attribute.
boolean	postProcessHVDC()
void	setAclfNetAdjust(AclfNetAdjustment value) Sets the value of the 'Aclf Net Adjust' containment reference.
void	setDefaultVoltageLimit(LimitType value) Sets the value of the 'Default Voltage Limit' attribute.
void	setLfConverged(boolean value) Sets the value of the 'Lf Converged' attribute.
void	setLfDataLoaded(boolean value) Sets the value of the 'Lf Data Loaded' attribute.
void	setNetworkType(NetworkType value) Sets the value of the 'Network Type' attribute.
void	setSensitivityCalculated(boolean value) Sets the value of the 'Sensitivity Calculated' attribute.
void	setXfrZAdjustSide(BranchBusSide value) Sets the value of the 'Xfr ZAdjust Side' attribute.
void	setZeroZBranchProcessed(boolean value) Sets the value of the 'Zero ZBranch Processed' attribute.
void	setZeroZBranchThreshold(double value) Sets the value of the 'Zero ZBranch Threshold' attribute.

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

accept, addArea, addOwner, addZone, arrangeBusNumber, formAdjacencyMatrix, getAreaList, getBaseKva, getBaseMva, getBranchList, getBusList, getChildNetList, getFrequency, getOriginalDataFormat, getOwnerList, getRefBusId, getRefBusType, getTieLineList, getZoneList, isAllowGroundBranch, isBusNumberArranged, isBypassDataCheck, isDataChecked, isRefBus, isSwitchBreakModel, net2String, rebuildLookupTable, setAllowGroundBranch, setBaseKva, setBusNumberArranged, setBypassDataCheck, setDataChecked, setFrequency, setOriginalDataFormat, setRefBusId, setRefBusType, setSwitchBreakModel, setToEmpty

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

checkData, checkData, copy, copyRef, getDesc, getId, getName, getNumber, isActive, isStatus, setDesc, setId, setName, setNumber, setStatus

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

readData, writeData

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

getAdapter, getAdapter

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

addTieLine, getArea, getOwner, getOwner, getZone, removeTieLine, setVisitedStatus

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

addBus, getBus, getBus, getBus, getNoActiveBus, getNoBus, hasBus, removeBus, removeBus, setBus

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

addBranch, addBranch, addBranch, addBranch, addBranch, getBranch, getBranch, getBranch, getBranch, getBranch, getNoActiveBranch, getNoBranch, hasBranch, hasBranch, removeBranch, removeBranch, removeBranch

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

getChildNet, hasChildNet

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.interpss.core.aclf.IAclfNetFunc

calLoadDFactor, hasBranchMavRatingViolation, maxMismatch, smallestLoad, totalGeneration, totalLoad, totalLoss

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

hasFunctionLoad, hasPQBusLimit, hasPSXfrPControl, hasPVBusLimit, hasRemoteQBus, hasStaticVarCompensator, hasSwitchedShuntAdjustment, hasTapControl, needDiscreteAdjust, needLimitAdjust, needLimitBackoffAdjust, needPowerAdjust, needVoltageAdjust

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

add3WXfr, add3WXfr, get3WXfr, get3WXfr, has3WXfr, has3WXfr, remove3WXfr

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

addHvdcLine2T, addHvdcLine2T, calculateHvdc, getHvdcLine2T, hasPSXfr

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

areaOutputPower, neighborAreas, neighborZones, powerAreaExport, powerZoneExport

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

formB11Matrix, formB11Matrix, formB1Matrix, formB1Matrix, formJMatrix, formJMatrix, formJMatrix, formYMatrix, formYMatrix

Method Detail

getNetworkType

NetworkType getNetworkType()

Returns the value of the 'Network Type' attribute. The literals are from the enumeration NetworkType. Network type: Transmission or Distribution

Returns:

the value of the 'Network Type' attribute.

See Also:

NetworkType, setNetworkType(NetworkType), AclfPackage.getBaseAclfNetwork_NetworkType()

setNetworkType

void setNetworkType(NetworkType value)

Sets the value of the 'Network Type' attribute.

Parameters:

value - the new value of the 'Network Type' attribute.

See Also:

NetworkType, getNetworkType()

isSensitivityCalculated

boolean isSensitivityCalculated()

Returns the value of the 'Sensitivity Calculated' attribute. The default value is "false". An indicator for network sensitivity for remoteQ bus analysis.

Returns:

the value of the 'Sensitivity Calculated' attribute.

See Also:

setSensitivityCalculated(boolean), AclfPackage.getBaseAclfNetwork_SensitivityCalculated()

setSensitivityCalculated

void setSensitivityCalculated(boolean value)

Sets the value of the 'Sensitivity Calculated' attribute.

Parameters:

value - the new value of the 'Sensitivity Calculated' attribute.

See Also:

isSensitivityCalculated()

isLfDataLoaded

boolean isLfDataLoaded()

Returns the value of the 'Lf Data Loaded' attribute. The default value is "false". attribute to indicate if loadflow data has been loaded into the Network

Returns:

the value of the 'Lf Data Loaded' attribute.

See Also:

setLfDataLoaded(boolean), AclfPackage.getBaseAclfNetwork_LfDataLoaded()

setLfDataLoaded

void setLfDataLoaded(boolean value)

Sets the value of the 'Lf Data Loaded' attribute.

Parameters:

value - the new value of the 'Lf Data Loaded' attribute.

See Also:

isLfDataLoaded()

isLfConverged

boolean isLfConverged()

Returns the value of the 'Lf Converged' attribute. The default value is "false". attribute to indicate if loadflow has converged

Returns:

the value of the 'Lf Converged' attribute.

See Also:

setLfConverged(boolean), AclfPackage.getBaseAclfNetwork_LfConverged()

setLfConverged

void setLfConverged(boolean value)

Sets the value of the 'Lf Converged' attribute.

Parameters:

value - the new value of the 'Lf Converged' attribute.

See Also:

isLfConverged()

getZeroZBranchThreshold

double getZeroZBranchThreshold()

Returns the value of the 'Zero ZBranch Threshold' attribute. The default value is "0.00001". small branch Z threshold

Returns:

the value of the 'Zero ZBranch Threshold' attribute.

See Also:

setZeroZBranchThreshold(double), AclfPackage.getBaseAclfNetwork_ZeroZBranchThreshold()

setZeroZBranchThreshold

void setZeroZBranchThreshold(double value)

Sets the value of the 'Zero ZBranch Threshold' attribute.

Parameters:

value - the new value of the 'Zero ZBranch Threshold' attribute.

See Also:

getZeroZBranchThreshold()

getXfrZAdjustSide

BranchBusSide getXfrZAdjustSide()

Returns the value of the 'Xfr ZAdjust Side' attribute. The default value is "FromSide". The literals are from the enumeration BranchBusSide. attribute to indicate xfr Z adjustment Table adjustment side

Returns:

the value of the 'Xfr ZAdjust Side' attribute.

See Also:

BranchBusSide, setXfrZAdjustSide(BranchBusSide), AclfPackage.getBaseAclfNetwork_XfrZAdjustSide()

setXfrZAdjustSide

void setXfrZAdjustSide(BranchBusSide value)

Sets the value of the 'Xfr ZAdjust Side' attribute.

Parameters:

value - the new value of the 'Xfr ZAdjust Side' attribute.

See Also:

BranchBusSide, getXfrZAdjustSide()

getDefaultVoltageLimit

LimitType getDefaultVoltageLimit()

Returns the value of the 'Default Voltage Limit' attribute. The default value is "(1.15, 0.85)". network default bus voltage limit

Returns:

the value of the 'Default Voltage Limit' attribute.

See Also:

setDefaultVoltageLimit(LimitType), AclfPackage.getBaseAclfNetwork_DefaultVoltageLimit()

setDefaultVoltageLimit

void setDefaultVoltageLimit(LimitType value)

Sets the value of the 'Default Voltage Limit' attribute.

Parameters:

value - the new value of the 'Default Voltage Limit' attribute.

See Also:

getDefaultVoltageLimit()

isZeroZBranchProcessed

boolean isZeroZBranchProcessed()

Returns the value of the 'Zero ZBranch Processed' attribute. The default value is "false". true, if zero-Z branches in the net have been processed

Returns:

the value of the 'Zero ZBranch Processed' attribute.

See Also:

setZeroZBranchProcessed(boolean), AclfPackage.getBaseAclfNetwork_ZeroZBranchProcessed()

setZeroZBranchProcessed

void setZeroZBranchProcessed(boolean value)

Sets the value of the 'Zero ZBranch Processed' attribute.

Parameters:

value - the new value of the 'Zero ZBranch Processed' attribute.

See Also:

isZeroZBranchProcessed()

getAclfNetAdjust

AclfNetAdjustment getAclfNetAdjust()

Returns the value of the 'Aclf Net Adjust' containment reference. reference to a container of the AclfNet adjustment objects

Returns:

the value of the 'Aclf Net Adjust' containment reference.

See Also:

setAclfNetAdjust(AclfNetAdjustment), AclfPackage.getBaseAclfNetwork_AclfNetAdjust()

setAclfNetAdjust

void setAclfNetAdjust(AclfNetAdjustment value)

Sets the value of the 'Aclf Net Adjust' containment reference.

Parameters:

value - the new value of the 'Aclf Net Adjust' containment reference.

See Also:

getAclfNetAdjust()

getXfrZTable

org.eclipse.emf.common.util.EList<XfrZTableEntry> getXfrZTable()

Returns the value of the 'Xfr ZTable' containment reference list. The list contents are of type XfrZTableEntry. Xfr Z adjustment table

Returns:

the value of the 'Xfr ZTable' containment reference list.

See Also:

AclfPackage.getBaseAclfNetwork_XfrZTable()

getPsXfrPControlList

org.eclipse.emf.common.util.EList<PSXfrPControl> getPsXfrPControlList()

Returns the value of the 'Ps Xfr PControl List' reference list. The list contents are of type PSXfrPControl. PsXfr angle control object list. PSXfrPControl object is contained by the network and referenced by a branch. It is not retrivable from the network.

Returns:

the value of the 'Ps Xfr PControl List' reference list.

See Also:

AclfPackage.getBaseAclfNetwork_PsXfrPControlList()

getTapControlList

org.eclipse.emf.common.util.EList<TapControl> getTapControlList()

Returns the value of the 'Tap Control List' reference list. The list contents are of type TapControl. Xfr tap control object list. TapControl object is contained by the network and referenced by a branch. It is not retrivable from the network.

Returns:

the value of the 'Tap Control List' reference list.

See Also:

AclfPackage.getBaseAclfNetwork_TapControlList()

getRemoteQBusList

org.eclipse.emf.common.util.EList<RemoteQBus> getRemoteQBusList()

Returns the value of the 'Remote QBus List' reference list. The list contents are of type RemoteQBus. RemoteQBus object list. RemoteQBus object is contained by the network and referenced by a bus. It is not retrivable from the network.

Returns:

the value of the 'Remote QBus List' reference list.

See Also:

AclfPackage.getBaseAclfNetwork_RemoteQBusList()

getSvcList

org.eclipse.emf.common.util.EList<StaticVarCompensator> getSvcList()

Returns the value of the 'Svc List' reference list. The list contents are of type StaticVarCompensator. SVC control object list. SVC object is contained by the network and referenced by a bus. It is not retrivable from the network.

Returns:

the value of the 'Svc List' reference list.

See Also:

AclfPackage.getBaseAclfNetwork_SvcList()

getSpecialBranchList

org.eclipse.emf.common.util.EList<Branch> getSpecialBranchList()

Returns the value of the 'Special Branch List' reference list. The list contents are of type Branch. branch list containing special branch objects, such as 3W xfr, HVDC link ..., which won't be included in the Y-matrix directly.

Returns:

the value of the 'Special Branch List' reference list.

See Also:

AclfPackage.getBaseAclfNetwork_SpecialBranchList()

initBusVoltage

void initBusVoltage()

AclfNetwork initialization for Loadflow run, including Bus Voltage initialization.

initContributeGenLoad

void initContributeGenLoad()
                    throws InterpssException

Initialization multi-contribution genertaors/loads for Loadflow run by consolidating multi-contribution generators/loads to an equiv-gen/load.

Throws:

InterpssException

allocateContributeGenQ

boolean allocateContributeGenQ(double tolerance)

Allocate PV Bus reactive power to individual contribution generators in multi-contribution generator situation. Return false if there is any issue.

getXfrZTableEntry

XfrZTableEntry getXfrZTableEntry(int number)

get xfr Z table entry by the number

adjustXfrZ

void adjustXfrZ()
         throws InterpssException

adjust Xfr Z per the Xfr Z Adjustment Table

Throws:

InterpssException

initBusWithSchedVolt

void initBusWithSchedVolt()

initialize with scheduled/desired voltage

postProcessHVDC

boolean postProcessHVDC()

getYMatrix

ISparseEqnComplex getYMatrix()