Module com.powsybl.loadflow.api

Package com.powsybl.loadflow

Class LoadFlowParameters

java.lang.Object

com.powsybl.commons.extensions.AbstractExtendable<LoadFlowParameters>

com.powsybl.loadflow.LoadFlowParameters

All Implemented Interfaces:

com.powsybl.commons.extensions.Extendable<LoadFlowParameters>

public class LoadFlowParameters
extends com.powsybl.commons.extensions.AbstractExtendable<LoadFlowParameters>

Parameters for loadflow computation. Extensions may be added, for instance for implementation-specific parameters.

Author:

Geoffroy Jamgotchian

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoadFlowParameters.BalanceType
static interface	LoadFlowParameters.ConfigLoader<E extends com.powsybl.commons.extensions.Extension<LoadFlowParameters>>	A configuration loader interface for the LoadFlowParameters extensions loaded from the platform configuration
static class	LoadFlowParameters.ConnectedComponentMode
static class	LoadFlowParameters.VoltageInitMode

Field Summary

Fields

Modifier and Type	Field	Description
static LoadFlowParameters.BalanceType	DEFAULT_BALANCE_TYPE
static LoadFlowParameters.ConnectedComponentMode	DEFAULT_CONNECTED_COMPONENT_MODE
static Set<Country>	DEFAULT_COUNTRIES_TO_BALANCE
static boolean	DEFAULT_DC
static boolean	DEFAULT_DC_USE_TRANSFORMER_RATIO_DEFAULT
static boolean	DEFAULT_DISTRIBUTED_SLACK
static boolean	DEFAULT_NO_GENERATOR_REACTIVE_LIMITS
static boolean	DEFAULT_PHASE_SHIFTER_REGULATION_ON
static boolean	DEFAULT_READ_SLACK_BUS
static boolean	DEFAULT_SIMUL_SHUNT
static boolean	DEFAULT_TRANSFORMER_VOLTAGE_CONTROL_ON
static boolean	DEFAULT_TWT_SPLIT_SHUNT_ADMITTANCE
static LoadFlowParameters.VoltageInitMode	DEFAULT_VOLTAGE_INIT_MODE
static boolean	DEFAULT_WRITE_SLACK_BUS
static String	VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
	LoadFlowParameters()
protected	LoadFlowParameters(LoadFlowParameters other)
	LoadFlowParameters(LoadFlowParameters.VoltageInitMode voltageInitMode)
	LoadFlowParameters(LoadFlowParameters.VoltageInitMode voltageInitMode, boolean transformerVoltageControlOn)
	LoadFlowParameters(LoadFlowParameters.VoltageInitMode voltageInitMode, boolean transformerVoltageControlOn, boolean noGeneratorReactiveLimits, boolean phaseShifterRegulationOn, boolean twtSplitShuntAdmittance)
	LoadFlowParameters(LoadFlowParameters.VoltageInitMode voltageInitMode, boolean transformerVoltageControlOn, boolean noGeneratorReactiveLimits, boolean phaseShifterRegulationOn, boolean twtSplitShuntAdmittance, boolean simulShunt, boolean readSlackBus, boolean writeSlackBus, boolean dc, boolean distributedSlack, LoadFlowParameters.BalanceType balanceType, boolean dcUseTransformerRatio, Set<Country> countriesToBalance, LoadFlowParameters.ConnectedComponentMode connectedComponentMode)

Method Summary

