CIM14/IEC61970/Dynamics/ExcitationSystems/ExcDC4B.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 ExcDC4B(ExcitationSystem):
  24     """IEEE (2005) DC4B Model  These excitation systems utilize a field-controlled dc commutator exciter with a continuously acting voltage regulator having supplies obtained from the generator or auxiliary bus. The replacement of the controls only as an upgrade (retaining the dc commutator exciter) has resulted in a new model. This excitation system typically includes a proportional, integral, and differential (PID) generator voltage regulator (AVR). An alternative rate feedback loop (<i>kf</i>, <i>tf</i>) for stabilization is also shown in the model if the AVR does not include a derivative term. If a PSS control is supplied, the appropriate model is the Type PSS2B model.
  25     """
  26
  27     def __init__(self, e1=0.0, se2=0.0, tf=0.0, oelin=0.0, ki=0.0, ta=0.0, vrmax=0.0, tr=0.0, kf=0.0, vrmin=0.0, te=0.0, ka=0.0, kp=0.0, td=0.0, kd=0.0, vemin=0.0, ke=0.0, se1=0.0, e2=0.0, uelin=0.0, *args, **kw_args):
  28         """Initialises a new 'ExcDC4B' instance.
  29
  30         @param e1: Field voltage value 1     (&gt; 0.)
  31         @param se2: Saturation factor at e2 (&gt;= 0.)
  32         @param tf: Rate feedback time constant (&gt;= 0.)
  33         @param oelin: OEL input: if &lt; 2, LV gate; if = 2, subtract from error signal
  34         @param ki: Integral gain (&gt;= 0.)
  35         @param ta: Time constant (&gt; 0.)
  36         @param vrmax: Maximum controller output
  37         @param tr: Filter time constant (&gt;= 0.)
  38         @param kf: Rate feedback gain (&gt;= 0.)
  39         @param vrmin: Minimum controller output (&lt;= 0.)
  40         @param te: Exciter time constant (&gt; 0.)
  41         @param ka: Gain (&gt; 0.)
  42         @param kp: Proportional gain (&gt;= 0.)
  43         @param td: Derivative time constant (&gt; 0. If kd &gt; 0.)
  44         @param kd: Derivative gain (&gt;= 0.)
  45         @param vemin: Exciter minimum output  (&lt;= 0.)
  46         @param ke: Exciter field resistance line slope
  47         @param se1: Saturation factor at e1   (&gt;= 0.)
  48         @param e2: Field voltage value 2.   (&gt; 0.)
  49         @param uelin: UEL input: if &lt; 2, HV gate; if = 2, add to error signal
  50         """
  51         #: Field voltage value 1     (&gt; 0.)
  52         self.e1 = e1
  53
  54         #: Saturation factor at e2 (&gt;= 0.)
  55         self.se2 = se2
  56
  57         #: Rate feedback time constant (&gt;= 0.)
  58         self.tf = tf
  59
  60         #: OEL input: if &lt; 2, LV gate; if = 2, subtract from error signal
  61         self.oelin = oelin
  62
  63         #: Integral gain (&gt;= 0.)
  64         self.ki = ki
  65
  66         #: Time constant (&gt; 0.)
  67         self.ta = ta
  68
  69         #: Maximum controller output
  70         self.vrmax = vrmax
  71
  72         #: Filter time constant (&gt;= 0.)
  73         self.tr = tr
  74
  75         #: Rate feedback gain (&gt;= 0.)
  76         self.kf = kf
  77
  78         #: Minimum controller output (&lt;= 0.)
  79         self.vrmin = vrmin
  80
  81         #: Exciter time constant (&gt; 0.)
  82         self.te = te
  83
  84         #: Gain (&gt; 0.)
  85         self.ka = ka
  86
  87         #: Proportional gain (&gt;= 0.)
  88         self.kp = kp
  89
  90         #: Derivative time constant (&gt; 0. If kd &gt; 0.)
  91         self.td = td
  92
  93         #: Derivative gain (&gt;= 0.)
  94         self.kd = kd
  95
  96         #: Exciter minimum output  (&lt;= 0.)
  97         self.vemin = vemin
  98
  99         #: Exciter field resistance line slope
 100         self.ke = ke
 101
 102         #: Saturation factor at e1   (&gt;= 0.)
 103         self.se1 = se1
 104
 105         #: Field voltage value 2.   (&gt; 0.)
 106         self.e2 = e2
 107
 108         #: UEL input: if &lt; 2, HV gate; if = 2, add to error signal
 109         self.uelin = uelin
 110
 111         super(ExcDC4B, self).__init__(*args, **kw_args)
 112
 113     _attrs = ["e1", "se2", "tf", "oelin", "ki", "ta", "vrmax", "tr", "kf", "vrmin", "te", "ka", "kp", "td", "kd", "vemin", "ke", "se1", "e2", "uelin"]
 114     _attr_types = {"e1": float, "se2": float, "tf": float, "oelin": float, "ki": float, "ta": float, "vrmax": float, "tr": float, "kf": float, "vrmin": float, "te": float, "ka": float, "kp": float, "td": float, "kd": float, "vemin": float, "ke": float, "se1": float, "e2": float, "uelin": float}
 115     _defaults = {"e1": 0.0, "se2": 0.0, "tf": 0.0, "oelin": 0.0, "ki": 0.0, "ta": 0.0, "vrmax": 0.0, "tr": 0.0, "kf": 0.0, "vrmin": 0.0, "te": 0.0, "ka": 0.0, "kp": 0.0, "td": 0.0, "kd": 0.0, "vemin": 0.0, "ke": 0.0, "se1": 0.0, "e2": 0.0, "uelin": 0.0}
 116     _enums = {}
 117     _refs = []
 118     _many_refs = []
 119