CIM14/IEC61970/Dynamics/ExcitationSystems/ExcDC3A.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 ExcDC3A(ExcitationSystem):
  24     """IEEE (1992/2005) DC3A Model  The Type DC3A model is used to represent older systems, in particular those dc commutator exciters with non-continuously acting regulators that were commonly used before the development of the continuously acting varieties. These systems respond at basically two different rates, depending upon the magnitude of voltage error. For small errors, adjustment is made periodically with a signal to a motor-operated rheostat. Larger errors cause resistors to be quickly shorted or inserted and a strong forcing signal applied to the exciter. Continuous motion of the motor-operated rheostat occurs for these larger error signals, even though it is bypassed by contactor action.
  25     """
  26
  27     def __init__(self, e1=0.0, vrmax=0.0, te=0.0, ke=0.0, tr=0.0, se2=0.0, trh=0.0, vrmin=0.0, exclim=0.0, e2=0.0, kv=0.0, se1=0.0, *args, **kw_args):
  28         """Initialises a new 'ExcDC3A' instance.
  29
  30         @param e1: Field voltage value 1    (&gt; 0.)
  31         @param vrmax: Maximum control element output (&gt; 0.)
  32         @param te: Exciter field time constant (&gt; 0.)
  33         @param ke: Exciter field resistance line slope
  34         @param tr: Filter  time constant (&gt;= 0.)
  35         @param se2: Saturation factor at e2  (&gt;= 0.)
  36         @param trh: Rheostat full range travel time (&gt; 0.)
  37         @param vrmin: Minimum control element output (&lt;= 0.)
  38         @param exclim: If not 0, apply lower limit of 0. to exciter output
  39         @param e2: Field voltage value 2.     (&gt; 0.)
  40         @param kv: Voltage error threshold min/max control action (&gt; 0.)
  41         @param se1: Saturation factor at e1 (&gt;= 0.)
  42         """
  43         #: Field voltage value 1    (&gt; 0.)
  44         self.e1 = e1
  45
  46         #: Maximum control element output (&gt; 0.)
  47         self.vrmax = vrmax
  48
  49         #: Exciter field time constant (&gt; 0.)
  50         self.te = te
  51
  52         #: Exciter field resistance line slope
  53         self.ke = ke
  54
  55         #: Filter  time constant (&gt;= 0.)
  56         self.tr = tr
  57
  58         #: Saturation factor at e2  (&gt;= 0.)
  59         self.se2 = se2
  60
  61         #: Rheostat full range travel time (&gt; 0.)
  62         self.trh = trh
  63
  64         #: Minimum control element output (&lt;= 0.)
  65         self.vrmin = vrmin
  66
  67         #: If not 0, apply lower limit of 0. to exciter output
  68         self.exclim = exclim
  69
  70         #: Field voltage value 2.     (&gt; 0.)
  71         self.e2 = e2
  72
  73         #: Voltage error threshold min/max control action (&gt; 0.)
  74         self.kv = kv
  75
  76         #: Saturation factor at e1 (&gt;= 0.)
  77         self.se1 = se1
  78
  79         super(ExcDC3A, self).__init__(*args, **kw_args)
  80
  81     _attrs = ["e1", "vrmax", "te", "ke", "tr", "se2", "trh", "vrmin", "exclim", "e2", "kv", "se1"]
  82     _attr_types = {"e1": float, "vrmax": float, "te": float, "ke": float, "tr": float, "se2": float, "trh": float, "vrmin": float, "exclim": float, "e2": float, "kv": float, "se1": float}
  83     _defaults = {"e1": 0.0, "vrmax": 0.0, "te": 0.0, "ke": 0.0, "tr": 0.0, "se2": 0.0, "trh": 0.0, "vrmin": 0.0, "exclim": 0.0, "e2": 0.0, "kv": 0.0, "se1": 0.0}
  84     _enums = {}
  85     _refs = []
  86     _many_refs = []
  87