Package com.powsybl.sensitivity
Interface SensitivityAnalysisProvider
-
- All Superinterfaces:
PlatformConfigNamedProvider
,Versionable
public interface SensitivityAnalysisProvider extends Versionable, PlatformConfigNamedProvider
Sensitivity analysis providerSensitivity analysis is used to assess the impact of a small modification of a network variables on the value of network functions. This analysis can be assimilated to a partial derivative computed on a given network variant and on that variant modified based on a list of contingencies, if specified.
PTDFs used in Flowbased methodology for example are sensitivity analysis results. The sensitivity variables are the GSK shift and the function reference are the monitored lines/transformers flows.
- Author:
- Sebastien Murgey <sebastien.murgey at rte-france.com>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.powsybl.commons.config.PlatformConfigNamedProvider
PlatformConfigNamedProvider.Finder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CompletableFuture<Void>
run(Network network, String workingVariantId, SensitivityFactorReader factorReader, SensitivityValueWriter valueWriter, List<Contingency> contingencies, List<SensitivityVariableSet> variableSets, SensitivityAnalysisParameters parameters, ComputationManager computationManager, Reporter reporter)
Run a single sensitivity analysis.-
Methods inherited from interface com.powsybl.commons.config.PlatformConfigNamedProvider
getName, getPlatformConfigName
-
Methods inherited from interface com.powsybl.commons.Versionable
getName, getVersion
-
-
-
-
Method Detail
-
run
CompletableFuture<Void> run(Network network, String workingVariantId, SensitivityFactorReader factorReader, SensitivityValueWriter valueWriter, List<Contingency> contingencies, List<SensitivityVariableSet> variableSets, SensitivityAnalysisParameters parameters, ComputationManager computationManager, Reporter reporter)
Run a single sensitivity analysis. Factors are given by afactorReader
on theworkingVariantId
of thenetwork
on pre-contingency state and after eachContingency
provided bycontingencies
according to theparameters
.- Parameters:
network
- IIDM network on which the sensitivity analysis will be performedworkingVariantId
- network variant ID on which the analysis will be performedfactorReader
- provider of sensitivity factors to be computedvalueWriter
- provider of sensitivity values resultscontingencies
- list of contingencies after which sensitivity factors will be computedvariableSets
- list of variableSetsparameters
- specific sensitivity analysis parameterscomputationManager
- a computation manager to external program executionreporter
- a reporter for functional logs- Returns:
- a
CompletableFuture
onSensitivityAnalysisResult
that gathers sensitivity factor values
-
-