com.interpss.core.algo

Interface LoadflowAlgorithm

All Superinterfaces:

com.hazelcast.nio.serialization.DataSerializable, org.eclipse.emf.ecore.EObject, IAclfNetBVisitor, NameTag, NetworkRef<BaseAclfNetwork<?,?>>, org.eclipse.emf.common.notify.Notifier

All Known Subinterfaces:

AclfDclfAlgorithm<TDcAlgo>

All Known Implementing Classes:

AclfDclfAlgorithmImpl, LoadflowAlgorithmImpl

public interface LoadflowAlgorithm
extends NetworkRef<BaseAclfNetwork<?,?>>, IAclfNetBVisitor

A representation of the model object 'Loadflow Algorithm'. Implementation of Loadflow algorithms (NR, PQ, GS and Custome). For adjustment, there are two important concepts: 1) Adjustment at Bus/Branch level, for example, apply PVBusLimit, TapControl. LfAlgo.applyAdjustAlgo turns on/off the adjustment. This category of adjustments will be done in each LF iteration step. The LfAdjustAlgorithm class is for the implementation of this category. 2) NetAdjustment - some adjustments are applied outside Loadflow iteration at the Network level. When to apply might need to be controlled. NetAdjustAlgorithm class is for implementing this set of adjustments. For serialization - AclfNet object and INRSolver object are trainsient. It can be applied to single network and multiple networks Loadflow calculation.

The following features are supported:

• Lf Method
• Non Divergent
• Max Iterations
• Tolerance
• Turn Off Island Bus
• B11 Matrix Dirty
• Gs Acc Factor
• Init Bus Voltage
• Data Check Config
• Net Adj Algo
• Lf Adj Algo
• Custom Method
• Lf Calculator
• Child Net Solver

See Also:

CoreAlgorithmPackage.getLoadflowAlgorithm()

Field Summary

Fields inherited from interface com.interpss.core.common.visitor.IAclfNetBVisitor

copyright

Method Summary

Modifier and Type	Method and Description
void	distributeLoad(double totalLoad) distribute the total load to Bus.contributeLoad.loadCP, based on the AclfLoad.dFactor.
AclfNetwork	getAclfNet() get the AclfNetwork object
IChildNetLfSolver	getChildNetSolver() Returns the value of the 'Child Net Solver' reference.
CustomLFMethod	getCustomMethod() Returns the value of the 'Custom Method' containment reference.
DataCheckConfiguration	getDataCheckConfig() Returns the value of the 'Data Check Config' containment reference.
double	getGsAccFactor() Returns the value of the 'Gs Acc Factor' attribute.
LfAdjustAlgorithm	getLfAdjAlgo() Returns the value of the 'Lf Adj Algo' containment reference.
LfCalculator	getLfCalculator() Returns the value of the 'Lf Calculator' containment reference.
AclfMethodType	getLfMethod() Returns the value of the 'Lf Method' attribute.
int	getMaxIterations() Returns the value of the 'Max Iterations' attribute.
NetAdjustAlgorithm	getNetAdjAlgo() Returns the value of the 'Net Adj Algo' containment reference.
double	getTolerance() Returns the value of the 'Tolerance' attribute.
double	getTolerance(Unit.UnitType unit, double baseKva) get tolerance in the unit specified
boolean	initializeAclfNet() Initialize the aclf network prior to running power flow.
boolean	isB11MatrixDirty() Returns the value of the 'B11 Matrix Dirty' attribute.
boolean	isInitBusVoltage() Returns the value of the 'Init Bus Voltage' attribute.
boolean	isNonDivergent() Returns the value of the 'Non Divergent' attribute.
boolean	isTurnOffIslandBus() Returns the value of the 'Turn Off Island Bus' attribute.
boolean	loadflow() perform LoadFlow calculation.
boolean	loadflow(boolean initNetwork) perform LoadFlow calculation.
boolean	loadflow(java.util.function.Consumer<BaseAclfNetwork<?,?>> extAclfNetDataChecker) perform LoadFlow calculation with an extenal AclfNetwork data checker.
boolean	needAdjustment() Check if there is a need to perform adjustment.
boolean	performAdjustment(Mismatch netMismatch, AclfMethodType lfMethod) Perform adjustment.
void	setB11MatrixDirty(boolean value) Sets the value of the 'B11 Matrix Dirty' attribute.
void	setChildNetSolver(IChildNetLfSolver value) Sets the value of the 'Child Net Solver' reference.
void	setCustomMethod(CustomLFMethod value) Sets the value of the 'Custom Method' containment reference.
void	setDataCheckConfig(DataCheckConfiguration value) Sets the value of the 'Data Check Config' containment reference.
void	setGsAccFactor(double value) Sets the value of the 'Gs Acc Factor' attribute.
void	setInitBusVoltage(boolean value) Sets the value of the 'Init Bus Voltage' attribute.
void	setLfAdjAlgo(LfAdjustAlgorithm value) Sets the value of the 'Lf Adj Algo' containment reference.
void	setLfCalculator(LfCalculator value) Sets the value of the 'Lf Calculator' containment reference.
void	setLfMethod(AclfMethodType value) Sets the value of the 'Lf Method' attribute.
void	setMaxIterations(int value) Sets the value of the 'Max Iterations' attribute.
void	setNetAdjAlgo(NetAdjustAlgorithm value) Sets the value of the 'Net Adj Algo' containment reference.
void	setNonDivergent(boolean value) Sets the value of the 'Non Divergent' attribute.
void	setTolerance(double value) Sets the value of the 'Tolerance' attribute.
void	setTolerance(double e, Unit.UnitType unit, double baseKva) set tolerance in the unit specified
void	setTurnOffIslandBus(boolean value) Sets the value of the 'Turn Off Island Bus' attribute.

