Package com.powsybl.iidm.network

Interface ShuntCompensator

All Superinterfaces:
Connectable<ShuntCompensator>, Extendable<ShuntCompensator>, Identifiable<ShuntCompensator>, Injection<ShuntCompensator>
public interface ShuntCompensator extends Injection<ShuntCompensator>
A shunt compensator.

Characteristics

Attribute Type Unit Required Defaut value Description
Id String - yes - Unique identifier of the shunt compensator
Name String - yes - Human-readable name of the shunt compensator
bPerSection double S yes - The Positive sequence shunt (charging) susceptance per section
MaximumSectionCount integer - yes - The maximum number of sections that may be switched on
CurrentSectionCount integer - yes - The current number of section that may be switched on
RegulatingTerminal Terminal - no The shunt compensator's terminal The terminal used for regulation
TargetV double kV only if VoltageRegulatorOn is set to true - The voltage target
TargetDeadband double kV only if VoltageRegulatorOn is set to true - The deadband used to avoid excessive update of controls
VoltageRegulatorOn boolean - no false The voltage regulating status
To create a shunt compensator, see ShuntCompensatorAdder
Author:
Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
See Also:

  • Method Details

    • getSectionCount

      int getSectionCount()
      Get the count of sections in service. Please note sections can only be sequentially in service i.e. the first sectionCount sections are in service.

      It is expected to be greater than one and lesser than or equal to the maximum section count.

      Depends on the working variant.

      See Also:

    • findSectionCount

      default OptionalInt findSectionCount()
      Get the count of sections in service if it is defined. Otherwise, get an empty optional.

      Depends on the working variant.

      See Also:

    • getMaximumSectionCount

      int getMaximumSectionCount()
      Get the maximum number of sections that can be in service

    • setSectionCount

      ShuntCompensator setSectionCount(int sectionCount)
      Change the count of sections in service. Please note sections can only be sequentially in service i.e. the first sectionCount sections are in service.

      Depends on the working variant.

      Parameters:
      sectionCount - the number of sections wanted to be put in service
      Returns:
      the shunt compensator to chain method calls.
      See Also:

    • unsetSectionCount

      default ShuntCompensator unsetSectionCount()
      Unset the count of sections in service. Note: this can be done only in SCADA validation level.

    • getB

      double getB()
      Get the susceptance (in S) of the shunt in its current state i.e. the sum of the sections' susceptances for all sections in service. Return 0 if no section is in service (disconnected state).
      See Also:

    • getG

      double getG()
      Get the conductance (in S) of the shunt in its current state i.e. the sum of the sections' conductances for all sections in service. If the conductance of a section in service is undefined, it is considered equal to 0. Return 0 if no section is in service (disconnected state).
      See Also:

    • getB

      double getB(int sectionCount)
      Get the susceptance (in S) for a given activated sections count i.e. the sum of the sections' susceptances from 1 to sectionCount. Return O if sectionCount is equal to 0 (disconnected state).
      Parameters:
      sectionCount - count of wanted activated sections. Must be in [0; maximumSectionCount]. Else, throws a ValidationException.

    • getG

      double getG(int sectionCount)
      Get the conductance (in S) for a given activated sections count i.e. the sum of the sections' conductances from 1 to sectionCount. If the conductance of a section is undefined, it is considered equal to 0. Return 0 if sectionCount is equal to 0 (disconnected state).
      Parameters:
      sectionCount - count of wanted activated sections. Must be in [0; maximumSectionCount]. Else, throws a ValidationException.

    • getModelType

      ShuntCompensatorModelType getModelType()
      Get the model type of the shunt compensator (linear or non-linear)

    • getModel

      ShuntCompensatorModel getModel()
      Get the shunt model.

    • getModel

      <M extends ShuntCompensatorModel> M getModel(Class<M> modelType)

    • getRegulatingTerminal

      default Terminal getRegulatingTerminal()
      Get the terminal used for regulation.

    • setRegulatingTerminal

      default ShuntCompensator setRegulatingTerminal(Terminal regulatingTerminal)
      Set the terminal used for regulation. If null is passed as regulating terminal, the regulation is considered local.

    • isVoltageRegulatorOn

      boolean isVoltageRegulatorOn()
      Get the shunt compensator's regulating status.

      Depends on the working variant.

      See Also:

    • setVoltageRegulatorOn

      default ShuntCompensator setVoltageRegulatorOn(boolean voltageRegulatorOn)
      Set the shunt compensator's regulating status.

      Depends on the working variant.

      See Also:

    • getTargetV

      default double getTargetV()
      Get the shunt compensator's voltage target in kV if it exists. Else return NaN.

      Depends on the working variant.

      See Also:

    • setTargetV

      default ShuntCompensator setTargetV(double targetV)
      Set the shunt compensator's voltage target in kV.

      Depends on the working variant.

      See Also:

    • getTargetDeadband

      default double getTargetDeadband()
      Get the shunt compensator's deadband (in kV) used to avoid excessive update of discrete control while regulating. This attribute is necessary only if the shunt compensator is regulating.

      Depends on the working variant.

      See Also:

    • setTargetDeadband

      default ShuntCompensator setTargetDeadband(double targetDeadband)
      Set the shunt compensator's deadband (in kV) used to avoid excessive update of discrete control while regulating. This attribute is necessary only if the shunt compensator is regulating. It must be positive.

      Depends on the working variant.

      See Also:

    • getType

      default IdentifiableType getType()
      Description copied from interface: Identifiable
      Get identifiable type.
      Specified by:
      getType in interface Identifiable<ShuntCompensator>
      Returns:
      the identifiable type