Package com.powsybl.iidm.modification.scalable

Class ProportionalScalable

java.lang.Object

com.powsybl.iidm.modification.scalable.ProportionalScalable

All Implemented Interfaces:

Scalable

public class ProportionalScalable
extends Object

Scalable that divides scale proportionally between multiple scalable.

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>, Sebastien Murgey <sebastien.murgey at rte-france.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProportionalScalable.DistributionMode

Nested classes/interfaces inherited from interface com.powsybl.iidm.modification.scalable.Scalable

Scalable.ScalingConvention

Constructor Summary

Constructors

Constructor	Description
ProportionalScalable(List<? extends Injection> injections, ProportionalScalable.DistributionMode distributionMode)

Method Summary

Modifier and Type	Method	Description
List<Injection>	filterInjections(Network network)	Scans all the expected injections of the scalable.
void	filterInjections(Network n, List<Injection> injections, List<String> notFoundInjections)	Scans all the expected injections of the scalable.
List<Injection>	filterInjections(Network network, List<String> notFound)	Scans all the expected injections of the scalable.
double	getSteadyStatePower(Network network, double asked, Scalable.ScalingConvention scalingConvention)	Returns the current power value for the injections corresponding to this Scalable
double	initialValue(Network n)	Get the constant active power in MW injected at the network.
double	maximumValue(Network n)	Get the maximal active power in MW.
double	maximumValue(Network n, Scalable.ScalingConvention powerConvention)	Get the maximal active power in MW with scaling convention.
double	minimumValue(Network n)	Get the minimal active power in MW.
double	minimumValue(Network n, Scalable.ScalingConvention powerConvention)	Get the minimal active power in MW with scaling convention.
void	reset(Network n)	Set the constant active power to zero.
double	scale(Network n, double asked, ScalingParameters parameters)	Scale the given network using Generator convention by default.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.powsybl.iidm.modification.scalable.Scalable

scale

Constructor Details

ProportionalScalable

public ProportionalScalable(List<? extends Injection> injections,
 ProportionalScalable.DistributionMode distributionMode)

Method Details

scale

public double scale(Network n,
 double asked,
 ScalingParameters parameters)

Description copied from interface: Scalable

Scale the given network using Generator convention by default. The actual scaling value may be different to the one asked if the Scalable limit is reached. If the scalable is disconnected, the scaling value will be 0.

Parameters:

n - network

asked - value asked to adjust the scalable active power

parameters - specific parameters used to scale

Returns:

the actual value of the scalable active power adjustment

getSteadyStatePower

public double getSteadyStatePower(Network network,
 double asked,
 Scalable.ScalingConvention scalingConvention)

Description copied from interface: Scalable

Returns the current power value for the injections corresponding to this Scalable

Parameters:

network - Network in which the injections are defined

Returns:

the current power value

initialValue

public double initialValue(Network n)

Description copied from interface: Scalable

Get the constant active power in MW injected at the network.

reset

public void reset(Network n)

Description copied from interface: Scalable

Set the constant active power to zero.

maximumValue

public double maximumValue(Network n)

Description copied from interface: Scalable

Get the maximal active power in MW. Uses Generator convention by default

Specified by:

maximumValue in interface Scalable

maximumValue

public double maximumValue(Network n,
 Scalable.ScalingConvention powerConvention)

Description copied from interface: Scalable

Get the maximal active power in MW with scaling convention.

See Also:

• Scalable.ScalingConvention

minimumValue

public double minimumValue(Network n)

Description copied from interface: Scalable

Get the minimal active power in MW. Uses Generator convention by default

Specified by:

minimumValue in interface Scalable

minimumValue

public double minimumValue(Network n,
 Scalable.ScalingConvention powerConvention)

Description copied from interface: Scalable

Get the minimal active power in MW with scaling convention.

See Also:

• Scalable.ScalingConvention

filterInjections

public void filterInjections(Network n,
 List<Injection> injections,
 List<String> notFoundInjections)

Description copied from interface: Scalable

Scans all the expected injections of the scalable. If the injection can be found in given network, it is added the the injections list. Otherwise, its identifier is added to the "notFound" list.

Parameters:

n - network

injections - network injections used in the scalable

notFoundInjections - expected injections not found in the network

filterInjections

public List<Injection> filterInjections(Network network,
 List<String> notFound)

Description copied from interface: Scalable

Scans all the expected injections of the scalable. If the injection can be found in given network, it is added the the injections list. Otherwise, its identifier is added to the "notFound" list.

Specified by:

filterInjections in interface Scalable

Parameters:

network - network

notFound - expected injections not found in the network

Returns:

network injections used in the scalable

filterInjections

public List<Injection> filterInjections(Network network)

Description copied from interface: Scalable

Scans all the expected injections of the scalable. If the injection can be found in given network, it is added to the injections list.

Specified by:

filterInjections in interface Scalable

Parameters:

network - network

Returns:

network injections used in the scalable