Package com.powsybl.sensitivity
Class SensitivityFactor
- java.lang.Object
-
- com.powsybl.sensitivity.SensitivityFactor
-
public class SensitivityFactor extends Object
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
-
-
Constructor Summary
Constructors Constructor Description SensitivityFactor(SensitivityFunctionType functionType, String functionId, SensitivityVariableType variableType, String variableId, boolean variableSet, ContingencyContext contingencyContext)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static List<SensitivityFactor>
createMatrix(SensitivityFunctionType functionType, Collection<String> functionIds, SensitivityVariableType variableType, Collection<String> variableIds, boolean variableSet, ContingencyContext contingencyContext)
ContingencyContext
getContingencyContext()
String
getFunctionId()
SensitivityFunctionType
getFunctionType()
String
getVariableId()
SensitivityVariableType
getVariableType()
boolean
isVariableSet()
static SensitivityFactor
parseJson(com.fasterxml.jackson.core.JsonParser parser)
String
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 Detail
-
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 Detail
-
getFunctionType
public SensitivityFunctionType getFunctionType()
-
getFunctionId
public String getFunctionId()
-
getVariableType
public SensitivityVariableType getVariableType()
-
getVariableId
public String getVariableId()
-
isVariableSet
public boolean isVariableSet()
-
getContingencyContext
public ContingencyContext getContingencyContext()
-
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
public static SensitivityFactor parseJson(com.fasterxml.jackson.core.JsonParser parser)
-
createMatrix
public static List<SensitivityFactor> createMatrix(SensitivityFunctionType functionType, Collection<String> functionIds, SensitivityVariableType variableType, Collection<String> variableIds, boolean variableSet, ContingencyContext contingencyContext)
-
-