CIM14/IEC61970/Dynamics/ExcitationSystems/ExcST1A.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 ExcST1A(ExcitationSystem):
  24     """IEEE (1992/2005) ST1A Model  The computer model of the Type ST1A potential-source controlled-rectifier excitation system represents systems in which excitation power is supplied through a transformer from the generator terminals (or the unit's auxiliary bus) and is regulated by a controlled rectifier. The maximum exciter voltage available from such systems is directly related to the generator terminal voltage.
  25     """
  26
  27     def __init__(self, ta=0.0, vimin=0.0, vamin=0.0, kf=0.0, vrmin=0.0, ka=0.0, tb=0.0, vamax=0.0, tb1=0.0, uelin=0.0, kc=0.0, tc1=0.0, tf=0.0, klr=0.0, vimax=0.0, tc=0.0, pssin=0.0, vrmax=0.0, tr=0.0, ilr=0.0, *args, **kw_args):
  28         """Initialises a new 'ExcST1A' instance.
  29
  30         @param ta: Time constant (&gt;= 0.)
  31         @param vimin: Minimum error (&lt; 0.)
  32         @param vamin: Minimum control element output (&lt; 0.)
  33         @param kf: Rate feedback gain (&gt;= 0.)
  34         @param vrmin: Excitation voltage lower limit (&lt; 0.)
  35         @param ka: Gain (&gt; 0.)
  36         @param tb: Lag time constant (&gt;= 0.)
  37         @param vamax: Maximum control element output (&gt; 0.)
  38         @param tb1: Lag time constant (&gt;= 0.)
  39         @param uelin: = 2 ? UEL input added to error signal = 1 ? UEL input HV gate with error signal = -1 ? UEL input HV gate with volt. reg. output = 0 ? ignore UEL signal
  40         @param kc: Excitation system regulation factor (&gt;= 0.)
  41         @param tc1: Lead time constant
  42         @param tf: Rate feedback time constant (&gt;= 0.)
  43         @param klr: Gain on field current limit
  44         @param vimax: Maximum error (&gt; 0.)
  45         @param tc: Lead time constant
  46         @param pssin: = 0 ? PSS input (Vs) added to error signal not 0 ? PSS input (Vs) added to voltage regulator output
  47         @param vrmax: Excitation voltage upper limit (&gt; 0.)
  48         @param tr: Voltage transducer time constant (&gt;= 0.)
  49         @param ilr: Maximum field current
  50         """
  51         #: Time constant (&gt;= 0.)
  52         self.ta = ta
  53
  54         #: Minimum error (&lt; 0.)
  55         self.vimin = vimin
  56
  57         #: Minimum control element output (&lt; 0.)
  58         self.vamin = vamin
  59
  60         #: Rate feedback gain (&gt;= 0.)
  61         self.kf = kf
  62
  63         #: Excitation voltage lower limit (&lt; 0.)
  64         self.vrmin = vrmin
  65
  66         #: Gain (&gt; 0.)
  67         self.ka = ka
  68
  69         #: Lag time constant (&gt;= 0.)
  70         self.tb = tb
  71
  72         #: Maximum control element output (&gt; 0.)
  73         self.vamax = vamax
  74
  75         #: Lag time constant (&gt;= 0.)
  76         self.tb1 = tb1
  77
  78         #: = 2 ? UEL input added to error signal = 1 ? UEL input HV gate with error signal = -1 ? UEL input HV gate with volt. reg. output = 0 ? ignore UEL signal
  79         self.uelin = uelin
  80
  81         #: Excitation system regulation factor (&gt;= 0.)
  82         self.kc = kc
  83
  84         #: Lead time constant
  85         self.tc1 = tc1
  86
  87         #: Rate feedback time constant (&gt;= 0.)
  88         self.tf = tf
  89
  90         #: Gain on field current limit
  91         self.klr = klr
  92
  93         #: Maximum error (&gt; 0.)
  94         self.vimax = vimax
  95
  96         #: Lead time constant
  97         self.tc = tc
  98
  99         #: = 0 ? PSS input (Vs) added to error signal not 0 ? PSS input (Vs) added to voltage regulator output
 100         self.pssin = pssin
 101
 102         #: Excitation voltage upper limit (&gt; 0.)
 103         self.vrmax = vrmax
 104
 105         #: Voltage transducer time constant (&gt;= 0.)
 106         self.tr = tr
 107
 108         #: Maximum field current
 109         self.ilr = ilr
 110
 111         super(ExcST1A, self).__init__(*args, **kw_args)
 112
 113     _attrs = ["ta", "vimin", "vamin", "kf", "vrmin", "ka", "tb", "vamax", "tb1", "uelin", "kc", "tc1", "tf", "klr", "vimax", "tc", "pssin", "vrmax", "tr", "ilr"]
 114     _attr_types = {"ta": float, "vimin": float, "vamin": float, "kf": float, "vrmin": float, "ka": float, "tb": float, "vamax": float, "tb1": float, "uelin": float, "kc": float, "tc1": float, "tf": float, "klr": float, "vimax": float, "tc": float, "pssin": float, "vrmax": float, "tr": float, "ilr": float}
 115     _defaults = {"ta": 0.0, "vimin": 0.0, "vamin": 0.0, "kf": 0.0, "vrmin": 0.0, "ka": 0.0, "tb": 0.0, "vamax": 0.0, "tb1": 0.0, "uelin": 0.0, "kc": 0.0, "tc1": 0.0, "tf": 0.0, "klr": 0.0, "vimax": 0.0, "tc": 0.0, "pssin": 0.0, "vrmax": 0.0, "tr": 0.0, "ilr": 0.0}
 116     _enums = {}
 117     _refs = []
 118     _many_refs = []
 119