CIM14/ENTSOE/Equipment/Wires/ShuntCompensator.py

   1 # Copyright (C) 2010-2011 Richard Lincoln
   2 #
   3 # Permission is hereby granted, free of charge, to any person obtaining a copy
   4 # of this software and associated documentation files (the "Software"), to
   5 # deal in the Software without restriction, including without limitation the
   6 # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   7 # sell copies of the Software, and to permit persons to whom the Software is
   8 # furnished to do so, subject to the following conditions:
   9 #
  10 # The above copyright notice and this permission notice shall be included in
  11 # all copies or substantial portions of the Software.
  12 #
  13 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  18 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  19 # IN THE SOFTWARE.
  20
  21 from CIM14.ENTSOE.Equipment.Wires.RegulatingCondEq import RegulatingCondEq
  22
  23 class ShuntCompensator(RegulatingCondEq):
  24     """A shunt capacitor or reactor or switchable bank of shunt capacitors or reactors. A section of a shunt compensator is an individual capacitor or reactor.  A negative value for reactivePerSection indicates that the compensator is a reactor. ShuntCompensator is a single terminal device.  Ground is implied.-  [R9.3] is satisfied by navigation to ConnectivityNode and Substation -  If the reactivePerSection attribute is positive, the Compensator is a capacitor.  If the value is negative, the Compensator is a reactor. -  Attributes b0PerSection and g0PerSection are not required.
  25     """
  26
  27     def __init__(self, g0PerSection=0.0, bPerSection=0.0, nomU=0.0, gPerSection=0.0, normalSections=0, b0PerSection=0.0, maximumSections=0, *args, **kw_args):
  28         """Initialises a new 'ShuntCompensator' instance.
  29
  30         @param g0PerSection: Zero sequence shunt (charging) conductance per section
  31         @param bPerSection: Positive sequence shunt (charging) susceptance per section
  32         @param nomU: The nominal voltage at which the nominal reactive power was measured. This should normally be within 10% of the voltage at which the capacitor is connected to the network.
  33         @param gPerSection: Positive sequence shunt (charging) conductance per section
  34         @param normalSections: For a capacitor bank, the normal number of sections switched in. This number should correspond to the nominal reactive power (nomQ).
  35         @param b0PerSection: Zero sequence shunt (charging) susceptance per section
  36         @param maximumSections: For a capacitor bank, the maximum number of sections that may be switched in.
  37         """
  38         #: Zero sequence shunt (charging) conductance per section
  39         self.g0PerSection = g0PerSection
  40
  41         #: Positive sequence shunt (charging) susceptance per section
  42         self.bPerSection = bPerSection
  43
  44         #: The nominal voltage at which the nominal reactive power was measured. This should normally be within 10% of the voltage at which the capacitor is connected to the network.
  45         self.nomU = nomU
  46
  47         #: Positive sequence shunt (charging) conductance per section
  48         self.gPerSection = gPerSection
  49
  50         #: For a capacitor bank, the normal number of sections switched in. This number should correspond to the nominal reactive power (nomQ).
  51         self.normalSections = normalSections
  52
  53         #: Zero sequence shunt (charging) susceptance per section
  54         self.b0PerSection = b0PerSection
  55
  56         #: For a capacitor bank, the maximum number of sections that may be switched in.
  57         self.maximumSections = maximumSections
  58
  59         super(ShuntCompensator, self).__init__(*args, **kw_args)
  60
  61     _attrs = ["g0PerSection", "bPerSection", "nomU", "gPerSection", "normalSections", "b0PerSection", "maximumSections"]
  62     _attr_types = {"g0PerSection": float, "bPerSection": float, "nomU": float, "gPerSection": float, "normalSections": int, "b0PerSection": float, "maximumSections": int}
  63     _defaults = {"g0PerSection": 0.0, "bPerSection": 0.0, "nomU": 0.0, "gPerSection": 0.0, "normalSections": 0, "b0PerSection": 0.0, "maximumSections": 0}
  64     _enums = {}
  65     _refs = []
  66     _many_refs = []
  67