Package com.powsybl.loadflow

Class LoadFlowParameters

java.lang.Object

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

com.powsybl.loadflow.LoadFlowParameters

All Implemented Interfaces:

Extendable<LoadFlowParameters>

public class LoadFlowParameters
extends AbstractExtendable<LoadFlowParameters>

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

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LoadFlowParameters.BalanceType	BalanceType enum describes the various options for active power slack distribution
static enum	LoadFlowParameters.ConnectedComponentMode
static enum	LoadFlowParameters.VoltageInitMode

Field Summary

Fields

Modifier and Type	Field	Description
static final LoadFlowParameters.BalanceType	DEFAULT_BALANCE_TYPE
static final LoadFlowParameters.ConnectedComponentMode	DEFAULT_CONNECTED_COMPONENT_MODE
static final Set<Country>	DEFAULT_COUNTRIES_TO_BALANCE
static final boolean	DEFAULT_DC
static final double	DEFAULT_DC_POWER_FACTOR
static final boolean	DEFAULT_DC_USE_TRANSFORMER_RATIO_DEFAULT
static final boolean	DEFAULT_DISTRIBUTED_SLACK
static final boolean	DEFAULT_HVDC_AC_EMULATION_ON
static final boolean	DEFAULT_PHASE_SHIFTER_REGULATION_ON
static final boolean	DEFAULT_READ_SLACK_BUS
static final boolean	DEFAULT_SHUNT_COMPENSATOR_VOLTAGE_CONTROL_ON
static final boolean	DEFAULT_TRANSFORMER_VOLTAGE_CONTROL_ON
static final boolean	DEFAULT_TWT_SPLIT_SHUNT_ADMITTANCE
static final boolean	DEFAULT_USE_REACTIVE_LIMITS
static final LoadFlowParameters.VoltageInitMode	DEFAULT_VOLTAGE_INIT_MODE
static final boolean	DEFAULT_WRITE_SLACK_BUS
static final String	VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
	LoadFlowParameters()
protected	LoadFlowParameters(LoadFlowParameters other)

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()
double	getDcPowerFactor()
LoadFlowParameters.VoltageInitMode	getVoltageInitMode()
boolean	isDc()
boolean	isDcUseTransformerRatio()
boolean	isDistributedSlack()
boolean	isHvdcAcEmulation()
boolean	isNoGeneratorReactiveLimits()	Deprecated. Use isUseReactiveLimits() instead.
boolean	isPhaseShifterRegulationOn()
boolean	isReadSlackBus()
boolean	isShuntCompensatorVoltageControlOn()
boolean	isSimulShunt()	Deprecated. Use isShuntCompensatorVoltageControlOn() instead.
boolean	isTransformerVoltageControlOn()
boolean	isTwtSplitShuntAdmittance()
boolean	isUseReactiveLimits()
boolean	isWriteSlackBus()
static LoadFlowParameters	load()	Loads parameters from the default platform configuration.
static LoadFlowParameters	load(PlatformConfig platformConfig)	Load parameters from a provided platform configuration.
protected static void	load(LoadFlowParameters parameters)
protected static void	load(LoadFlowParameters parameters, PlatformConfig platformConfig)
LoadFlowParameters	setBalanceType(LoadFlowParameters.BalanceType balanceType)
LoadFlowParameters	setConnectedComponentMode(LoadFlowParameters.ConnectedComponentMode connectedComponentMode)
LoadFlowParameters	setCountriesToBalance(Set<Country> countriesToBalance)
LoadFlowParameters	setDc(boolean dc)
LoadFlowParameters	setDcPowerFactor(double dcPowerFactor)
LoadFlowParameters	setDcUseTransformerRatio(boolean dcUseTransformerRatio)
LoadFlowParameters	setDistributedSlack(boolean distributedSlack)
LoadFlowParameters	setHvdcAcEmulation(boolean hvdcAcEmulation)
LoadFlowParameters	setNoGeneratorReactiveLimits(boolean noGeneratorReactiveLimits)	Deprecated. Use setNoGeneratorReactiveLimits(boolean) instead.
LoadFlowParameters	setPhaseShifterRegulationOn(boolean phaseShifterRegulationOn)
LoadFlowParameters	setReadSlackBus(boolean readSlackBus)
LoadFlowParameters	setShuntCompensatorVoltageControlOn(boolean shuntCompensatorVoltageControlOn)
LoadFlowParameters	setSimulShunt(boolean simulShunt)	Deprecated. Use setShuntCompensatorVoltageControlOn(boolean) instead.
LoadFlowParameters	setTransformerVoltageControlOn(boolean transformerVoltageControlOn)
LoadFlowParameters	setTwtSplitShuntAdmittance(boolean twtSplitShuntAdmittance)
LoadFlowParameters	setUseReactiveLimits(boolean useReactiveLimits)
LoadFlowParameters	setVoltageInitMode(LoadFlowParameters.VoltageInitMode voltageInitMode)
LoadFlowParameters	setWriteSlackBus(boolean writeSlackBus)
Map<String,Object>	toMap()
String	toString()

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

addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, removeExtension, 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 Details

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_USE_REACTIVE_LIMITS

public static final boolean DEFAULT_USE_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_SHUNT_COMPENSATOR_VOLTAGE_CONTROL_ON

public static final boolean DEFAULT_SHUNT_COMPENSATOR_VOLTAGE_CONTROL_ON

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

DEFAULT_HVDC_AC_EMULATION_ON

public static final boolean DEFAULT_HVDC_AC_EMULATION_ON

See Also:

• Constant Field Values

DEFAULT_DC_POWER_FACTOR

public static final double DEFAULT_DC_POWER_FACTOR

See Also:

• Constant Field Values

Constructor Details

LoadFlowParameters

public LoadFlowParameters()

LoadFlowParameters

protected LoadFlowParameters(LoadFlowParameters other)

Method Details

load

public static LoadFlowParameters load()

Loads parameters from the default platform configuration.

load

public static LoadFlowParameters load(PlatformConfig platformConfig)

Load parameters from a provided platform configuration.

load

protected static void load(LoadFlowParameters parameters)

load

protected static void load(LoadFlowParameters parameters,
 PlatformConfig platformConfig)

getVoltageInitMode

public LoadFlowParameters.VoltageInitMode getVoltageInitMode()

setVoltageInitMode

public LoadFlowParameters setVoltageInitMode(LoadFlowParameters.VoltageInitMode voltageInitMode)

isTransformerVoltageControlOn

public boolean isTransformerVoltageControlOn()

setTransformerVoltageControlOn

public LoadFlowParameters setTransformerVoltageControlOn(boolean transformerVoltageControlOn)

isUseReactiveLimits

public boolean isUseReactiveLimits()

setUseReactiveLimits

public LoadFlowParameters setUseReactiveLimits(boolean useReactiveLimits)

isNoGeneratorReactiveLimits

@Deprecated(since="5.1.0")
public boolean isNoGeneratorReactiveLimits()

Deprecated.

Use isUseReactiveLimits() instead.

setNoGeneratorReactiveLimits

@Deprecated(since="5.1.0")
public LoadFlowParameters setNoGeneratorReactiveLimits(boolean noGeneratorReactiveLimits)

Deprecated.

Use setNoGeneratorReactiveLimits(boolean) instead.

isPhaseShifterRegulationOn

public boolean isPhaseShifterRegulationOn()

setPhaseShifterRegulationOn

public LoadFlowParameters setPhaseShifterRegulationOn(boolean phaseShifterRegulationOn)

isTwtSplitShuntAdmittance

public boolean isTwtSplitShuntAdmittance()

setTwtSplitShuntAdmittance

public LoadFlowParameters setTwtSplitShuntAdmittance(boolean twtSplitShuntAdmittance)

isSimulShunt

@Deprecated(since="4.7.0")
public boolean isSimulShunt()

Deprecated.

Use isShuntCompensatorVoltageControlOn() instead.

isShuntCompensatorVoltageControlOn

public boolean isShuntCompensatorVoltageControlOn()

setSimulShunt

@Deprecated(since="4.7.0")
public LoadFlowParameters setSimulShunt(boolean simulShunt)

Deprecated.

Use setShuntCompensatorVoltageControlOn(boolean) instead.

setShuntCompensatorVoltageControlOn

public LoadFlowParameters setShuntCompensatorVoltageControlOn(boolean shuntCompensatorVoltageControlOn)

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()

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)

isHvdcAcEmulation

public boolean isHvdcAcEmulation()

setHvdcAcEmulation

public LoadFlowParameters setHvdcAcEmulation(boolean hvdcAcEmulation)

getDcPowerFactor

public double getDcPowerFactor()

setDcPowerFactor

public LoadFlowParameters setDcPowerFactor(double dcPowerFactor)

toMap

public Map<String,Object> toMap()

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