Package com.powsybl.action.util

Interface Scalable

public interface Scalable

Author:

Geoffroy Jamgotchian , Ameni Walha

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Scalable.ScalingConvention	Sign convention usable for scaling.

Method Summary

Modifier and Type	Method	Description
List<Injection>	filterInjections(Network network)	Scans all the expected injections of the scalable.
void	filterInjections(Network network, List<Injection> injections, List<String> notFound)	Scans all the expected injections of the scalable.
List<Injection>	filterInjections(Network network, List<String> notFound)	Scans all the expected injections of the scalable.
static com.powsybl.action.util.GeneratorScalable	gen(String id)	Deprecated. gen should be replaced by onGenerator
double	initialValue(Network n)	Get the constant active power in MW injected at the network.
List<Generator>	listGenerators(Network n)	Deprecated. listGenerators should be replaced by filterInjections
void	listGenerators(Network n, List<Generator> generators, List<String> notFoundGenerators)	Deprecated. listGenerators should be replaced by filterInjections
List<Generator>	listGenerators(Network n, List<String> notFoundGenerators)	Deprecated. listGenerators should be replaced by filterInjections
double	maximumValue(Network n)	Get the maximal active power in MW.
double	maximumValue(Network n, Scalable.ScalingConvention scalingConvention)	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 scalingConvention)	Get the minimal active power in MW with scaling convention.
static com.powsybl.action.util.GeneratorScalable	onGenerator(String id)	create GeneratorScalable with id
static com.powsybl.action.util.GeneratorScalable	onGenerator(String id, double minValue, double maxValue)	create GeneratorScalable with id, min and max power values for scaling
static com.powsybl.action.util.LoadScalable	onLoad(String id)	create LoadScalable with id
static com.powsybl.action.util.LoadScalable	onLoad(String id, double minValue, double maxValue)	create LoadScalable with id, min and max power values for scaling
static com.powsybl.action.util.ProportionalScalable	proportional(float percentage, Scalable scalable)
static com.powsybl.action.util.ProportionalScalable	proportional(float percentage1, Scalable scalable1, float percentage2, Scalable scalable2)
static com.powsybl.action.util.ProportionalScalable	proportional(float percentage1, Scalable scalable1, float percentage2, Scalable scalable2, float percentage3, Scalable scalable3)
static com.powsybl.action.util.ProportionalScalable	proportional(float percentage1, Scalable scalable1, float percentage2, Scalable scalable2, float percentage3, Scalable scalable3, float percentage4, Scalable scalable4)
static com.powsybl.action.util.ProportionalScalable	proportional(float percentage1, Scalable scalable1, float percentage2, Scalable scalable2, float percentage3, Scalable scalable3, float percentage4, Scalable scalable4, float percentage5, Scalable scalable5)
static com.powsybl.action.util.ProportionalScalable	proportional(List<Float> percentages, List<Scalable> scalables)
static com.powsybl.action.util.ProportionalScalable	proportional(List<Float> percentages, List<Scalable> scalables, boolean iterative)
void	reset(Network n)	Set the constant active power to zero.
static Scalable	scalable(String id)
static List<Scalable>	scalables(String... ids)
double	scale(Network n, double asked)	Scale the given network using Generator convention by default.
double	scale(Network n, double asked, Scalable.ScalingConvention scalingConvention)	Scale the given network.
static com.powsybl.action.util.StackScalable	stack(Scalable... scalables)
static com.powsybl.action.util.StackScalable	stack(String... ids)
static com.powsybl.action.util.UpDownScalable	upDown(Scalable upScalable, Scalable downScalable)

Method Detail

initialValue

double initialValue(Network n)

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

reset

void reset(Network n)

Set the constant active power to zero.

maximumValue

double maximumValue(Network n)

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

minimumValue

double minimumValue(Network n)

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

maximumValue

double maximumValue(Network n,
                    Scalable.ScalingConvention scalingConvention)

Get the maximal active power in MW with scaling convention.

See Also:

Scalable.ScalingConvention

minimumValue

double minimumValue(Network n,
                    Scalable.ScalingConvention scalingConvention)

Get the minimal active power in MW with scaling convention.

See Also:

Scalable.ScalingConvention

