CIM14/IEC61970/Dynamics/ExcitationSystems/ExcST4B.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 ExcST4B(ExcitationSystem):
  24     """IEEE (2005) ST4B Model  This model is a variation of the Type ST3A model, with a proportional plus integral (PI) regulator block replacing the lag-lead regulator characteristic that was in the ST3A model. Both potential- and compoundsource rectifier excitation systems are modeled. The PI regulator blocks have nonwindup limits that are represented. The voltage regulator of this model is typically implemented digitally.
  25     """
  26
  27     def __init__(self, kp=0.0, kim=0.0, vbmax=0.0, kc=0.0, kpr=0.0, xl=0.0, vgmax=0.0, vmmin=0.0, kg=0.0, vmmax=0.0, tr=0.0, ta=0.0, kpm=0.0, angp=0.0, vrmin=0.0, kir=0.0, vrmax=0.0, ki=0.0, *args, **kw_args):
  28         """Initialises a new 'ExcST4B' instance.
  29
  30         @param kp: Potential source gain (&gt; 0.)
  31         @param kim: Integral gain of inner loop regulator
  32         @param vbmax: Maximum excitation voltage (&gt; 0.)
  33         @param kc: Exciter regulation factor (&gt;= 0.)
  34         @param kpr: AVR proportional gain
  35         @param xl: P-bar leakage reactance (&gt;= 0.)
  36         @param vgmax: Maximum inner loop feedback gain (&gt;= 0.)
  37         @param vmmin: Minimum inner loop regulator output
  38         @param kg: Inner loop feedback gain (&gt;= 0.)
  39         @param vmmax: Maximum inner loop regulator output
  40         @param tr: Voltage transducer time constant (&gt;= 0.)
  41         @param ta: AVR time constant (&gt;= 0.)
  42         @param kpm: Prop. gain of inner loop regulator
  43         @param angp: Phase angle of potential source
  44         @param vrmin: Minimum AVR output (&lt; 0.)
  45         @param kir: AVR Integral gain
  46         @param vrmax: Maximum AVR output (&gt; 0.)
  47         @param ki: Current source gain (&gt;= 0.)
  48         """
  49         #: Potential source gain (&gt; 0.)
  50         self.kp = kp
  51
  52         #: Integral gain of inner loop regulator
  53         self.kim = kim
  54
  55         #: Maximum excitation voltage (&gt; 0.)
  56         self.vbmax = vbmax
  57
  58         #: Exciter regulation factor (&gt;= 0.)
  59         self.kc = kc
  60
  61         #: AVR proportional gain
  62         self.kpr = kpr
  63
  64         #: P-bar leakage reactance (&gt;= 0.)
  65         self.xl = xl
  66
  67         #: Maximum inner loop feedback gain (&gt;= 0.)
  68         self.vgmax = vgmax
  69
  70         #: Minimum inner loop regulator output
  71         self.vmmin = vmmin
  72
  73         #: Inner loop feedback gain (&gt;= 0.)
  74         self.kg = kg
  75
  76         #: Maximum inner loop regulator output
  77         self.vmmax = vmmax
  78
  79         #: Voltage transducer time constant (&gt;= 0.)
  80         self.tr = tr
  81
  82         #: AVR time constant (&gt;= 0.)
  83         self.ta = ta
  84
  85         #: Prop. gain of inner loop regulator
  86         self.kpm = kpm
  87
  88         #: Phase angle of potential source
  89         self.angp = angp
  90
  91         #: Minimum AVR output (&lt; 0.)
  92         self.vrmin = vrmin
  93
  94         #: AVR Integral gain
  95         self.kir = kir
  96
  97         #: Maximum AVR output (&gt; 0.)
  98         self.vrmax = vrmax
  99
 100         #: Current source gain (&gt;= 0.)
 101         self.ki = ki
 102
 103         super(ExcST4B, self).__init__(*args, **kw_args)
 104
 105     _attrs = ["kp", "kim", "vbmax", "kc", "kpr", "xl", "vgmax", "vmmin", "kg", "vmmax", "tr", "ta", "kpm", "angp", "vrmin", "kir", "vrmax", "ki"]
 106     _attr_types = {"kp": float, "kim": float, "vbmax": float, "kc": float, "kpr": float, "xl": float, "vgmax": float, "vmmin": float, "kg": float, "vmmax": float, "tr": float, "ta": float, "kpm": float, "angp": float, "vrmin": float, "kir": float, "vrmax": float, "ki": float}
 107     _defaults = {"kp": 0.0, "kim": 0.0, "vbmax": 0.0, "kc": 0.0, "kpr": 0.0, "xl": 0.0, "vgmax": 0.0, "vmmin": 0.0, "kg": 0.0, "vmmax": 0.0, "tr": 0.0, "ta": 0.0, "kpm": 0.0, "angp": 0.0, "vrmin": 0.0, "kir": 0.0, "vrmax": 0.0, "ki": 0.0}
 108     _enums = {}
 109     _refs = []
 110     _many_refs = []
 111