public class SensitivityComputationResults extends Object
Mainly composed of the lists of sensitivity values in N, and optionally in N-1
A single sensitivity computation should return, besides its status and some stats on the computation itself, all the sensitivity values for each factor (combination of a monitoredBranch and a specific equipment or group of equipments). The HADES2 sensitivity provider used with Powsybl offers the possibility to calculate the sensitivity on a set of contingencies besides the N state. The computation is launched only once, but the solver itself modifies the matrix for each state of the network to output a full set of results. In the sensitivity API, it has been allowed to provide a list of contingencies as an optional input, which then triggers such a sensitivity analysis. The full set of results consists of : - the list of sensitivity values in N - the lists of sensitivity values for each N-1 situation - some metadata (status, stats, logs)SensitivityValue
Constructor and Description |
---|
SensitivityComputationResults(boolean ok,
Map<String,String> metrics,
String logs,
List<SensitivityValue> sensitivityValues) |
SensitivityComputationResults(boolean ok,
Map<String,String> metrics,
String logs,
List<SensitivityValue> sensitivityValues,
Map<String,List<SensitivityValue>> sensitivityValuesContingencies)
Hades2 sensitivity computation results
|
Modifier and Type | Method and Description |
---|---|
boolean |
contingenciesArePresent()
Get the status of the presence of contingencies
|
static SensitivityComputationResults |
empty() |
String |
getLogs()
Get computation logs.
|
Map<String,String> |
getMetrics()
Get some metrics about computation execution.
|
SensitivityValue |
getSensitivityValue(SensitivityFactor factor)
Get the sensitivity value associated with given factor in state N.
|
SensitivityValue |
getSensitivityValue(SensitivityFactor factor,
String contingencyId)
Get the sensitivity value associated with given factor for a specific contingency
|
SensitivityValue |
getSensitivityValue(SensitivityFunction function,
SensitivityVariable variable)
Get the sensitivity value associated with given function and given variable in state N.
|
SensitivityValue |
getSensitivityValue(SensitivityFunction function,
SensitivityVariable variable,
String contingencyId)
Get the sensitivity value associated with given function and given variable for a specific contingency.
|
Collection<SensitivityValue> |
getSensitivityValues()
Get a collection of all the sensitivity values in state N.
|
Collection<SensitivityValue> |
getSensitivityValuesByFunction(SensitivityFunction function)
Get a collection of all the sensitivity values associated with given function in state N.
|
Collection<SensitivityValue> |
getSensitivityValuesByFunction(SensitivityFunction function,
String contingencyId)
Get a collection of all the sensitivity values associated with given function
for a specific contingency.
|
Collection<SensitivityValue> |
getSensitivityValuesByVariable(SensitivityVariable variable)
Get a collection of all the sensitivity values associated with given variable in state N.
|
Collection<SensitivityValue> |
getSensitivityValuesByVariable(SensitivityVariable variable,
String contingencyId)
Get a collection of all the sensitivity values associated with given variable
for a specific contingency.
|
Map<String,List<SensitivityValue>> |
getSensitivityValuesContingencies()
Get a collection of all the sensitivity values for all contingencies.
|
boolean |
isOk()
Get the status of the sensitivity computation
|
public SensitivityComputationResults(boolean ok, Map<String,String> metrics, String logs, List<SensitivityValue> sensitivityValues, Map<String,List<SensitivityValue>> sensitivityValuesContingencies)
ok
- true if the computation succeeded, false otherwisemetrics
- map of metrics about the computationlogs
- computation logssensitivityValues
- result values of the senstivity computation in NsensitivityValuesContingencies
- result values of the senstivity computation on contingenciespublic boolean isOk()
public Map<String,String> getMetrics()
public String getLogs()
public Collection<SensitivityValue> getSensitivityValues()
public Collection<SensitivityValue> getSensitivityValuesByFunction(SensitivityFunction function)
function
- sensitivity functionpublic Collection<SensitivityValue> getSensitivityValuesByVariable(SensitivityVariable variable)
variable
- sensitivity variablepublic SensitivityValue getSensitivityValue(SensitivityFunction function, SensitivityVariable variable)
function
- sensitivity functionvariable
- sensitivity variablepublic SensitivityValue getSensitivityValue(SensitivityFactor factor)
factor
- sensitivity factorpublic boolean contingenciesArePresent()
public Map<String,List<SensitivityValue>> getSensitivityValuesContingencies()
public Collection<SensitivityValue> getSensitivityValuesByFunction(SensitivityFunction function, String contingencyId)
function
- sensitivity functioncontingencyId
- the ID of the considered contingencypublic Collection<SensitivityValue> getSensitivityValuesByVariable(SensitivityVariable variable, String contingencyId)
variable
- sensitivity variablecontingencyId
- the ID of the considered contingencypublic SensitivityValue getSensitivityValue(SensitivityFunction function, SensitivityVariable variable, String contingencyId)
function
- sensitivity functionvariable
- sensitivity variablecontingencyId
- the ID of the considered contingencypublic SensitivityValue getSensitivityValue(SensitivityFactor factor, String contingencyId)
factor
- sensitivity factorcontingencyId
- the ID of the considered contingencypublic static SensitivityComputationResults empty()
Copyright © 2020. All rights reserved.