CIM14/IEC61970/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.IEC61970.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.
  25     """
  26
  27     def __init__(self, maxU=0.0, reactivePerSection=0.0, aVRDelay=0.0, voltageSensitivity=0.0, normalSections=0, g0PerSection=0.0, maximumSections=0, bPerSection=0.0, nomQ=0.0, switchOnCount=0, minU=0.0, b0PerSection=0.0, switchOnDate='', nomU=0.0, gPerSection=0.0, SvShuntCompensatorSections=None, *args, **kw_args):
  28         """Initialises a new 'ShuntCompensator' instance.
  29
  30         @param maxU: The maximum voltage at which the capacitor bank should operate.
  31         @param reactivePerSection: For a capacitor bank, the size in reactive power of each switchable section at the nominal voltage.
  32         @param aVRDelay: Time delay required for the device to be connected or disconnected by automatic voltage regulation (AVR).
  33         @param voltageSensitivity: Voltage sensitivity required for the device to regulate the bus voltage, in voltage/reactive power.
  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 g0PerSection: Zero sequence shunt (charging) conductance per section
  36         @param maximumSections: For a capacitor bank, the maximum number of sections that may be switched in.
  37         @param bPerSection: Positive sequence shunt (charging) susceptance per section
  38         @param nomQ: Nominal reactive power output of the capacitor bank at the nominal voltage. This number should be positive.
  39         @param switchOnCount: The switch on count since the capacitor count was last reset or initialized.
  40         @param minU: The minimum voltage at which the capacitor bank should operate.
  41         @param b0PerSection: Zero sequence shunt (charging) susceptance per section
  42         @param switchOnDate: The date and time when the capacitor bank was last switched on.
  43         @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.
  44         @param gPerSection: Positive sequence shunt (charging) conductance per section
  45         @param SvShuntCompensatorSections: The state for the number of shunt compensator sections in service.
  46         """
  47         #: The maximum voltage at which the capacitor bank should operate.
  48         self.maxU = maxU
  49
  50         #: For a capacitor bank, the size in reactive power of each switchable section at the nominal voltage.
  51         self.reactivePerSection = reactivePerSection
  52
  53         #: Time delay required for the device to be connected or disconnected by automatic voltage regulation (AVR).
  54         self.aVRDelay = aVRDelay
  55
  56         #: Voltage sensitivity required for the device to regulate the bus voltage, in voltage/reactive power.
  57         self.voltageSensitivity = voltageSensitivity
  58
  59         #: For a capacitor bank, the normal number of sections switched in. This number should correspond to the nominal reactive power (nomQ).
  60         self.normalSections = normalSections
  61
  62         #: Zero sequence shunt (charging) conductance per section
  63         self.g0PerSection = g0PerSection
  64
  65         #: For a capacitor bank, the maximum number of sections that may be switched in.
  66         self.maximumSections = maximumSections
  67
  68         #: Positive sequence shunt (charging) susceptance per section
  69         self.bPerSection = bPerSection
  70
  71         #: Nominal reactive power output of the capacitor bank at the nominal voltage. This number should be positive.
  72         self.nomQ = nomQ
  73
  74         #: The switch on count since the capacitor count was last reset or initialized.
  75         self.switchOnCount = switchOnCount
  76
  77         #: The minimum voltage at which the capacitor bank should operate.
  78         self.minU = minU
  79
  80         #: Zero sequence shunt (charging) susceptance per section
  81         self.b0PerSection = b0PerSection
  82
  83         #: The date and time when the capacitor bank was last switched on.
  84         self.switchOnDate = switchOnDate
  85
  86         #: 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.
  87         self.nomU = nomU
  88
  89         #: Positive sequence shunt (charging) conductance per section
  90         self.gPerSection = gPerSection
  91
  92         self._SvShuntCompensatorSections = None
  93         self.SvShuntCompensatorSections = SvShuntCompensatorSections
  94
  95         super(ShuntCompensator, self).__init__(*args, **kw_args)
  96
  97     _attrs = ["maxU", "reactivePerSection", "aVRDelay", "voltageSensitivity", "normalSections", "g0PerSection", "maximumSections", "bPerSection", "nomQ", "switchOnCount", "minU", "b0PerSection", "switchOnDate", "nomU", "gPerSection"]
  98     _attr_types = {"maxU": float, "reactivePerSection": float, "aVRDelay": float, "voltageSensitivity": float, "normalSections": int, "g0PerSection": float, "maximumSections": int, "bPerSection": float, "nomQ": float, "switchOnCount": int, "minU": float, "b0PerSection": float, "switchOnDate": str, "nomU": float, "gPerSection": float}
  99     _defaults = {"maxU": 0.0, "reactivePerSection": 0.0, "aVRDelay": 0.0, "voltageSensitivity": 0.0, "normalSections": 0, "g0PerSection": 0.0, "maximumSections": 0, "bPerSection": 0.0, "nomQ": 0.0, "switchOnCount": 0, "minU": 0.0, "b0PerSection": 0.0, "switchOnDate": '', "nomU": 0.0, "gPerSection": 0.0}
 100     _enums = {}
 101     _refs = ["SvShuntCompensatorSections"]
 102     _many_refs = []
 103
 104     def getSvShuntCompensatorSections(self):
 105         """The state for the number of shunt compensator sections in service.
 106         """
 107         return self._SvShuntCompensatorSections
 108
 109     def setSvShuntCompensatorSections(self, value):
 110         if self._SvShuntCompensatorSections is not None:
 111             self._SvShuntCompensatorSections._ShuntCompensator = None
 112
 113         self._SvShuntCompensatorSections = value
 114         if self._SvShuntCompensatorSections is not None:
 115             self._SvShuntCompensatorSections.ShuntCompensator = None
 116             self._SvShuntCompensatorSections._ShuntCompensator = self
 117
 118     SvShuntCompensatorSections = property(getSvShuntCompensatorSections, setSvShuntCompensatorSections)
 119