Package com.powsybl.loadflow

Interface LoadFlowProvider

All Superinterfaces:

PlatformConfigNamedProvider, Versionable

public interface LoadFlowProvider
extends Versionable, PlatformConfigNamedProvider

Service Provider Interface for loadflow implementations.

A loadflow provider is required to implement the main method run(com.powsybl.iidm.network.Network, com.powsybl.computation.ComputationManager, java.lang.String, com.powsybl.loadflow.LoadFlowParameters), in charge of actually running a loadflow and updating the network variant with computed physical values.

It may, additionally, provide methods to support implementation-specific parameters. Specific parameters should be implemented as an implementation of Extension.

• In order to support JSON serialization for those specific parameters, implementing getSpecificParametersSerializer() is required.
• In order to support loading specific parameters from platform configuration, implementing loadSpecificParameters(PlatformConfig) is required.

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 List<String>	getSpecificParametersNames()	get the list of the specific parameters names.
default Optional<ExtensionJsonSerializer>	getSpecificParametersSerializer()	The serializer for implementation-specific parameters, or Optional.empty() if the implementation does not have any specific parameters, or does not support JSON serialization.
default Optional<Extension<LoadFlowParameters>>	loadSpecificParameters(PlatformConfig config)	Reads implementation-specific parameters from platform config, or return Optional.empty() if the implementation does not have any specific parameters, or does not support loading from config.
default Optional<Extension<LoadFlowParameters>>	loadSpecificParameters(Map<String,String> properties)	Reads implementation-specific parameters from a Map, or return Optional.empty() if the implementation does not have any specific parameters, or does not support loading from config.
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]

getSpecificParametersSerializer

default Optional<ExtensionJsonSerializer> getSpecificParametersSerializer()

The serializer for implementation-specific parameters, or Optional.empty() if the implementation does not have any specific parameters, or does not support JSON serialization.

Note that the actual serializer type should be ExtensionJsonSerializer<LoadFlowParameters, MyParametersExtension> where MyParametersExtension is the specific parameters class.

Returns:

The serializer for implementation-specific parameters.

loadSpecificParameters

default Optional<Extension<LoadFlowParameters>> loadSpecificParameters(PlatformConfig config)

Reads implementation-specific parameters from platform config, or return Optional.empty() if the implementation does not have any specific parameters, or does not support loading from config.

Returns:

The specific parameters read from platform config.

loadSpecificParameters

default Optional<Extension<LoadFlowParameters>> loadSpecificParameters(Map<String,String> properties)

Reads implementation-specific parameters from a Map, or return Optional.empty() if the implementation does not have any specific parameters, or does not support loading from config.

Returns:

The specific parameters read from Map.

getSpecificParametersNames

default List<String> getSpecificParametersNames()

get the list of the specific parameters names.

Returns:

the list of the specific parameters names.