Package com.powsybl.loadflow
Class LoadFlow
java.lang.Object
com.powsybl.loadflow.LoadFlow
LoadFlow main API. It is a utility class (so with only static methods) used as an entry point for running
a loadflow allowing to choose either a specific find implementation or just to rely on default one.
- Author:
- Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
A loadflow runner is responsible for providing convenient methods on top ofLoadFlowProvider
: several variants of synchronous and asynchronous run with default parameters. -
Method Summary
Modifier and TypeMethodDescriptionstatic LoadFlow.Runner
find()
Get a runner for default loadflow implementation.static LoadFlow.Runner
Get a runner for loadflow implementation namedname
.static LoadFlowResult
static LoadFlowResult
run
(Network network, ComputationManager computationManager, LoadFlowParameters parameters) static LoadFlowResult
run
(Network network, LoadFlowParameters parameters) static LoadFlowResult
run
(Network network, String workingStateId, ComputationManager computationManager, LoadFlowParameters parameters) static LoadFlowResult
run
(Network network, String workingStateId, ComputationManager computationManager, LoadFlowParameters parameters, ReportNode reportNode) static CompletableFuture<LoadFlowResult>
static CompletableFuture<LoadFlowResult>
runAsync
(Network network, ComputationManager computationManager, LoadFlowParameters parameters) static CompletableFuture<LoadFlowResult>
runAsync
(Network network, LoadFlowParameters parameters) static CompletableFuture<LoadFlowResult>
runAsync
(Network network, String workingStateId, ComputationManager computationManager, LoadFlowParameters parameters) static CompletableFuture<LoadFlowResult>
runAsync
(Network network, String workingStateId, ComputationManager computationManager, LoadFlowParameters parameters, ReportNode reportNode)
-
Method Details
-
find
Get a runner for loadflow implementation namedname
. In the case of a nullname
, default implementation is used.- Parameters:
name
- name of the load flow implementation, null if we want to use default one- Returns:
- a runner for loadflow implementation named
name
-
find
Get a runner for default loadflow implementation.- Returns:
- a runner for default loadflow implementation
- Throws:
PowsyblException
- in case we cannot find a default implementation
-
runAsync
public static CompletableFuture<LoadFlowResult> runAsync(Network network, String workingStateId, ComputationManager computationManager, LoadFlowParameters parameters, ReportNode reportNode) -
runAsync
public static CompletableFuture<LoadFlowResult> runAsync(Network network, String workingStateId, ComputationManager computationManager, LoadFlowParameters parameters) -
runAsync
public static CompletableFuture<LoadFlowResult> runAsync(Network network, ComputationManager computationManager, LoadFlowParameters parameters) -
runAsync
public static CompletableFuture<LoadFlowResult> runAsync(Network network, LoadFlowParameters parameters) -
runAsync
-
run
public static LoadFlowResult run(Network network, String workingStateId, ComputationManager computationManager, LoadFlowParameters parameters, ReportNode reportNode) -
run
public static LoadFlowResult run(Network network, String workingStateId, ComputationManager computationManager, LoadFlowParameters parameters) -
run
public static LoadFlowResult run(Network network, ComputationManager computationManager, LoadFlowParameters parameters) -
run
-
run
-