Package com.powsybl.loadflow
Class LoadFlowParameters
java.lang.Object
com.powsybl.commons.extensions.AbstractExtendable<LoadFlowParameters>
com.powsybl.loadflow.LoadFlowParameters
- All Implemented Interfaces:
Extendable<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
Modifier and TypeClassDescriptionstatic enum
BalanceType enum describes the various options for active power slack distributionstatic enum
static enum
-
Field Summary
Modifier and TypeFieldDescriptionstatic final LoadFlowParameters.BalanceType
static final LoadFlowParameters.ConnectedComponentMode
static final boolean
static final double
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final LoadFlowParameters.VoltageInitMode
static final boolean
static final String
-
Constructor Summary
ModifierConstructorDescriptionprotected
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
This copy methods uses json serializer mechanism to rebuild all extensions in the this parameters.double
boolean
isDc()
boolean
boolean
boolean
boolean
Deprecated.boolean
boolean
boolean
boolean
Deprecated.UseisShuntCompensatorVoltageControlOn()
instead.boolean
boolean
boolean
boolean
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) setBalanceType
(LoadFlowParameters.BalanceType balanceType) setConnectedComponentMode
(LoadFlowParameters.ConnectedComponentMode connectedComponentMode) setCountriesToBalance
(Set<Country> countriesToBalance) setDc
(boolean dc) setDcPowerFactor
(double dcPowerFactor) setDcUseTransformerRatio
(boolean dcUseTransformerRatio) setDistributedSlack
(boolean distributedSlack) setHvdcAcEmulation
(boolean hvdcAcEmulation) setNoGeneratorReactiveLimits
(boolean noGeneratorReactiveLimits) Deprecated.UsesetNoGeneratorReactiveLimits(boolean)
instead.setPhaseShifterRegulationOn
(boolean phaseShifterRegulationOn) setReadSlackBus
(boolean readSlackBus) setShuntCompensatorVoltageControlOn
(boolean shuntCompensatorVoltageControlOn) setSimulShunt
(boolean simulShunt) Deprecated.UsesetShuntCompensatorVoltageControlOn(boolean)
instead.setTransformerVoltageControlOn
(boolean transformerVoltageControlOn) setTwtSplitShuntAdmittance
(boolean twtSplitShuntAdmittance) setUseReactiveLimits
(boolean useReactiveLimits) setVoltageInitMode
(LoadFlowParameters.VoltageInitMode voltageInitMode) setWriteSlackBus
(boolean writeSlackBus) toMap()
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
- See Also:
-
DEFAULT_VOLTAGE_INIT_MODE
-
DEFAULT_TRANSFORMER_VOLTAGE_CONTROL_ON
public static final boolean DEFAULT_TRANSFORMER_VOLTAGE_CONTROL_ON- See Also:
-
DEFAULT_USE_REACTIVE_LIMITS
public static final boolean DEFAULT_USE_REACTIVE_LIMITS- See Also:
-
DEFAULT_PHASE_SHIFTER_REGULATION_ON
public static final boolean DEFAULT_PHASE_SHIFTER_REGULATION_ON- See Also:
-
DEFAULT_TWT_SPLIT_SHUNT_ADMITTANCE
public static final boolean DEFAULT_TWT_SPLIT_SHUNT_ADMITTANCE- See Also:
-
DEFAULT_SHUNT_COMPENSATOR_VOLTAGE_CONTROL_ON
public static final boolean DEFAULT_SHUNT_COMPENSATOR_VOLTAGE_CONTROL_ON- See Also:
-
DEFAULT_READ_SLACK_BUS
public static final boolean DEFAULT_READ_SLACK_BUS- See Also:
-
DEFAULT_WRITE_SLACK_BUS
public static final boolean DEFAULT_WRITE_SLACK_BUS- See Also:
-
DEFAULT_DC
public static final boolean DEFAULT_DC- See Also:
-
DEFAULT_DISTRIBUTED_SLACK
public static final boolean DEFAULT_DISTRIBUTED_SLACK- See Also:
-
DEFAULT_BALANCE_TYPE
-
DEFAULT_DC_USE_TRANSFORMER_RATIO_DEFAULT
public static final boolean DEFAULT_DC_USE_TRANSFORMER_RATIO_DEFAULT- See Also:
-
DEFAULT_COUNTRIES_TO_BALANCE
-
DEFAULT_CONNECTED_COMPONENT_MODE
-
DEFAULT_HVDC_AC_EMULATION_ON
public static final boolean DEFAULT_HVDC_AC_EMULATION_ON- See Also:
-
DEFAULT_DC_POWER_FACTOR
public static final double DEFAULT_DC_POWER_FACTOR- See Also:
-
-
Constructor Details
-
LoadFlowParameters
public LoadFlowParameters() -
LoadFlowParameters
-
-
Method Details
-
load
Loads parameters from the default platform configuration. -
load
Load parameters from a provided platform configuration. -
load
-
load
-
getVoltageInitMode
-
setVoltageInitMode
-
isTransformerVoltageControlOn
public boolean isTransformerVoltageControlOn() -
setTransformerVoltageControlOn
-
isUseReactiveLimits
public boolean isUseReactiveLimits() -
setUseReactiveLimits
-
isNoGeneratorReactiveLimits
Deprecated.UseisUseReactiveLimits()
instead. -
setNoGeneratorReactiveLimits
@Deprecated(since="5.1.0") public LoadFlowParameters setNoGeneratorReactiveLimits(boolean noGeneratorReactiveLimits) Deprecated.UsesetNoGeneratorReactiveLimits(boolean)
instead. -
isPhaseShifterRegulationOn
public boolean isPhaseShifterRegulationOn() -
setPhaseShifterRegulationOn
-
isTwtSplitShuntAdmittance
public boolean isTwtSplitShuntAdmittance() -
setTwtSplitShuntAdmittance
-
isSimulShunt
Deprecated.UseisShuntCompensatorVoltageControlOn()
instead. -
isShuntCompensatorVoltageControlOn
public boolean isShuntCompensatorVoltageControlOn() -
setSimulShunt
Deprecated.UsesetShuntCompensatorVoltageControlOn(boolean)
instead. -
setShuntCompensatorVoltageControlOn
public LoadFlowParameters setShuntCompensatorVoltageControlOn(boolean shuntCompensatorVoltageControlOn) -
isReadSlackBus
public boolean isReadSlackBus() -
setReadSlackBus
-
isWriteSlackBus
public boolean isWriteSlackBus() -
setWriteSlackBus
-
isDc
public boolean isDc() -
setDc
-
isDistributedSlack
public boolean isDistributedSlack() -
setDistributedSlack
-
setBalanceType
-
getBalanceType
-
setDcUseTransformerRatio
-
isDcUseTransformerRatio
public boolean isDcUseTransformerRatio() -
setCountriesToBalance
-
getCountriesToBalance
-
getConnectedComponentMode
-
setConnectedComponentMode
public LoadFlowParameters setConnectedComponentMode(LoadFlowParameters.ConnectedComponentMode connectedComponentMode) -
isHvdcAcEmulation
public boolean isHvdcAcEmulation() -
setHvdcAcEmulation
-
getDcPowerFactor
public double getDcPowerFactor() -
setDcPowerFactor
-
toMap
-
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
-
isUseReactiveLimits()
instead.