Methods inherited from interface com.interpss.core.net.ref.NetworkRef

getNetwork, setNetwork

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.common.visitor.IAclfNetBVisitor

visit

Method Detail

getMaxIterations

int getMaxIterations()

Returns the value of the 'Max Iterations' attribute. The default value is "20".

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

attribute for max iterations for loadflow. For multi-net Loadflow, it also controls number of iterations between the main network and the child network(s).

Returns:

the value of the 'Max Iterations' attribute.

See Also:

setMaxIterations(int), CoreAlgorithmPackage.getLoadflowAlgorithm_MaxIterations()

setMaxIterations

void setMaxIterations(int value)

Sets the value of the 'Max Iterations' attribute.

Parameters:

value - the new value of the 'Max Iterations' attribute.

See Also:

getMaxIterations()

getTolerance

double getTolerance()

Returns the value of the 'Tolerance' attribute. The default value is "0.0001".

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

attribute for loadflow tolerance

Returns:

the value of the 'Tolerance' attribute.

See Also:

setTolerance(double), CoreAlgorithmPackage.getLoadflowAlgorithm_Tolerance()

setTolerance

void setTolerance(double value)

Sets the value of the 'Tolerance' attribute.

Parameters:

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

See Also:

getTolerance()

isTurnOffIslandBus

boolean isTurnOffIslandBus()

Returns the value of the 'Turn Off Island Bus' attribute. The default value is "true".

If the meaning of the 'Turn Off Island Bus' attribute isn't clear, there really should be more of a description here...

option to turn island bus off

Returns:

the value of the 'Turn Off Island Bus' attribute.

See Also:

setTurnOffIslandBus(boolean), CoreAlgorithmPackage.getLoadflowAlgorithm_TurnOffIslandBus()

setTurnOffIslandBus

void setTurnOffIslandBus(boolean value)

Sets the value of the 'Turn Off Island Bus' attribute.

Parameters:

value - the new value of the 'Turn Off Island Bus' attribute.

See Also:

isTurnOffIslandBus()

isB11MatrixDirty

boolean isB11MatrixDirty()

Returns the value of the 'B11 Matrix Dirty' attribute. The default value is "true".

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

attribute to indicate B11 matrix dirty status.

Returns:

the value of the 'B11 Matrix Dirty' attribute.

See Also:

setB11MatrixDirty(boolean), CoreAlgorithmPackage.getLoadflowAlgorithm_B11MatrixDirty()

setB11MatrixDirty

void setB11MatrixDirty(boolean value)

Sets the value of the 'B11 Matrix Dirty' attribute.

Parameters:

value - the new value of the 'B11 Matrix Dirty' attribute.

See Also:

isB11MatrixDirty()

getGsAccFactor

double getGsAccFactor()

Returns the value of the 'Gs Acc Factor' attribute. The default value is "1.0".

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

GS acceleration factor

Returns:

the value of the 'Gs Acc Factor' attribute.

See Also:

setGsAccFactor(double), CoreAlgorithmPackage.getLoadflowAlgorithm_GsAccFactor()

setGsAccFactor

