Package com.powsybl.sensitivity

Class SensitivityAnalysisParameters

java.lang.Object

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

com.powsybl.sensitivity.SensitivityAnalysisParameters

All Implemented Interfaces:

Extendable<SensitivityAnalysisParameters>

public class SensitivityAnalysisParameters
extends AbstractExtendable<SensitivityAnalysisParameters>

Parameters for sensitivity analysis. Extensions may be added, for instance for implementation-specific parameters.

Author:

Sebastien Murgey <sebastien.murgey at rte-france.com>

Field Summary

Fields

Modifier and Type	Field	Description
static String	VERSION

Constructor Summary

Constructors

Constructor	Description
SensitivityAnalysisParameters()

Method Summary

Modifier and Type	Method	Description
double	getAngleFlowSensitivityValueThreshold()	AngleFlowSensitivityValueThreshold is the threshold under which sensitivity values having variable type among TRANSFORMER_PHASE and TRANSFORMER_PHASE_1/2/3 and function type among BRANCH_ACTIVE_POWER_1/2/3, BRANCH_REACTIVE_POWER_1/2/3 and BRANCH_CURRENT_1/2/3 will be filtered from the analysis results.
double	getFlowFlowSensitivityValueThreshold()	FlowFlowSensitivityValueThreshold is the threshold under which sensitivity values having variable type among INJECTION_ACTIVE_POWER, INJECTION_REACTIVE_POWER and HVDC_LINE_ACTIVE_POWER and function type among BRANCH_ACTIVE_POWER_1/2/3, BRANCH_REACTIVE_POWER_1/2/3 and BRANCH_CURRENT_1/2/3 will be filtered from the analysis results.
double	getFlowVoltageSensitivityValueThreshold()	FlowVoltageSensitivityValueThreshold is the threshold under which sensitivity values having variable type among INJECTION_REACTIVE_POWER and BUS_TARGET_VOLTAGE and function type among BUS_VOLTAGE, BRANCH_REACTIVE_POWER_1/2/3 and BRANCH_CURRENT_1/2/3 will be filtered from the analysis results.
LoadFlowParameters	getLoadFlowParameters()
double	getVoltageVoltageSensitivityValueThreshold()	VoltageVoltageSensitivityValueThreshold is the threshold under which sensitivity values having variable type BUS_TARGET_VOLTAGE and function type BUS_VOLTAGE will be filtered from the analysis results.
static SensitivityAnalysisParameters	load()	Load parameters from platform default config.
static SensitivityAnalysisParameters	load(PlatformConfig platformConfig)	Load parameters from a provided platform config.
SensitivityAnalysisParameters	setAngleFlowSensitivityValueThreshold(double threshold)
SensitivityAnalysisParameters	setFlowFlowSensitivityValueThreshold(double threshold)
SensitivityAnalysisParameters	setFlowVoltageSensitivityValueThreshold(double threshold)
SensitivityAnalysisParameters	setLoadFlowParameters(LoadFlowParameters loadFlowParameters)
SensitivityAnalysisParameters	setVoltageVoltageSensitivityValueThreshold(double threshold)

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

addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, removeExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.powsybl.commons.extensions.Extendable

newExtension

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

Constructor Detail

SensitivityAnalysisParameters

public SensitivityAnalysisParameters()

Method Detail

load

public static SensitivityAnalysisParameters load()

Load parameters from platform default config.

load

public static SensitivityAnalysisParameters load(PlatformConfig platformConfig)

Load parameters from a provided platform config.

getLoadFlowParameters

public LoadFlowParameters getLoadFlowParameters()

setLoadFlowParameters

public SensitivityAnalysisParameters setLoadFlowParameters(LoadFlowParameters loadFlowParameters)

setFlowFlowSensitivityValueThreshold

public SensitivityAnalysisParameters setFlowFlowSensitivityValueThreshold(double threshold)

getFlowFlowSensitivityValueThreshold

public double getFlowFlowSensitivityValueThreshold()

FlowFlowSensitivityValueThreshold is the threshold under which sensitivity values having variable type among INJECTION_ACTIVE_POWER, INJECTION_REACTIVE_POWER and HVDC_LINE_ACTIVE_POWER and function type among BRANCH_ACTIVE_POWER_1/2/3, BRANCH_REACTIVE_POWER_1/2/3 and BRANCH_CURRENT_1/2/3 will be filtered from the analysis results.

Returns:

The threshold

setVoltageVoltageSensitivityValueThreshold

public SensitivityAnalysisParameters setVoltageVoltageSensitivityValueThreshold(double threshold)

getVoltageVoltageSensitivityValueThreshold

public double getVoltageVoltageSensitivityValueThreshold()

VoltageVoltageSensitivityValueThreshold is the threshold under which sensitivity values having variable type BUS_TARGET_VOLTAGE and function type BUS_VOLTAGE will be filtered from the analysis results.

Returns:

The threshold

setFlowVoltageSensitivityValueThreshold

public SensitivityAnalysisParameters setFlowVoltageSensitivityValueThreshold(double threshold)

getFlowVoltageSensitivityValueThreshold

public double getFlowVoltageSensitivityValueThreshold()

FlowVoltageSensitivityValueThreshold is the threshold under which sensitivity values having variable type among INJECTION_REACTIVE_POWER and BUS_TARGET_VOLTAGE and function type among BUS_VOLTAGE, BRANCH_REACTIVE_POWER_1/2/3 and BRANCH_CURRENT_1/2/3 will be filtered from the analysis results.

Returns:

The threshold

setAngleFlowSensitivityValueThreshold

public SensitivityAnalysisParameters setAngleFlowSensitivityValueThreshold(double threshold)

getAngleFlowSensitivityValueThreshold

public double getAngleFlowSensitivityValueThreshold()

AngleFlowSensitivityValueThreshold is the threshold under which sensitivity values having variable type among TRANSFORMER_PHASE and TRANSFORMER_PHASE_1/2/3 and function type among BRANCH_ACTIVE_POWER_1/2/3, BRANCH_REACTIVE_POWER_1/2/3 and BRANCH_CURRENT_1/2/3 will be filtered from the analysis results.

Returns:

The threshold