Modifier and Type	Method	Description
LoadFlowParameters	copy()	This copy methods uses json serializer mechanism to rebuild all extensions in the this parameters.
LoadFlowParameters.BalanceType	getBalanceType()
LoadFlowParameters.ConnectedComponentMode	getConnectedComponentMode()
Set<Country>	getCountriesToBalance()
LoadFlowParameters.VoltageInitMode	getVoltageInitMode()
boolean	isDc()
boolean	isDcUseTransformerRatio()
boolean	isDistributedSlack()
boolean	isNoGeneratorReactiveLimits()
boolean	isPhaseShifterRegulationOn()
boolean	isReadSlackBus()
boolean	isSimulShunt()
boolean	isSpecificCompatibility()	Deprecated. Use isTwtSplitShuntAdmittance() instead.
boolean	isT2wtSplitShuntAdmittance()	Deprecated. Use isTwtSplitShuntAdmittance() instead.
boolean	isTransformerVoltageControlOn()
boolean	isTwtSplitShuntAdmittance()
boolean	isWriteSlackBus()
static LoadFlowParameters	load()	Loads parameters from the default platform configuration.
static LoadFlowParameters	load(com.powsybl.commons.config.PlatformConfig platformConfig)	Load parameters from a provided platform configuration.
protected static void	load(LoadFlowParameters parameters)
protected static void	load(LoadFlowParameters parameters, com.powsybl.commons.config.PlatformConfig platformConfig)
LoadFlowParameters	setBalanceType(LoadFlowParameters.BalanceType balanceType)
LoadFlowParameters	setConnectedComponentMode(LoadFlowParameters.ConnectedComponentMode connectedComponentMode)
LoadFlowParameters	setCountriesToBalance(Set<Country> countriesToBalance)
LoadFlowParameters	setDc(boolean dc)
LoadFlowParameters	setDcUseTransformerRatio(boolean dcUseTransformerRatio)
LoadFlowParameters	setDistributedSlack(boolean distributedSlack)
LoadFlowParameters	setNoGeneratorReactiveLimits(boolean noGeneratorReactiveLimits)
LoadFlowParameters	setPhaseShifterRegulationOn(boolean phaseShifterRegulationOn)
LoadFlowParameters	setReadSlackBus(boolean readSlackBus)
LoadFlowParameters	setSimulShunt(boolean simulShunt)
LoadFlowParameters	setSpecificCompatibility(boolean twtSplitShuntAdmittance)	Deprecated. Use setTwtSplitShuntAdmittance(boolean) instead.
LoadFlowParameters	setT2wtSplitShuntAdmittance(boolean twtSplitShuntAdmittance)	Deprecated. Use setTwtSplitShuntAdmittance(boolean) instead.
LoadFlowParameters	setTransformerVoltageControlOn(boolean transformerVoltageControlOn)
LoadFlowParameters	setTwtSplitShuntAdmittance(boolean twtSplitShuntAdmittance)
LoadFlowParameters	setVoltageInitMode(LoadFlowParameters.VoltageInitMode voltageInitMode)
LoadFlowParameters	setWriteSlackBus(boolean writeSlackBus)
protected Map<String,Object>	toMap()
String	toString()

Methods inherited from class com.powsybl.commons.extensions.AbstractExtendable

addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, removeExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.powsybl.commons.extensions.Extendable

newExtension

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

DEFAULT_VOLTAGE_INIT_MODE

public static final LoadFlowParameters.VoltageInitMode DEFAULT_VOLTAGE_INIT_MODE

DEFAULT_TRANSFORMER_VOLTAGE_CONTROL_ON

public static final boolean DEFAULT_TRANSFORMER_VOLTAGE_CONTROL_ON

See Also:

Constant Field Values

DEFAULT_NO_GENERATOR_REACTIVE_LIMITS

public static final boolean DEFAULT_NO_GENERATOR_REACTIVE_LIMITS

See Also:

Constant Field Values

DEFAULT_PHASE_SHIFTER_REGULATION_ON

public static final boolean DEFAULT_PHASE_SHIFTER_REGULATION_ON

See Also:

Constant Field Values

DEFAULT_TWT_SPLIT_SHUNT_ADMITTANCE

public static final boolean DEFAULT_TWT_SPLIT_SHUNT_ADMITTANCE

See Also:

Constant Field Values

DEFAULT_SIMUL_SHUNT

public static final boolean DEFAULT_SIMUL_SHUNT

See Also:

Constant Field Values

DEFAULT_READ_SLACK_BUS

public static final boolean DEFAULT_READ_SLACK_BUS

See Also:

Constant Field Values

DEFAULT_WRITE_SLACK_BUS

public static final boolean DEFAULT_WRITE_SLACK_BUS

See Also:

Constant Field Values

DEFAULT_DC

public static final boolean DEFAULT_DC

See Also:

Constant Field Values

DEFAULT_DISTRIBUTED_SLACK

public static final boolean DEFAULT_DISTRIBUTED_SLACK

See Also:

Constant Field Values

DEFAULT_BALANCE_TYPE

public static final LoadFlowParameters.BalanceType DEFAULT_BALANCE_TYPE

DEFAULT_DC_USE_TRANSFORMER_RATIO_DEFAULT

public static final boolean DEFAULT_DC_USE_TRANSFORMER_RATIO_DEFAULT

See Also:

Constant Field Values

DEFAULT_COUNTRIES_TO_BALANCE

public static final Set<Country> DEFAULT_COUNTRIES_TO_BALANCE

DEFAULT_CONNECTED_COMPONENT_MODE

public static final LoadFlowParameters.ConnectedComponentMode DEFAULT_CONNECTED_COMPONENT_MODE

Constructor Detail

LoadFlowParameters

public LoadFlowParameters(LoadFlowParameters.VoltageInitMode voltageInitMode,
                          boolean transformerVoltageControlOn,
                          boolean noGeneratorReactiveLimits,
                          boolean phaseShifterRegulationOn,
                          boolean twtSplitShuntAdmittance,
                          boolean simulShunt,
                          boolean readSlackBus,
                          boolean writeSlackBus,
                          boolean dc,
                          boolean distributedSlack,
                          LoadFlowParameters.BalanceType balanceType,
                          boolean dcUseTransformerRatio,
                          Set<Country> countriesToBalance,
                          LoadFlowParameters.ConnectedComponentMode connectedComponentMode)

LoadFlowParameters

