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 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 final 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 void	run(Network network, String workingVariantId, SensitivityFactorReader factorReader, SensitivityResultWriter resultWriter, List<Contingency> contingencies, List<SensitivityVariableSet> variableSets, SensitivityAnalysisParameters parameters, ComputationManager computationManager, Reporter reporter)
static SensitivityAnalysisResult	run(Network network, String workingVariantId, List<SensitivityFactor> factors, List<Contingency> contingencies, List<SensitivityVariableSet> variableSets, SensitivityAnalysisParameters parameters)
static SensitivityAnalysisResult	run(Network network, String workingVariantId, List<SensitivityFactor> factors, List<Contingency> contingencies, List<SensitivityVariableSet> variableSets, SensitivityAnalysisParameters parameters, ComputationManager computationManager, Reporter reporter)
static SensitivityAnalysisResult	run(Network network, List<SensitivityFactor> factors)
static SensitivityAnalysisResult	run(Network network, List<SensitivityFactor> factors, SensitivityAnalysisParameters parameters)
static SensitivityAnalysisResult	run(Network network, List<SensitivityFactor> factors, List<Contingency> contingencies)
static SensitivityAnalysisResult	run(Network network, List<SensitivityFactor> factors, List<Contingency> contingencies, SensitivityAnalysisParameters parameters)
static SensitivityAnalysisResult	run(Network network, List<SensitivityFactor> factors, List<Contingency> contingencies, List<SensitivityVariableSet> variableSets, SensitivityAnalysisParameters parameters)
static CompletableFuture<Void>	runAsync(Network network, String workingVariantId, SensitivityFactorReader factorReader, SensitivityResultWriter resultWriter, List<Contingency> contingencies, List<SensitivityVariableSet> variableSets, SensitivityAnalysisParameters parameters, ComputationManager computationManager, Reporter reporter)
static CompletableFuture<SensitivityAnalysisResult>	runAsync(Network network, String workingVariantId, List<SensitivityFactor> factors, List<Contingency> contingencies, List<SensitivityVariableSet> variableSets, SensitivityAnalysisParameters parameters, ComputationManager computationManager, Reporter reporter)

Methods inherited from class java.lang.Object

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

Method Details

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<Void> runAsync(Network network,
 String workingVariantId,
 SensitivityFactorReader factorReader,
 SensitivityResultWriter resultWriter,
 List<Contingency> contingencies,
 List<SensitivityVariableSet> variableSets,
 SensitivityAnalysisParameters parameters,
 ComputationManager computationManager,
 Reporter reporter)

runAsync

public static CompletableFuture<SensitivityAnalysisResult> runAsync(Network network,
 String workingVariantId,
 List<SensitivityFactor> factors,
 List<Contingency> contingencies,
 List<SensitivityVariableSet> variableSets,
 SensitivityAnalysisParameters parameters,
 ComputationManager computationManager,
 Reporter reporter)

run

public static void run(Network network,
 String workingVariantId,
 SensitivityFactorReader factorReader,
 SensitivityResultWriter resultWriter,
 List<Contingency> contingencies,
 List<SensitivityVariableSet> variableSets,
 SensitivityAnalysisParameters parameters,
 ComputationManager computationManager,
 Reporter reporter)

run

public static SensitivityAnalysisResult run(Network network,
 String workingVariantId,
 List<SensitivityFactor> factors,
 List<Contingency> contingencies,
 List<SensitivityVariableSet> variableSets,
 SensitivityAnalysisParameters parameters,
 ComputationManager computationManager,
 Reporter reporter)

run

public static SensitivityAnalysisResult run(Network network,
 String workingVariantId,
 List<SensitivityFactor> factors,
 List<Contingency> contingencies,
 List<SensitivityVariableSet> variableSets,
 SensitivityAnalysisParameters parameters)

run

public static SensitivityAnalysisResult run(Network network,
 List<SensitivityFactor> factors,
 List<Contingency> contingencies,
 List<SensitivityVariableSet> variableSets,
 SensitivityAnalysisParameters parameters)

run

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

run

public static SensitivityAnalysisResult run(Network network,
 List<SensitivityFactor> factors,
 List<Contingency> contingencies)

run

public static SensitivityAnalysisResult run(Network network,
 List<SensitivityFactor> factors)

run

public static SensitivityAnalysisResult run(Network network,
 List<SensitivityFactor> factors,
 SensitivityAnalysisParameters parameters)