Package com.powsybl.sensitivity
Enum SensitivityVariableType
- java.lang.Object
-
- java.lang.Enum<SensitivityVariableType>
-
- com.powsybl.sensitivity.SensitivityVariableType
-
- All Implemented Interfaces:
Serializable
,Comparable<SensitivityVariableType>
public enum SensitivityVariableType extends Enum<SensitivityVariableType>
A variable represents a change on a equipment or on a group of equipments. The supported variable types are:- Use
INJECTION_ACTIVE_POWER
to model a change on the production of a generator or on a group of generators, on the consumption of a load or on a group of loads or on GLSK (for Generation and Load Shift keys) that describes a linear combination of power injection shifts on generators and loads. The variable increase is in MW. - Use
INJECTION_REACTIVE_POWER
to model a change on the reactive production of a generator or on the reactive consumption of a load. The variable increase is in MVar. - Use
TRANSFORMER_PHASE
to model the change of the tap position of a phase tap changer of a two windings transformer or a three windings transformer that contains only one phase tap changer. The increase is in degree. - Use
BUS_TARGET_VOLTAGE
to model an increase of the voltage target of a generator, a static var compensator, a two or three windings transformer, a shunt compensator or a VSC converter station. The increase is in KV. - Use
HVDC_LINE_ACTIVE_POWER
to model the change of the active power set point of an HVDC line. The increase is in MW. - Use
TRANSFORMER_PHASE_1
,TRANSFORMER_PHASE_2
orTRANSFORMER_PHASE_3
to model the change of the tap position of a phase tap changer of a three windings transformer that contains several phase tap changers.
- Author:
- Geoffroy Jamgotchian
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BUS_TARGET_VOLTAGE
increase in kVHVDC_LINE_ACTIVE_POWER
increase in MWINJECTION_ACTIVE_POWER
increase in MWINJECTION_REACTIVE_POWER
increase in MVarTRANSFORMER_PHASE
increase in degreesTRANSFORMER_PHASE_1
increase in degreesTRANSFORMER_PHASE_2
increase in degreesTRANSFORMER_PHASE_3
increase in degrees
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description OptionalInt
getSide()
static SensitivityVariableType
valueOf(String name)
Returns the enum constant of this type with the specified name.static SensitivityVariableType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
INJECTION_ACTIVE_POWER
public static final SensitivityVariableType INJECTION_ACTIVE_POWER
increase in MW
-
INJECTION_REACTIVE_POWER
public static final SensitivityVariableType INJECTION_REACTIVE_POWER
increase in MVar
-
TRANSFORMER_PHASE
public static final SensitivityVariableType TRANSFORMER_PHASE
increase in degrees
-
BUS_TARGET_VOLTAGE
public static final SensitivityVariableType BUS_TARGET_VOLTAGE
increase in kV
-
HVDC_LINE_ACTIVE_POWER
public static final SensitivityVariableType HVDC_LINE_ACTIVE_POWER
increase in MW
-
TRANSFORMER_PHASE_1
public static final SensitivityVariableType TRANSFORMER_PHASE_1
increase in degrees
-
TRANSFORMER_PHASE_2
public static final SensitivityVariableType TRANSFORMER_PHASE_2
increase in degrees
-
TRANSFORMER_PHASE_3
public static final SensitivityVariableType TRANSFORMER_PHASE_3
increase in degrees
-
-
Method Detail
-
values
public static SensitivityVariableType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (SensitivityVariableType c : SensitivityVariableType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SensitivityVariableType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getSide
public OptionalInt getSide()
-
-