void setGsAccFactor(double value)

Sets the value of the 'Gs Acc Factor' attribute.

Parameters:

value - the new value of the 'Gs Acc Factor' attribute.

See Also:

getGsAccFactor()

isInitBusVoltage

boolean isInitBusVoltage()

Returns the value of the 'Init Bus Voltage' attribute. The default value is "true". option to init AclfNet, including bus initial voltage, before a Loadflow run

Returns:

the value of the 'Init Bus Voltage' attribute.

See Also:

setInitBusVoltage(boolean), CoreAlgorithmPackage.getLoadflowAlgorithm_InitBusVoltage()

setInitBusVoltage

void setInitBusVoltage(boolean value)

Sets the value of the 'Init Bus Voltage' attribute.

Parameters:

value - the new value of the 'Init Bus Voltage' attribute.

See Also:

isInitBusVoltage()

getDataCheckConfig

DataCheckConfiguration getDataCheckConfig()

Returns the value of the 'Data Check Config' containment reference. referece to network adjustment/control object container

Returns:

the value of the 'Data Check Config' containment reference.

See Also:

setDataCheckConfig(DataCheckConfiguration), CoreAlgorithmPackage.getLoadflowAlgorithm_DataCheckConfig()

setDataCheckConfig

void setDataCheckConfig(DataCheckConfiguration value)

Sets the value of the 'Data Check Config' containment reference.

Parameters:

value - the new value of the 'Data Check Config' containment reference.

See Also:

getDataCheckConfig()

getLfMethod

AclfMethodType getLfMethod()

Returns the value of the 'Lf Method' attribute. The default value is "NR". The literals are from the enumeration AclfMethodType.

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

loadflow method

Returns:

the value of the 'Lf Method' attribute.

See Also:

AclfMethodType, setLfMethod(AclfMethodType), CoreAlgorithmPackage.getLoadflowAlgorithm_LfMethod()

setLfMethod

void setLfMethod(AclfMethodType value)

Sets the value of the 'Lf Method' attribute.

Parameters:

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

See Also:

AclfMethodType, getLfMethod()

isNonDivergent

boolean isNonDivergent()

Returns the value of the 'Non Divergent' attribute. The default value is "false".

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

attribute for non divergent loadflow

Returns:

the value of the 'Non Divergent' attribute.

See Also:

setNonDivergent(boolean), CoreAlgorithmPackage.getLoadflowAlgorithm_NonDivergent()

setNonDivergent

void setNonDivergent(boolean value)

Sets the value of the 'Non Divergent' attribute.

Parameters:

value - the new value of the 'Non Divergent' attribute.

See Also:

isNonDivergent()

getNetAdjAlgo

NetAdjustAlgorithm getNetAdjAlgo()

Returns the value of the 'Net Adj Algo' containment reference. It is bidirectional and its opposite is 'Lf Algo'.

If the meaning of the 'Net Adj Algo' reference isn't clear, there really should be more of a description here...

referece to network adjustment/control object container

Returns:

the value of the 'Net Adj Algo' containment reference.

See Also:

setNetAdjAlgo(NetAdjustAlgorithm), CoreAlgorithmPackage.getLoadflowAlgorithm_NetAdjAlgo(), NetAdjustAlgorithm.getLfAlgo()

setNetAdjAlgo

void setNetAdjAlgo(NetAdjustAlgorithm value)

Sets the value of the 'Net Adj Algo' containment reference.

Parameters:

value - the new value of the 'Net Adj Algo' containment reference.

See Also:

getNetAdjAlgo()

getLfAdjAlgo

LfAdjustAlgorithm getLfAdjAlgo()

Returns the value of the 'Lf Adj Algo' containment reference. It is bidirectional and its opposite is 'Lf Algo'.

If the meaning of the 'Lf Adj Algo' reference isn't clear, there really should be more of a description here...

referece to bus/branch adjustment/control object container

Returns:

the value of the 'Lf Adj Algo' containment reference.

See Also:

setLfAdjAlgo(LfAdjustAlgorithm), CoreAlgorithmPackage.getLoadflowAlgorithm_LfAdjAlgo(), LfAdjustAlgorithm.getLfAlgo()

setLfAdjAlgo

void setLfAdjAlgo(LfAdjustAlgorithm value)

Sets the value of the 'Lf Adj Algo' containment reference.

Parameters:

value - the new value of the 'Lf Adj Algo' containment reference.

See Also:

getLfAdjAlgo()

getLfCalculator

