Package com.powsybl.iidm.modification.scalable

Class ScalingParameters

java.lang.Object

com.powsybl.iidm.modification.scalable.ScalingParameters

public class ScalingParameters
extends Object

Author:

Coline Piloquet <[email protected]>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ScalingParameters.Priority
static enum	ScalingParameters.ScalingType

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ALLOWS_GENERATOR_OUT_OF_ACTIVE_POWER_LIMITS
static final boolean	DEFAULT_CONSTANT_POWER_FACTOR
static final ScalingParameters.Priority	DEFAULT_PRIORITY
static final boolean	DEFAULT_RECONNECT
static final Scalable.ScalingConvention	DEFAULT_SCALING_CONVENTION
static final ScalingParameters.ScalingType	DEFAULT_SCALING_TYPE
static final String	VERSION

Constructor Summary

Constructors

Constructor	Description
ScalingParameters()
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(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 Type	Method	Description
ScalingParameters.Priority	getPriority()
Scalable.ScalingConvention	getScalingConvention()
ScalingParameters.ScalingType	getScalingType()
boolean	isAllowsGeneratorOutOfActivePowerLimits()
boolean	isConstantPowerFactor()
boolean	isIterative()	Deprecated. : replace with method "getPriority"
boolean	isReconnect()
static ScalingParameters	load()
static ScalingParameters	load(PlatformConfig platformConfig)
ScalingParameters	setAllowsGeneratorOutOfActivePowerLimits(boolean allowsGeneratorOutOfActivePowerLimits)
ScalingParameters	setConstantPowerFactor(boolean constantPowerFactor)
ScalingParameters	setIterative(boolean iterative)	Deprecated. : replace with the method "setPriority"
ScalingParameters	setPriority(ScalingParameters.Priority priority)
ScalingParameters	setReconnect(boolean reconnect)
ScalingParameters	setScalingConvention(Scalable.ScalingConvention scalingConvention)
ScalingParameters	setScalingType(ScalingParameters.ScalingType scalingType)

Methods inherited from class java.lang.Object

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

Field Details

VERSION

public static final String VERSION

See Also:

• Constant Field Values

DEFAULT_SCALING_CONVENTION

public static final Scalable.ScalingConvention DEFAULT_SCALING_CONVENTION

DEFAULT_CONSTANT_POWER_FACTOR

public static final boolean DEFAULT_CONSTANT_POWER_FACTOR

See Also:

• Constant Field Values

DEFAULT_RECONNECT

public static final boolean DEFAULT_RECONNECT

See Also:

• Constant Field Values

DEFAULT_ALLOWS_GENERATOR_OUT_OF_ACTIVE_POWER_LIMITS

public static final boolean DEFAULT_ALLOWS_GENERATOR_OUT_OF_ACTIVE_POWER_LIMITS

See Also:

• Constant Field Values

DEFAULT_PRIORITY

public static final ScalingParameters.Priority DEFAULT_PRIORITY

DEFAULT_SCALING_TYPE

public static final ScalingParameters.ScalingType 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

public Scalable.ScalingConvention getScalingConvention()

Returns:

the scaling convention for the scaling, Scalable.ScalingConvention GENERATOR by default.

setScalingConvention

public ScalingParameters setScalingConvention(Scalable.ScalingConvention scalingConvention)

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

public ScalingParameters setReconnect(boolean reconnect)

isConstantPowerFactor

public boolean isConstantPowerFactor()

Returns:

a boolean indicating if the scaling should be done with a constant power factor.

setConstantPowerFactor

public ScalingParameters setConstantPowerFactor(boolean constantPowerFactor)

isIterative

@Deprecated(since="v6.0.0")
public boolean isIterative()

Deprecated.

: replace with method "getPriority"

Scale may be iterative or not for ProportionalScalable. If the iterative mode is activated, the residues due to scalable saturation is divided between the other scalable composing the ProportionalScalable.

Returns:

the iterative boolean, false by default.

setIterative

@Deprecated(since="v6.0.0")
public ScalingParameters setIterative(boolean iterative)

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

public ScalingParameters.ScalingType getScalingType()

Returns:

the type of scaling asked (DELTA_P or TARGET_P)

setScalingType

public ScalingParameters setScalingType(ScalingParameters.ScalingType scalingType)

getPriority

public ScalingParameters.Priority 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

public ScalingParameters setPriority(ScalingParameters.Priority priority)

load

public static ScalingParameters load()

load

public static ScalingParameters load(PlatformConfig platformConfig)