CIM14/IEC61970/Dynamics/ExcitationSystems/ExcDC1A.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 ExcDC1A(ExcitationSystem):
  24     """IEEE (1992/2005) DC1A Model  This model is used to represent field-controlled dc commutator exciters with continuously acting voltage regulators (especially the direct-acting rheostatic, rotating amplifier, and magnetic amplifier types). Because this model has been widely implemented by the industry, it is sometimes used to represent other types of systems when detailed data for them are not available or when a simplified model is required.
  25     """
  26
  27     def __init__(self, ta=0.0, ka=0.0, e1=0.0, tb=0.0, se2=0.0, te=0.0, exclim=0.0, e2=0.0, tr=0.0, uelin=0.0, tf=0.0, vrmax=0.0, kf=0.0, ke=0.0, se1=0.0, vrmin=0.0, tc=0.0, *args, **kw_args):
  28         """Initialises a new 'ExcDC1A' instance.
  29
  30         @param ta: Time constant (&gt; 0.)
  31         @param ka: Gain (&gt; 0.)
  32         @param e1: Field voltage value 1    (&gt; 0.)
  33         @param tb: Lag time constant (&gt;= 0.)
  34         @param se2: Saturation factor at e2  (&gt;= 0.)
  35         @param te: Exciter time constant (&gt; 0.)
  36         @param exclim: If not 0, apply lower limit of 0. to exciter output
  37         @param e2: Field voltage value 2.   (&gt; 0.)
  38         @param tr: Filter time constant (&gt;= 0.)
  39         @param uelin: UEL input: if &lt; 2, HV gate; if = 2, add to error signal
  40         @param tf: Rate feedback time constant, sec. (&gt; 0.)
  41         @param vrmax: Maximum controller output
  42         @param kf: Rate feedback gain (&gt;= 0.)
  43         @param ke: Exciter field resistance line slope
  44         @param se1: Saturation factor at e1  (&gt;= 0.)
  45         @param vrmin: Minimum controller output (&lt; 0.)
  46         @param tc: Lead time constant
  47         """
  48         #: Time constant (&gt; 0.)
  49         self.ta = ta
  50
  51         #: Gain (&gt; 0.)
  52         self.ka = ka
  53
  54         #: Field voltage value 1    (&gt; 0.)
  55         self.e1 = e1
  56
  57         #: Lag time constant (&gt;= 0.)
  58         self.tb = tb
  59
  60         #: Saturation factor at e2  (&gt;= 0.)
  61         self.se2 = se2
  62
  63         #: Exciter time constant (&gt; 0.)
  64         self.te = te
  65
  66         #: If not 0, apply lower limit of 0. to exciter output
  67         self.exclim = exclim
  68
  69         #: Field voltage value 2.   (&gt; 0.)
  70         self.e2 = e2
  71
  72         #: Filter time constant (&gt;= 0.)
  73         self.tr = tr
  74
  75         #: UEL input: if &lt; 2, HV gate; if = 2, add to error signal
  76         self.uelin = uelin
  77
  78         #: Rate feedback time constant, sec. (&gt; 0.)
  79         self.tf = tf
  80
  81         #: Maximum controller output
  82         self.vrmax = vrmax
  83
  84         #: Rate feedback gain (&gt;= 0.)
  85         self.kf = kf
  86
  87         #: Exciter field resistance line slope
  88         self.ke = ke
  89
  90         #: Saturation factor at e1  (&gt;= 0.)
  91         self.se1 = se1
  92
  93         #: Minimum controller output (&lt; 0.)
  94         self.vrmin = vrmin
  95
  96         #: Lead time constant
  97         self.tc = tc
  98
  99         super(ExcDC1A, self).__init__(*args, **kw_args)
 100
 101     _attrs = ["ta", "ka", "e1", "tb", "se2", "te", "exclim", "e2", "tr", "uelin", "tf", "vrmax", "kf", "ke", "se1", "vrmin", "tc"]
 102     _attr_types = {"ta": float, "ka": float, "e1": float, "tb": float, "se2": float, "te": float, "exclim": float, "e2": float, "tr": float, "uelin": float, "tf": float, "vrmax": float, "kf": float, "ke": float, "se1": float, "vrmin": float, "tc": float}
 103     _defaults = {"ta": 0.0, "ka": 0.0, "e1": 0.0, "tb": 0.0, "se2": 0.0, "te": 0.0, "exclim": 0.0, "e2": 0.0, "tr": 0.0, "uelin": 0.0, "tf": 0.0, "vrmax": 0.0, "kf": 0.0, "ke": 0.0, "se1": 0.0, "vrmin": 0.0, "tc": 0.0}
 104     _enums = {}
 105     _refs = []
 106     _many_refs = []
 107