cimpy.cgmes_v2_4_15.SynchronousMachine module
- class cimpy.cgmes_v2_4_15.SynchronousMachine.SynchronousMachine(InitialReactiveCapabilityCurve=None, maxQ=0.0, minQ=0.0, qPercent=0.0, type=None, earthing=False, earthingStarPointR=0.0, earthingStarPointX=0.0, ikk=0.0, mu=0.0, r0=0.0, r2=0.0, satDirectSubtransX=0.0, satDirectSyncX=0.0, satDirectTransX=0.0, shortCircuitRotorType=None, voltageRegulationRange=0.0, r=0.0, x0=0.0, x2=0.0, operatingMode=None, referencePriority=0, SynchronousMachineDynamics=None, *args, **kw_args)[source]
An electromechanical device that operates with shaft rotating synchronously with the network. It is a single machine operating either as a generator or synchronous condenser or pump.
- InitialReactiveCapabilityCurve
Synchronous machines using this curve as default. Default: None
- maxQ
Maximum reactive power limit. This is the maximum (nameplate) limit for the unit. Default: 0.0
- minQ
Minimum reactive power limit for the unit. Default: 0.0
- qPercent
Percent of the coordinated reactive control that comes from this machine. Default: 0.0
- type
Modes that this synchronous machine can operate in. Default: None
- earthing
Indicates whether or not the generator is earthed. Used for short circuit data exchange according to IEC 60909 Default: False
- earthingStarPointR
Generator star point earthing resistance (Re). Used for short circuit data exchange according to IEC 60909 Default: 0.0
- earthingStarPointX
Generator star point earthing reactance (Xe). Used for short circuit data exchange according to IEC 60909 Default: 0.0
- ikk
Steady-state short-circuit current (in A for the profile) of generator with compound excitation during 3-phase short circuit. - Ikk=0: Generator with no compound excitation. - Ikk?0: Generator with compound excitation. Ikk is used to calculate the minimum steady-state short-circuit current for generators with compound excitation (Section 4.6.1.2 in the IEC 60909-0) Used only for single fed short circuit on a generator. (Section 4.3.4.2. in the IEC 60909-0) Default: 0.0
- mu
Factor to calculate the breaking current (Section 4.5.2.1 in the IEC 60909-0). Used only for single fed short circuit on a generator (Section 4.3.4.2. in the IEC 60909-0). Default: 0.0
- r0
Zero sequence resistance of the synchronous machine. Default: 0.0
- r2
Negative sequence resistance. Default: 0.0
- satDirectSubtransX
Direct-axis subtransient reactance saturated, also known as Xd`sat. Default: 0.0
- satDirectSyncX
Direct-axes saturated synchronous reactance (xdsat); reciprocal of short-circuit ration. Used for short circuit data exchange, only for single fed short circuit on a generator. (Section 4.3.4.2. in the IEC 60909-0). Default: 0.0
- satDirectTransX
Saturated Direct-axis transient reactance. The attribute is primarily used for short circuit calculations according to ANSI. Default: 0.0
- shortCircuitRotorType
Type of rotor, used by short circuit applications, only for single fed short circuit according to IEC 60909. Default: None
- voltageRegulationRange
Range of generator voltage regulation (PG in the IEC 60909-0) used for calculation of the impedance correction factor KG defined in IEC 60909-0 This attribute is used to describe the operating voltage of the generating unit. Default: 0.0
- r
Equivalent resistance (RG) of generator. RG is considered for the calculation of all currents, except for the calculation of the peak current ip. Used for short circuit data exchange according to IEC 60909 Default: 0.0
- x0
Zero sequence reactance of the synchronous machine. Default: 0.0
- x2
Negative sequence reactance. Default: 0.0
- operatingMode
Current mode of operation. Default: None
- referencePriority
Priority of unit for use as powerflow voltage phase angle reference bus selection. 0 = don t care (default) 1 = highest priority. 2 is less than 1 and so on. Default: 0
- SynchronousMachineDynamics
Synchronous machine dynamics model used to describe dynamic behavior of this synchronous machine. Default: None
Documentation of parent class RotatingMachine:
A rotating machine which may be used as a generator or motor.
- GeneratingUnit
A synchronous machine may operate as a generator and as such becomes a member of a generating unit. Default: None
- HydroPump
The synchronous machine drives the turbine which moves the water from a low elevation to a higher elevation. The direction of machine rotation for pumping may or may not be the same as for generating. Default: None
- ratedPowerFactor
Power factor (nameplate data). It is primarily used for short circuit data exchange according to IEC 60909. Default: 0.0
- ratedS
Nameplate apparent power rating for the unit. The attribute shall have a positive value. Default: 0.0
- ratedU
Rated voltage (nameplate data, Ur in IEC 60909-0). It is primarily used for short circuit data exchange according to IEC 60909. Default: 0.0
- p
Active power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution. Default: 0.0
- q
Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution. Default: 0.0
Documentation of parent class RegulatingCondEq:
A type of conducting equipment that can regulate a quantity (i.e. voltage or flow) at a specific point in the network.
- RegulatingControl
The regulating control scheme in which this equipment participates. Default: None
- controlEnabled
Specifies the regulation status of the equipment. True is regulating, false is not regulating. Default: False
Documentation of parent class ConductingEquipment:
The parts of the AC power system that are designed to carry current or that are conductively connected through terminals.
- BaseVoltage
All conducting equipment with this base voltage. Use only when there is no voltage level container used and only one base voltage applies. For example, not used for transformers. Default: None
- Terminals
Conducting equipment have terminals that may be connected to other conducting equipment terminals via connectivity nodes or topological nodes. Default: “list”
- SvStatus
The status state variable associated with this conducting equipment. Default: None
Documentation of parent class Equipment:
The parts of a power system that are physical devices, electronic or mechanical.
- aggregate
The single instance of equipment represents multiple pieces of equipment that have been modeled together as an aggregate. Examples would be power transformers or synchronous machines operating in parallel modeled as a single aggregate power transformer or aggregate synchronous machine. This is not to be used to indicate equipment that is part of a group of interdependent equipment produced by a network production program. Default: False
- EquipmentContainer
Container of this equipment. Default: None
- OperationalLimitSet
The operational limit sets associated with this equipment. Default: “list”
Documentation of parent class PowerSystemResource:
A power system resource can be an item of equipment such as a switch, an equipment container containing many individual items of equipment such as a substation, or an organisational entity such as sub-control area. Power system resources can have measurements associated.
- Controls
Regulating device governed by this control output. Default: “list”
- Measurements
The power system resource that contains the measurement. Default: “list”
- Location
Location of this power system resource. Default: None
Documentation of parent class IdentifiedObject:
This is a root class to provide common identification for all classes needing identification and naming attributes.
- DiagramObjects
The domain object to which this diagram object is associated. Default: “list”
- mRID
Master resource identifier issued by a model authority. The mRID is globally unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552 Edition 1, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements. Default: ‘’
- name
The name is any free human readable and possibly non unique text naming the object. Default: ‘’
- description
The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy. Default: ‘’
- energyIdentCodeEic
The attribute is used for an exchange of the EIC code (Energy identification Code). The length of the string is 16 characters as defined by the EIC code. References: Default: ‘’
- shortName
The attribute is used for an exchange of a human readable short name with length of the string 12 characters maximum. Default: ‘’
Inheritance Diagram:
