CIM14/IEC61970/Dynamics/ExcitationSystems/ExcSCRX.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 ExcSCRX(ExcitationSystem):
  24     """Simple excitation system model representing generic characteristics of many excitation systems; intended for use where negative field current may be a problem
  25     """
  26
  27     def __init__(self, tb=0.0, cswitch=False, emin=0.0, k=0.0, te=0.0, emax=0.0, tatb=0.0, rcrfd=0.0, *args, **kw_args):
  28         """Initialises a new 'ExcSCRX' instance.
  29
  30         @param tb: Denominator time constant of lag-lead block
  31         @param cswitch: Power source switch:     1 ? fixed voltage     0 ? generator terminal voltage
  32         @param emin: Minimum field voltage output
  33         @param k: Gain (&gt; 0.)
  34         @param te: Time constant of gain block (&gt; 0.)
  35         @param emax: Maximum field voltage output
  36         @param tatb: Ta/Tb - gain reduction ratio of lag-lead element
  37         @param rcrfd: Rc/Rfd - ratio of field discharge resistance to field winding resistance
  38         """
  39         #: Denominator time constant of lag-lead block
  40         self.tb = tb
  41
  42         #: Power source switch:     1 ? fixed voltage     0 ? generator terminal voltage
  43         self.cswitch = cswitch
  44
  45         #: Minimum field voltage output
  46         self.emin = emin
  47
  48         #: Gain (&gt; 0.)
  49         self.k = k
  50
  51         #: Time constant of gain block (&gt; 0.)
  52         self.te = te
  53
  54         #: Maximum field voltage output
  55         self.emax = emax
  56
  57         #: Ta/Tb - gain reduction ratio of lag-lead element
  58         self.tatb = tatb
  59
  60         #: Rc/Rfd - ratio of field discharge resistance to field winding resistance
  61         self.rcrfd = rcrfd
  62
  63         super(ExcSCRX, self).__init__(*args, **kw_args)
  64
  65     _attrs = ["tb", "cswitch", "emin", "k", "te", "emax", "tatb", "rcrfd"]
  66     _attr_types = {"tb": float, "cswitch": bool, "emin": float, "k": float, "te": float, "emax": float, "tatb": float, "rcrfd": float}
  67     _defaults = {"tb": 0.0, "cswitch": False, "emin": 0.0, "k": 0.0, "te": 0.0, "emax": 0.0, "tatb": 0.0, "rcrfd": 0.0}
  68     _enums = {}
  69     _refs = []
  70     _many_refs = []
  71