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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_NO_GENERATOR_REACTIVE_LIMITS
static boolean	DEFAULT_PHASE_SHIFTER_REGULATION_ON
static boolean	DEFAULT_SPECIFIC_COMPATIBILITY
static boolean	DEFAULT_TRANSFORMER_VOLTAGE_CONTROL_ON
static LoadFlowParameters.VoltageInitMode	DEFAULT_VOLTAGE_INIT_MODE
static java.lang.String	VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
	LoadFlowParameters()
	LoadFlowParameters(LoadFlowParameters.VoltageInitMode voltageInitMode)
	LoadFlowParameters(LoadFlowParameters.VoltageInitMode voltageInitMode, boolean transformerVoltageControlOn)
	LoadFlowParameters(LoadFlowParameters.VoltageInitMode voltageInitMode, boolean transformerVoltageControlOn, boolean noGeneratorReactiveLimits, boolean phaseShifterRegulationOn, boolean specificCompatibility)
protected	LoadFlowParameters(LoadFlowParameters other)

Method Summary

Modifier and Type	Method and Description
LoadFlowParameters	copy()
LoadFlowParameters.VoltageInitMode	getVoltageInitMode()
boolean	isNoGeneratorReactiveLimits()
boolean	isPhaseShifterRegulationOn()
boolean	isSpecificCompatibility()
boolean	isTransformerVoltageControlOn()
static LoadFlowParameters	load() Loads parameters from the default platform configuration.
protected static void	load(LoadFlowParameters parameters)
protected static void	load(LoadFlowParameters parameters, PlatformConfig platformConfig)
static LoadFlowParameters	load(PlatformConfig platformConfig) Load parameters from a provided platform configuration.
LoadFlowParameters	setNoGeneratorReactiveLimits(boolean noGeneratorReactiveLimits)
LoadFlowParameters	setPhaseShifterRegulationOn(boolean phaseShifterRegulationOn)
LoadFlowParameters	setSpecificCompatibility(boolean specificCompatibility)
LoadFlowParameters	setTransformerVoltageControlOn(boolean transformerVoltageControlOn)
LoadFlowParameters	setVoltageInitMode(LoadFlowParameters.VoltageInitMode voltageInitMode)
protected java.util.Map<java.lang.String,java.lang.Object>	toMap()
java.lang.String	toString()

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

addExtension, getExtension, getExtensionByName, getExtensions, removeExtension

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.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_SPECIFIC_COMPATIBILITY

public static final boolean DEFAULT_SPECIFIC_COMPATIBILITY

See Also:

Constant Field Values

Constructor Detail

LoadFlowParameters

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

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

isNoGeneratorReactiveLimits

public boolean isNoGeneratorReactiveLimits()

setNoGeneratorReactiveLimits

public LoadFlowParameters setNoGeneratorReactiveLimits(boolean noGeneratorReactiveLimits)

isPhaseShifterRegulationOn

public boolean isPhaseShifterRegulationOn()

setPhaseShifterRegulationOn

public LoadFlowParameters setPhaseShifterRegulationOn(boolean phaseShifterRegulationOn)

isSpecificCompatibility

public boolean isSpecificCompatibility()

setSpecificCompatibility

public LoadFlowParameters setSpecificCompatibility(boolean specificCompatibility)

toMap

protected java.util.Map<java.lang.String,java.lang.Object> toMap()

copy

public LoadFlowParameters copy()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object