Package com.powsybl.loadflow

Enum LoadFlowParameters.BalanceType

java.lang.Object

java.lang.Enum<LoadFlowParameters.BalanceType>

com.powsybl.loadflow.LoadFlowParameters.BalanceType

All Implemented Interfaces:

Serializable, Comparable<LoadFlowParameters.BalanceType>

Enclosing class:

LoadFlowParameters

public static enum LoadFlowParameters.BalanceType
extends Enum<LoadFlowParameters.BalanceType>

BalanceType enum describes the various options for active power slack distribution

Enum Constant Summary

Enum Constants

Enum Constant	Description
PROPORTIONAL_TO_CONFORM_LOAD	active power slack distribution on conforming loads (see LoadDetails extension)
PROPORTIONAL_TO_GENERATION_P	active power slack distribution on generators, proportional to generator targetP
PROPORTIONAL_TO_GENERATION_P_MAX	active power slack distribution on generators, proportional to generator maxP
PROPORTIONAL_TO_GENERATION_PARTICIPATION_FACTOR	active power slack distribution on generators, proportional to participationFactor (see ActivePowerControl extension)
PROPORTIONAL_TO_GENERATION_REMAINING_MARGIN	active power slack distribution on generators, proportional to generator maxP - targetP
PROPORTIONAL_TO_LOAD	active power slack distribution on all loads

Method Summary

Modifier and Type	Method	Description
static LoadFlowParameters.BalanceType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LoadFlowParameters.BalanceType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PROPORTIONAL_TO_GENERATION_P

public static final LoadFlowParameters.BalanceType PROPORTIONAL_TO_GENERATION_P

active power slack distribution on generators, proportional to generator targetP

PROPORTIONAL_TO_GENERATION_P_MAX

public static final LoadFlowParameters.BalanceType PROPORTIONAL_TO_GENERATION_P_MAX

active power slack distribution on generators, proportional to generator maxP

PROPORTIONAL_TO_GENERATION_REMAINING_MARGIN

public static final LoadFlowParameters.BalanceType PROPORTIONAL_TO_GENERATION_REMAINING_MARGIN

active power slack distribution on generators, proportional to generator maxP - targetP

PROPORTIONAL_TO_GENERATION_PARTICIPATION_FACTOR

public static final LoadFlowParameters.BalanceType PROPORTIONAL_TO_GENERATION_PARTICIPATION_FACTOR

active power slack distribution on generators, proportional to participationFactor (see ActivePowerControl extension)

PROPORTIONAL_TO_LOAD

public static final LoadFlowParameters.BalanceType PROPORTIONAL_TO_LOAD

active power slack distribution on all loads

PROPORTIONAL_TO_CONFORM_LOAD

public static final LoadFlowParameters.BalanceType PROPORTIONAL_TO_CONFORM_LOAD

active power slack distribution on conforming loads (see LoadDetails extension)

Method Detail

values

public static LoadFlowParameters.BalanceType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LoadFlowParameters.BalanceType c : LoadFlowParameters.BalanceType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LoadFlowParameters.BalanceType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null