com.interpss.core.algo.dclf

Interface DclfAlgorithm

All Superinterfaces:

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

All Known Subinterfaces:

ContingencyAnalysisAlgorithm, EDclfAlgorithm, NetGenAdjustAlgorithm, SenAnalysisAlgorithm

All Known Implementing Classes:

ContingencyAnalysisAlgorithmImpl, DclfAlgorithmImpl, EDclfAlgorithmImpl, NetGenAdjustAlgorithmImpl, SenAnalysisAlgorithmImpl

public interface DclfAlgorithm
extends NetworkRef<BaseAclfNetwork<?,?>>, IDclfAlgoLookup, IDclfResult

A representation of the model object 'Dc Loadflow'. Dclf algorithm object and Dclf calculation method definition. It contains a list of DclfAlgoBus and a list of DclfAlgoBranch.

The following features are supported:

• Dclf Calculated
• Apply Adjustment
• Adj Max Iterations
• Adj Tolerance
• Acc Factor
• Dclf Solver
• Dclf Algo Bus List
• Dclf Algo Branch List

See Also:

DclfAlgorithmPackage.getDclfAlgorithm()

Method Summary

Modifier and Type	Method and Description
boolean	calculateDclf() Calculate DC Loadflow and cache the results.
boolean	calculateDclf(boolean reset) Calculate DC Loadflow and cache the results.
boolean	calculateDclf(DclfMethod method) Calculate DC Loadflow and cache the results.
boolean	calculateDclf(DclfMethod method, boolean reset) Calculate DC Loadflow and cache the results.
boolean	checkCondition() boolean for checking Dclf calculation precondition
DclfAlgorithm	deepCopy() make copy of all fields and refrences.
void	distributeLoad(double totalLoad) distribute the total load to DclfAlgoLoad.adjust field, based on the AclfLoad.dFactor
double	getAccFactor() Returns the value of the 'Acc Factor' attribute.
AclfNetwork	getAclfNet() get the AclfNetwork object
int	getAdjMaxIterations() Returns the value of the 'Adj Max Iterations' attribute.
double	getAdjTolerance() Returns the value of the 'Adj Tolerance' attribute.
ISparseEqnDouble	getB11Matrix() This is a wrapper of aclfNet.formBMatrix() method, making it ready to be used.
ISparseEqnDouble	getB1Matrix() This is a wrapper of aclfNet.formBMatrix() method, making it ready to be used.
DclfAlgoBranch	getDclfAlgoBranch(java.lang.String branchId) get the DclfAlgoBranch object by branch id
org.eclipse.emf.common.util.EList<DclfAlgoBranch>	getDclfAlgoBranchList() Returns the value of the 'Dclf Algo Branch List' containment reference list.
DclfAlgoBus	getDclfAlgoBus(java.lang.String busId) get the DclfAlgoBus object by bus id
org.eclipse.emf.common.util.EList<DclfAlgoBus>	getDclfAlgoBusList() Returns the value of the 'Dclf Algo Bus List' containment reference list.
IDclfSolver	getDclfSolver() Returns the value of the 'Dclf Solver' attribute.
boolean	isApplyAdjustment() Returns the value of the 'Apply Adjustment' attribute.
boolean	isDclfCalculated() Returns the value of the 'Dclf Calculated' attribute.
boolean	removeDclfAlgoBranch(java.lang.String branchId) Remove the DclfAlgo branch object identified by the busId from the container.
boolean	removeDclfAlgoBus(java.lang.String busId) Remove the DclfAlgo bus object identified by the busId from the container.
void	setAccFactor(double value) Sets the value of the 'Acc Factor' attribute.
void	setAdjMaxIterations(int value) Sets the value of the 'Adj Max Iterations' attribute.
void	setAdjTolerance(double value) Sets the value of the 'Adj Tolerance' attribute.
void	setApplyAdjustment(boolean value) Sets the value of the 'Apply Adjustment' attribute.
void	setDclfCalculated(boolean value) Sets the value of the 'Dclf Calculated' attribute.
void	setDclfSolver(IDclfSolver value) Sets the value of the 'Dclf Solver' attribute.
void	setRefBus(java.lang.String busId) set ref bus identified by busId for the analysis.
void	setRefBus(java.lang.String[] busIdAry) set ref bus for the analysis according some rule.
boolean	transfer2AclfNet(boolean clearGenLoadAdjInfo) Transfer Dclf info (Gen/Load adjust) and results (voltage angle) to the AclfNetwork object.

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.algo.dclf.IDclfAlgoLookup

