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

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_ALLOWS_GENERATOR_OUT_OF_ACTIVE_POWER_LIMITS
static boolean	DEFAULT_CONSTANT_POWER_FACTOR
static boolean	DEFAULT_ITERATIVE
static boolean	DEFAULT_RECONNECT
static Scalable.ScalingConvention	DEFAULT_SCALING_CONVENTION
static String	VERSION

Constructor Summary

Constructors

Constructor	Description
ScalingParameters()
ScalingParameters(Scalable.ScalingConvention scalingConvention, boolean reconnect, boolean constantPowerFactor, boolean iterative, boolean allowsGeneratorOutOfActivePowerLimits)

Method Summary

Modifier and Type	Method	Description
Scalable.ScalingConvention	getScalingConvention()
boolean	isAllowsGeneratorOutOfActivePowerLimits()
boolean	isConstantPowerFactor()
boolean	isIterative()	Scale may be iterative or not for ProportionalScalable.
boolean	isReconnect()
static ScalingParameters	load()
static ScalingParameters	load(PlatformConfig platformConfig)
ScalingParameters	setAllowsGeneratorOutOfActivePowerLimits(boolean allowsGeneratorOutOfActivePowerLimits)
ScalingParameters	setConstantPowerFactor(boolean constantPowerFactor)
ScalingParameters	setIterative(boolean iterative)
ScalingParameters	setReconnect(boolean reconnect)
ScalingParameters	setScalingConvention(Scalable.ScalingConvention scalingConvention)

Methods inherited from class java.lang.Object

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

Field Detail

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_ITERATIVE

public static final boolean DEFAULT_ITERATIVE

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

Constructor Detail

ScalingParameters

public ScalingParameters()

ScalingParameters

public ScalingParameters(Scalable.ScalingConvention scalingConvention,
                         boolean reconnect,
                         boolean constantPowerFactor,
                         boolean iterative,
                         boolean allowsGeneratorOutOfActivePowerLimits)

Method Detail

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.

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

public boolean isIterative()

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

public ScalingParameters setIterative(boolean iterative)

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)

load

public static ScalingParameters load()

load

public static ScalingParameters load(PlatformConfig platformConfig)