listGenerators

@Deprecated
void listGenerators(Network n,
                    List<Generator> generators,
                    List<String> notFoundGenerators)

Deprecated.

listGenerators should be replaced by filterInjections

listGenerators

@Deprecated
List<Generator> listGenerators(Network n,
                               List<String> notFoundGenerators)

Deprecated.

listGenerators should be replaced by filterInjections

listGenerators

@Deprecated
List<Generator> listGenerators(Network n)

Deprecated.

listGenerators should be replaced by filterInjections

filterInjections

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

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:

network - network

injections - network injections used in the scalable

notFound - expected injections not found in the network

filterInjections

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

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:

network - network

notFound - expected injections not found in the network

Returns:

network injections used in the scalable

filterInjections

List<Injection> filterInjections(Network network)

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

Parameters:

network - network

Returns:

network injections used in the scalable

scale

double scale(Network n,
             double asked)

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.

Parameters:

n - network

asked - value asked to adjust the scalable active power

Returns:

the actual value of the scalable active power adjustment

scale

double scale(Network n,
             double asked,
             Scalable.ScalingConvention scalingConvention)

Scale the given network. The actual scaling value may be different to the one asked, if the Scalable limit is reached.

Parameters:

n - network

asked - value asked to adjust the scalable active power

scalingConvention - power convention used for scaling

Returns:

the actual value of the scalable active power adjustment

See Also:

Scalable.ScalingConvention

gen

@Deprecated
static com.powsybl.action.util.GeneratorScalable gen(String id)

Deprecated.

gen should be replaced by onGenerator

onGenerator

static com.powsybl.action.util.GeneratorScalable onGenerator(String id)

create GeneratorScalable with id

onGenerator

static com.powsybl.action.util.GeneratorScalable onGenerator(String id,
                                                             double minValue,
                                                             double maxValue)

create GeneratorScalable with id, min and max power values for scaling

onLoad

static com.powsybl.action.util.LoadScalable onLoad(String id)

create LoadScalable with id

onLoad

static com.powsybl.action.util.LoadScalable onLoad(String id,
                                                   double minValue,
                                                   double maxValue)

create LoadScalable with id, min and max power values for scaling

scalable

static Scalable scalable(String id)

scalables

static List<Scalable> scalables(String... ids)

proportional

static com.powsybl.action.util.ProportionalScalable proportional(List<Float> percentages,
                                                                 List<Scalable> scalables)

proportional

static com.powsybl.action.util.ProportionalScalable proportional(List<Float> percentages,
                                                                 List<Scalable> scalables,
                                                                 boolean iterative)

proportional

static com.powsybl.action.util.ProportionalScalable proportional(float percentage,
                                                                 Scalable scalable)

proportional

static com.powsybl.action.util.ProportionalScalable proportional(float percentage1,
                                                                 Scalable scalable1,
                                                                 float percentage2,
                                                                 Scalable scalable2)

proportional

static com.powsybl.action.util.ProportionalScalable proportional(float percentage1,
                                                                 Scalable scalable1,
                                                                 float percentage2,
                                                                 Scalable scalable2,
                                                                 float percentage3,
                                                                 Scalable scalable3)

proportional

static com.powsybl.action.util.ProportionalScalable proportional(float percentage1,
                                                                 Scalable scalable1,
                                                                 float percentage2,
                                                                 Scalable scalable2,
                                                                 float percentage3,
                                                                 Scalable scalable3,
                                                                 float percentage4,
                                                                 Scalable scalable4)

proportional

static com.powsybl.action.util.ProportionalScalable proportional(float percentage1,
                                                                 Scalable scalable1,
                                                                 float percentage2,
                                                                 Scalable scalable2,
                                                                 float percentage3,
                                                                 Scalable scalable3,
                                                                 float percentage4,
                                                                 Scalable scalable4,
                                                                 float percentage5,
                                                                 Scalable scalable5)

stack

static com.powsybl.action.util.StackScalable stack(Scalable... scalables)

stack

static com.powsybl.action.util.StackScalable stack(String... ids)

upDown

static com.powsybl.action.util.UpDownScalable upDown(Scalable upScalable,
                                                     Scalable downScalable)