Migration guide v5.2.0

Breaking changes

XML serialization of network model

TODO

IIDM Adders

TODO

Scalable

We have introduced ScalingParameters to be used in the scale method. The parameters are the scaling convention (generator or load), a boolean that says if we have te reconnect a disconnected injection involves in a scalable, a boolean that says if the power constant must remain constant during scaling and another boolean to precise if the scale or proportional scalable should be iterative or not. If the iterative mode is activated, the residues due to scalable saturation is divided between the other scalable composing the proportional scalable.

Security analysis API

The useless identifiableType from IdentifierContingencyList has been removed totally.

Short-circuit API

New classes should be used to return results after a short circuit analysis depending on the level of detail of the result and the parameters. These classes are MagnitudeFaultResult, which includes MagnitudeFeederResult and MagnitudeShortCircuitBusResult, and FortescueFaultResult, which includes FortescueFeederResult and FortescueShortCircuitBusResult. The MagnitudeFaultResult should be used if the currents and voltages are given as magnitudes on the three phases and the FortescueFaultResult should be used if they are given in detail on each phase.

The parameters have also evolved. The withVoltageMap parameter has been removed from ShortCircuitParameters and FaultParameters. Two new parameters have been added to both the classes:

• withFortescueResult indicates whether the result in the classes FaultResult, FeederResult and ShortCircuitBusResult should be double or FortescueValue (i.e. detailed on each phase). The classes described above should be used to return results depending on this parameter. If it is set to false, then the classes MagnitudeFaultResult, MagnitudeFeederResult and MagnitudeShortCircuitBusResult should be used. Otherwise, use the FortescueFaultResult, FortescueFeederResult and FortescueShortCircuitBusResult classes.
• withVoltageResult indicates if the ShortCircuitResult should include a ShortCircuitBusResult. This class now also includes the initial voltage magnitude and the voltage drop as a percentage of the initial value.

In the FortescueValue class, some attribute names have changed:

• magnitude1 becomes magnitudeA
• magnitude2 becomes magnitudeB
• magnitude3 becomes magnitudeC
• angle1 becomes angleA
• angle2 becomes angleB
• angle3 becomes angleC