schemata/CIM14/Dynamics/ExcitationSystems/ExcAC5A.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 ExcAC5A(ExcitationSystem):
  20     """IEEE (1992/2005) AC5A Model  The model designated as Type AC5A, is a simplified model for brushless excitation systems. The regulator is supplied from a source, such as a permanent magnet generator, which is not affected by system disturbances. Unlike other ac models, this model uses loaded rather than open circuit exciter saturation data in the same way as it is used for the dc models. Because the model has been widely implemented by the industry, it is sometimes used to represent other types of systems when either detailed data for them are not available or simplified models are required.
  21     """
  22
  23     def __init__(self, ka=0.0, e1=0.0, kf=0.0, te=0.0, vrmin=0.0, vrmax=0.0, se2=0.0, tf3=0.0, e2=0.0, ke=0.0, tr=0.0, se1=0.0, tf2=0.0, tf1=0.0, ta=0.0, *args, **kw_args):
  24         """Initialises a new 'ExcAC5A' instance.
  25
  26         @param ka: Gain  (&gt; 0.)
  27         @param e1: Field voltage value 1      (&gt; 0.)
  28         @param kf: Rate feedback gain (&gt;= 0.)
  29         @param te: Exciter time constant, sec. (&gt; 0.)
  30         @param vrmin: Minimum controller output (&lt;  0.)
  31         @param vrmax: Maximum controller output (&gt; 0.)
  32         @param se2: Saturation factor at e2 (&gt;= 0.)
  33         @param tf3: Rate feedback lead time constant
  34         @param e2: Field voltage value 2.  (&gt; 0.)
  35         @param ke: Exciter field resistance line slope
  36         @param tr: Filter time constant (&gt;= 0.)
  37         @param se1: Saturation factor at e1  (&gt;= 0.)
  38         @param tf2: Rate feedback lag time constant (&gt;= 0.)
  39         @param tf1: Rate feedback lag time constant (&gt; 0.)
  40         @param ta: Time constant (&gt; 0.)
  41         """
  42         #: Gain  (&gt; 0.)
  43         self.ka = ka
  44
  45         #: Field voltage value 1      (&gt; 0.)
  46         self.e1 = e1
  47
  48         #: Rate feedback gain (&gt;= 0.)
  49         self.kf = kf
  50
  51         #: Exciter time constant, sec. (&gt; 0.)
  52         self.te = te
  53
  54         #: Minimum controller output (&lt;  0.)
  55         self.vrmin = vrmin
  56
  57         #: Maximum controller output (&gt; 0.)
  58         self.vrmax = vrmax
  59
  60         #: Saturation factor at e2 (&gt;= 0.)
  61         self.se2 = se2
  62
  63         #: Rate feedback lead time constant
  64         self.tf3 = tf3
  65
  66         #: Field voltage value 2.  (&gt; 0.)
  67         self.e2 = e2
  68
  69         #: Exciter field resistance line slope
  70         self.ke = ke
  71
  72         #: Filter time constant (&gt;= 0.)
  73         self.tr = tr
  74
  75         #: Saturation factor at e1  (&gt;= 0.)
  76         self.se1 = se1
  77
  78         #: Rate feedback lag time constant (&gt;= 0.)
  79         self.tf2 = tf2
  80
  81         #: Rate feedback lag time constant (&gt; 0.)
  82         self.tf1 = tf1
  83
  84         #: Time constant (&gt; 0.)
  85         self.ta = ta
  86
  87         super(ExcAC5A, self).__init__(*args, **kw_args)
  88
  89     _attrs = ["ka", "e1", "kf", "te", "vrmin", "vrmax", "se2", "tf3", "e2", "ke", "tr", "se1", "tf2", "tf1", "ta"]
  90     _attr_types = {"ka": float, "e1": float, "kf": float, "te": float, "vrmin": float, "vrmax": float, "se2": float, "tf3": float, "e2": float, "ke": float, "tr": float, "se1": float, "tf2": float, "tf1": float, "ta": float}
  91     _defaults = {"ka": 0.0, "e1": 0.0, "kf": 0.0, "te": 0.0, "vrmin": 0.0, "vrmax": 0.0, "se2": 0.0, "tf3": 0.0, "e2": 0.0, "ke": 0.0, "tr": 0.0, "se1": 0.0, "tf2": 0.0, "tf1": 0.0, "ta": 0.0}
  92     _enums = {}
  93     _refs = []
  94     _many_refs = []
  95