CIM14/IEC61970/Dynamics/ExcitationSystems/ExcST2A.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 ExcST2A(ExcitationSystem):
  24     """IEEE (1992/2005) ST2A Model  Some static systems utilize both current and voltage sources (generator terminal quantities) to comprise the power source. These compound-source rectifier excitation systems are designated Type ST2A. The regulator controls the exciter output through controlled saturation of the power transformer components.
  25     """
  26
  27     def __init__(self, te=0.0, ka=0.0, tb=0.0, tf=0.0, kf=0.0, ke=0.0, tr=0.0, tc=0.0, ta=0.0, kc=0.0, ki=0.0, kp=0.0, uelin=0.0, vrmax=0.0, efdmax=0.0, vrmin=0.0, *args, **kw_args):
  28         """Initialises a new 'ExcST2A' instance.
  29
  30         @param te: Transformer saturation control time constant (&gt; 0.)
  31         @param ka: Gain (&gt; 0.)
  32         @param tb: Time constant (&gt;=0.)
  33         @param tf: Rate feedback time constant (&gt;= 0.)
  34         @param kf: Rate feedback gain (&gt;= 0.)
  35         @param ke: Time constant feedback
  36         @param tr: Filter time constant (&gt;= 0.)
  37         @param tc: Time constant
  38         @param ta: Time constant (&gt; 0.)
  39         @param kc: Rectifier loading factor (&gt;= 0.)
  40         @param ki: Current source gain (&gt;= 0.)
  41         @param kp: Potential source gain (&gt;= 0.)
  42         @param uelin: UEL input: if = 1, HV gate; if = 2, add to error signal
  43         @param vrmax: Maximum controller output (&gt; 0.)
  44         @param efdmax: Maximum field voltage (&gt;=0.)
  45         @param vrmin: Minimum controller output (&lt; 0.)
  46         """
  47         #: Transformer saturation control time constant (&gt; 0.)
  48         self.te = te
  49
  50         #: Gain (&gt; 0.)
  51         self.ka = ka
  52
  53         #: Time constant (&gt;=0.)
  54         self.tb = tb
  55
  56         #: Rate feedback time constant (&gt;= 0.)
  57         self.tf = tf
  58
  59         #: Rate feedback gain (&gt;= 0.)
  60         self.kf = kf
  61
  62         #: Time constant feedback
  63         self.ke = ke
  64
  65         #: Filter time constant (&gt;= 0.)
  66         self.tr = tr
  67
  68         #: Time constant
  69         self.tc = tc
  70
  71         #: Time constant (&gt; 0.)
  72         self.ta = ta
  73
  74         #: Rectifier loading factor (&gt;= 0.)
  75         self.kc = kc
  76
  77         #: Current source gain (&gt;= 0.)
  78         self.ki = ki
  79
  80         #: Potential source gain (&gt;= 0.)
  81         self.kp = kp
  82
  83         #: UEL input: if = 1, HV gate; if = 2, add to error signal
  84         self.uelin = uelin
  85
  86         #: Maximum controller output (&gt; 0.)
  87         self.vrmax = vrmax
  88
  89         #: Maximum field voltage (&gt;=0.)
  90         self.efdmax = efdmax
  91
  92         #: Minimum controller output (&lt; 0.)
  93         self.vrmin = vrmin
  94
  95         super(ExcST2A, self).__init__(*args, **kw_args)
  96
  97     _attrs = ["te", "ka", "tb", "tf", "kf", "ke", "tr", "tc", "ta", "kc", "ki", "kp", "uelin", "vrmax", "efdmax", "vrmin"]
  98     _attr_types = {"te": float, "ka": float, "tb": float, "tf": float, "kf": float, "ke": float, "tr": float, "tc": float, "ta": float, "kc": float, "ki": float, "kp": float, "uelin": float, "vrmax": float, "efdmax": float, "vrmin": float}
  99     _defaults = {"te": 0.0, "ka": 0.0, "tb": 0.0, "tf": 0.0, "kf": 0.0, "ke": 0.0, "tr": 0.0, "tc": 0.0, "ta": 0.0, "kc": 0.0, "ki": 0.0, "kp": 0.0, "uelin": 0.0, "vrmax": 0.0, "efdmax": 0.0, "vrmin": 0.0}
 100     _enums = {}
 101     _refs = []
 102     _many_refs = []
 103