schemata/CIM14/Dynamics/ExcitationSystems/ExcAC1A.py

   1 # Copyright (C) 2010 Richard Lincoln
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA, USA
  16
  17 from CIM14.Dynamics.ExcitationSystems.ExcitationSystem import ExcitationSystem
  18
  19 class ExcAC1A(ExcitationSystem):
  20     """IEEE (1992/2005) AC1A Model The model represents the field-controlled alternator-rectifier excitation systems designated Type AC1A. These excitation systems consist of an alternator main exciter with non-controlled rectifiers.
  21     """
  22
  23     def __init__(self, vrmin=0.0, tr=0.0, vrmax=0.0, ta=0.0, kf=0.0, te=0.0, ka=0.0, vamax=0.0, tb=0.0, e1=0.0, kd=0.0, se1=0.0, vamin=0.0, ke=0.0, kc=0.0, tf=0.0, tc=0.0, e2=0.0, se2=0.0, *args, **kw_args):
  24         """Initialises a new 'ExcAC1A' instance.
  25
  26         @param vrmin: Minimum exciter control signal  (&lt; 0.)
  27         @param tr: Filter time constant (&gt;= 0.)
  28         @param vrmax: Maximum exciter control signal (&gt; 0.)
  29         @param ta: AVR time constant (&gt; 0.)
  30         @param kf: Rate feedback gain (&gt;= 0.)
  31         @param te: Exciter time constant (&gt; 0.)
  32         @param ka: AVR gain (&gt; 0.)
  33         @param vamax: Maximum AVR output (&gt; 0.)
  34         @param tb: TGR lag time constant (&gt;= 0.)
  35         @param e1: Field voltage value 1    (&gt; 0.)
  36         @param kd: Exciter internal reactance  (&gt;= 0.)
  37         @param se1: Saturation factor at e1  (&gt;= 0.)
  38         @param vamin: Minimum AVR output (&lt; 0.)
  39         @param ke: Exciter field resistance constant
  40         @param kc: Rectifier regulation factor (&gt;= 0.)
  41         @param tf: Rate feedback time constant (&gt; 0.)
  42         @param tc: TGR lead time constant
  43         @param e2: Field voltage value 2.   (&gt; 0.)
  44         @param se2: Saturation factor at e2   (&gt;= 0.)
  45         """
  46         #: Minimum exciter control signal  (&lt; 0.)
  47         self.vrmin = vrmin
  48
  49         #: Filter time constant (&gt;= 0.)
  50         self.tr = tr
  51
  52         #: Maximum exciter control signal (&gt; 0.)
  53         self.vrmax = vrmax
  54
  55         #: AVR time constant (&gt; 0.)
  56         self.ta = ta
  57
  58         #: Rate feedback gain (&gt;= 0.)
  59         self.kf = kf
  60
  61         #: Exciter time constant (&gt; 0.)
  62         self.te = te
  63
  64         #: AVR gain (&gt; 0.)
  65         self.ka = ka
  66
  67         #: Maximum AVR output (&gt; 0.)
  68         self.vamax = vamax
  69
  70         #: TGR lag time constant (&gt;= 0.)
  71         self.tb = tb
  72
  73         #: Field voltage value 1    (&gt; 0.)
  74         self.e1 = e1
  75
  76         #: Exciter internal reactance  (&gt;= 0.)
  77         self.kd = kd
  78
  79         #: Saturation factor at e1  (&gt;= 0.)
  80         self.se1 = se1
  81
  82         #: Minimum AVR output (&lt; 0.)
  83         self.vamin = vamin
  84
  85         #: Exciter field resistance constant
  86         self.ke = ke
  87
  88         #: Rectifier regulation factor (&gt;= 0.)
  89         self.kc = kc
  90
  91         #: Rate feedback time constant (&gt; 0.)
  92         self.tf = tf
  93
  94         #: TGR lead time constant
  95         self.tc = tc
  96
  97         #: Field voltage value 2.   (&gt; 0.)
  98         self.e2 = e2
  99
 100         #: Saturation factor at e2   (&gt;= 0.)
 101         self.se2 = se2
 102
 103         super(ExcAC1A, self).__init__(*args, **kw_args)
 104
 105     _attrs = ["vrmin", "tr", "vrmax", "ta", "kf", "te", "ka", "vamax", "tb", "e1", "kd", "se1", "vamin", "ke", "kc", "tf", "tc", "e2", "se2"]
 106     _attr_types = {"vrmin": float, "tr": float, "vrmax": float, "ta": float, "kf": float, "te": float, "ka": float, "vamax": float, "tb": float, "e1": float, "kd": float, "se1": float, "vamin": float, "ke": float, "kc": float, "tf": float, "tc": float, "e2": float, "se2": float}
 107     _defaults = {"vrmin": 0.0, "tr": 0.0, "vrmax": 0.0, "ta": 0.0, "kf": 0.0, "te": 0.0, "ka": 0.0, "vamax": 0.0, "tb": 0.0, "e1": 0.0, "kd": 0.0, "se1": 0.0, "vamin": 0.0, "ke": 0.0, "kc": 0.0, "tf": 0.0, "tc": 0.0, "e2": 0.0, "se2": 0.0}
 108     _enums = {}
 109     _refs = []
 110     _many_refs = []
 111