Package com.powsybl.openloadflow.network

Class VoltageControl<T extends LfElement>

java.lang.Object

com.powsybl.openloadflow.network.Control

com.powsybl.openloadflow.network.VoltageControl<T>

Direct Known Subclasses:

DiscreteVoltageControl, GeneratorVoltageControl

public class VoltageControl<T extends LfElement>
extends Control

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VoltageControl.MergeStatus
static enum	VoltageControl.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected final LfBus	controlledBus
protected final List<T>	controllerElements
protected boolean	disabled
protected VoltageControl<T>	mainMergedVoltageControl
protected final List<VoltageControl<T>>	mergedDependentVoltageControls
protected VoltageControl.MergeStatus	mergeStatus
protected int	priority
protected final VoltageControl.Type	type

Fields inherited from class com.powsybl.openloadflow.network.Control

targetValue

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VoltageControl(double targetValue, VoltageControl.Type type, int priority, LfBus controlledBus)

Method Summary

Modifier and Type	Method	Description
void	addControllerElement(T controllerElement)
Optional<LfBus>	findMainVisibleControlledBus()	Find controlled bus which is part of: - the visible voltage control - the main voltage control of the global merged one This controlled bus is important because this is the one that will be targeted by a voltage equation in the equation system.
static List<VoltageControl<?>>	findMainVoltageControlsSortedByPriority(LfBus bus)	Find the list of voltage control with merge status as main, connected to a given bus (so including by traversing non impedant branches).
LfBus	getControlledBus()
List<T>	getControllerElements()
<E extends VoltageControl<T>> E	getMainVoltageControl()
List<LfBus>	getMergedControlledBuses()
List<T>	getMergedControllerElements()
List<VoltageControl<T>>	getMergedDependentVoltageControls()
VoltageControl.MergeStatus	getMergeStatus()
protected int	getPriority()
VoltageControl.Type	getType()
boolean	isControllerEnabled(T controllerElement)
boolean	isDisabled()	Check is the merged voltage to which this voltage control belongs is disabled.
boolean	isHidden()	Check if the merged voltage to which this voltage control belongs is hidden by another one of a different type (generator, transformer or shunt).
boolean	isVisible()
void	setDisabled(boolean disabled)
String	toString()

Methods inherited from class com.powsybl.openloadflow.network.Control

getTargetValue, setTargetValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

type

protected final VoltageControl.Type type

priority

protected int priority

controlledBus

protected final LfBus controlledBus

controllerElements

protected final List<T extends LfElement> controllerElements

mergeStatus

protected VoltageControl.MergeStatus mergeStatus

mergedDependentVoltageControls

protected final List<VoltageControl<T extends LfElement>> mergedDependentVoltageControls

mainMergedVoltageControl

protected VoltageControl<T extends LfElement> mainMergedVoltageControl

disabled

protected boolean disabled

Constructor Details

VoltageControl

protected VoltageControl(double targetValue,
 VoltageControl.Type type,
 int priority,
 LfBus controlledBus)

Method Details

getControlledBus

public LfBus getControlledBus()

getControllerElements

public List<T> getControllerElements()

addControllerElement

public void addControllerElement(T controllerElement)

isControllerEnabled

public boolean isControllerEnabled(T controllerElement)

getMergedDependentVoltageControls

public List<VoltageControl<T>> getMergedDependentVoltageControls()

getPriority

protected int getPriority()

getType

public VoltageControl.Type getType()

isDisabled

public boolean isDisabled()

Check is the merged voltage to which this voltage control belongs is disabled. Disabled means that there is no more controlled bus or no more controller element. Having a disabled controlled among several controlled bus in a merge voltage control is an open question. Disabling a controlled bus could also lead to removing the associated controller buses from the merge voltage control. The merge status could be updated too.

setDisabled

public void setDisabled(boolean disabled)

getMergeStatus

public VoltageControl.MergeStatus getMergeStatus()

getMainVoltageControl

public <E extends VoltageControl<T>> E getMainVoltageControl()

getMergedControlledBuses

public List<LfBus> getMergedControlledBuses()

getMergedControllerElements

public List<T> getMergedControllerElements()

findMainVoltageControlsSortedByPriority

public static List<VoltageControl<?>> findMainVoltageControlsSortedByPriority(LfBus bus)

Find the list of voltage control with merge status as main, connected to a given bus (so including by traversing non impedant branches).

isHidden

public boolean isHidden()

Check if the merged voltage to which this voltage control belongs is hidden by another one of a different type (generator, transformer or shunt). The hidden status includes the disable status so a disable voltage control is also hidden. FIXME: take into account controllers status to have a proper definition For generator voltage control, isGeneratorVoltageControlEnabled() should be called. For transformer voltage control, isVoltageControlEnabled() should be called. For shunt voltage control, isVoltageControlEnabled() should be called.

isVisible

public boolean isVisible()

findMainVisibleControlledBus

public Optional<LfBus> findMainVisibleControlledBus()

Find controlled bus which is part of: - the visible voltage control - the main voltage control of the global merged one This controlled bus is important because this is the one that will be targeted by a voltage equation in the equation system.

toString

public String toString()

Overrides:

toString in class Object