Package com.powsybl.loadflow

Interface LoadFlowProvider

All Superinterfaces:

PlatformConfigNamedProvider, Versionable

public interface LoadFlowProvider
extends Versionable, PlatformConfigNamedProvider

SPI for load implementations.

Author:

Geoffroy Jamgotchian

Nested Class Summary

Nested classes/interfaces inherited from interface com.powsybl.commons.config.PlatformConfigNamedProvider

PlatformConfigNamedProvider.Finder

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<LoadFlowResult>	run(Network network, ComputationManager computationManager, String workingVariantId, LoadFlowParameters parameters)	Run a loadflow on variant workingVariantId of network delegating external program execution to computationManager if necessary and using loadflow execution parameters.
default CompletableFuture<LoadFlowResult>	run(Network network, ComputationManager computationManager, String workingVariantId, LoadFlowParameters parameters, Reporter reporter)	Run a loadflow on variant workingVariantId of network delegating external program execution to computationManager if necessary and using loadflow execution parameters.

Methods inherited from interface com.powsybl.commons.config.PlatformConfigNamedProvider

getName, getPlatformConfigName

Methods inherited from interface com.powsybl.commons.Versionable

getName, getVersion

Method Detail

run

default CompletableFuture<LoadFlowResult> run(Network network,
                                              ComputationManager computationManager,
                                              String workingVariantId,
                                              LoadFlowParameters parameters)

Run a loadflow on variant workingVariantId of network delegating external program execution to computationManager if necessary and using loadflow execution parameters. This method is expected to be stateless so that it can be call simultaneously with different arguments (a different network for instance) without any concurrency issue.

Parameters:

network - the network

computationManager - a computation manager to external program execution

workingVariantId - variant id of the network

parameters - load flow execution parameters

Returns:

a CompletableFuture on {@link LoadFlowResult]

run

default CompletableFuture<LoadFlowResult> run(Network network,
                                              ComputationManager computationManager,
                                              String workingVariantId,
                                              LoadFlowParameters parameters,
                                              Reporter reporter)

Run a loadflow on variant workingVariantId of network delegating external program execution to computationManager if necessary and using loadflow execution parameters. This method is expected to be stateless so that it can be call simultaneously with different arguments (a different network for instance) without any concurrency issue.

Parameters:

network - the network

computationManager - a computation manager to external program execution

workingVariantId - variant id of the network

parameters - load flow execution parameters

reporter - the reporter used for functional logs

Returns:

a CompletableFuture on {@link LoadFlowResult]