Fixing website and API documentation links
[PyCIM.git] / CIM14 / IEC61970 / Dynamics / AsynchronousMachine.py
blob74145fb68818b86096fbd1564ea805ad8f9d3e49
1 # Copyright (C) 2010-2011 Richard Lincoln
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:
10 # The above copyright notice and this permission notice shall be included in
11 # all copies or substantial portions of the Software.
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.
21 from CIM14.IEC61970.Dynamics.RotatingMachine import RotatingMachine
23 class AsynchronousMachine(RotatingMachine):
24 """An asynchronous (induction) machine with no external connection to the rotor windings, e.g squirel-cage induction machine.
25 """
27 def __init__(self, xm=0.0, xs=0.0, xpp=0.0, xlr2=0.0, rr2=0.0, tpo=0.0, rr1=0.0, xp=0.0, tppo=0.0, xlr1=0.0, *args, **kw_args):
28 """Initialises a new 'AsynchronousMachine' instance.
30 @param xm: Magnetizing reactance
31 @param xs: Synchronous reactance (>= Xp)
32 @param xpp: Sub-transient reactance (unsaturated) (> Xl)
33 @param xlr2: Damper 2 winding leakage reactance
34 @param rr2: Damper 2 winding resistance
35 @param tpo: Transient rotor time constant (> Tppo)
36 @param rr1: Damper 1 winding resistance
37 @param xp: Transient reactance (unsaturated) (> =Xpp)
38 @param tppo: Sub-transient rotor time constant (> 0.)
39 @param xlr1: Damper 1 winding leakage reactance
40 """
41 #: Magnetizing reactance
42 self.xm = xm
44 #: Synchronous reactance (>= Xp)
45 self.xs = xs
47 #: Sub-transient reactance (unsaturated) (> Xl)
48 self.xpp = xpp
50 #: Damper 2 winding leakage reactance
51 self.xlr2 = xlr2
53 #: Damper 2 winding resistance
54 self.rr2 = rr2
56 #: Transient rotor time constant (> Tppo)
57 self.tpo = tpo
59 #: Damper 1 winding resistance
60 self.rr1 = rr1
62 #: Transient reactance (unsaturated) (> =Xpp)
63 self.xp = xp
65 #: Sub-transient rotor time constant (> 0.)
66 self.tppo = tppo
68 #: Damper 1 winding leakage reactance
69 self.xlr1 = xlr1
71 super(AsynchronousMachine, self).__init__(*args, **kw_args)
73 _attrs = ["xm", "xs", "xpp", "xlr2", "rr2", "tpo", "rr1", "xp", "tppo", "xlr1"]
74 _attr_types = {"xm": float, "xs": float, "xpp": float, "xlr2": float, "rr2": float, "tpo": float, "rr1": float, "xp": float, "tppo": float, "xlr1": float}
75 _defaults = {"xm": 0.0, "xs": 0.0, "xpp": 0.0, "xlr2": 0.0, "rr2": 0.0, "tpo": 0.0, "rr1": 0.0, "xp": 0.0, "tppo": 0.0, "xlr1": 0.0}
76 _enums = {}
77 _refs = []
78 _many_refs = []