CIM14/Dynamics/ExcitationSystems/ExcST5B.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 ExcST5B(ExcitationSystem):
  20     """IEEE (2005) ST5B Model  The Type ST5B excitation system is a variation of the Type ST1A model, with alternative overexcitation and underexcitation inputs and additional limits. The corresponding stabilizer models that can be used with these models are the Type PSS2B, PSS3B, or PSS4B.
  21     """
  22
  23     def __init__(self, tb2=0.0, tb1=0.0, tub2=0.0, tuc1=0.0, kr=0.0, tob2=0.0, tob1=0.0, tc1=0.0, toc1=0.0, tub1=0.0, tc2=0.0, kc=0.0, vrmax=0.0, tuc2=0.0, toc2=0.0, t1=0.0, tr=0.0, vrmin=0.0, *args, **kw_args):
  24         """Initialises a new 'ExcST5B' instance.
  25
  26         @param tb2: Regulator lag time constant (&gt;= 0.)
  27         @param tb1: Regulator lag time constant (&gt;= 0.)
  28         @param tub2: UEL lag time constant (&gt;= 0.)
  29         @param tuc1: UEL lead time constant.
  30         @param kr: Regulator gain (&gt; 0.)
  31         @param tob2: OEL lag time constant (&gt;= 0.)
  32         @param tob1: OEL lag time constant (&gt;= 0.)
  33         @param tc1: Regulator lead time constant
  34         @param toc1: OEL lead time constant
  35         @param tub1: UEL lag time constant (&gt;= 0.)
  36         @param tc2: Regulator lead time constant.
  37         @param kc: Rectifier regulation factor (&gt;= 0.)
  38         @param vrmax: Maximum regulator output (&gt; 0.)
  39         @param tuc2: UEL lead time constant
  40         @param toc2: OEL lead time constant
  41         @param t1: Firing circuit time constant (&gt;= 0.)
  42         @param tr: Filter time constant (&gt;= 0.)
  43         @param vrmin: Minimum regulator output (&lt; 0.)
  44         """
  45         #: Regulator lag time constant (&gt;= 0.)
  46         self.tb2 = tb2
  47
  48         #: Regulator lag time constant (&gt;= 0.)
  49         self.tb1 = tb1
  50
  51         #: UEL lag time constant (&gt;= 0.)
  52         self.tub2 = tub2
  53
  54         #: UEL lead time constant.
  55         self.tuc1 = tuc1
  56
  57         #: Regulator gain (&gt; 0.)
  58         self.kr = kr
  59
  60         #: OEL lag time constant (&gt;= 0.)
  61         self.tob2 = tob2
  62
  63         #: OEL lag time constant (&gt;= 0.)
  64         self.tob1 = tob1
  65
  66         #: Regulator lead time constant
  67         self.tc1 = tc1
  68
  69         #: OEL lead time constant
  70         self.toc1 = toc1
  71
  72         #: UEL lag time constant (&gt;= 0.)
  73         self.tub1 = tub1
  74
  75         #: Regulator lead time constant.
  76         self.tc2 = tc2
  77
  78         #: Rectifier regulation factor (&gt;= 0.)
  79         self.kc = kc
  80
  81         #: Maximum regulator output (&gt; 0.)
  82         self.vrmax = vrmax
  83
  84         #: UEL lead time constant
  85         self.tuc2 = tuc2
  86
  87         #: OEL lead time constant
  88         self.toc2 = toc2
  89
  90         #: Firing circuit time constant (&gt;= 0.)
  91         self.t1 = t1
  92
  93         #: Filter time constant (&gt;= 0.)
  94         self.tr = tr
  95
  96         #: Minimum regulator output (&lt; 0.)
  97         self.vrmin = vrmin
  98
  99         super(ExcST5B, self).__init__(*args, **kw_args)
 100
 101     _attrs = ["tb2", "tb1", "tub2", "tuc1", "kr", "tob2", "tob1", "tc1", "toc1", "tub1", "tc2", "kc", "vrmax", "tuc2", "toc2", "t1", "tr", "vrmin"]
 102     _attr_types = {"tb2": float, "tb1": float, "tub2": float, "tuc1": float, "kr": float, "tob2": float, "tob1": float, "tc1": float, "toc1": float, "tub1": float, "tc2": float, "kc": float, "vrmax": float, "tuc2": float, "toc2": float, "t1": float, "tr": float, "vrmin": float}
 103     _defaults = {"tb2": 0.0, "tb1": 0.0, "tub2": 0.0, "tuc1": 0.0, "kr": 0.0, "tob2": 0.0, "tob1": 0.0, "tc1": 0.0, "toc1": 0.0, "tub1": 0.0, "tc2": 0.0, "kc": 0.0, "vrmax": 0.0, "tuc2": 0.0, "toc2": 0.0, "t1": 0.0, "tr": 0.0, "vrmin": 0.0}
 104     _enums = {}
 105     _refs = []
 106     _many_refs = []
 107