CIM14/IEC61970/Dynamics/ExcitationSystems/ExcAC6A.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 ExcAC6A(ExcitationSystem):
  24     """IEEE (1992/2005) AC6A Model  The model is used to represent field-controlled alternator-rectifier excitation systems with system-supplied electronic voltage regulators. The maximum output of the regulator, <i>V</i><i><sub>R</sub></i>, is a function of terminal voltage, <i>V</i><i><sub>T</sub></i>. The field current limiter included in the original model AC6A remains in the 2005 update.
  25     """
  26
  27     def __init__(self, te=0.0, ka=0.0, vhmax=0.0, kh=0.0, tk=0.0, ke=0.0, se1=0.0, tr=0.0, vrmin=0.0, vrmax=0.0, tc=0.0, e2=0.0, tj=0.0, kc=0.0, vfelim=0.0, ta=0.0, th=0.0, kd=0.0, vamax=0.0, tb=0.0, e1=0.0, vamin=0.0, se2=0.0, *args, **kw_args):
  28         """Initialises a new 'ExcAC6A' instance.
  29
  30         @param te: Exciter time constant (&gt; 0.)
  31         @param ka: Gain (&gt; 0.)
  32         @param vhmax: Maximum field current limiter signal (&gt; 0.)
  33         @param kh: Exciter field current limiter gain (&gt;= 0.)
  34         @param tk: Lag time constant (&gt;= 0.)
  35         @param ke: Exciter field resistance constant
  36         @param se1: Saturation factor at e1 (&gt;= 0.)
  37         @param tr: Filter time constant
  38         @param vrmin: Minimum exciter control signal (&lt; 0.)
  39         @param vrmax: Maximum exciter control signal (&gt; 0.)
  40         @param tc: Lead time constant
  41         @param e2: Field voltage value 2.    (&gt; 0.)
  42         @param tj: Field current limiter time constant (&gt;= 0.)
  43         @param kc: Rectifier regulation factor (&gt;= 0.)
  44         @param vfelim: Exciter field current limit reference (&gt; 0.)
  45         @param ta: Time constant (&gt;= 0.)
  46         @param th: Field current limiter time constant (&gt; 0.)
  47         @param kd: Exciter internal reactance (&gt;= 0.)
  48         @param vamax: Maximum controller element output (&gt; 0.)
  49         @param tb: Time constant (&gt;= 0.)
  50         @param e1: Field voltage value 1     (&gt; 0.)
  51         @param vamin: Minimum controller element output (&lt; 0.)
  52         @param se2: Saturation factor at e2  (&gt;= 0.)
  53         """
  54         #: Exciter time constant (&gt; 0.)
  55         self.te = te
  56
  57         #: Gain (&gt; 0.)
  58         self.ka = ka
  59
  60         #: Maximum field current limiter signal (&gt; 0.)
  61         self.vhmax = vhmax
  62
  63         #: Exciter field current limiter gain (&gt;= 0.)
  64         self.kh = kh
  65
  66         #: Lag time constant (&gt;= 0.)
  67         self.tk = tk
  68
  69         #: Exciter field resistance constant
  70         self.ke = ke
  71
  72         #: Saturation factor at e1 (&gt;= 0.)
  73         self.se1 = se1
  74
  75         #: Filter time constant
  76         self.tr = tr
  77
  78         #: Minimum exciter control signal (&lt; 0.)
  79         self.vrmin = vrmin
  80
  81         #: Maximum exciter control signal (&gt; 0.)
  82         self.vrmax = vrmax
  83
  84         #: Lead time constant
  85         self.tc = tc
  86
  87         #: Field voltage value 2.    (&gt; 0.)
  88         self.e2 = e2
  89
  90         #: Field current limiter time constant (&gt;= 0.)
  91         self.tj = tj
  92
  93         #: Rectifier regulation factor (&gt;= 0.)
  94         self.kc = kc
  95
  96         #: Exciter field current limit reference (&gt; 0.)
  97         self.vfelim = vfelim
  98
  99         #: Time constant (&gt;= 0.)
 100         self.ta = ta
 101
 102         #: Field current limiter time constant (&gt; 0.)
 103         self.th = th
 104
 105         #: Exciter internal reactance (&gt;= 0.)
 106         self.kd = kd
 107
 108         #: Maximum controller element output (&gt; 0.)
 109         self.vamax = vamax
 110
 111         #: Time constant (&gt;= 0.)
 112         self.tb = tb
 113
 114         #: Field voltage value 1     (&gt; 0.)
 115         self.e1 = e1
 116
 117         #: Minimum controller element output (&lt; 0.)
 118         self.vamin = vamin
 119
 120         #: Saturation factor at e2  (&gt;= 0.)
 121         self.se2 = se2
 122
 123         super(ExcAC6A, self).__init__(*args, **kw_args)
 124
 125     _attrs = ["te", "ka", "vhmax", "kh", "tk", "ke", "se1", "tr", "vrmin", "vrmax", "tc", "e2", "tj", "kc", "vfelim", "ta", "th", "kd", "vamax", "tb", "e1", "vamin", "se2"]
 126     _attr_types = {"te": float, "ka": float, "vhmax": float, "kh": float, "tk": float, "ke": float, "se1": float, "tr": float, "vrmin": float, "vrmax": float, "tc": float, "e2": float, "tj": float, "kc": float, "vfelim": float, "ta": float, "th": float, "kd": float, "vamax": float, "tb": float, "e1": float, "vamin": float, "se2": float}
 127     _defaults = {"te": 0.0, "ka": 0.0, "vhmax": 0.0, "kh": 0.0, "tk": 0.0, "ke": 0.0, "se1": 0.0, "tr": 0.0, "vrmin": 0.0, "vrmax": 0.0, "tc": 0.0, "e2": 0.0, "tj": 0.0, "kc": 0.0, "vfelim": 0.0, "ta": 0.0, "th": 0.0, "kd": 0.0, "vamax": 0.0, "tb": 0.0, "e1": 0.0, "vamin": 0.0, "se2": 0.0}
 128     _enums = {}
 129     _refs = []
 130     _many_refs = []
 131