All Classes and Interfaces
Class
Description
Provides some utility functions for implementations :
AbstractAmplNetworkUpdater.busConnection(com.powsybl.iidm.network.Terminal, int, com.powsybl.commons.util.StringToIntMapper<com.powsybl.ampl.converter.AmplSubset>)
AbstractAmplNetworkUpdater.getThreeWindingsTransformerLeg(com.powsybl.iidm.network.ThreeWindingsTransformer, java.lang.String)
AbstractAmplNetworkUpdater.getThreeWindingsTransformer(com.powsybl.iidm.network.Network, java.lang.String)
Provides implementations for aggregation methods of
LimitViolationDetector.AbstractEquipmentCriterionContingencyListDeserializer<T extends AbstractEquipmentCriterionContingencyList>
Provides some default method implementations for
ExecutionHandlers implementations.A base class for implementations of
ExtensionAdder that holds the
extendable to be able build and then add the extension to the extendable.Abstract class responsible for computing reduced limits using a list of
LimitReduction.Interface for objects allowing to retrieve limits (of generic type
AbstractLimitReductionsApplier.OriginalLimitsGetter) from an object
manageable by the LimitsComputer (of generic type AbstractLimitReductionsApplier.OriginalLimitsGetter).Abstract class responsible for computing limits (potentially altered from the ones declared on
the network element).
This class is responsible for generating an object (of generic type
AbstractLimitsReducer) containing the reduced limits
from the original limits and the reduction coefficients to apply for the permanent and each of the temporary limits.Interface for objects generating an
AbstractLimitsReducer object
configured for a network element, with its original limits of generic type AbstractLimitsReducerCreator.Provides implementations for aggregation methods of
LimitViolationDetector.An action to:
change the P0 of a load or a dangling line , either by specifying a new absolute value (MW) or a relative change (MW).
change the Q0 of a load or a dangling line, either by specifying a new absolute value (MVar) or a relative change (MVar).
Provides implementation for most methods of
ModuleConfig,
based on a single "mapping" method to be implemented {@link this#getValue(String)}.Abstract class for matrix that provides an implementation for common methods.
Provides implementation for methods of
ModuleConfig.Deprecated.
Abstract classes for
NetworkElementCriterion implementations.Abstract class for
NetworkElementCriterion implementations' deserializers.Abstract classes for
NetworkElementCriterion implementations corresponding to real network elements.Abstract extension for Voltage and Current Extensions
Simple abstract implementation of
LoadingLimits not linked to a network element, used to provide
reduced limits without altering the real limits of the network element.Simple
NetworkModification for elements that needs to modify
their voltage and reactive setpoints.An action modifying the regulation of a two or three windings transformer
AbstractTapChangerRegulationActionBuilderDeserializer<T extends AbstractTapChangerRegulationActionBuilder>
An action modifying the tap position of a two or three windings transformer
AbstractTapChangerTapPositionActionBuilderDeserializer<T extends AbstractTapChangerTapPositionActionBuilder>
Super class for criteria used to filter temporary limits.
Tree data export of an IIDM model.
An action is taken according to an operator strategy when a condition occurs.
Users may define their own handling of action DSL objects,
by implementing this interface and calling
ActionDslLoader.loadDsl(groovy.lang.Binding, com.powsybl.iidm.network.Network, com.powsybl.action.ial.dsl.ActionDslHandler, com.powsybl.action.ial.dsl.ActionDslLoaderObserver) method.A container for a list of actions.
Criterion used to filter all temporary limits regardless of their acceptable duration.
Deserializer for
AllTemporaryDurationCriterion objects.Serializer for
AllTemporaryDurationCriterion objects.simulate the associated action if there is all violation on any of those network elements
Specialization of CSV table formatter for AMPL .dat file generation.
3 differences:
- separator is white space
- comments are allowed and start with # (header is also a comment)
- strings are quoted because of the white space separator
An additional file provided to an Ampl run.
Interface to represent an Ampl model to run on a network.
This executionHandler will run an ampl model on a network.
Interface to modify a network after an Ampl solve.
AmplNetworkReader does the Ampl output parsing,
and AmplNetworkUpdater modifies the Network.Factory pattern to create
AmplNetworkUpdater.An additional file to read as output of an Ampl run.
Parameters to interface extension to the defaults Ampl model files needed.
This enum maps elements to their reading function in
AmplNetworkReaderBasic class for Ampl solve information.
simulate the associated action as soon there is any violation
Exports a short circuit analysis result as an ASCII formatted table.
Criterion checking that at least one side of a network element belongs to a country defined in a list.
Criterion checking that one of the nominal voltages of the network element, on whichever side,
is inside a
VoltageInterval.simulate the associated action if there is a violation on any of those network elements
On creation, tries to guess the balancing method used by the computation, from the differences between
the computed power outputs and initial target power.
Simplified command model for completion script generation.
Simplified option model for completion script generation.
Legacy exporter that must be retrocompatible,
and only fixes should be made on this class.
A battery system.
To create a battery, from a
VoltageLevel instance call
the VoltageLevel.newBattery() method to get a battery builder
instance.Simple
NetworkModification for a battery.Binary export of an IIDM model.
Binary import of an IIDM model.
An equipment with two terminals.
Class to describe the characteristics of the fault to be simulated.
provide electrical information on a branch after a security analysis.
This deserializer is only kept for backward compatibility, to be able to still read an old IIDM serialized file
containing the branch status extension.
A bus is a set of equipments connected together through a closed switch.
A busbar section, a non impedant element used in a node/breaker substation
topology to connect equipments.
Position information about the BusbarSection
within the corresponding busbar (
BusbarSectionPosition.getSectionIndex())
relative to other busbars of the voltage level (BusbarSectionPosition.getBusbarIndex())
Class to describe the characteristics of the fault to be simulated.
provide electrical information on a bus after a security analysis.
A computation carried out on a network, which result
may be validated through the validation tool.
Provides access to the list of known candidate computations.
Interface for CGMES post-processor plugins.
Interface for CGMES pre-processor plugins.
In each CGMES instance file there is a unique
Model object that holds metadata information.In each CGMES instance file there is a unique
Model object that holds metadata information.The classic powsybl PlatformConfig provider.
Thread pool executors that can execute cleaning tasks each time a thread go back to the pool.
A command represents a set of instructions to be executed.
A command execution essentially defines how a
Command should be executed.A
CompletableFuture which embeds an actual task, unlike the default implementation.A set of connected bus in the network.
RLE (Run-Length encoding) compressed double data chunk.
RLE (Run-Length encoding) compressed string data chunk.
A special exception containing information about an error that occurred during
an externally executed computation.
Used to ease the creation of a
ComputationException.Computation managers have the ability to execute commands provided through an
ExecutionHandler.Computation manager factories are in charge of creating instances of
ComputationManager.describes when an action is taken
A conditional action is a link between a
Condition and a list of actions through ids.An equipment that is part of a substation topology.
This class gives some information for visualization tools, for a given connectable:
its position relative to other equipments in its voltage level(s),
its direction relative to the corresponding busbar section(s) (top or bottom - as the busbar section is usually displayed horizontally - or undefined),
its display name(s).
This gives visualization tools suggestions for displaying the equipments within a voltage level.
This method cuts an existing line in two lines that will be created and connected to an existing voltage level
(also called switching voltage level).
A utility class that create IIDM containers, i.e voltage levels and substations from a bus branch model with respect
to IIDM container requirements.
A factory which creates preprocessors that read contingencies according to a
ContingenciesProviderFactoryTwoWindingsTransformer Interpretation
Countries alpha-2 code.
This class allows to add a new branch's feeders on existing busbar sections.
Adds a coupling device between two busbar sections.
This method adds a new injection bay on an existing busbar section.
Connect an existing voltage level (in practice a voltage level where we have some loads or generations) to an
existing line through a tee point.
A CGMES pre-processor that defines missing containers in input data.
Creates symmetrical matrix topology in a given voltage level,
containing a given number of busbar with a given number of sections each.
See
See
CreateVoltageLevelTopologyBuilder.the purpose of these class is to filter contingencies in a criterion contingency list
currently all criterion contingency lists have a criterion on countries, one on nominal voltage,
one on properties and one on regex.
Exports a short circuit analysis result in CSV format.
Current limits are defined by:
A permanent limit (A)
Any number of temporary limits.
A dangling line to model boundaries (X nodes).
An action to:
change the P0 of a load, either by specifying a new absolute value (MW) or a relative change (MW).
change the Q0 of a load, either by specifying a new absolute value (MVar) or a relative change (MVar).
NetworkElementCriterion on dangling lines.Deserializer for
DanglingLineCriterion objects.An observer to be notified when a stream is opened or closed.
Study case loader that is able to connect to PowerFactory DB using C++ API.
This class implements the default behavior of applying changes to the network.
This class provides a default empty implementation for the
DataSourceObserver interface.Implementation of
AbstractLimitReductionsApplier working with Identifiable.AbstractLimitsReducer implementation responsible for computing reduced limits of type LoadingLimits.Implements the default behaviour for limit violation detection.
Default naming strategy used if no other naming strategy is specified.
A
NamingStrategy implementation that ensures the conformity of IDs with the UCTE-DEF formatAdapter to have a
NetworkElement from an Identifiable object.A default implementation of
NetworkPredicate that keeps everything.Default implementation of the SecurityAnalysisInterceptor interface.
Dense matrix implementation based on an array of
rowCount * columnCount double values.Dense matrix factory.
A measurement with a discrete value (string, boolean or int) such as: tap position, switch position and so on.
If it is the modelization of a tap position (or any discrete measurement on a tap changer),
can explicit which tap changer of the transformer it is applied on.
Specify what is measured.
Explicit what type of discrete value is used for this measurement (boolean, int or string).
Measurements with discrete values associated with an equipment (the extended equipment).
Execute a security analysis by spawning a specified number of subtasks, each of which
will consist to a separate call to itools security-analysis through the specified
ComputationManager.A configuration loader interface for the DynamicSimulationParameters
extensions loaded from the platform configuration
The energy source of a generator.
A
ModuleConfig designed to read property values
from the map of environment variables.A
ModuleConfigRepository designed to read property values
from the map of environment variables.Criterion used to filter temporary limits which acceptable durations are equal to a given value (in seconds).
Deserializer for
EqualityTemporaryDurationCriterion objects.Serializer for
EqualityTemporaryDurationCriterion objects.Use
AbstractEquipmentTopologyVisitor insteadEuropean Low Voltage Test Feeder.
This is a network test based on Eurostag tutorial example 1.
Defines the execution environment for commands to be executed:
a map of environment variables
a prefix for the execution working directory
a debug indicator
Base interface for processing to be executed through a
ComputationManager.Exponential load model.
This is the base class for all IIDM exporters.
A utility class to work with IIDM exporters.
Extension data for extendables.
An ExtensionAdder is a builder for an extension that is built and then added
to an extendable.
ExtensionAdderProvider<T extends Extendable<T>,E extends Extension<T>,B extends ExtensionAdder<T,E>>
A provider used through java's
ServiceLoader.A utility class to help finding providers using ServiceLoader.
Loads an extension from platform configuration.
An
ExtensionProvider able to serialize/deserialize extensions from JSON.An ExtensionProvider able to serialize/deserialize extensions from XML.
Interface to describe the characteristics of the fault to be simulated.
Results for one fault computation with currents and voltage on the three phases.
The aim of this class is to store the magnitude and angle of current or voltage on the three phases, and
the magnitude and angle of current or voltage for the Fortescue positive, zero and negative components.
Forwards the execution of a security analysis to another itools process.
Forwards calls to a given output stream.
This test network is constituted of four substations, with five voltage levels.
This test network is constituted the same as the one in FourSubstationsNodeBreakerFactory.
A power generator.
An action to:
change the targetP of a generator, either by specifying a new absolute value (MW) or a relative change (MW).
enable or disable the generator voltage control.
change targetQ of a generator (MVar).
To create a generator, from a
VoltageLevel instance call
the VoltageLevel.newGenerator() method to get a generator builder
instance.Example to generate a svg from the dot file:
sfdp -Goverlap=prism -Tsvg -o /tmp/a.svg /tmp/a.dot
A
ContingenciesProvider which provides same contingencies definition syntax as
GroovyDslContingenciesProvider,
but allows to use more complete action-dsl scripts as is for standard security analysis.Commands to be executed sequentially on a single computation node.
An action to modify HVDC parameters and/or operating mode.
Active power control mode based on an offset in MW and a droop in MW/degree
ActivePowerSetpoint = p0 + droop * (angle1 - angle2)
HVDC converter station.
HDVC type: VSC or LCC
HVDC converter station builder and adder.
A HVDC line connected to two HVDC converters on DC side.
Converters mode used to known the sign of the active power of the HVDC line.
HVDC line builder and adder.
There would be three types of id:
1. id of equipment:
2. id of a configured bus itself:
3. id of branch, in this case, side is required
An object that is part of the network model and that is identified uniquely
by a
String id.NetworkElementCriterion on identifiables of a network.Deserializer for
IdentifiableCriterion objects.0 - Transmission line
1 - Fixed tap
2 - Variable tap for voltage control (TCUL, LTC)
3 - Variable tap (turns ratio) for MVAR control
4 - Variable phase angle for MW control (phase shifter)
0 - Unregulated (load, PQ)
1 - Hold MVAR generation within voltage limits, (PQ)
2 - Hold voltage within VAR limits (gen, PV)
3 - Hold voltage and angle (swing, V-Theta) (must always have one)
Generic configuration for network importing.
This is the base class for all IIDM importers.
A utility class to work with IIDM importers.
A equipment with one terminal.
Command input file.
Criterion used to filter temporary limits which acceptable durations are inside a given interval (in seconds).
Deserializer for
IntervalTemporaryDurationCriterion objects.Serializer for
IntervalTemporaryDurationCriterion objects.Provides methods to read and write DynamicSimulationParameters from and to JSON.
JsonDynamicSimulationParameters.ExtensionSerializer<E extends Extension<DynamicSimulationParameters>>
A configuration loader interface for the DynamicSimulationParameters extensions loaded from the platform configuration
JSON export of an IIDM model.
Provides methods to read and write LoadFlowParameters from and to JSON.
Provides methods to read and write SecurityAnalysisParameters from and to JSON.
A SecurityAnalysisResultExporter implementation which export the result in JSON
Exports a short circuit analysis result in JSON format.
A configuration loader interface for the
JsonShortCircuitParameters extensions loaded from the platform configurationCalled by variants of
JsonUtil.parseObject(com.fasterxml.jackson.core.JsonParser, com.powsybl.commons.json.JsonUtil.FieldHandler) on each encountered field.Based on a list of (value, target, coeff), computes the balancing ratio k such that
LCC converter station.
LCC converter station builder and adder.
Harmonic filter.
Interface for limit duration criteria (both permanent and temporary)
Jackson module for serialization/deserialization of
LimitDurationCriterion.Utility class for serialization/deserialization of
LimitDurationCriterion objects.This class represents a reduction that should be applied to operational limits of a certain type.
Builder used to create a
LimitReduction.Contains the list of the applied limit reductions.
Interface for classes responsible for accessing limits of generic type
LimitsComputer
from a network element of generic type LimitsComputer, and potentially creating a modified copy of them.An implementation of
LimitsComputer only retrieving the limits without applying modifications.Class corresponding to the result of the
LimitsComputer computation.A generic representation of a violation of a network equipment security limit.
A builder class for
LimitViolations.Being given some physical values (currents, voltages, ...) for network elements,
is in charge of deciding whether there are limit violations or not.
Utility methods for
LimitViolations, in particular to ease their building and comparison.Helper methods for checking the occurrence of overloads.
An AC line.
To create a new AC line, from a
Network instance call the
Network.newLine() method to get a line builder instance.NetworkElementCriterion on lines.Deserializer for
LineCriterion objects.A constant power load (fixed p0 and q0).
An action to:
change the P0 of a load, either by specifying a new absolute value (MW) or a relative change (MW).
change the Q0 of a load, either by specifying a new absolute value (MVar) or a relative change (MVar).
To create a load, from a
VoltageLevel instance call
the VoltageLevel.newLoad() method to get a load builder
instance.This class is used as an extension of a "classical" balanced direct load
we store here the deltas of power that will build the unblalanced loads.
LoadFlow main API.
A loadflow runner is responsible for providing convenient methods on top of
LoadFlowProvider:
several variants of synchronous and asynchronous run with default parameters.Load flow as a computation candidate for validation.
Parameters for loadflow computation.
BalanceType enum describes the various options for active power slack distribution
Service Provider Interface for loadflow implementations.
Loadflow result API.
Result for one component
Component calculation status
Result for one slack bus
Load Flow global calculation status, derived from all
LoadFlowResult.ComponentResult, using
LoadFlowResult.ComponentResult.Status, but excluding non-calculated component i.e. excluding
components having status NO_CALCULATIONTemporary current limit.
Interface for objects used to report the performed operation on limits when fixed by
LoadingLimitsUtil.fixMissingPermanentLimit(LoadingLimitsAdder, double, String, LimitFixLogger).Permanently or temporarily admissible limit violations,
as defined in the ENTSO-E operation handbook.
p = p0 * (a1 * (v / v0)^2 + a2 * v / v0 + a3)
q = q0 * (a4 * (v / v0)^2 + a5 * v / v0 + a6)
LU decomposition utility class.
Results for one fault computation with current magnitude.
A
ModuleConfig backed by a simple key/value Map.Interface for all double typed matrix implementation.
An element of the matrix.
Handler used to iterate a matrix and get values.
Interface for matrix factory.
Branch data
Bus data
bus type (1 = PQ, 2 = PV, 3 = ref, 4 = isolated)
A measurement with a continuous numeric value (double) such as: angle, voltage, active power and so on.
Specify what is measured.
Measurements with continuous numeric values associated with an equipment (the extended equipment).
Generator data
Generator reactive limits that does not depend of the active
power.An action consisting in an ordered list of actions.
Multi-thread
ReportNodeContext's implementation.An interface implemented by network objects that have attributes depending on
the variant.
The naming strategy aims at clarifying and facilitating the naming of the different network elements created via the
different
NetworkModification classes.A power network model.
A global bus/breaker view of the network.
A global bus view of the network.
Just being able to name method create et not createNetwork.
Interface that should implement objects representing network elements in order for them to be processable by
the
NetworkElementCriterion inheriting criterion classes.Interface for criterion classes used to filter network elements (represented as
NetworkElement objects).Jackson module for serialization/deserialization of
NetworkElementCriterion.Utility class for serialization/deserialization of
NetworkElementCriterion objects.Serializer for
AbstractNetworkElementEquipmentCriterion objects (the real class is used as T parameter).NetworkElementCriterion on network element identifiers.Deserializer for
NetworkElementIdListCriterion objects.Serializer for
NetworkElementIdListCriterion objects.Visitor used to detect if a given
NetworkElement validates criteria.Warning : a NetworkReducer must not be considered reusable nor thread-safe.
Provides information about the state of some elements of the network, either:
- on N state
- on post-contingency states
- on post-corrective actions states
A network variant, simply embeds a
Network and the ID of one of its variants.Provides higher level methods to manipulate node-breaker topology graph.
A NodeCalc is an element of the timeseries computation tree.
A NodeCalcVisitor controls the traversal and performs a computation on
NodeCalc trees.This utility class implements the core iterative algorithm to perform
a post-order
NodeCalc tree traversal using a
NodeCalcVisitor.Quality information.
An output stream wrapper that allows notification when the stream is opened
and closed.
An extension to describe the operating status of an equipment.
Describes a strategy that an operator would apply to solve violations occurring after a contingency.
A container for a list of strategies.
An operator strategy could contain several conditional actions (also called stages).
Tries to guess option argument type, to guide autocompletion.
Command output file.
Simple POJO to define some properties of files read after an Ampl solve
A simple, default implementation of
Overload.An overload management system.
OverloadManagementSystemAdder.TrippingAdder<I extends OverloadManagementSystemAdder.TrippingAdder<I>>
Runs a load flow action simulator through calls to itools action-simulator command,
submitted to the computation manager.
To override programmatic default value.
Criterion used to filter permanent limits.
Deserializer for
PermanentDurationCriterion objects.Serializer for
PermanentDurationCriterion objects.Generic parameters for short-circuit computations.
A very small network to test phase shifters.
A phase tap changer that is associated to a transformer to control the phase.
Interface for classes responsible for building a single step when using
PhaseTapChangerAdder.An action modifying the regulation of a phase-shifting transformer
Interface for classes responsible for building a single step.
Interface for classes responsible for building a single step when using
PhaseTapChangerStepsReplacer.An action changing the tap position of a phase-shifting transformer.
A provider that can be loaded by by Java's ServiceLoader based on its name
present in an entry in the PlatformConfig.
A utility class to find providers in the
PlatformConfig by their
names configured in standard fields. the find* methods use the standard
fields while the find*BackwardsCompatible methods also look in the legacy
fields.Provides the default PlatformConfig returned by
PlatformConfig.defaultConfig().Environment variables substitution
PSSE RAW data common to all versions
Should be able to read the case identification to obtain the version (case identification "rev" attribute)
PSSE RAWX data common to all versions
Should be able to read the case identification to obtain the version (case identification "rev" attribute)
Scalable that divides scale proportionally between multiple scalable.
A ratio tap changer that is associated to a transformer to control the voltage or reactive power.
Interface for classes responsible for building a single step when using
RatioTapChangerAdder.An action activating or deactivating the regulation of a ratio transformer
Interface for classes responsible for building a single step.
Interface for classes responsible for building a single step when using
RatioTapChangerStepsReplacer.An action modifying the tap position of a ratio transformer
A reactive capability curve to define reactive limits of a
Generator
or Battery that depends of the active power.A point of the reactive capability curve, for a given active power the
minimal and the maximal value for the reactive power.
Base class for
Generator reactive limits.Simple implementation of
ActivePowerLimits not linked to a network element, used to provide
reduced active power limits without altering the real ones of the network element.Simple implementation of
ApparentPowerLimits not linked to a network element, used to provide
reduced apparent power limits without altering the real ones of the network element.Simple implementation of
CurrentLimits not linked to a network element, used to provide
reduced current limits without altering the real ones of the network element.ReferencePriorities iIDM extension allows specifying priorities among network equipments terminals for the selection
of a reference bus, for example the angle reference in the context of a load flow.
The extension is attached to a
A priority level can be defined, as an integer, for each Terminal of the connectable.
A priority 0 means should not be used. 1 is highest priority for selection. 2 is second highest priority, etc ...
The extension is attached to a
Connectable, i.e. any equipment with Terminals.A priority level can be defined, as an integer, for each Terminal of the connectable.
A priority 0 means should not be used. 1 is highest priority for selection. 2 is second highest priority, etc ...
ReferencePriority iIDM extension allow to specify priority for a Terminal.
ReferenceTerminals iIDM extension allows storing the angle references that were chosen by a load flow, for
example (but not necessarily) chosen using
There should be one reference terminal per SynchronousComponent calculated.
ReferencePriorities inputs.There should be one reference terminal per SynchronousComponent calculated.
This modification removes the whole feeder bay related to a given feeder connectable.
This method transform the action done in the CreateLineOnLine class into the action done in the ConnectVoltageLevelOnLine class :
it replaces 3 existing lines (with the same voltage level at one of their side (tee point)) with two new lines,
and removes the tee point
A
ReportNode allows building up functional reports with a tree hierarchy.An adder to create a
ReportNode object.A builder to create a
ReportNode object.An adder to create a
ReportNode object as a child of given ReportNode parent.An in-memory implementation of
ReportNode.A default no-op implementation
An adder to create a
ReportNode object as a child of given ReportRoot parent.This method reverses the action done in the ConnectVoltageLevelOnLine class :
it replaces 2 existing lines (with the same voltage level at one of their side) with a new line,
and eventually removes the voltage level in common (switching voltage level), if it contains no equipments anymore, except bus or bus bar section
This method reverses the action done in the
Before modification:
CreateLineOnLine class :
it replaces 3 existing lines (with the same voltage level at one of their side) with a new line,
and eventually removes the existing voltage levels (tee point and tapped voltage level), if they contain no equipments
anymore, except bus or bus bar section Before modification:
TODO: I think having state ID here is broken, as security analysis contract does not guarantee that
the corresponding state will be filled with N results
Sign convention usable for scaling.
Security analysis main API.
A security analysis runner is responsible for providing convenient methods on top of
SecurityAnalysisProvider:
several variants of synchronous and asynchronous run with default parameters.Utility class to programmatically generate an itools security-analysis command with its various options.
Configuration for a
SecurityAnalysis.Represents a security analysis to be executed on inputs typically provided as files and
text-formatted options.
Helper class to build a
SecurityAnalysisExecution,
based on specified options, in particular distribution options.Base implementation for
ExecutionHandlers which may execute one or multiple itools security-analysis command(s).Factory methods for security analysis execution handlers.
A local execution of a security analysis.
Arguments for a
SecurityAnalysisExecution :
a Network and the variant to be considered
some SecurityAnalysisParameters
a set of requested result extensions
the set of violation types to be considered
an optional ByteSource which describes contingencies
Input data/configuration for a
SecurityAnalysis computation.In charge of transforming an execution input to an actual
security analysis input.
Security analysis interceptors are notified at various steps of the construction of
the
SecurityAnalysisResult, for instance when adding new limit violations.Parameters for security analysis computation.
A preprocessor which may be called before the execution of a security analysis,
in order to customize its
SecurityAnalysisInput, in particular
contingencies and limit violations detection.In charge of building instances of
SecurityAnalysisPreprocessor based on an arbitrary
configuration provided as a source of bytes.Provides instances of
SecurityAnalysisPreprocessors or factories.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.Facilitates the creation of security analysis results.
A context associated with a part of the result of a security analysis.
A utility class to work with security analysis result exporters
Observer which executes a list of handlers of
SecurityAnalysisResult once the simulation is finished.Sensitivity analysis main API.
A sensitivity analysis runner is responsible for providing convenient methods on top of
SensitivityAnalysisProvider:
several variants of synchronous and asynchronous run with default parameters.Parameters for sensitivity analysis.
Json deserializer for sensitivity analysis parameters
Json serializer for sensitivity analysis parameters
Sensitivity analysis provider
Sensitivity analysis result
Sensitivity factor to be computed in the sensitivity analysis.
Supported function types related to the equipment to monitor.
Elementary result value of a sensitivity analysis, given the sensitivity factor and a contingency id (use null to get
a pre-contingency value).
Models a group of variables.
A variable represents a change on a equipment or on a group of equipments.
A thread safe service loader.
API for elementary short-circuit computations.
Computation results are provided asynchronously as a
ShortCircuitAnalysisResult.Results of localized short-circuit computations.
Implementations provide a method to write down the content of a
ShortCircuitAnalysisResult.Provides easy access to known implementations of result "exporters"
Input data/configuration for a
ShortCircuitAnalysis computation.Generic parameters for short-circuit computations.
A shunt compensator.
To create a shunt compensator, from a
VoltageLevel instance call
the VoltageLevel.newShuntCompensator() method to get a shunt compensator builder
instance.Simple
NetworkModification to (dis)connect a shunt compensator and/or change its section.A single command to be executed, defined by its program name and a list of arguments.
Simple mono-thread ReportNodeContext's implementation.
Sparse matrix implementation in CSC format.
Sparse matrix factory.
Sparse matrix serializer/deserializer using the MATLAB binary format.
A
ModuleConfigRepository backed by a list of modules repositories.Static VAR compensator model.
An action to:
change the regulationMode of a static var compensator, three options are available VOLTAGE, REACTIVE_POWER or OFF
change voltageSetPoint to change the voltage setpoint if the regulation mode is set to VOLTAGE (kV)
change reactivePowerSetpoint to change the reactive power setpoint if the regulation mode is set to REACTIVE_POWER (MVAR)
Simple
NetworkModification for a static var compensator.Generator based on stringtemplate lib
A contingencies provider which provides a subset of another provider,
defined by a
Partition.A contingencies provider which provides a subset of another provider,
defined by a
Partition.A network reducer predicate that allow reduction based on a center voltage level and all other voltage level neighbors
within a specified depth.
A substation is a collection of equipments located at a the same geographical
site.
To create a substation, from a
Network instance call
the Network.newSubstation() method to get a substation builder
instance.CGMES standard:
A PowerTransformer is contained in one Substation, but it can connect a Terminal to another different Substation
A Switch can connect to different voltageLevels
A PowerTransformer is contained in one Substation, but it can connect a Terminal to another different Substation
A Switch can connect to different voltageLevels
Utility class to compute the state variables on one side of a branch, knowing
the state variables on the other side.
A very small network to test SVC modeling. 2 buses B1 and B2.
A switch to connect equipments in a substation.
An action opening or closing a switch.
Utility class to compute the flow of the switches associated to a voltageLevel
The kind of switch.
TapChanger<C extends TapChanger<C,S,R,A>,S extends TapChangerStep<S>,R extends TapChangerStepsReplacer<R,A>,A extends TapChangerStepAdder<A,R>>
TapChangerAdder<S extends TapChangerAdder<S,D,A,B,R,C>,D extends TapChangerStep<D>,A extends TapChangerStepAdder<A,S>,B extends TapChangerStepAdder<B,R>,R extends TapChangerStepsReplacer<R,B>,C extends TapChanger<C,D,R,B>>
Generic adder interface of the tap changer.
TapChangerTypes
Set of methods to build a new step for a tap changer.
Contains methods to build and replace the list of steps of an existing tap changer.
TBooleanArrayList implement (not provided by trove4j) based on TByteArrayList.
An equipment connection point in a substation topology.
A bus/breaker view of the terminal.
A bus view of the terminal.
A node/breaker view of the terminal.
Topology traversal handler
A class which allows to find the best terminal, according to given comparator or list of predicate, among several
terminals.
An action of opening or closing an equipment terminal(s).
Use
AbstractTerminalTopologyVisitor insteadProvides a PlatformConfig reading config from the classpath only.
A Three Windings Power Transformer.
Transformer leg
ThreeWindingsTransformer Cgmes Conversion
NetworkElementCriterion on three windings transformers.Deserializer for
ThreeWindingsTransformerCriterion objects.provide electrical information on a three windings transformer
after a security analysis. it belongs to pre and post Contingency results.
Indicate for a state estimation which tap changers are to be estimated (i.e. their tap positions should be outputs).
A tie line is an AC line sharing power between two neighbouring regional grids.
NetworkElementCriterion on tie-lines.Deserializer for
TieLineCriterion objects.Utility class to load time series into a table and then:
Get direct access to all values
Compute statistics like mean, standard deviation, and Pearson product-moment correlation coefficient
Convert to CSV
Some design considerations and limitations:
Number of version loadable in the table has to be specified at creation
Versions have to contiguous
Once first batch of time series has been loaded, new time series cannot be added but data of existing one can be updated
Concurrent load (i.e multi-thread) of data is supported (using same time series list)
Concurrency between data loading and other operations (CSV writing, statistics computation) is NOT supported
Wrapper around
CommandLine to provide a more user friendly syntax,
in particular based on Optionals.The kind of topology.
The level of topology.
Tries to validate that transformers regulating voltage have been correclty simulated.
Result of graph traversal step, used to decide whether to pursue or not current traversal.
A Triplestore database.
Factory for the creation of Triplestore databases.
A factory service that allows creation of Triplestore databases.
always simulate the associated action
A two windings power transformer.
TwoWindingsTransformer Cgmes Conversion
NetworkElementCriterion on two windings transformers.Deserializer for
TwoWindingsTransformerCriterion objects.Indicate for a state estimation which tap changers are to be estimated (i.e. their tap positions should be outputs).
A class associating a value with a type.
Node status.
Node type code.
Power plant type.
A
OutputStream wrapper that do not close underlying OutputStream but call
OutputStream.flush() instead.An undirected graph implementation.
This class provides methods to manage variants of the network (create and
remove a variant, set the working variant, etc).
Extension to handle pre-contingency voltage value for a voltage limit violation
Deserializer for
VoltageInterval objects.Serializer for
VoltageInterval objects.A voltage level is a collection of equipments located in the same substation
and at the same base voltage.
A bus/breaker view of the topology.
A bus view of the substation topology.
A node/breaker view of the topology.
A class that stores coefficients and nominal voltages to be applied to each nominal voltage of the network in a range.
VSC converter station.
VSC converter station builder and adder.
Simple
NetworkModification for a VSC converter station.Associates a classical sensitivity variable and a weight.
XML export of an IIDM model.
Deprecated.
Use
ZipPackager instead.ZIP (polynomial) load model.
AbstractMultiVariantIdentifiableExtensioninstead.