Package com.powsybl.sensitivity

Interface SensitivityAnalysisProvider

All Superinterfaces:

PlatformConfigNamedProvider, Versionable

public interface SensitivityAnalysisProvider
extends Versionable, PlatformConfigNamedProvider

Sensitivity analysis provider

Sensitivity 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 state and on that state 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 sensitivity function 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

Modifier and Type	Method	Description
default CompletableFuture<SensitivityAnalysisResult>	run(Network network, String workingStateId, SensitivityFactorsProvider factorsProvider, List<Contingency> contingencies, SensitivityAnalysisParameters parameters, ComputationManager computationManager)	Run an asynchronous single sensitivity analysis job.
default CompletableFuture<SensitivityAnalysisResult>	run(Network network, String workingStateId, SensitivityFactorsProvider factorsProvider, List<Contingency> contingencies, SensitivityAnalysisParameters parameters, ComputationManager computationManager, Reporter reporter)	Run an asynchronous single sensitivity analysis job.

Methods inherited from interface com.powsybl.commons.config.PlatformConfigNamedProvider

getName, getPlatformConfigName

Methods inherited from interface com.powsybl.commons.Versionable

getName, getVersion

Method Detail

run

default CompletableFuture<SensitivityAnalysisResult> run(Network network,
                                                         String workingStateId,
                                                         SensitivityFactorsProvider factorsProvider,
                                                         List<Contingency> contingencies,
                                                         SensitivityAnalysisParameters parameters,
                                                         ComputationManager computationManager)

Run an asynchronous single sensitivity analysis job. Factors will be computed by a computationManager on the workingStateId of the network on pre-contingency state and after each Contingency provided by contingencies according to the parameters.

Parameters:

network - IIDM network on which the sensitivity analysis will be performed

workingStateId - network variant ID on which the analysis will be performed

factorsProvider - provider of sensitivity factors to be computed

contingencies - list of contingencies after which sensitivity factors will be computed

parameters - specific sensitivity analysis parameters

computationManager - a computation manager to external program execution

Returns:

a CompletableFuture on SensitivityAnalysisResult that gathers sensitivity factor values

run

default CompletableFuture<SensitivityAnalysisResult> run(Network network,
                                                         String workingStateId,
                                                         SensitivityFactorsProvider factorsProvider,
                                                         List<Contingency> contingencies,
                                                         SensitivityAnalysisParameters parameters,
                                                         ComputationManager computationManager,
                                                         Reporter reporter)

Run an asynchronous single sensitivity analysis job. Factors will be computed by a computationManager on the workingStateId of the network on pre-contingency state and after each Contingency provided by contingencies according to the parameters.

Parameters:

network - IIDM network on which the sensitivity analysis will be performed

workingStateId - network variant ID on which the analysis will be performed

factorsProvider - provider of sensitivity factors to be computed

contingencies - list of contingencies after which sensitivity factors will be computed

parameters - specific sensitivity analysis parameters

computationManager - a computation manager to external program execution

reporter - a reporter for functional logs

Returns:

a CompletableFuture on SensitivityAnalysisResult that gathers sensitivity factor values