Package com.powsybl.sensitivity
Class SensitivityFactor
java.lang.Object
com.powsybl.sensitivity.SensitivityFactor
Sensitivity factor to be computed in the sensitivity analysis.
It regroups in a single object a description of the variable to modify, a description of the function to monitor
and a contingency context. A factor corresponds to the definition of a partial derivative to be extracted from the
network in a given contingency context. Usually we compute the impact of an injection increase on a branch flow or current,
the impact of a shift of a phase tap changer on a branch flow or current or the impact of a voltage target increase on a bus voltage.
- Author:
- Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
-
Constructor Summary
ConstructorDescriptionSensitivityFactor
(SensitivityFunctionType functionType, String functionId, SensitivityVariableType variableType, String variableId, boolean variableSet, ContingencyContext contingencyContext) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionstatic List<SensitivityFactor>
createMatrix
(SensitivityFunctionType functionType, Collection<String> functionIds, SensitivityVariableType variableType, Collection<String> variableIds, boolean variableSet, ContingencyContext contingencyContext) boolean
static SensitivityFactor
parseJson
(com.fasterxml.jackson.core.JsonParser parser) toString()
static void
writeJson
(com.fasterxml.jackson.core.JsonGenerator jsonGenerator, SensitivityFactor factor) static void
writeJson
(com.fasterxml.jackson.core.JsonGenerator jsonGenerator, SensitivityFunctionType functionType, String functionId, SensitivityVariableType variableType, String variableId, boolean variableSet, ContingencyContext contingencyContext)
-
Constructor Details
-
SensitivityFactor
public SensitivityFactor(SensitivityFunctionType functionType, String functionId, SensitivityVariableType variableType, String variableId, boolean variableSet, ContingencyContext contingencyContext) Constructor.- Parameters:
functionType
- seeSensitivityFunctionType
functionId
- the id of the equipment to monitor (in general the id of a branch). For BUS_VOLTAGE type, seeIdBasedBusRef
variableType
- seeSensitivityVariableType
variableId
- id of the equipment affected by the injection increase, the angle sift, the voltage target increase or the active power set point increase.variableSet
- boolean to says if the variable is a variable set or notcontingencyContext
- seeContingencyContext
-
-
Method Details
-
getFunctionType
-
getFunctionId
-
getVariableType
-
getVariableId
-
isVariableSet
public boolean isVariableSet() -
getContingencyContext
-
toString
-
writeJson
public static void writeJson(com.fasterxml.jackson.core.JsonGenerator jsonGenerator, SensitivityFactor factor) -
writeJson
public static void writeJson(com.fasterxml.jackson.core.JsonGenerator jsonGenerator, SensitivityFunctionType functionType, String functionId, SensitivityVariableType variableType, String variableId, boolean variableSet, ContingencyContext contingencyContext) -
parseJson
-
createMatrix
public static List<SensitivityFactor> createMatrix(SensitivityFunctionType functionType, Collection<String> functionIds, SensitivityVariableType variableType, Collection<String> variableIds, boolean variableSet, ContingencyContext contingencyContext)
-