CIM14/IEC61970/Dynamics/ExcitationSystems/ExcAC3A.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 ExcAC3A(ExcitationSystem):
  24     """IEEE (1992/2005) AC3A Model  The model represents the field-controlled alternator-rectifier excitation systems designated Type AC3A. These excitation systems include an alternator main exciter with non-controlled rectifiers. The exciter employs self-excitation, and the voltage regulator power is derived from the exciter output voltage. Therefore, this system has an additional nonlinearity, simulated by the use of a multiplier whose inputs are the voltage regulator command signal, <i>VA</i>, and the exciter output voltage, <i>EFD</i>, times <i>KR</i>. This model is applicable to excitation systems employing static voltage regulators.
  25     """
  26
  27     def __init__(self, kf=0.0, e2=0.0, te=0.0, ka=0.0, kr=0.0, tc=0.0, efdn=0.0, ke=0.0, e1=0.0, kd=0.0, se2=0.0, vamax=0.0, tr=0.0, vamin=0.0, tf=0.0, vemin=0.0, kn=0.0, vfemax=0.0, tb=0.0, se1=0.0, kc=0.0, ta=0.0, *args, **kw_args):
  28         """Initialises a new 'ExcAC3A' instance.
  29
  30         @param kf: Low level rate feedback gain (&gt;= 0.)
  31         @param e2: Field voltage value 2.     (&gt; 0.)
  32         @param te: Exciter time constant (&gt; 0.)
  33         @param ka: AVR gain (&gt; 0.)
  34         @param kr: Field self-excitation feedback gain (&gt; 0.)
  35         @param tc: TGR lead time constant
  36         @param efdn: Rate feedback gain break level (&gt; 0.)
  37         @param ke: Exciter field resistance constant
  38         @param e1: Field voltage value 1     (&gt; 0.)
  39         @param kd: Exciter internal reactance (&gt;= 0.)
  40         @param se2: Saturation factor at e2   (&gt;= 0.)
  41         @param vamax: Maximum AVR output (&gt; 0.)
  42         @param tr: Filter time constant (&gt;= 0.)
  43         @param vamin: Minimum AVR output (&lt; 0.)
  44         @param tf: Rate feedback time constant (&gt; 0.)
  45         @param vemin: Minimum field voltage limit (&lt;= 0.)
  46         @param kn: High level rate feedback gain (&gt;= 0.)
  47         @param vfemax: Exciter field current limit parameter (&gt;= 0.)
  48         @param tb: TGR lag time constant (&gt;= 0.)
  49         @param se1: Saturation factor at e1   (&gt;= 0.)
  50         @param kc: Rectifier regulation factor (&gt;= 0.)
  51         @param ta: AVR time constant (&gt; 0.)
  52         """
  53         #: Low level rate feedback gain (&gt;= 0.)
  54         self.kf = kf
  55
  56         #: Field voltage value 2.     (&gt; 0.)
  57         self.e2 = e2
  58
  59         #: Exciter time constant (&gt; 0.)
  60         self.te = te
  61
  62         #: AVR gain (&gt; 0.)
  63         self.ka = ka
  64
  65         #: Field self-excitation feedback gain (&gt; 0.)
  66         self.kr = kr
  67
  68         #: TGR lead time constant
  69         self.tc = tc
  70
  71         #: Rate feedback gain break level (&gt; 0.)
  72         self.efdn = efdn
  73
  74         #: Exciter field resistance constant
  75         self.ke = ke
  76
  77         #: Field voltage value 1     (&gt; 0.)
  78         self.e1 = e1
  79
  80         #: Exciter internal reactance (&gt;= 0.)
  81         self.kd = kd
  82
  83         #: Saturation factor at e2   (&gt;= 0.)
  84         self.se2 = se2
  85
  86         #: Maximum AVR output (&gt; 0.)
  87         self.vamax = vamax
  88
  89         #: Filter time constant (&gt;= 0.)
  90         self.tr = tr
  91
  92         #: Minimum AVR output (&lt; 0.)
  93         self.vamin = vamin
  94
  95         #: Rate feedback time constant (&gt; 0.)
  96         self.tf = tf
  97
  98         #: Minimum field voltage limit (&lt;= 0.)
  99         self.vemin = vemin
 100
 101         #: High level rate feedback gain (&gt;= 0.)
 102         self.kn = kn
 103
 104         #: Exciter field current limit parameter (&gt;= 0.)
 105         self.vfemax = vfemax
 106
 107         #: TGR lag time constant (&gt;= 0.)
 108         self.tb = tb
 109
 110         #: Saturation factor at e1   (&gt;= 0.)
 111         self.se1 = se1
 112
 113         #: Rectifier regulation factor (&gt;= 0.)
 114         self.kc = kc
 115
 116         #: AVR time constant (&gt; 0.)
 117         self.ta = ta
 118
 119         super(ExcAC3A, self).__init__(*args, **kw_args)
 120
 121     _attrs = ["kf", "e2", "te", "ka", "kr", "tc", "efdn", "ke", "e1", "kd", "se2", "vamax", "tr", "vamin", "tf", "vemin", "kn", "vfemax", "tb", "se1", "kc", "ta"]
 122     _attr_types = {"kf": float, "e2": float, "te": float, "ka": float, "kr": float, "tc": float, "efdn": float, "ke": float, "e1": float, "kd": float, "se2": float, "vamax": float, "tr": float, "vamin": float, "tf": float, "vemin": float, "kn": float, "vfemax": float, "tb": float, "se1": float, "kc": float, "ta": float}
 123     _defaults = {"kf": 0.0, "e2": 0.0, "te": 0.0, "ka": 0.0, "kr": 0.0, "tc": 0.0, "efdn": 0.0, "ke": 0.0, "e1": 0.0, "kd": 0.0, "se2": 0.0, "vamax": 0.0, "tr": 0.0, "vamin": 0.0, "tf": 0.0, "vemin": 0.0, "kn": 0.0, "vfemax": 0.0, "tb": 0.0, "se1": 0.0, "kc": 0.0, "ta": 0.0}
 124     _enums = {}
 125     _refs = []
 126     _many_refs = []
 127