CIM14/IEC61970/Dynamics/ExcitationSystems/ExcST6B.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.Dynamics.ExcitationSystems.ExcitationSystem import ExcitationSystem
  22
  23 class ExcST6B(ExcitationSystem):
  24     """IEEE (2005) ST6B Model  The AVR consists of a PI voltage regulator with an inner loop field voltage regulator and pre-control. The field voltage regulator implements a proportional control. The pre-control and the delay in the feedback circuit increase the dynamic response.
  25     """
  26
  27     def __init__(self, tr=0.0, ilr=0.0, vrmin=0.0, vmult=0.0, vrmax=0.0, oelin=0.0, klr=0.0, kg=0.0, kpa=0.0, vamax=0.0, ts=0.0, kcl=0.0, tg=0.0, vamin=0.0, kia=0.0, kff=0.0, km=0.0, *args, **kw_args):
  28         """Initialises a new 'ExcST6B' instance.
  29
  30         @param tr: Filter time constant (&gt;= 0.)
  31         @param ilr: Field current limiter setpoint (&gt; 0.)
  32         @param vrmin: Minimum regulator output (&lt; 0.)
  33         @param vmult: If non-zero, multiply regulator output by terminal voltage
  34         @param vrmax: Maximum regulator output (&gt; 0.)
  35         @param oelin: OEL input selector: 1 ? before UEL, 2 ? after UEL, 0 ? no OEL input
  36         @param klr: Field current limiter gain (&gt; 0.)
  37         @param kg: Feedback gain (&gt;= 0.)
  38         @param kpa: Regulator proportional gain (&gt; 0.)
  39         @param vamax: PI maximum output. (&gt; 0.)
  40         @param ts: Rectifier firing time constant (not in IEEE model) (&gt;= 0.)
  41         @param kcl: Field current limiter conversion factor (&gt; 0.)
  42         @param tg: Feedback time constant (&gt;= 0.)
  43         @param vamin: PI minimum output (&lt; 0.)
  44         @param kia: Regulator integral gain (&gt; 0.)
  45         @param kff: Feedforward gain
  46         @param km: Main gain
  47         """
  48         #: Filter time constant (&gt;= 0.)
  49         self.tr = tr
  50
  51         #: Field current limiter setpoint (&gt; 0.)
  52         self.ilr = ilr
  53
  54         #: Minimum regulator output (&lt; 0.)
  55         self.vrmin = vrmin
  56
  57         #: If non-zero, multiply regulator output by terminal voltage
  58         self.vmult = vmult
  59
  60         #: Maximum regulator output (&gt; 0.)
  61         self.vrmax = vrmax
  62
  63         #: OEL input selector: 1 ? before UEL, 2 ? after UEL, 0 ? no OEL input
  64         self.oelin = oelin
  65
  66         #: Field current limiter gain (&gt; 0.)
  67         self.klr = klr
  68
  69         #: Feedback gain (&gt;= 0.)
  70         self.kg = kg
  71
  72         #: Regulator proportional gain (&gt; 0.)
  73         self.kpa = kpa
  74
  75         #: PI maximum output. (&gt; 0.)
  76         self.vamax = vamax
  77
  78         #: Rectifier firing time constant (not in IEEE model) (&gt;= 0.)
  79         self.ts = ts
  80
  81         #: Field current limiter conversion factor (&gt; 0.)
  82         self.kcl = kcl
  83
  84         #: Feedback time constant (&gt;= 0.)
  85         self.tg = tg
  86
  87         #: PI minimum output (&lt; 0.)
  88         self.vamin = vamin
  89
  90         #: Regulator integral gain (&gt; 0.)
  91         self.kia = kia
  92
  93         #: Feedforward gain
  94         self.kff = kff
  95
  96         #: Main gain
  97         self.km = km
  98
  99         super(ExcST6B, self).__init__(*args, **kw_args)
 100
 101     _attrs = ["tr", "ilr", "vrmin", "vmult", "vrmax", "oelin", "klr", "kg", "kpa", "vamax", "ts", "kcl", "tg", "vamin", "kia", "kff", "km"]
 102     _attr_types = {"tr": float, "ilr": float, "vrmin": float, "vmult": float, "vrmax": float, "oelin": float, "klr": float, "kg": float, "kpa": float, "vamax": float, "ts": float, "kcl": float, "tg": float, "vamin": float, "kia": float, "kff": float, "km": float}
 103     _defaults = {"tr": 0.0, "ilr": 0.0, "vrmin": 0.0, "vmult": 0.0, "vrmax": 0.0, "oelin": 0.0, "klr": 0.0, "kg": 0.0, "kpa": 0.0, "vamax": 0.0, "ts": 0.0, "kcl": 0.0, "tg": 0.0, "vamin": 0.0, "kia": 0.0, "kff": 0.0, "km": 0.0}
 104     _enums = {}
 105     _refs = []
 106     _many_refs = []
 107