LfAdjustAlgorithm

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

LfAdjustAlgorithmImpl
```
public interface LfAdjustAlgorithm
extends org.eclipse.emf.ecore.EObject
```
A representation of the model object 'Lf Adjust Config'. Loadflow bus/branch adjustment/control algorithm implementation class
The following features are supported:
See Also:

CoreAlgorithmPackage.getLfAdjustAlgorithm()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`doAllAdjust(Mismatch mismatch, AclfMethodType lfMethod)` Perform all adjust in the network, including Bus, Branch adjustment.
`LfAdjustAccFactor`	`getAccFactorConfig()` Returns the value of the 'Acc Factor Config' reference.
`LoadflowAlgorithm`	`getLfAlgo()` Returns the value of the 'Lf Algo' container reference.
`PowerAdjControlConfig`	`getPowerAdjConfig()` Returns the value of the 'Power Adj Config' reference.
`double`	`getPowerAdjStartError(double tolerance)` get power adjustment starting error tolerance.
`VoltageAdjControlConfig`	`getVoltAdjConfig()` Returns the value of the 'Volt Adj Config' reference.
`double`	`getVoltAdjStartError(double tolerance)` get voltage adjustment starting error tolerance.
`void`	`initialize(java.util.function.Consumer<LfAdjustAlgorithm> initializer)` initialize the Adj Algo before running the Loadflow
`void`	`initSensitivity()` initialize sensitivity for RemoteQBus adjustment.
`boolean`	`isActivateAllAdjust()` Returns the value of the 'Activate All Adjust' attribute.
`boolean`	`isApplyAdjustAlgo()` Returns the value of the 'Apply Adjust Algo' attribute.
`boolean`	`isLimitBackoffCheck()` Returns the value of the 'Limit Backoff Check' attribute.
`boolean`	`needAdjustment()` Check to see if there is any adjustment need in the network.
`void`	`setAccFactorConfig(LfAdjustAccFactor value)` Sets the value of the '`Acc Factor Config`' reference.
`void`	`setActivateAllAdjust(boolean value)` Sets the value of the '`Activate All Adjust`' attribute.
`void`	`setApplyAdjustAlgo(boolean value)` Sets the value of the '`Apply Adjust Algo`' attribute.
`void`	`setLfAlgo(LoadflowAlgorithm value)` Sets the value of the '`Lf Algo`' container reference.
`void`	`setLimitBackoffCheck(boolean value)` Sets the value of the '`Limit Backoff Check`' attribute.
`void`	`setPowerAdjConfig(PowerAdjControlConfig value)` Sets the value of the '`Power Adj Config`' reference.
`void`	`setVoltAdjConfig(VoltageAdjControlConfig value)` Sets the value of the '`Volt Adj Config`' reference.

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

- Method Detail
  - isApplyAdjustAlgo
```
boolean isApplyAdjustAlgo()
```
    Returns the value of the 'Apply Adjust Algo' attribute. The default value is "true".
    If the meaning of the 'Apply Adjust Algo' attribute isn't clear, there really should be more of a description here...
    attribute to control if Adjustment/control should be applied during the Loadflow calculation process.
    
    Returns:
    
    the value of the 'Apply Adjust Algo' attribute.
    
    See Also:
    
    setApplyAdjustAlgo(boolean), CoreAlgorithmPackage.getLfAdjustAlgorithm_ApplyAdjustAlgo()
  - setApplyAdjustAlgo
```
void setApplyAdjustAlgo(boolean value)
```
    Sets the value of the 'Apply Adjust Algo' attribute.
    
    Parameters:
    
    value - the new value of the 'Apply Adjust Algo' attribute.
    
    See Also:
    
    isApplyAdjustAlgo()
  - isLimitBackoffCheck
```
boolean isLimitBackoffCheck()
```
    Returns the value of the 'Limit Backoff Check' attribute. The default value is "true".
    If the meaning of the 'Limit Backoff Check' attribute isn't clear, there really should be more of a description here...
    attribute to control if limit back-off should be applied in a Loadflow run
    
    Returns:
    
    the value of the 'Limit Backoff Check' attribute.
    
    See Also:
    
    setLimitBackoffCheck(boolean), CoreAlgorithmPackage.getLfAdjustAlgorithm_LimitBackoffCheck()
  - setLimitBackoffCheck
```
void setLimitBackoffCheck(boolean value)
```
    Sets the value of the 'Limit Backoff Check' attribute.
    
    Parameters:
    
    value - the new value of the 'Limit Backoff Check' attribute.
    
    See Also:
    
    isLimitBackoffCheck()
  - getAccFactorConfig
```
LfAdjustAccFactor getAccFactorConfig()
```
    Returns the value of the 'Acc Factor Config' reference. Aclf adjustment/control acceleration factor configuration info
    
    Returns:
    
    the value of the 'Acc Factor Config' reference.
    
    See Also:
    
    setAccFactorConfig(LfAdjustAccFactor), CoreAlgorithmPackage.getLfAdjustAlgorithm_AccFactorConfig()
  - setAccFactorConfig
```
void setAccFactorConfig(LfAdjustAccFactor value)
```
    Sets the value of the 'Acc Factor Config' reference.
    
    Parameters:
    
    value - the new value of the 'Acc Factor Config' reference.
    
    See Also:
    
    getAccFactorConfig()
  - getVoltAdjConfig