LfCalculator getLfCalculator()

Returns the value of the 'Lf Calculator' containment reference. It is bidirectional and its opposite is 'Lf Algo'.

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

referece to loadflow calculator, where loadflow calculation is implemented.

Returns:

the value of the 'Lf Calculator' containment reference.

See Also:

setLfCalculator(LfCalculator), CoreAlgorithmPackage.getLoadflowAlgorithm_LfCalculator(), LfCalculator.getLfAlgo()

setLfCalculator

void setLfCalculator(LfCalculator value)

Sets the value of the 'Lf Calculator' containment reference.

Parameters:

value - the new value of the 'Lf Calculator' containment reference.

See Also:

getLfCalculator()

getChildNetSolver

IChildNetLfSolver getChildNetSolver()

Returns the value of the 'Child Net Solver' reference. referece to multi-net loadflow solver

Returns:

the value of the 'Child Net Solver' reference.

See Also:

setChildNetSolver(IChildNetLfSolver), CoreAlgorithmPackage.getLoadflowAlgorithm_ChildNetSolver()

setChildNetSolver

void setChildNetSolver(IChildNetLfSolver value)

Sets the value of the 'Child Net Solver' reference.

Parameters:

value - the new value of the 'Child Net Solver' reference.

See Also:

getChildNetSolver()

getAclfNet

AclfNetwork getAclfNet()

get the AclfNetwork object

getCustomMethod

CustomLFMethod getCustomMethod()

Returns the value of the 'Custom Method' containment reference.

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

referece to custom Loadflow method definition object

Returns:

the value of the 'Custom Method' containment reference.

See Also:

setCustomMethod(CustomLFMethod), CoreAlgorithmPackage.getLoadflowAlgorithm_CustomMethod()

setCustomMethod

void setCustomMethod(CustomLFMethod value)

Sets the value of the 'Custom Method' containment reference.

Parameters:

value - the new value of the 'Custom Method' containment reference.

See Also:

getCustomMethod()

loadflow

boolean loadflow()
          throws InterpssException

perform LoadFlow calculation. The algorithm used will be determined by the lfMethod attribute.

Throws:

InterpssException

loadflow

boolean loadflow(java.util.function.Consumer<BaseAclfNetwork<?,?>> extAclfNetDataChecker)
          throws InterpssException

perform LoadFlow calculation with an extenal AclfNetwork data checker. The algorithm used will be determined by the lfMethod attribute.

Throws:

InterpssException

loadflow

boolean loadflow(boolean initNetwork)
          throws InterpssException

perform LoadFlow calculation. The algorithm used will be determined by the lfMethod attribute.

Parameters:

initNetwork - flag to define if the network needs to be reinitialized, this should be called after any generation, load and topology changes is applied to the network

Throws:

InterpssException

initializeAclfNet

boolean initializeAclfNet()
                   throws InterpssException

Initialize the aclf network prior to running power flow. This should be called after any generation, load and topology change is applied to the network, especially running power flow in a time series power flow or repeated manner.

Throws:

InterpssException

getTolerance

double getTolerance(Unit.UnitType unit,
                    double baseKva)

get tolerance in the unit specified

Parameters:

unit - tolerance unit

baseKva - base kva for unit conversion

setTolerance

void setTolerance(double e,
                  Unit.UnitType unit,
                  double baseKva)

set tolerance in the unit specified

Parameters:

e - tolerance

unit - tolerance unit

baseKva - base kva for unit conversion

needAdjustment

boolean needAdjustment()
                throws IpssNumericException

Check if there is a need to perform adjustment. It delegates the decision to the LfAdjustAlgorithm and NetAdjustAlgorithm. The info is used when checking LF convergence. The actual adjustment might be delayed depending on adjustment implementation.

Throws:

IpssNumericException

performAdjustment

boolean performAdjustment(Mismatch netMismatch,
                          AclfMethodType lfMethod)

Perform adjustment. It delegates the action to the LfAdjustAlgorithm and NetAdjustAlgorithm. Rules may be implement to determine when the adjustment might be performed.

Parameters:

netMismatch - max mismatch in the network

lfMethod - Aclf method

distributeLoad

void distributeLoad(double totalLoad)

distribute the total load to Bus.contributeLoad.loadCP, based on the AclfLoad.dFactor. Both P and Q are adjusted.

Parameters:

totalLoad - if set to true, reset Dclf Algorithm, for example, BMatrix, for the dc loadflow calculation.