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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Scalable.ScalingConvention	getScalingConvention()
boolean	isConstantPowerFactor()
boolean	isIterative()	Scale may be iterative or not for ProportionalScalable.
boolean	isReconnect()
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

Constructor Detail

ScalingParameters

public ScalingParameters()

ScalingParameters

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

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)