Package com.powsybl.shortcircuit
Interface ShortCircuitAnalysisProvider
-
- All Superinterfaces:
PlatformConfigNamedProvider
,Versionable
public interface ShortCircuitAnalysisProvider extends Versionable, PlatformConfigNamedProvider
Computation results are provided asynchronously as a
ShortCircuitAnalysisResult
.Implementations of that interface may typically rely on an external tool.
- Author:
- Anne Tilloy
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.powsybl.commons.config.PlatformConfigNamedProvider
PlatformConfigNamedProvider.Finder
-
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static List<ShortCircuitAnalysisProvider>
findAll()
default CompletableFuture<ShortCircuitAnalysisResult>
run(Network network, List<Fault> faults, ShortCircuitParameters parameters, ComputationManager computationManager, List<FaultParameters> faultParameters)
Run an asynchronous single short circuit analysis job.default CompletableFuture<ShortCircuitAnalysisResult>
run(Network network, List<Fault> faults, ShortCircuitParameters parameters, ComputationManager computationManager, List<FaultParameters> faultParameters, Reporter reporter)
Run an asynchronous single short circuit analysis job.-
Methods inherited from interface com.powsybl.commons.config.PlatformConfigNamedProvider
getName, getPlatformConfigName
-
Methods inherited from interface com.powsybl.commons.Versionable
getName, getVersion
-
-
-
-
Method Detail
-
findAll
static List<ShortCircuitAnalysisProvider> findAll()
-
run
default CompletableFuture<ShortCircuitAnalysisResult> run(Network network, List<Fault> faults, ShortCircuitParameters parameters, ComputationManager computationManager, List<FaultParameters> faultParameters)
Run an asynchronous single short circuit analysis job.- Parameters:
faultParameters
- parameters that define the fault about which information will be written after short circuit analysis
-
run
default CompletableFuture<ShortCircuitAnalysisResult> run(Network network, List<Fault> faults, ShortCircuitParameters parameters, ComputationManager computationManager, List<FaultParameters> faultParameters, Reporter reporter)
Run an asynchronous single short circuit analysis job.
-
-