Package com.powsybl.openloadflow.ac.nr

Class NewtonRaphsonParameters

java.lang.Object

com.powsybl.openloadflow.ac.nr.NewtonRaphsonParameters

public class NewtonRaphsonParameters
extends Object

Author:

Geoffroy Jamgotchian

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	ALWAYS_UPDATE_NETWORK_DEFAULT_VALUE
static int	DEFAULT_MAX_ITERATIONS
static double	DEFAULT_MAX_REALISTIC_VOLTAGE
static double	DEFAULT_MIN_REALISTIC_VOLTAGE
static StateVectorScalingMode	DEFAULT_STATE_VECTOR_SCALING_MODE

Constructor Summary

Constructors

Constructor	Description
NewtonRaphsonParameters()

Method Summary

Modifier and Type	Method	Description
static int	checkMaxIteration(int maxIteration)
int	getMaxIterations()
double	getMaxRealisticVoltage()
double	getMinRealisticVoltage()
StateVectorScalingMode	getStateVectorScalingMode()
NewtonRaphsonStoppingCriteria	getStoppingCriteria()
boolean	isAlwaysUpdateNetwork()
boolean	isDetailedReport()
NewtonRaphsonParameters	setAlwaysUpdateNetwork(boolean alwaysUpdateNetwork)
NewtonRaphsonParameters	setDetailedReport(boolean detailedReport)
NewtonRaphsonParameters	setMaxIterations(int maxIterations)
NewtonRaphsonParameters	setMaxRealisticVoltage(double maxRealisticVoltage)
NewtonRaphsonParameters	setMinRealisticVoltage(double minRealisticVoltage)
NewtonRaphsonParameters	setStateVectorScalingMode(StateVectorScalingMode stateVectorScalingMode)
NewtonRaphsonParameters	setStoppingCriteria(NewtonRaphsonStoppingCriteria stoppingCriteria)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_ITERATIONS

public static final int DEFAULT_MAX_ITERATIONS

See Also:

Constant Field Values

DEFAULT_MIN_REALISTIC_VOLTAGE

public static final double DEFAULT_MIN_REALISTIC_VOLTAGE

See Also:

Constant Field Values

DEFAULT_MAX_REALISTIC_VOLTAGE

public static final double DEFAULT_MAX_REALISTIC_VOLTAGE

See Also:

Constant Field Values

DEFAULT_STATE_VECTOR_SCALING_MODE

public static final StateVectorScalingMode DEFAULT_STATE_VECTOR_SCALING_MODE

ALWAYS_UPDATE_NETWORK_DEFAULT_VALUE

public static final boolean ALWAYS_UPDATE_NETWORK_DEFAULT_VALUE

See Also:

Constant Field Values

Constructor Detail

NewtonRaphsonParameters

public NewtonRaphsonParameters()

Method Detail

checkMaxIteration

public static int checkMaxIteration(int maxIteration)

getMaxIterations

public int getMaxIterations()

setMaxIterations

public NewtonRaphsonParameters setMaxIterations(int maxIterations)

getMinRealisticVoltage

public double getMinRealisticVoltage()

setMinRealisticVoltage

public NewtonRaphsonParameters setMinRealisticVoltage(double minRealisticVoltage)

getMaxRealisticVoltage

public double getMaxRealisticVoltage()

setMaxRealisticVoltage

public NewtonRaphsonParameters setMaxRealisticVoltage(double maxRealisticVoltage)

getStoppingCriteria

public NewtonRaphsonStoppingCriteria getStoppingCriteria()

setStoppingCriteria

public NewtonRaphsonParameters setStoppingCriteria(NewtonRaphsonStoppingCriteria stoppingCriteria)

getStateVectorScalingMode

public StateVectorScalingMode getStateVectorScalingMode()

setStateVectorScalingMode

public NewtonRaphsonParameters setStateVectorScalingMode(StateVectorScalingMode stateVectorScalingMode)

isDetailedReport

public boolean isDetailedReport()

setDetailedReport

public NewtonRaphsonParameters setDetailedReport(boolean detailedReport)

isAlwaysUpdateNetwork

public boolean isAlwaysUpdateNetwork()

setAlwaysUpdateNetwork

public NewtonRaphsonParameters setAlwaysUpdateNetwork(boolean alwaysUpdateNetwork)

toString

public String toString()

Overrides:

toString in class Object