schemata/CIM14/Dynamics/ExcitationSystems/ExcDC2A.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 ExcDC2A(ExcitationSystem):
  20     """IEEE (1992/2005) DC2A Model  The model is used to represent field-controlled dc commutator exciters with continuously acting voltage regulators having supplies obtained from the generator or auxiliary bus. It differs from the Type DC1A model only in the voltage regulator output limits, which are now proportional to terminal voltage <i>V</i><i><sub>T</sub></i>. It is representative of solid-state replacements for various forms of older mechanical and rotating amplifier regulating equipment connected to dc commutator exciters.
  21     """
  22
  23     def __init__(self, te=0.0, ke=0.0, e1=0.0, tc=0.0, se2=0.0, tb=0.0, uelin=0.0, e2=0.0, tf=0.0, kf=0.0, vrmax=0.0, se1=0.0, ta=0.0, ka=0.0, tr=0.0, exclim=0.0, vrmin=0.0, *args, **kw_args):
  24         """Initialises a new 'ExcDC2A' instance.
  25
  26         @param te: Exciter time constant (&gt; 0.)
  27         @param ke: Exciter field resistance line slope
  28         @param e1: Field voltage value 1     (&gt; 0.)
  29         @param tc: Lead time constant
  30         @param se2: Saturation factor at e2  (&gt;= 0.)
  31         @param tb: Lag time constant (&gt;= 0.)
  32         @param uelin: UEL input: if &lt; 2, HV gate; if = 2, add to error signal
  33         @param e2: Field voltage value 2.    (&gt; 0.)
  34         @param tf: Rate feedback time constant, sec. (&gt; 0.)
  35         @param kf: Rate feedback gain (&gt;= 0.)
  36         @param vrmax: Maximum controller output
  37         @param se1: Saturation factor at e1  (&gt;= 0.)
  38         @param ta: Time constant (&gt; 0.)
  39         @param ka: Gain (&gt; 0.)
  40         @param tr: Filter time constant (&gt;= 0.)
  41         @param exclim: If not 0, apply lower limit of 0. to exciter output
  42         @param vrmin: Minimum controller output (&lt; 0.)
  43         """
  44         #: Exciter time constant (&gt; 0.)
  45         self.te = te
  46
  47         #: Exciter field resistance line slope
  48         self.ke = ke
  49
  50         #: Field voltage value 1     (&gt; 0.)
  51         self.e1 = e1
  52
  53         #: Lead time constant
  54         self.tc = tc
  55
  56         #: Saturation factor at e2  (&gt;= 0.)
  57         self.se2 = se2
  58
  59         #: Lag time constant (&gt;= 0.)
  60         self.tb = tb
  61
  62         #: UEL input: if &lt; 2, HV gate; if = 2, add to error signal
  63         self.uelin = uelin
  64
  65         #: Field voltage value 2.    (&gt; 0.)
  66         self.e2 = e2
  67
  68         #: Rate feedback time constant, sec. (&gt; 0.)
  69         self.tf = tf
  70
  71         #: Rate feedback gain (&gt;= 0.)
  72         self.kf = kf
  73
  74         #: Maximum controller output
  75         self.vrmax = vrmax
  76
  77         #: Saturation factor at e1  (&gt;= 0.)
  78         self.se1 = se1
  79
  80         #: Time constant (&gt; 0.)
  81         self.ta = ta
  82
  83         #: Gain (&gt; 0.)
  84         self.ka = ka
  85
  86         #: Filter time constant (&gt;= 0.)
  87         self.tr = tr
  88
  89         #: If not 0, apply lower limit of 0. to exciter output
  90         self.exclim = exclim
  91
  92         #: Minimum controller output (&lt; 0.)
  93         self.vrmin = vrmin
  94
  95         super(ExcDC2A, self).__init__(*args, **kw_args)
  96
  97     _attrs = ["te", "ke", "e1", "tc", "se2", "tb", "uelin", "e2", "tf", "kf", "vrmax", "se1", "ta", "ka", "tr", "exclim", "vrmin"]
  98     _attr_types = {"te": float, "ke": float, "e1": float, "tc": float, "se2": float, "tb": float, "uelin": float, "e2": float, "tf": float, "kf": float, "vrmax": float, "se1": float, "ta": float, "ka": float, "tr": float, "exclim": float, "vrmin": float}
  99     _defaults = {"te": 0.0, "ke": 0.0, "e1": 0.0, "tc": 0.0, "se2": 0.0, "tb": 0.0, "uelin": 0.0, "e2": 0.0, "tf": 0.0, "kf": 0.0, "vrmax": 0.0, "se1": 0.0, "ta": 0.0, "ka": 0.0, "tr": 0.0, "exclim": 0.0, "vrmin": 0.0}
 100     _enums = {}
 101     _refs = []
 102     _many_refs = []
 103