CIM14/IEC61970/Dynamics/ExcitationSystems/ExcST5B.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 ExcST5B(ExcitationSystem):
  24     """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.
  25     """
  26
  27     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):
  28         """Initialises a new 'ExcST5B' instance.
  29
  30         @param tb2: Regulator lag time constant (&gt;= 0.)
  31         @param tb1: Regulator lag time constant (&gt;= 0.)
  32         @param tub2: UEL lag time constant (&gt;= 0.)
  33         @param tuc1: UEL lead time constant.
  34         @param kr: Regulator gain (&gt; 0.)
  35         @param tob2: OEL lag time constant (&gt;= 0.)
  36         @param tob1: OEL lag time constant (&gt;= 0.)
  37         @param tc1: Regulator lead time constant
  38         @param toc1: OEL lead time constant
  39         @param tub1: UEL lag time constant (&gt;= 0.)
  40         @param tc2: Regulator lead time constant.
  41         @param kc: Rectifier regulation factor (&gt;= 0.)
  42         @param vrmax: Maximum regulator output (&gt; 0.)
  43         @param tuc2: UEL lead time constant
  44         @param toc2: OEL lead time constant
  45         @param t1: Firing circuit time constant (&gt;= 0.)
  46         @param tr: Filter time constant (&gt;= 0.)
  47         @param vrmin: Minimum regulator output (&lt; 0.)
  48         """
  49         #: Regulator lag time constant (&gt;= 0.)
  50         self.tb2 = tb2
  51
  52         #: Regulator lag time constant (&gt;= 0.)
  53         self.tb1 = tb1
  54
  55         #: UEL lag time constant (&gt;= 0.)
  56         self.tub2 = tub2
  57
  58         #: UEL lead time constant.
  59         self.tuc1 = tuc1
  60
  61         #: Regulator gain (&gt; 0.)
  62         self.kr = kr
  63
  64         #: OEL lag time constant (&gt;= 0.)
  65         self.tob2 = tob2
  66
  67         #: OEL lag time constant (&gt;= 0.)
  68         self.tob1 = tob1
  69
  70         #: Regulator lead time constant
  71         self.tc1 = tc1
  72
  73         #: OEL lead time constant
  74         self.toc1 = toc1
  75
  76         #: UEL lag time constant (&gt;= 0.)
  77         self.tub1 = tub1
  78
  79         #: Regulator lead time constant.
  80         self.tc2 = tc2
  81
  82         #: Rectifier regulation factor (&gt;= 0.)
  83         self.kc = kc
  84
  85         #: Maximum regulator output (&gt; 0.)
  86         self.vrmax = vrmax
  87
  88         #: UEL lead time constant
  89         self.tuc2 = tuc2
  90
  91         #: OEL lead time constant
  92         self.toc2 = toc2
  93
  94         #: Firing circuit time constant (&gt;= 0.)
  95         self.t1 = t1
  96
  97         #: Filter time constant (&gt;= 0.)
  98         self.tr = tr
  99
 100         #: Minimum regulator output (&lt; 0.)
 101         self.vrmin = vrmin
 102
 103         super(ExcST5B, self).__init__(*args, **kw_args)
 104
 105     _attrs = ["tb2", "tb1", "tub2", "tuc1", "kr", "tob2", "tob1", "tc1", "toc1", "tub1", "tc2", "kc", "vrmax", "tuc2", "toc2", "t1", "tr", "vrmin"]
 106     _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}
 107     _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}
 108     _enums = {}
 109     _refs = []
 110     _many_refs = []
 111