Class ScalingParameters
java.lang.Object
com.powsybl.iidm.modification.scalable.ScalingParameters
- Author:
- Coline Piloquet <[email protected]>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static enum
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
static final boolean
static final ScalingParameters.Priority
static final boolean
static final Scalable.ScalingConvention
static final ScalingParameters.ScalingType
static final String
-
Constructor Summary
ConstructorDescriptionScalingParameters
(Scalable.ScalingConvention scalingConvention, boolean reconnect, boolean constantPowerFactor, boolean iterative, boolean allowsGeneratorOutOfActivePowerLimits) Deprecated.: replace with ScalingParameters(Scalable.ScalingConvention scalingConvention, boolean reconnect, boolean constantPowerFactor, Priority priority, boolean allowsGeneratorOutOfActivePowerLimits)ScalingParameters
(Scalable.ScalingConvention scalingConvention, boolean reconnect, boolean constantPowerFactor, ScalingParameters.Priority priority, boolean allowsGeneratorOutOfActivePowerLimits) ScalingParameters
(Scalable.ScalingConvention scalingConvention, boolean reconnect, boolean constantPowerFactor, ScalingParameters.Priority priority, boolean allowsGeneratorOutOfActivePowerLimits, ScalingParameters.ScalingType scalingType) -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
boolean
Deprecated.: replace with method "getPriority"boolean
static ScalingParameters
load()
static ScalingParameters
load
(PlatformConfig platformConfig) setAllowsGeneratorOutOfActivePowerLimits
(boolean allowsGeneratorOutOfActivePowerLimits) setConstantPowerFactor
(boolean constantPowerFactor) setIterative
(boolean iterative) Deprecated.: replace with the method "setPriority"setPriority
(ScalingParameters.Priority priority) setReconnect
(boolean reconnect) setScalingConvention
(Scalable.ScalingConvention scalingConvention) setScalingType
(ScalingParameters.ScalingType scalingType)
-
Field Details
-
VERSION
- See Also:
-
DEFAULT_SCALING_CONVENTION
-
DEFAULT_CONSTANT_POWER_FACTOR
public static final boolean DEFAULT_CONSTANT_POWER_FACTOR- See Also:
-
DEFAULT_RECONNECT
public static final boolean DEFAULT_RECONNECT- See Also:
-
DEFAULT_ALLOWS_GENERATOR_OUT_OF_ACTIVE_POWER_LIMITS
public static final boolean DEFAULT_ALLOWS_GENERATOR_OUT_OF_ACTIVE_POWER_LIMITS- See Also:
-
DEFAULT_PRIORITY
-
DEFAULT_SCALING_TYPE
-
-
Constructor Details
-
ScalingParameters
public ScalingParameters() -
ScalingParameters
@Deprecated(since="v6.0.0") public ScalingParameters(Scalable.ScalingConvention scalingConvention, boolean reconnect, boolean constantPowerFactor, boolean iterative, boolean allowsGeneratorOutOfActivePowerLimits) Deprecated.: replace with ScalingParameters(Scalable.ScalingConvention scalingConvention, boolean reconnect, boolean constantPowerFactor, Priority priority, boolean allowsGeneratorOutOfActivePowerLimits) -
ScalingParameters
public ScalingParameters(Scalable.ScalingConvention scalingConvention, boolean reconnect, boolean constantPowerFactor, ScalingParameters.Priority priority, boolean allowsGeneratorOutOfActivePowerLimits) -
ScalingParameters
public ScalingParameters(Scalable.ScalingConvention scalingConvention, boolean reconnect, boolean constantPowerFactor, ScalingParameters.Priority priority, boolean allowsGeneratorOutOfActivePowerLimits, ScalingParameters.ScalingType scalingType)
-
-
Method Details
-
getScalingConvention
- Returns:
- the scaling convention for the scaling,
Scalable.ScalingConvention
GENERATOR by default.
-
setScalingConvention
-
isReconnect
public boolean isReconnect()- Returns:
- a boolean indicating if the terminal of the scalable should be reconnected if it is disconnected. If the scalable is disconnected, then it will not be scaled.
-
setReconnect
-
isConstantPowerFactor
public boolean isConstantPowerFactor()- Returns:
- a boolean indicating if the scaling should be done with a constant power factor.
-
setConstantPowerFactor
-
isIterative
Deprecated.: replace with method "getPriority"Scale may be iterative or not forProportionalScalable
. If the iterative mode is activated, the residues due to scalable saturation is divided between the other scalable composing theProportionalScalable
.- Returns:
- the iterative boolean, false by default.
-
setIterative
Deprecated.: replace with the method "setPriority" -
isAllowsGeneratorOutOfActivePowerLimits
public boolean isAllowsGeneratorOutOfActivePowerLimits()- Returns:
- a boolean indicating if the scaling allows generators with an initial targetP outside the [Pmin - Pmax] range values
-
setAllowsGeneratorOutOfActivePowerLimits
public ScalingParameters setAllowsGeneratorOutOfActivePowerLimits(boolean allowsGeneratorOutOfActivePowerLimits) -
getScalingType
- Returns:
- the type of scaling asked (DELTA_P or TARGET_P)
-
setScalingType
-
getPriority
- Returns:
- an enum representing the priority of the scaling. It can be either RESPECT_OF_VOLUME_ASKED (the scaling will distribute the power asked as much as possible by iterating if elements get saturated, even if it means not respecting potential percentages), RESPECT_OF_DISTRIBUTION (the scaling will respect the percentages even if it means not scaling all what is asked), or ONESHOT (the scaling will distribute the power asked as is, in one iteration even if elements get saturated and even if it means not respecting potential percentages).
-
setPriority
-
load
-
load
-