Package com.powsybl.shortcircuit

Class ShortCircuitParameters

java.lang.Object
com.powsybl.commons.extensions.AbstractExtendable<ShortCircuitParameters>
com.powsybl.shortcircuit.ShortCircuitParameters
All Implemented Interfaces:
Extendable<ShortCircuitParameters>
public class ShortCircuitParameters extends AbstractExtendable<ShortCircuitParameters>
Generic parameters for short-circuit computations. May contain extensions for implementation-specific parameters.
Author:
Boubakeur Brahimi

  • Field Details

  • Constructor Details

    • ShortCircuitParameters

      public ShortCircuitParameters()

  • Method Details

    • load

      public static ShortCircuitParameters load()
      Load parameters from platform default config.

    • load

      public static ShortCircuitParameters load(PlatformConfig platformConfig)

    • isWithLimitViolations

      public boolean isWithLimitViolations()
      Whether limit violations should be returned after the calculation. They indicate whether the maximum or minimum allowable current has been reached.

    • setWithLimitViolations

      public ShortCircuitParameters setWithLimitViolations(boolean withLimitViolations)

    • isWithVoltageMap

      @Deprecated(since="5.2.0") public boolean isWithVoltageMap()
      Deprecated.
      Use isWithVoltageResult() instead. Used for backward compatibility.

    • setWithVoltageMap

      @Deprecated(since="5.2.0") public ShortCircuitParameters setWithVoltageMap(boolean withVoltageMap)
      Deprecated.
      Use setWithVoltageResult(boolean) instead. Used for backward compatibility.

    • isWithFortescueResult

      public boolean isWithFortescueResult()
      Whether faultResults, feederResults and shortCircuitBusResults should be detailed for each phase as FortescueValues or if only the three-phase magnitude for currents and voltages should be given.

    • setWithFortescueResult

      public ShortCircuitParameters setWithFortescueResult(boolean withFortescueResult)

    • getStudyType

      public StudyType getStudyType()
      The type of study: transient, sub-transient or steady state.

    • setStudyType

      public ShortCircuitParameters setStudyType(StudyType studyType)

    • isWithFeederResult

      public boolean isWithFeederResult()
      Whether the results should include the currents on each feeder of the fault point.

    • setWithFeederResult

      public ShortCircuitParameters setWithFeederResult(boolean withFeederResult)

    • isWithVoltageResult

      public boolean isWithVoltageResult()
      Whether the results should include the voltages and voltage drops on every bus of the network.

    • setWithVoltageResult

      public ShortCircuitParameters setWithVoltageResult(boolean withVoltageResult)

    • getMinVoltageDropProportionalThreshold

      public double getMinVoltageDropProportionalThreshold()
      The maximum voltage drop threshold in %, to filter the results.

    • setMinVoltageDropProportionalThreshold

      public ShortCircuitParameters setMinVoltageDropProportionalThreshold(double minVoltageDropProportionalThreshold)

    • getSubTransientCoefficient

      public double getSubTransientCoefficient()
      In the case of a sub-transient study, a multiplicative coefficient to obtain the sub-transient reactance of the generators from the transient reactance. By default, X''d = 0.7 * X'd.

    • setSubTransientCoefficient

      public ShortCircuitParameters setSubTransientCoefficient(double subTransientCoefficient)

    • isWithLoads

      public boolean isWithLoads()
      Whether the loads should be taken into account for the computation. If false, the loads P0 and Q0 are considered to be set to 0.

    • setWithLoads

      public ShortCircuitParameters setWithLoads(boolean withLoads)

    • isWithShuntCompensators

      public boolean isWithShuntCompensators()
      Whether the shunt compensators should be taken into account in the computation. If true, the shunt admittance will be used in the admittance matrix. If false, the shunts will be ignored.

    • setWithShuntCompensators

      public ShortCircuitParameters setWithShuntCompensators(boolean withShuntCompensators)

    • isWithVSCConverterStations

      public boolean isWithVSCConverterStations()
      Whether the VSC converter stations should be taken into account in the computation. If true, the VSC converter stations are modeled as equivalent reactances. If false, they are ignored.

    • setWithVSCConverterStations

      public ShortCircuitParameters setWithVSCConverterStations(boolean withVSCConverterStations)

    • isWithNeutralPosition

      public boolean isWithNeutralPosition()
      Defines which step of the tap changer should be used for the computation. If false, the step defined in the network model will be used. If true, the neutral step (rho = 1, alpha = 0) will be used.

    • setWithNeutralPosition

      public ShortCircuitParameters setWithNeutralPosition(boolean withNeutralPosition)

    • getInitialVoltageProfileMode

      public InitialVoltageProfileMode getInitialVoltageProfileMode()
      The initial voltage profile mode, it can be either: - nominal: nominal voltages will be used - configured: the voltage profile is given by the user, voltage ranges and associated coefficients should be given using VoltageRange - previous value: the voltage profile computed from the load flow will be used

    • setInitialVoltageProfileMode

      public ShortCircuitParameters setInitialVoltageProfileMode(InitialVoltageProfileMode initialVoltageProfileMode)

    • getVoltageRanges

      public List<VoltageRange> getVoltageRanges()
      In case of CONFIGURED initial voltage profile, the coefficients to apply to each nominal voltage.
      Returns:
      a list with voltage ranges and associated coefficients

    • setVoltageRanges

      public ShortCircuitParameters setVoltageRanges(List<VoltageRange> voltageRanges)

    • isDetailedReport

      public boolean isDetailedReport()
      A boolean indicating if the functional logs in reportNode should be detailed or aggregated.

    • setDetailedReport

      public ShortCircuitParameters setDetailedReport(boolean detailedReport)

    • validate

      public void validate()
      Validates the ShortCircuitParameters. If the initial voltage profile mode is set to CONFIGURED, then the voltage ranges should not be empty.