getDclfAlgoBranchIdLookupTable, getDclfAlgoBusIdLookupTable, getDclfAlgoGenNameLookupTable, getDclfAlgoLoadNameLookupTable, rebuildLookupRefRelationship

Methods inherited from interface com.interpss.core.algo.dclf.IDclfResult

calTotalGen, calTotalLoad, getBranchFlow, getBranchFlow, getBranchFlow, getBusAngle, getBusAngle, getBusPower, getBusPower, getBusPowerInfoNet, getBusPowerInfoNet, getMismatch, loading, loading, loss, ratingViolation, ratingViolation

Method Detail

isDclfCalculated

boolean isDclfCalculated()

Returns the value of the 'Dclf Calculated' attribute. The default value is "false".

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

Dclf calculation status

Returns:

the value of the 'Dclf Calculated' attribute.

See Also:

setDclfCalculated(boolean), DclfAlgorithmPackage.getDclfAlgorithm_DclfCalculated()

setDclfCalculated

void setDclfCalculated(boolean value)

Sets the value of the 'Dclf Calculated' attribute.

Parameters:

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

See Also:

isDclfCalculated()

isApplyAdjustment

boolean isApplyAdjustment()

Returns the value of the 'Apply Adjustment' attribute. The default value is "false".

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

apply adjustment during Dclf calculation process

Returns:

the value of the 'Apply Adjustment' attribute.

See Also:

setApplyAdjustment(boolean), DclfAlgorithmPackage.getDclfAlgorithm_ApplyAdjustment()

setApplyAdjustment

void setApplyAdjustment(boolean value)

Sets the value of the 'Apply Adjustment' attribute.

Parameters:

value - the new value of the 'Apply Adjustment' attribute.

See Also:

isApplyAdjustment()

getAdjMaxIterations

int getAdjMaxIterations()

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

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

max iterations for the dclf adjustment

Returns:

the value of the 'Adj Max Iterations' attribute.

See Also:

setAdjMaxIterations(int), DclfAlgorithmPackage.getDclfAlgorithm_AdjMaxIterations()

setAdjMaxIterations

void setAdjMaxIterations(int value)

Sets the value of the 'Adj Max Iterations' attribute.

Parameters:

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

See Also:

getAdjMaxIterations()

getAdjTolerance

double getAdjTolerance()

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

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

Dclf adjustment tolerance

Returns:

the value of the 'Adj Tolerance' attribute.

See Also:

setAdjTolerance(double), DclfAlgorithmPackage.getDclfAlgorithm_AdjTolerance()

setAdjTolerance

void setAdjTolerance(double value)

Sets the value of the 'Adj Tolerance' attribute.

Parameters:

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

See Also:

getAdjTolerance()

getAccFactor

double getAccFactor()

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

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

Dclf adjustment accelearion factor

Returns:

the value of the 'Acc Factor' attribute.

See Also:

setAccFactor(double), DclfAlgorithmPackage.getDclfAlgorithm_AccFactor()

setAccFactor

void setAccFactor(double value)

Sets the value of the 'Acc Factor' attribute.

Parameters:

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

See Also:

getAccFactor()

getDclfAlgoBusList

org.eclipse.emf.common.util.EList<DclfAlgoBus> getDclfAlgoBusList()

Returns the value of the 'Dclf Algo Bus List' containment reference list. The list contents are of type DclfAlgoBus. Dclf algo bus list

Returns:

the value of the 'Dclf Algo Bus List' containment reference list.

See Also:

DclfAlgorithmPackage.getDclfAlgorithm_DclfAlgoBusList()

getDclfAlgoBranchList

org.eclipse.emf.common.util.EList<DclfAlgoBranch> getDclfAlgoBranchList()

