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