CIM14/IEC61970/Dynamics/ExcitationSystems/ExcAC2A.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 ExcAC2A(ExcitationSystem):
  24     """IEEE (1992/2005) AC2A Model The model designated as Type AC2A, represents a high initial response fieldcontrolled alternator-rectifier excitation system. The alternator main exciter is used with non-controlled rectifiers. The Type AC2A model is similar to that of Type AC1A except for the inclusion of exciter time constant compensation and exciter field current limiting elements.
  25     """
  26
  27     def __init__(self, vrmin=0.0, vamin=0.0, kh=0.0, vrmax=0.0, tb=0.0, e1=0.0, se1=0.0, te=0.0, kf=0.0, tc=0.0, e2=0.0, ke=0.0, tr=0.0, tf=0.0, ta=0.0, kc=0.0, kd=0.0, se2=0.0, vfemax=0.0, vamax=0.0, kb=0.0, ka=0.0, *args, **kw_args):
  28         """Initialises a new 'ExcAC2A' instance.
  29
  30         @param vrmin: Minimum exciter control signal (&lt; 0.)
  31         @param vamin: Minimum AVR output (&lt; 0.)
  32         @param kh: Exciter field current feedback gain (&gt;= 0.)
  33         @param vrmax: Maximum exciter control signal (&gt; 0.)
  34         @param tb: TGR lag time constant (&gt;= 0.)
  35         @param e1: Field voltage value 1     (&gt; 0.)
  36         @param se1: Saturation factor at e1  (&gt;= 0.)
  37         @param te: Exciter time constant (&gt; 0.)
  38         @param kf: Rate feedback gain (&gt;= 0.)
  39         @param tc: TGR lead time constant
  40         @param e2: Field voltage value 2.    (&gt; 0.)
  41         @param ke: Exciter field resistance constant
  42         @param tr: Filter time constant (&gt;= 0.)
  43         @param tf: Rate feedback time constant (&gt; 0.)
  44         @param ta: AVR time constant (&gt; 0.)
  45         @param kc: Rectifier regulation factor (&gt;= 0.)
  46         @param kd: Exciter internal reactance (&gt;= 0.)
  47         @param se2: Saturation factor at e2   (&gt;= 0.)
  48         @param vfemax: Exciter field current limit parameter (&gt;= 0.)
  49         @param vamax: Maximum AVR output (&gt; 0.)
  50         @param kb: Exciter field current controller gain (&gt; 0.)
  51         @param ka: AVR gain (&gt; 0.)
  52         """
  53         #: Minimum exciter control signal (&lt; 0.)
  54         self.vrmin = vrmin
  55
  56         #: Minimum AVR output (&lt; 0.)
  57         self.vamin = vamin
  58
  59         #: Exciter field current feedback gain (&gt;= 0.)
  60         self.kh = kh
  61
  62         #: Maximum exciter control signal (&gt; 0.)
  63         self.vrmax = vrmax
  64
  65         #: TGR lag time constant (&gt;= 0.)
  66         self.tb = tb
  67
  68         #: Field voltage value 1     (&gt; 0.)
  69         self.e1 = e1
  70
  71         #: Saturation factor at e1  (&gt;= 0.)
  72         self.se1 = se1
  73
  74         #: Exciter time constant (&gt; 0.)
  75         self.te = te
  76
  77         #: Rate feedback gain (&gt;= 0.)
  78         self.kf = kf
  79
  80         #: TGR lead time constant
  81         self.tc = tc
  82
  83         #: Field voltage value 2.    (&gt; 0.)
  84         self.e2 = e2
  85
  86         #: Exciter field resistance constant
  87         self.ke = ke
  88
  89         #: Filter time constant (&gt;= 0.)
  90         self.tr = tr
  91
  92         #: Rate feedback time constant (&gt; 0.)
  93         self.tf = tf
  94
  95         #: AVR time constant (&gt; 0.)
  96         self.ta = ta
  97
  98         #: Rectifier regulation factor (&gt;= 0.)
  99         self.kc = kc
 100
 101         #: Exciter internal reactance (&gt;= 0.)
 102         self.kd = kd
 103
 104         #: Saturation factor at e2   (&gt;= 0.)
 105         self.se2 = se2
 106
 107         #: Exciter field current limit parameter (&gt;= 0.)
 108         self.vfemax = vfemax
 109
 110         #: Maximum AVR output (&gt; 0.)
 111         self.vamax = vamax
 112
 113         #: Exciter field current controller gain (&gt; 0.)
 114         self.kb = kb
 115
 116         #: AVR gain (&gt; 0.)
 117         self.ka = ka
 118
 119         super(ExcAC2A, self).__init__(*args, **kw_args)
 120
 121     _attrs = ["vrmin", "vamin", "kh", "vrmax", "tb", "e1", "se1", "te", "kf", "tc", "e2", "ke", "tr", "tf", "ta", "kc", "kd", "se2", "vfemax", "vamax", "kb", "ka"]
 122     _attr_types = {"vrmin": float, "vamin": float, "kh": float, "vrmax": float, "tb": float, "e1": float, "se1": float, "te": float, "kf": float, "tc": float, "e2": float, "ke": float, "tr": float, "tf": float, "ta": float, "kc": float, "kd": float, "se2": float, "vfemax": float, "vamax": float, "kb": float, "ka": float}
 123     _defaults = {"vrmin": 0.0, "vamin": 0.0, "kh": 0.0, "vrmax": 0.0, "tb": 0.0, "e1": 0.0, "se1": 0.0, "te": 0.0, "kf": 0.0, "tc": 0.0, "e2": 0.0, "ke": 0.0, "tr": 0.0, "tf": 0.0, "ta": 0.0, "kc": 0.0, "kd": 0.0, "se2": 0.0, "vfemax": 0.0, "vamax": 0.0, "kb": 0.0, "ka": 0.0}
 124     _enums = {}
 125     _refs = []
 126     _many_refs = []
 127