Returns the value of the 'Dclf Algo Branch List' containment reference list. The list contents are of type DclfAlgoBranch. Dclf algo bus list

Returns:

the value of the 'Dclf Algo Branch List' containment reference list.

See Also:

DclfAlgorithmPackage.getDclfAlgorithm_DclfAlgoBranchList()

checkCondition

boolean checkCondition()

boolean for checking Dclf calculation precondition

distributeLoad

void distributeLoad(double totalLoad)

distribute the total load to DclfAlgoLoad.adjust field, based on the AclfLoad.dFactor

Parameters:

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

calculateDclf

boolean calculateDclf()

Calculate DC Loadflow and cache the results. Branch flow results are cached in the aclfBranch.dclfFlow and aclfBus.dclfInjectP.

calculateDclf

boolean calculateDclf(DclfMethod method)

Calculate DC Loadflow and cache the results. Branch flow results are cached in the aclfBranch.dclfFlow and aclfBus.dclfInjectP.

Parameters:

method - Dclf method

calculateDclf

boolean calculateDclf(boolean reset)

Calculate DC Loadflow and cache the results. Branch flow results are cached in the aclfBranch.dclfFlow and aclfBus.dclfInjectP.

Parameters:

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

calculateDclf

boolean calculateDclf(DclfMethod method,
                      boolean reset)

Calculate DC Loadflow and cache the results. Branch flow results are cached in the aclfBranch.dclfFlow and aclfBus.dclfInjectP.

Parameters:

method - Dclf method

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

getDclfSolver

IDclfSolver getDclfSolver()

Returns the value of the 'Dclf Solver' attribute. The default value is "". Dclf solver object

Returns:

the value of the 'Dclf Solver' attribute.

See Also:

setDclfSolver(IDclfSolver), DclfAlgorithmPackage.getDclfAlgorithm_DclfSolver()

getB1Matrix

ISparseEqnDouble getB1Matrix()
                      throws InterpssException

This is a wrapper of aclfNet.formBMatrix() method, making it ready to be used.

Throws:

InterpssException

getB11Matrix

ISparseEqnDouble getB11Matrix()
                       throws InterpssException

This is a wrapper of aclfNet.formBMatrix() method, making it ready to be used.

Throws:

InterpssException

setRefBus

void setRefBus(java.lang.String busId)

set ref bus identified by busId for the analysis. [B] matrix is set dirty also.

Parameters:

busId - bus id

setRefBus

void setRefBus(java.lang.String[] busIdAry)

set ref bus for the analysis according some rule. For example, select a non-gen and non-load bus. [B] matrix is set dirty also.

Parameters:

busIdAry - a list of bus ids which should not be set as the reference bus.

getDclfAlgoBus

DclfAlgoBus getDclfAlgoBus(java.lang.String busId)

get the DclfAlgoBus object by bus id

Parameters:

busId - bus id

getDclfAlgoBranch

DclfAlgoBranch getDclfAlgoBranch(java.lang.String branchId)

get the DclfAlgoBranch object by branch id

Parameters:

branchId - bus id

removeDclfAlgoBus

boolean removeDclfAlgoBus(java.lang.String busId)

Remove the DclfAlgo bus object identified by the busId from the container.

Parameters:

busId - bus id

removeDclfAlgoBranch

boolean removeDclfAlgoBranch(java.lang.String branchId)

Remove the DclfAlgo branch object identified by the busId from the container.

Parameters:

branchId - bus id

setDclfSolver

void setDclfSolver(IDclfSolver value)

Sets the value of the 'Dclf Solver' attribute.

Parameters:

value - the new value of the 'Dclf Solver' attribute.

See Also:

getDclfSolver()

transfer2AclfNet

boolean transfer2AclfNet(boolean clearGenLoadAdjInfo)

Transfer Dclf info (Gen/Load adjust) and results (voltage angle) to the AclfNetwork object.

Parameters:

clearGenLoadAdjInfo - if true, clear all Dclf Gen/Load adjustment info

deepCopy

DclfAlgorithm deepCopy()

make copy of all fields and refrences. Its actual implementation is done by the HZ read/writeData() methods.

getAclfNet

AclfNetwork getAclfNet()

get the AclfNetwork object