public LoadFlowParameters(LoadFlowParameters.VoltageInitMode voltageInitMode,
                          boolean transformerVoltageControlOn,
                          boolean noGeneratorReactiveLimits,
                          boolean phaseShifterRegulationOn,
                          boolean twtSplitShuntAdmittance)

LoadFlowParameters

public LoadFlowParameters(LoadFlowParameters.VoltageInitMode voltageInitMode,
                          boolean transformerVoltageControlOn)

LoadFlowParameters

public LoadFlowParameters(LoadFlowParameters.VoltageInitMode voltageInitMode)

LoadFlowParameters

public LoadFlowParameters()

LoadFlowParameters

protected LoadFlowParameters(LoadFlowParameters other)

Method Detail

load

public static LoadFlowParameters load()

Loads parameters from the default platform configuration.

load

public static LoadFlowParameters load(com.powsybl.commons.config.PlatformConfig platformConfig)

Load parameters from a provided platform configuration.

load

protected static void load(LoadFlowParameters parameters)

load

protected static void load(LoadFlowParameters parameters,
                           com.powsybl.commons.config.PlatformConfig platformConfig)

getVoltageInitMode

public LoadFlowParameters.VoltageInitMode getVoltageInitMode()

setVoltageInitMode

public LoadFlowParameters setVoltageInitMode(LoadFlowParameters.VoltageInitMode voltageInitMode)

isTransformerVoltageControlOn

public boolean isTransformerVoltageControlOn()

setTransformerVoltageControlOn

public LoadFlowParameters setTransformerVoltageControlOn(boolean transformerVoltageControlOn)

isNoGeneratorReactiveLimits

public boolean isNoGeneratorReactiveLimits()

setNoGeneratorReactiveLimits

public LoadFlowParameters setNoGeneratorReactiveLimits(boolean noGeneratorReactiveLimits)

isPhaseShifterRegulationOn

public boolean isPhaseShifterRegulationOn()

setPhaseShifterRegulationOn

public LoadFlowParameters setPhaseShifterRegulationOn(boolean phaseShifterRegulationOn)

isSpecificCompatibility

@Deprecated
public boolean isSpecificCompatibility()

Deprecated.

Use isTwtSplitShuntAdmittance() instead.

isT2wtSplitShuntAdmittance

@Deprecated
public boolean isT2wtSplitShuntAdmittance()

Deprecated.

Use isTwtSplitShuntAdmittance() instead.

isTwtSplitShuntAdmittance

public boolean isTwtSplitShuntAdmittance()

setSpecificCompatibility

@Deprecated
public LoadFlowParameters setSpecificCompatibility(boolean twtSplitShuntAdmittance)

Deprecated.

Use setTwtSplitShuntAdmittance(boolean) instead.

setT2wtSplitShuntAdmittance

@Deprecated
public LoadFlowParameters setT2wtSplitShuntAdmittance(boolean twtSplitShuntAdmittance)

Deprecated.

Use setTwtSplitShuntAdmittance(boolean) instead.

setTwtSplitShuntAdmittance

public LoadFlowParameters setTwtSplitShuntAdmittance(boolean twtSplitShuntAdmittance)

isSimulShunt

public boolean isSimulShunt()

setSimulShunt

public LoadFlowParameters setSimulShunt(boolean simulShunt)

isReadSlackBus

public boolean isReadSlackBus()

setReadSlackBus

public LoadFlowParameters setReadSlackBus(boolean readSlackBus)

isWriteSlackBus

public boolean isWriteSlackBus()

setWriteSlackBus

public LoadFlowParameters setWriteSlackBus(boolean writeSlackBus)

isDc

public boolean isDc()

setDc

public LoadFlowParameters setDc(boolean dc)

isDistributedSlack

public boolean isDistributedSlack()

setDistributedSlack

public LoadFlowParameters setDistributedSlack(boolean distributedSlack)

setBalanceType

public LoadFlowParameters setBalanceType(LoadFlowParameters.BalanceType balanceType)

getBalanceType

public LoadFlowParameters.BalanceType getBalanceType()

toMap

protected Map<String,Object> toMap()

setDcUseTransformerRatio

public LoadFlowParameters setDcUseTransformerRatio(boolean dcUseTransformerRatio)

isDcUseTransformerRatio

public boolean isDcUseTransformerRatio()

setCountriesToBalance

public LoadFlowParameters setCountriesToBalance(Set<Country> countriesToBalance)

getCountriesToBalance

public Set<Country> getCountriesToBalance()

getConnectedComponentMode

public LoadFlowParameters.ConnectedComponentMode getConnectedComponentMode()

setConnectedComponentMode

public LoadFlowParameters setConnectedComponentMode(LoadFlowParameters.ConnectedComponentMode connectedComponentMode)

copy

public LoadFlowParameters copy()

This copy methods uses json serializer mechanism to rebuild all extensions in the this parameters. If an extension's serializer not found via @AutoService, the extension would be lost in copied.

Returns:

a new copied instance and with original's extensions found based-on json serializer.

toString

public String toString()

Overrides:

toString in class Object