Package com.powsybl.shortcircuit

Class ShortCircuitAnalysis

java.lang.Object

com.powsybl.shortcircuit.ShortCircuitAnalysis

public final class ShortCircuitAnalysis
extends Object

API for elementary short-circuit computations.

Author:

Anne Tilloy <anne.tilloy at rte-france.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ShortCircuitAnalysis.Runner

Method Summary

Modifier and Type	Method	Description
static ShortCircuitAnalysis.Runner	find()	Get a runner for default short circuit analysis implementation.
static ShortCircuitAnalysis.Runner	find(String name)
static ShortCircuitAnalysisResult	run(Network network, List<Fault> faults)
static ShortCircuitAnalysisResult	run(Network network, List<Fault> faults, ShortCircuitParameters parameters, ComputationManager computationManager, List<FaultParameters> faultParameters)
static ShortCircuitAnalysisResult	run(Network network, List<Fault> faults, ShortCircuitParameters parameters, ComputationManager computationManager, List<FaultParameters> faultParameters, ReportNode reportNode)
static ShortCircuitAnalysisResult	run(Network network, List<Fault> faults, ShortCircuitParameters parameters, List<FaultParameters> faultParameters)
static ShortCircuitAnalysisResult	run(Network network, List<Fault> faults, List<FaultParameters> faultParameters)
static CompletableFuture<ShortCircuitAnalysisResult>	runAsync(Network network, List<Fault> faults, ShortCircuitParameters parameters, ComputationManager computationManager, List<FaultParameters> faultParameters)
static CompletableFuture<ShortCircuitAnalysisResult>	runAsync(Network network, List<Fault> faults, ShortCircuitParameters parameters, ComputationManager computationManager, List<FaultParameters> faultParameters, ReportNode reportNode)

Methods inherited from class java.lang.Object

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

Method Details

find

public static ShortCircuitAnalysis.Runner find(String name)

find

public static ShortCircuitAnalysis.Runner find()

Get a runner for default short circuit analysis implementation.

Returns:

a runner for default short circuit analysis implementation

Throws:

PowsyblException - in case we cannot find a default implementation

runAsync

public static CompletableFuture<ShortCircuitAnalysisResult> runAsync(Network network,
 List<Fault> faults,
 ShortCircuitParameters parameters,
 ComputationManager computationManager,
 List<FaultParameters> faultParameters)

runAsync

public static CompletableFuture<ShortCircuitAnalysisResult> runAsync(Network network,
 List<Fault> faults,
 ShortCircuitParameters parameters,
 ComputationManager computationManager,
 List<FaultParameters> faultParameters,
 ReportNode reportNode)

run

public static ShortCircuitAnalysisResult run(Network network,
 List<Fault> faults,
 ShortCircuitParameters parameters,
 ComputationManager computationManager,
 List<FaultParameters> faultParameters,
 ReportNode reportNode)

run

public static ShortCircuitAnalysisResult run(Network network,
 List<Fault> faults,
 ShortCircuitParameters parameters,
 ComputationManager computationManager,
 List<FaultParameters> faultParameters)

run

public static ShortCircuitAnalysisResult run(Network network,
 List<Fault> faults,
 ShortCircuitParameters parameters,
 List<FaultParameters> faultParameters)

run

public static ShortCircuitAnalysisResult run(Network network,
 List<Fault> faults,
 List<FaultParameters> faultParameters)

run

public static ShortCircuitAnalysisResult run(Network network,
 List<Fault> faults)