- java.lang.Object
-
- com.powsybl.loadflow.LoadFlow
-
public final class LoadFlow extends Object
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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LoadFlow.Runner
A loadflow runner is responsible for providing convenient methods on top ofLoadFlowProvider
: several variants of synchronous and asynchronous run with default parameters.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static LoadFlow.Runner
find()
Get a runner for default loadflow implementation.static LoadFlow.Runner
find(String name)
Get a runner for loadflow implementation namedname
.static LoadFlowResult
run(Network network)
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, com.powsybl.commons.reporter.Reporter reporter)
static CompletableFuture<LoadFlowResult>
runAsync(Network network)
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, com.powsybl.commons.reporter.Reporter reporter)
-
-
-
Method Detail
-
find
public static LoadFlow.Runner find(String name)
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
public static LoadFlow.Runner find()
Get a runner for default loadflow implementation.- Returns:
- a runner for default loadflow implementation
- Throws:
com.powsybl.commons.PowsyblException
- in case we cannot find a default implementation
-
runAsync
public static CompletableFuture<LoadFlowResult> runAsync(Network network, String workingStateId, ComputationManager computationManager, LoadFlowParameters parameters, com.powsybl.commons.reporter.Reporter reporter)
-
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
public static CompletableFuture<LoadFlowResult> runAsync(Network network)
-
run
public static LoadFlowResult run(Network network, String workingStateId, ComputationManager computationManager, LoadFlowParameters parameters, com.powsybl.commons.reporter.Reporter reporter)
-
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
public static LoadFlowResult run(Network network, LoadFlowParameters parameters)
-
run
public static LoadFlowResult run(Network network)
-
-