Package com.powsybl.sensitivity

Class SensitivityAnalysis

java.lang.Object

com.powsybl.sensitivity.SensitivityAnalysis

public final class SensitivityAnalysis
extends Object

Sensitivity analysis main API. It is a utility class (so with only static methods) used as an entry point for running a sensitivity analysis allowing to choose either a specific implementation or just to rely on the default one.

Author:

Joris Mancini <joris.mancini at rte-france.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SensitivityAnalysis.Runner	A sensitivity analysis runner is responsible for providing convenient methods on top of SensitivityAnalysisProvider: several variants of synchronous and asynchronous run with default parameters.

Method Summary

Modifier and Type	Method	Description
static SensitivityAnalysis.Runner	find()	Get a runner for default sensitivity analysis implementation.
static SensitivityAnalysis.Runner	find(String name)	Get a runner for sensitivity analysis implementation named name.
static SensitivityAnalysisResult	run(Network network, SensitivityFactorsProvider factorsProvider)
static SensitivityAnalysisResult	run(Network network, SensitivityFactorsProvider factorsProvider, SensitivityAnalysisParameters parameters)
static SensitivityAnalysisResult	run(Network network, SensitivityFactorsProvider factorsProvider, List<Contingency> contingencies)
static SensitivityAnalysisResult	run(Network network, SensitivityFactorsProvider factorsProvider, List<Contingency> contingencies, SensitivityAnalysisParameters parameters)
static SensitivityAnalysisResult	run(Network network, String workingStateId, SensitivityFactorsProvider factorsProvider, SensitivityAnalysisParameters parameters)
static SensitivityAnalysisResult	run(Network network, String workingStateId, SensitivityFactorsProvider factorsProvider, SensitivityAnalysisParameters parameters, ComputationManager computationManager)
static SensitivityAnalysisResult	run(Network network, String workingStateId, SensitivityFactorsProvider factorsProvider, List<Contingency> contingencies, SensitivityAnalysisParameters parameters)
static SensitivityAnalysisResult	run(Network network, String workingStateId, SensitivityFactorsProvider factorsProvider, List<Contingency> contingencies, SensitivityAnalysisParameters parameters, ComputationManager computationManager)
static CompletableFuture<SensitivityAnalysisResult>	runAsync(Network network, SensitivityFactorsProvider factorsProvider)
static CompletableFuture<SensitivityAnalysisResult>	runAsync(Network network, SensitivityFactorsProvider factorsProvider, SensitivityAnalysisParameters parameters)
static CompletableFuture<SensitivityAnalysisResult>	runAsync(Network network, SensitivityFactorsProvider factorsProvider, List<Contingency> contingencies)
static CompletableFuture<SensitivityAnalysisResult>	runAsync(Network network, SensitivityFactorsProvider factorsProvider, List<Contingency> contingencies, SensitivityAnalysisParameters parameters)
static CompletableFuture<SensitivityAnalysisResult>	runAsync(Network network, String workingStateId, SensitivityFactorsProvider factorsProvider, SensitivityAnalysisParameters parameters)
static CompletableFuture<SensitivityAnalysisResult>	runAsync(Network network, String workingStateId, SensitivityFactorsProvider factorsProvider, SensitivityAnalysisParameters parameters, ComputationManager computationManager)
static CompletableFuture<SensitivityAnalysisResult>	runAsync(Network network, String workingStateId, SensitivityFactorsProvider factorsProvider, List<Contingency> contingencies, SensitivityAnalysisParameters parameters)
static CompletableFuture<SensitivityAnalysisResult>	runAsync(Network network, String workingStateId, SensitivityFactorsProvider factorsProvider, List<Contingency> contingencies, SensitivityAnalysisParameters parameters, ComputationManager computationManager)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

find

public static SensitivityAnalysis.Runner find(String name)

Get a runner for sensitivity analysis implementation named name. In the case of a null name, default implementation is used.

Parameters:

name - name of the sensitivity analysis implementation, null if we want to use default one

Returns:

a runner for sensitivity analysis implementation named name

find

public static SensitivityAnalysis.Runner find()

Get a runner for default sensitivity analysis implementation.

Returns:

a runner for default sensitivity analysis implementation

Throws:

PowsyblException - in case we cannot find a default implementation

runAsync

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

runAsync

public static CompletableFuture<SensitivityAnalysisResult> runAsync(Network network,
                                                                    String workingStateId,
                                                                    SensitivityFactorsProvider factorsProvider,
                                                                    List<Contingency> contingencies,
                                                                    SensitivityAnalysisParameters parameters)

runAsync

public static CompletableFuture<SensitivityAnalysisResult> runAsync(Network network,
                                                                    SensitivityFactorsProvider factorsProvider,
                                                                    List<Contingency> contingencies,
                                                                    SensitivityAnalysisParameters parameters)

runAsync

public static CompletableFuture<SensitivityAnalysisResult> runAsync(Network network,
                                                                    SensitivityFactorsProvider factorsProvider,
                                                                    List<Contingency> contingencies)

runAsync

public static CompletableFuture<SensitivityAnalysisResult> runAsync(Network network,
                                                                    String workingStateId,
                                                                    SensitivityFactorsProvider factorsProvider,
                                                                    SensitivityAnalysisParameters parameters,
                                                                    ComputationManager computationManager)

runAsync

public static CompletableFuture<SensitivityAnalysisResult> runAsync(Network network,
                                                                    String workingStateId,
                                                                    SensitivityFactorsProvider factorsProvider,
                                                                    SensitivityAnalysisParameters parameters)

runAsync

public static CompletableFuture<SensitivityAnalysisResult> runAsync(Network network,
                                                                    SensitivityFactorsProvider factorsProvider,
                                                                    SensitivityAnalysisParameters parameters)

runAsync

public static CompletableFuture<SensitivityAnalysisResult> runAsync(Network network,
                                                                    SensitivityFactorsProvider factorsProvider)

run

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

run

public static SensitivityAnalysisResult run(Network network,
                                            String workingStateId,
                                            SensitivityFactorsProvider factorsProvider,
                                            List<Contingency> contingencies,
                                            SensitivityAnalysisParameters parameters)

run

public static SensitivityAnalysisResult run(Network network,
                                            SensitivityFactorsProvider factorsProvider,
                                            List<Contingency> contingencies,
                                            SensitivityAnalysisParameters parameters)

run

public static SensitivityAnalysisResult run(Network network,
                                            SensitivityFactorsProvider factorsProvider,
                                            List<Contingency> contingencies)

run

public static SensitivityAnalysisResult run(Network network,
                                            String workingStateId,
                                            SensitivityFactorsProvider factorsProvider,
                                            SensitivityAnalysisParameters parameters,
                                            ComputationManager computationManager)

run

public static SensitivityAnalysisResult run(Network network,
                                            String workingStateId,
                                            SensitivityFactorsProvider factorsProvider,
                                            SensitivityAnalysisParameters parameters)

run

public static SensitivityAnalysisResult run(Network network,
                                            SensitivityFactorsProvider factorsProvider,
                                            SensitivityAnalysisParameters parameters)

run

public static SensitivityAnalysisResult run(Network network,
                                            SensitivityFactorsProvider factorsProvider)