com.interpss.core.dclf

Interface DcLoadflow

All Superinterfaces:

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

All Known Subinterfaces:

DclfAlgorithm

All Known Implementing Classes:

DclfAlgorithmImpl, DcLoadflowImpl

public interface DcLoadflow
extends NetworkRef<AclfNetwork>, IDclfResult

A representation of the model object 'Dc Loadflow'. Class for defining Dclf algorithm object

The following features are supported:

• Dclf Calculated
• Apply Adjustment
• Adj Max Iterations
• Adj Tolerance
• Acc Factor

See Also:

DclfPackage.getDcLoadflow()

Method Summary

Modifier and Type	Method and Description
boolean	calculateDclf() Calculate DC Loadflow and cache the results.
boolean	checkCondition() boolean for checking Dclf calculation precondition
double	getAccFactor() Returns the value of the 'Acc Factor' attribute.
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.
IDclfSolver	getDclfSolver() get Dclf solver object
boolean	isApplyAdjustment() Returns the value of the 'Apply Adjustment' attribute.
boolean	isDclfCalculated() Returns the value of the 'Dclf Calculated' attribute.
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 solver) set Dclf solver object
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.

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

getNetwork, setNetwork

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 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.dclf.IDclfResult

getBranchFlow, getBranchFlow, getBranchFlow, getBusAngle, getBusAngle, getBusPower, 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), DclfPackage.getDcLoadflow_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), DclfPackage.getDcLoadflow_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), DclfPackage.getDcLoadflow_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), DclfPackage.getDcLoadflow_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), DclfPackage.getDcLoadflow_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()

checkCondition

boolean checkCondition()

boolean for checking Dclf calculation precondition

calculateDclf

boolean calculateDclf()
               throws InterpssException,
                      ReferenceBusException,
                      IpssNumericException

Calculate DC Loadflow and cache the results. Branch flow results are cached in the aclfBranch.weight and aclfBranch.intFlag

Throws:

InterpssException

ReferenceBusException

IpssNumericException

getDclfSolver

IDclfSolver getDclfSolver()

get Dclf solver object

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.

setDclfSolver

void setDclfSolver(IDclfSolver solver)

set Dclf solver object