```
VoltageAdjControlConfig getVoltAdjConfig()
```
    Returns the value of the 'Volt Adj Config' reference. Voltage adjustment/control configuration info
    
    Returns:
    
    the value of the 'Volt Adj Config' reference.
    
    See Also:
    
    setVoltAdjConfig(VoltageAdjControlConfig), CoreAlgorithmPackage.getLfAdjustAlgorithm_VoltAdjConfig()
  - setVoltAdjConfig
```
void setVoltAdjConfig(VoltageAdjControlConfig value)
```
    Sets the value of the 'Volt Adj Config' reference.
    
    Parameters:
    
    value - the new value of the 'Volt Adj Config' reference.
    
    See Also:
    
    getVoltAdjConfig()
  - getPowerAdjConfig
```
PowerAdjControlConfig getPowerAdjConfig()
```
    Returns the value of the 'Power Adj Config' reference. Power adjustment/control configuration info
    
    Returns:
    
    the value of the 'Power Adj Config' reference.
    
    See Also:
    
    setPowerAdjConfig(PowerAdjControlConfig), CoreAlgorithmPackage.getLfAdjustAlgorithm_PowerAdjConfig()
  - setPowerAdjConfig
```
void setPowerAdjConfig(PowerAdjControlConfig value)
```
    Sets the value of the 'Power Adj Config' reference.
    
    Parameters:
    
    value - the new value of the 'Power Adj Config' reference.
    
    See Also:
    
    getPowerAdjConfig()
  - getLfAlgo
```
LoadflowAlgorithm getLfAlgo()
```
    Returns the value of the 'Lf Algo' container reference. It is bidirectional and its opposite is 'Lf Adj Algo'.
    If the meaning of the 'Lf Algo' reference isn't clear, there really should be more of a description here...
    reference to the parant Loadflow algorithm object, containing this adjustment/control algorithm object.
    
    Returns:
    
    the value of the 'Lf Algo' container reference.
    
    See Also:
    
    setLfAlgo(LoadflowAlgorithm), CoreAlgorithmPackage.getLfAdjustAlgorithm_LfAlgo(), LoadflowAlgorithm.getLfAdjAlgo()
  - setLfAlgo
```
void setLfAlgo(LoadflowAlgorithm value)
```
    Sets the value of the 'Lf Algo' container reference.
    
    Parameters:
    
    value - the new value of the 'Lf Algo' container reference.
    
    See Also:
    
    getLfAlgo()
  - getPowerAdjStartError
```
double getPowerAdjStartError(double tolerance)
```
    get power adjustment starting error tolerance.
    
    Parameters:
    
    tolerance - error tolerance
  - getVoltAdjStartError
```
double getVoltAdjStartError(double tolerance)
```
    get voltage adjustment starting error tolerance.
    
    Parameters:
    
    tolerance - error tolerance
  - isActivateAllAdjust
```
boolean isActivateAllAdjust()
```
    Returns the value of the 'Activate All Adjust' attribute. The default value is "true".
    If the meaning of the 'Activate All Adjust' attribute isn't clear, there really should be more of a description here...
    attribute to control if all adjustment/control should be activated before a loadflow run.
    
    Returns:
    
    the value of the 'Activate All Adjust' attribute.
    
    See Also:
    
    setActivateAllAdjust(boolean), CoreAlgorithmPackage.getLfAdjustAlgorithm_ActivateAllAdjust()
  - setActivateAllAdjust
```
void setActivateAllAdjust(boolean value)
```
    Sets the value of the 'Activate All Adjust' attribute.
    
    Parameters:
    
    value - the new value of the 'Activate All Adjust' attribute.
    
    See Also:
    
    isActivateAllAdjust()
  - initSensitivity
```
void initSensitivity()
              throws InterpssException
```
    initialize sensitivity for RemoteQBus adjustment.
    
    Throws:
    
    InterpssException
  - initialize
```
void initialize(java.util.function.Consumer<LfAdjustAlgorithm> initializer)
```
    initialize the Adj Algo before running the Loadflow
    
    Parameters:
    
    initializer - error tolerance
  - needAdjustment
```
boolean needAdjustment()
                throws IpssNumericException
```
    Check to see if there is any adjustment need in the network. It is only used for LF convergence checking.
    
    Throws:
    
    IpssNumericException
  - doAllAdjust
```
void doAllAdjust(Mismatch mismatch,
                 AclfMethodType lfMethod)
```
    Perform all adjust in the network, including Bus, Branch adjustment. Network level adjustment is done in the NetAdjustAlgorithm
    
    Parameters:
    
    mismatch - Max LF calculation mismatch in the parent network for controlling if the adjustment/control should be started.
    
    lfMethod - Aclf method

Interface LfAdjustAlgorithm

Method Summary

Methods inherited from interface org.eclipse.emf.ecore.EObject

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

Method Detail

isApplyAdjustAlgo

setApplyAdjustAlgo

isLimitBackoffCheck

setLimitBackoffCheck

getAccFactorConfig

setAccFactorConfig

getVoltAdjConfig

setVoltAdjConfig

getPowerAdjConfig

setPowerAdjConfig

getLfAlgo

setLfAlgo

getPowerAdjStartError

getVoltAdjStartError

isActivateAllAdjust

setActivateAllAdjust

initSensitivity

initialize

needAdjustment

doAllAdjust