Class BalanceComputationParameters
- java.lang.Object
-
- com.powsybl.commons.extensions.AbstractExtendable<BalanceComputationParameters>
-
- com.powsybl.balances_adjustment.balance_computation.BalanceComputationParameters
-
- All Implemented Interfaces:
com.powsybl.commons.extensions.Extendable<BalanceComputationParameters>
public class BalanceComputationParameters extends com.powsybl.commons.extensions.AbstractExtendable<BalanceComputationParameters>
parameters for balance computation.- Author:
- Ameni Walha <ameni.walha at rte-france.com>, Mohamed Ben Rejeb <mohamed.benrejeb at rte-france.com>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
BalanceComputationParameters.ConfigLoader<E extends com.powsybl.commons.extensions.Extension<BalanceComputationParameters>>
A configuration loader interface for the RaoComputationParameters extensions loaded from the platform configuration
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_MAX_NUMBER_ITERATIONS
static double
DEFAULT_THRESHOLD_NET_POSITION
-
Constructor Summary
Constructors Constructor Description BalanceComputationParameters()
Constructor with default parametersBalanceComputationParameters(double threshold, int maxNumberIterations)
Constructor with given parameters
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.powsybl.loadflow.LoadFlowParameters
getLoadFlowParameters()
int
getMaxNumberIterations()
double
getThresholdNetPosition()
static BalanceComputationParameters
load()
Load parameters from platform default config.static BalanceComputationParameters
load(com.powsybl.commons.config.PlatformConfig platformConfig)
Load parameters from a provided platform config.BalanceComputationParameters
setLoadFlowParameters(com.powsybl.loadflow.LoadFlowParameters loadFlowParameters)
BalanceComputationParameters
setMaxNumberIterations(int maxNumberIterations)
BalanceComputationParameters
setThresholdNetPosition(double thresholdNetPosition)
-
Methods inherited from class com.powsybl.commons.extensions.AbstractExtendable
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, removeExtension
-
-
-
-
Field Detail
-
DEFAULT_THRESHOLD_NET_POSITION
public static final double DEFAULT_THRESHOLD_NET_POSITION
- See Also:
- Constant Field Values
-
DEFAULT_MAX_NUMBER_ITERATIONS
public static final int DEFAULT_MAX_NUMBER_ITERATIONS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BalanceComputationParameters
public BalanceComputationParameters()
Constructor with default parameters
-
BalanceComputationParameters
public BalanceComputationParameters(double threshold, int maxNumberIterations)
Constructor with given parameters- Parameters:
threshold
- Threshold for comparing net positions (given in MW)maxNumberIterations
- Maximum iteration number for balances adjustment
-
-
Method Detail
-
load
public static BalanceComputationParameters load()
Load parameters from platform default config.
-
load
public static BalanceComputationParameters load(com.powsybl.commons.config.PlatformConfig platformConfig)
Load parameters from a provided platform config.
-
getLoadFlowParameters
public com.powsybl.loadflow.LoadFlowParameters getLoadFlowParameters()
-
setLoadFlowParameters
public BalanceComputationParameters setLoadFlowParameters(com.powsybl.loadflow.LoadFlowParameters loadFlowParameters)
-
getThresholdNetPosition
public double getThresholdNetPosition()
-
setThresholdNetPosition
public BalanceComputationParameters setThresholdNetPosition(double thresholdNetPosition)
-
getMaxNumberIterations
public int getMaxNumberIterations()
-
setMaxNumberIterations
public BalanceComputationParameters setMaxNumberIterations(int maxNumberIterations)
-
-