CIM14/Dynamics/ExcitationSystems/ExcST2A.py

   1 # Copyright (C) 2010 Richard Lincoln
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA, USA
  16
  17 from CIM14.Dynamics.ExcitationSystems.ExcitationSystem import ExcitationSystem
  18
  19 class ExcST2A(ExcitationSystem):
  20     """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.
  21     """
  22
  23     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):
  24         """Initialises a new 'ExcST2A' instance.
  25
  26         @param te: Transformer saturation control time constant (&gt; 0.)
  27         @param ka: Gain (&gt; 0.)
  28         @param tb: Time constant (&gt;=0.)
  29         @param tf: Rate feedback time constant (&gt;= 0.)
  30         @param kf: Rate feedback gain (&gt;= 0.)
  31         @param ke: Time constant feedback
  32         @param tr: Filter time constant (&gt;= 0.)
  33         @param tc: Time constant
  34         @param ta: Time constant (&gt; 0.)
  35         @param kc: Rectifier loading factor (&gt;= 0.)
  36         @param ki: Current source gain (&gt;= 0.)
  37         @param kp: Potential source gain (&gt;= 0.)
  38         @param uelin: UEL input: if = 1, HV gate; if = 2, add to error signal
  39         @param vrmax: Maximum controller output (&gt; 0.)
  40         @param efdmax: Maximum field voltage (&gt;=0.)
  41         @param vrmin: Minimum controller output (&lt; 0.)
  42         """
  43         #: Transformer saturation control time constant (&gt; 0.)
  44         self.te = te
  45
  46         #: Gain (&gt; 0.)
  47         self.ka = ka
  48
  49         #: Time constant (&gt;=0.)
  50         self.tb = tb
  51
  52         #: Rate feedback time constant (&gt;= 0.)
  53         self.tf = tf
  54
  55         #: Rate feedback gain (&gt;= 0.)
  56         self.kf = kf
  57
  58         #: Time constant feedback
  59         self.ke = ke
  60
  61         #: Filter time constant (&gt;= 0.)
  62         self.tr = tr
  63
  64         #: Time constant
  65         self.tc = tc
  66
  67         #: Time constant (&gt; 0.)
  68         self.ta = ta
  69
  70         #: Rectifier loading factor (&gt;= 0.)
  71         self.kc = kc
  72
  73         #: Current source gain (&gt;= 0.)
  74         self.ki = ki
  75
  76         #: Potential source gain (&gt;= 0.)
  77         self.kp = kp
  78
  79         #: UEL input: if = 1, HV gate; if = 2, add to error signal
  80         self.uelin = uelin
  81
  82         #: Maximum controller output (&gt; 0.)
  83         self.vrmax = vrmax
  84
  85         #: Maximum field voltage (&gt;=0.)
  86         self.efdmax = efdmax
  87
  88         #: Minimum controller output (&lt; 0.)
  89         self.vrmin = vrmin
  90
  91         super(ExcST2A, self).__init__(*args, **kw_args)
  92
  93     _attrs = ["te", "ka", "tb", "tf", "kf", "ke", "tr", "tc", "ta", "kc", "ki", "kp", "uelin", "vrmax", "efdmax", "vrmin"]
  94     _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}
  95     _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}
  96     _enums = {}
  97     _refs = []
  98     _many_refs = []
  99