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, IChildNet, INet3WXfrElement, NameTag, Network<TBus,TBranch>, org.eclipse.emf.common.notify.Notifier

All Known Subinterfaces:

AclfNetwork, AcscNetwork, BaseAcscNetwork<TBus,TBranch>, BaseDStabNetwork<TBus,TBra>, DStabilityNetwork, OpfNetwork, PlanningAclfNetwork, SENetwork, Static3PNetwork

All Known Implementing Classes:

AclfNetworkImpl, AcscNetworkImpl, BaseAclfNetworkImpl, BaseAcscNetworkImpl, BaseDStabNetworkImpl, DStabilityNetworkImpl, OpfNetworkImpl, PlanningAclfNetworkImpl, SENetworkImpl, Static3PNetworkImpl

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
• Aclf Net Model Type
• Contribute Gen Load Model
• Sensitivity Calculated
• Lf Data Loaded
• Lf Converged
• Zero ZBranch Threshold
• Xfr ZAdjust Side
• Default Voltage Limit
• Aclf Net Adjust
• Xfr ZTable
• Special Branch List

See Also:

AclfPackage.getBaseAclfNetwork()

Method Summary

Modifier and Type	Method and Description
boolean	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.
void	calLoadDFactor() calculate Load distribution factors.
void	calLoadDFactor(java.util.function.Predicate<AclfLoad> predicate) calculate Load distribution factors.
AclfNetAdjustment	getAclfNetAdjust() Returns the value of the 'Aclf Net Adjust' containment reference.
AclfNetModelType	getAclfNetModelType() Returns the value of the 'Aclf Net Model Type' attribute.
LimitType	getDefaultVoltageLimit() Returns the value of the 'Default Voltage Limit' attribute.
NetworkType	getNetworkType() Returns the value of the 'Network Type' attribute.
Branch	getSpecialBranch(java.lang.String Id) Get a special branch object identified by id
org.eclipse.emf.common.util.EList<Branch>	getSpecialBranchList() Returns the value of the 'Special Branch 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
double	getZeroZBranchThreshold() Returns the value of the 'Zero ZBranch Threshold' attribute.
boolean	hasSwingBus() check if there is at least one swing bus
void	initBusVoltage() AclfNetwork initialization for Loadflow run, including Bus Voltage initialization.
boolean	initContributeGenLoad(boolean dclfOnly) Initialization multi-contribution genertaors/loads for Loadflow run by consolidating multi-contribution generators/loads to an equiv-gen/load.
boolean	isContributeGenLoadModel() Returns the value of the 'Contribute Gen Load Model' attribute.
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.
void	setAclfNetAdjust(AclfNetAdjustment value) Sets the value of the 'Aclf Net Adjust' containment reference.
void	setAclfNetModelType(AclfNetModelType value) Sets the value of the 'Aclf Net Model Type' attribute.
void	setContributeGenLoadModel(boolean value) Sets the value of the 'Contribute Gen Load Model' attribute.
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	setZeroZBranchThreshold(double value) Sets the value of the 'Zero ZBranch Threshold' attribute.

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

accept, addArea, addBranch, addBranch, addBranch, addBranch2Cache, addBranch2Cache, addBranch2Cache, addBus, addBus2Cache, addGroundBranch, addOwner, addSubstation, addTieLine, addZone, arrangeBusNumber, cachedBranches2Net, cachedBuses2Net, formAdjacencyMatrix, getArea, getArea, getAreaMap, getBaseKva, getBaseMva, getBranch, getBranch, getBranch, getBranches, getBranches, getBranchList, getBus, getBus, getBusList, getChildNetWrapperList, getExtraInfo, getFrequency, getNoActiveBranch, getNoActiveBranch, getNoActiveBus, getNoActiveBus, getNoBranch, getNoBranch, getNoBus, getNoBus, getOriginalDataFormat, getOwner, getOwner, getOwnerMap, getRefBusId, getRefBusIdSet, getRefBusType, getSubstation, getSubstationMap, getSubstationMap, getTieLineList, getTimeStamp, getZone, getZone, getZoneMap, hasBranch, hasBranch, hasBus, hzCopy, isAllowGroundBranch, isBusNumberArranged, isBypassDataCheck, isDataChecked, isOnlineModel, isRefBus, net2String, rebuildLookupTable, removeBranch, removeBranch, removeBranch, removeBus, removeBus, removeTieLine, replaceBus, setAllowGroundBranch, setBaseKva, setBusNumberArranged, setBypassDataCheck, setDataChecked, setExtraInfo, setFrequency, setOriginalDataFormat, setRefBusId, setRefBusIdSet, setRefBusType, setTimeStamp, setToEmpty, setVisitedStatus, updateBranchId

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 com.hazelcast.nio.serialization.DataSerializable

readData, writeData

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

getChildNetWrapper, 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

calExternalPowerIntoNet, hasBranchMavRatingViolation, maxMismatch, maxMismatch, maxMismatch, smallestLoad, totalGeneration, totalLoad, 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()

getAclfNetModelType

AclfNetModelType getAclfNetModelType()

Returns the value of the 'Aclf Net Model Type' attribute. The default value is "Regular". The literals are from the enumeration AclfNetModelType. flag to indicate zero-Z branch processing model

Returns:

the value of the 'Aclf Net Model Type' attribute.

See Also:

AclfNetModelType, setAclfNetModelType(AclfNetModelType), AclfPackage.getBaseAclfNetwork_AclfNetModelType()

setAclfNetModelType

void setAclfNetModelType(AclfNetModelType value)

Sets the value of the 'Aclf Net Model Type' attribute.

Parameters:

value - the new value of the 'Aclf Net Model Type' attribute.

See Also:

AclfNetModelType, getAclfNetModelType()

isContributeGenLoadModel

boolean isContributeGenLoadModel()

Returns the value of the 'Contribute Gen Load Model' attribute. The default value is "false". A flag for indicating is the AclfNetwork is of contributeGen/Load type

Returns:

the value of the 'Contribute Gen Load Model' attribute.

See Also:

setContributeGenLoadModel(boolean), AclfPackage.getBaseAclfNetwork_ContributeGenLoadModel()

setContributeGenLoadModel

void setContributeGenLoadModel(boolean value)

Sets the value of the 'Contribute Gen Load Model' attribute.

Parameters:

value - the new value of the 'Contribute Gen Load Model' attribute.

See Also:

isContributeGenLoadModel()

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()

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()

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. Network.branchList stores 2-terminal branches. This special branch list contains 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

boolean initContributeGenLoad(boolean dclfOnly)

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

Parameters:

dclfOnly - initialization for Dclf only

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.

calLoadDFactor

void calLoadDFactor()
             throws InterpssException

calculate Load distribution factors. The network has to be contributeGenLoadModel

Throws:

InterpssException

calLoadDFactor

void calLoadDFactor(java.util.function.Predicate<AclfLoad> predicate)
             throws InterpssException

calculate Load distribution factors. The network has to be contributeGenLoadModel

Parameters:

predicate - predicate to determine if an AclfLoad is included in the Load distribution factor calculation.

Throws:

InterpssException

getXfrZTableEntry

XfrZTableEntry getXfrZTableEntry(int number)

get xfr Z table entry by the number

adjustXfrZ

boolean adjustXfrZ()

adjust Xfr Z per the Xfr Z Adjustment Table

hasSwingBus

boolean hasSwingBus()

check if there is at least one swing bus

getSpecialBranch

Branch getSpecialBranch(java.lang.String Id)

Get a special branch object identified by id

Parameters:

Id - from bus id