Package com.powsybl.security

Interface SecurityAnalysisProvider

All Superinterfaces:

PlatformConfigNamedProvider, Versionable

All Known Implementing Classes:

DefaultSecurityAnalysisProvider

public interface SecurityAnalysisProvider
extends Versionable, PlatformConfigNamedProvider

A SecurityAnalysisProvider is a power system computation which computes, for a Network, the LimitViolations on N-situation and the ones caused by a specified list of Contingencies.

Computation results are provided asynchronously as a SecurityAnalysisResult.

Implementations of that interface may typically rely on an external tool.

Interceptors might be used to execute client user-specific code on events such as the availability of N-situation results, for example to further customize the results content through Extensions.

Author:

Thomas Adam

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<SecurityAnalysisReport>	run(Network network, String workingVariantId, LimitViolationDetector detector, LimitViolationFilter filter, ComputationManager computationManager, SecurityAnalysisParameters parameters, ContingenciesProvider contingenciesProvider, List<SecurityAnalysisInterceptor> interceptors)	Run an asynchronous single security analysis job.
default CompletableFuture<SecurityAnalysisReport>	run(Network network, String workingVariantId, LimitViolationDetector detector, LimitViolationFilter filter, ComputationManager computationManager, SecurityAnalysisParameters parameters, ContingenciesProvider contingenciesProvider, List<SecurityAnalysisInterceptor> interceptors, List<StateMonitor> monitors)	Run an asynchronous single security 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

run

default CompletableFuture<SecurityAnalysisReport> run(Network network,
                                                      String workingVariantId,
                                                      LimitViolationDetector detector,
                                                      LimitViolationFilter filter,
                                                      ComputationManager computationManager,
                                                      SecurityAnalysisParameters parameters,
                                                      ContingenciesProvider contingenciesProvider,
                                                      List<SecurityAnalysisInterceptor> interceptors)

Run an asynchronous single security analysis job.

if there are exceptions thrown. But the original exception would be wrapped in ComputationException, and those .out/.err log file's contents are be collected in the ComputationException too.

 
 try {
       SecurityAnalysisResult result = securityAnalysis.run(network, variantId, detector, filter, computationManager, parameters, contingenciesProvider, interceptors).join();
   } catch (CompletionException e) {
       if (e.getCause() instanceof ComputationException) {
           ComputationException computationException = (ComputationException) e.getCause();
           System.out.println("Consume exception...");
           computationException.getOutLogs().forEach((name, content) -> {
               System.out.println("-----" + name + "----");
               System.out.println(content);
           });
           computationException.getErrLogs().forEach((name, content) -> {
               System.out.println("-----" + name + "----");
               System.out.println(content);
           });
       }
       throw e;
   }
 

Parameters:

network - IIDM network on which the security analysis will be performed

workingVariantId - network variant ID on which the analysis will be performed

detector -

filter -

computationManager -

parameters - specific security analysis parameters

contingenciesProvider - provides list of contingencies

interceptors -

Returns:

a CompletableFuture on SecurityAnalysisResult that gathers security factor values

run

default CompletableFuture<SecurityAnalysisReport> run(Network network,
                                                      String workingVariantId,
                                                      LimitViolationDetector detector,
                                                      LimitViolationFilter filter,
                                                      ComputationManager computationManager,
                                                      SecurityAnalysisParameters parameters,
                                                      ContingenciesProvider contingenciesProvider,
                                                      List<SecurityAnalysisInterceptor> interceptors,
                                                      List<StateMonitor> monitors)

Run an asynchronous single security analysis job.

if there are exceptions thrown. But the original exception would be wrapped in ComputationException, and those .out/.err log file's contents are be collected in the ComputationException too.

 
 try {
       SecurityAnalysisResult result = securityAnalysis.run(network, variantId, detector, filter, computationManager, parameters, contingenciesProvider, interceptors).join();
   } catch (CompletionException e) {
       if (e.getCause() instanceof ComputationException) {
           ComputationException computationException = (ComputationException) e.getCause();
           System.out.println("Consume exception...");
           computationException.getOutLogs().forEach((name, content) -> {
               System.out.println("-----" + name + "----");
               System.out.println(content);
           });
           computationException.getErrLogs().forEach((name, content) -> {
               System.out.println("-----" + name + "----");
               System.out.println(content);
           });
       }
       throw e;
   }
 

Parameters:

network - IIDM network on which the security analysis will be performed

workingVariantId - network variant ID on which the analysis will be performed

detector -

filter -

computationManager -

parameters - specific security analysis parameters

contingenciesProvider - provides list of contingencies

interceptors -

monitors - stateMonitor that defines the branch bus and threeWindingsTransformer about which informations will be written after security analysis

Returns:

a CompletableFuture on SecurityAnalysisResult that gathers security factor values