Package CIM15 :: Package IEC61970 :: Package Wires :: Module SynchronousMachine' :: Class SynchronousMachine
[hide private]
[frames] | no frames]

Class SynchronousMachine

                           object --+                        
                                    |                        
                     Element'.Element --+                    
                                        |                    
  Core.IdentifiedObject'.IdentifiedObject --+                
                                            |                
Core.PowerSystemResource'.PowerSystemResource --+            
                                                |            
                        Core.Equipment'.Equipment --+        
                                                    |        
        Core.ConductingEquipment'.ConductingEquipment --+    
                                                        |    
                       RegulatingCondEq'.RegulatingCondEq --+
                                                            |
                                                           SynchronousMachine

An electromechanical device that operates synchronously with the network. It is a single machine operating either as a generator or synchronous condenser or pump.An electromechanical device that operates synchronously with the network. It is a single machine operating either as a generator or synchronous condenser or pump.

Instance Methods [hide private]
 
__init__(self, ratedS=0.0, r2=0.0, r0=0.0, manualToAVR=0.0, qPercent=0.0, coolantCondition=0.0, condenserP=0.0, xQuadTrans=0.0, xQuadSubtrans=0.0, xQuadSync=0.0, xDirectSync=0.0, minQ=0.0, aVRToManualLag=0.0, damping=0.0, operatingMode='condenser', xDirectSubtrans=0.0, coolantType='air', aVRToManualLead=0.0, minU=0.0, maxQ=0.0, referencePriority=0, maxU=0.0, xDirectTrans=0.0, inertia=0.0, baseQ=0.0, type='condenser', r=0.0, x0=0.0, x2=0.0, x=0.0, PrimeMovers=None, GeneratingUnit=None, ReactiveCapabilityCurves=None, HydroPump=None, InitialReactiveCapabilityCurve=None, *args, **kw_args)
Initialises a new 'SynchronousMachine' instance.
 
addPrimeMovers(self, *PrimeMovers)
 
addReactiveCapabilityCurves(self, *ReactiveCapabilityCurves)
 
getGeneratingUnit(self)
A synchronous machine may operate as a generator and as such becomes a member of a generating unit
 
getHydroPump(self)
The synchronous machine drives the turbine which moves the water from a low elevation to a higher elevation.
 
getInitialReactiveCapabilityCurve(self)
The default ReactiveCapabilityCurve for use by a SynchronousMachine
 
getPrimeMovers(self)
Prime movers that drive this SynchronousMachine.
 
getReactiveCapabilityCurves(self)
All available Reactive capability curves for this SynchronousMachine.
 
removePrimeMovers(self, *PrimeMovers)
 
removeReactiveCapabilityCurves(self, *ReactiveCapabilityCurves)
 
setGeneratingUnit(self, value)
 
setHydroPump(self, value)
 
setInitialReactiveCapabilityCurve(self, value)
 
setPrimeMovers(self, value)
 
setReactiveCapabilityCurves(self, value)

Inherited from RegulatingCondEq'.RegulatingCondEq: addControls, getControls, getRegulatingControl, removeControls, setControls, setRegulatingControl

Inherited from Core.ConductingEquipment'.ConductingEquipment: addClearanceTags, addOutageStepRoles, addProtectionEquipments, addTerminals, getBaseVoltage, getClearanceTags, getOutageStepRoles, getProtectionEquipments, getSvStatus, getTerminals, removeClearanceTags, removeOutageStepRoles, removeProtectionEquipments, removeTerminals, setBaseVoltage, setClearanceTags, setOutageStepRoles, setProtectionEquipments, setSvStatus, setTerminals

Inherited from Core.Equipment'.Equipment: addContingencyEquipment, addCustomerAgreements, getContingencyEquipment, getCustomerAgreements, getEquipmentContainer, removeContingencyEquipment, removeCustomerAgreements, setContingencyEquipment, setCustomerAgreements, setEquipmentContainer

Inherited from Core.PowerSystemResource'.PowerSystemResource: addAssets, addChangeItems, addDocumentRoles, addErpOrganisationRoles, addMeasurements, addNetworkDataSets, addOperatingShare, addPSREvent, addPsrLists, addReportingGroup, addSafetyDocuments, addScheduleSteps, getAssets, getChangeItems, getDocumentRoles, getErpOrganisationRoles, getLocation, getMeasurements, getNetworkDataSets, getOperatingShare, getOutageSchedule, getPSREvent, getPSRType, getPsrLists, getReportingGroup, getSafetyDocuments, getScheduleSteps, removeAssets, removeChangeItems, removeDocumentRoles, removeErpOrganisationRoles, removeMeasurements, removeNetworkDataSets, removeOperatingShare, removePSREvent, removePsrLists, removeReportingGroup, removeSafetyDocuments, removeScheduleSteps, setAssets, setChangeItems, setDocumentRoles, setErpOrganisationRoles, setLocation, setMeasurements, setNetworkDataSets, setOperatingShare, setOutageSchedule, setPSREvent, setPSRType, setPsrLists, setReportingGroup, setSafetyDocuments, setScheduleSteps

Inherited from Core.IdentifiedObject'.IdentifiedObject: addDiagramObjects, addNames, getDiagramObjects, getModelingAuthoritySet, getNames, removeDiagramObjects, removeNames, setDiagramObjects, setModelingAuthoritySet, setNames

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  _attr_types = {'aVRToManualLag': <type 'float'>, 'aVRToManualL...
  _attrs = ['ratedS', 'r2', 'r0', 'manualToAVR', 'qPercent', 'co...
  _defaults = {'aVRToManualLag': 0.0, 'aVRToManualLead': 0.0, 'b...
  _enums = {'coolantType': 'CoolantType', 'operatingMode': 'Sync...
  _many_refs = ['PrimeMovers', 'ReactiveCapabilityCurves']
  _refs = ['PrimeMovers', 'GeneratingUnit', 'ReactiveCapabilityC...
Properties [hide private]
  GeneratingUnit
A synchronous machine may operate as a generator and as such becomes a member of a generating unit
  HydroPump
The synchronous machine drives the turbine which moves the water from a low elevation to a higher elevation.
  InitialReactiveCapabilityCurve
The default ReactiveCapabilityCurve for use by a SynchronousMachine
  PrimeMovers
Prime movers that drive this SynchronousMachine.
  ReactiveCapabilityCurves
All available Reactive capability curves for this SynchronousMachine.

Inherited from RegulatingCondEq'.RegulatingCondEq: Controls, RegulatingControl

Inherited from Core.ConductingEquipment'.ConductingEquipment: BaseVoltage, ClearanceTags, OutageStepRoles, ProtectionEquipments, SvStatus, Terminals

Inherited from Core.Equipment'.Equipment: ContingencyEquipment, CustomerAgreements, EquipmentContainer

Inherited from Core.PowerSystemResource'.PowerSystemResource: Assets, ChangeItems, DocumentRoles, ErpOrganisationRoles, Location, Measurements, NetworkDataSets, OperatingShare, OutageSchedule, PSREvent, PSRType, PsrLists, ReportingGroup, SafetyDocuments, ScheduleSteps

Inherited from Core.IdentifiedObject'.IdentifiedObject: DiagramObjects, ModelingAuthoritySet, Names

Inherited from object: __class__

Method Details [hide private]

__init__(self, ratedS=0.0, r2=0.0, r0=0.0, manualToAVR=0.0, qPercent=0.0, coolantCondition=0.0, condenserP=0.0, xQuadTrans=0.0, xQuadSubtrans=0.0, xQuadSync=0.0, xDirectSync=0.0, minQ=0.0, aVRToManualLag=0.0, damping=0.0, operatingMode='condenser', xDirectSubtrans=0.0, coolantType='air', aVRToManualLead=0.0, minU=0.0, maxQ=0.0, referencePriority=0, maxU=0.0, xDirectTrans=0.0, inertia=0.0, baseQ=0.0, type='condenser', r=0.0, x0=0.0, x2=0.0, x=0.0, PrimeMovers=None, GeneratingUnit=None, ReactiveCapabilityCurves=None, HydroPump=None, InitialReactiveCapabilityCurve=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'SynchronousMachine' instance.

Parameters:
  • ratedS - Nameplate apparent power rating for the unit
  • r2 - Negative sequence resistance.
  • r0 - Zero sequence resistance of the synchronous machine.
  • manualToAVR - Time delay required when switching from Manual to Automatic Voltage Regulation. This value is used in the accelerating power reference frame for powerflow solutions
  • qPercent - Percent of the coordinated reactive control that comes from this machine.
  • coolantCondition - Temperature or pressure of coolant medium
  • condenserP - Active power consumed when in condenser mode operation.
  • xQuadTrans - Quadrature-axis transient reactance, also known as X'q.
  • xQuadSubtrans - Quadrature-axis subtransient reactance, also known as X'q.
  • xQuadSync - Quadrature-axis synchronous reactance (Xq) , the ratio of the component of reactive armature voltage, due to the quadrature-axis component of armature current, to this component of current, under steady state conditions and at rated frequency.
  • xDirectSync - Direct-axis synchronous reactance. The quotient of a sustained value of that AC component of armature voltage that is produced by the total direct-axis flux due to direct-axis armature current and the value of the AC component of this current, the machine running at rated speed. (Xd)
  • minQ - Minimum reactive power limit for the unit.
  • aVRToManualLag - Time delay required when switching from Automatic Voltage Regulation (AVR) to Manual for a lagging MVAr violation.
  • damping - Damping torque coefficient, a proportionality constant that, when multiplied by the angular velocity of the rotor poles with respect to the magnetic field (frequency), results in the damping torque.
  • operatingMode - Current mode of operation. Values are: "condenser", "generator"
  • xDirectSubtrans - Direct-axis subtransient reactance, also known as X'd.
  • coolantType - Method of cooling the machine. Values are: "air", "hydrogenGas", "water"
  • aVRToManualLead - Time delay required when switching from Automatic Voltage Regulation (AVR) to Manual for a leading MVAr violation.
  • minU - Minimum voltage limit for the unit.
  • maxQ - Maximum reactive power limit. This is the maximum (nameplate) limit for the unit.
  • referencePriority - Priority of unit for reference bus selection. 0 = don t care (default) 1 = highest priority. 2 is less than 1 and so on.
  • maxU - Maximum voltage limit for the unit.
  • xDirectTrans - Direct-axis transient reactance, also known as X'd.
  • inertia - The energy stored in the rotor when operating at rated speed. This value is used in the accelerating power reference frame for operator training simulator solutions.
  • baseQ - Default base reactive power value. This value represents the initial reactive power that can be used by any application function.
  • type - Modes that this synchronous machine can operate in. Values are: "condenser", "generator_or_condenser", "generator"
  • r - Positive sequence resistance of the synchronous machine.
  • x0 - Zero sequence reactance of the synchronous machine.
  • x2 - Negative sequence reactance.
  • x - Positive sequence reactance of the synchronous machine.
  • PrimeMovers - Prime movers that drive this SynchronousMachine.
  • GeneratingUnit - A synchronous machine may operate as a generator and as such becomes a member of a generating unit
  • ReactiveCapabilityCurves - All available Reactive capability curves for this SynchronousMachine.
  • 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.
  • InitialReactiveCapabilityCurve - The default ReactiveCapabilityCurve for use by a SynchronousMachine
Overrides: object.__init__

getHydroPump(self)

 

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.


Class Variable Details [hide private]

_attr_types

Value:
{'aVRToManualLag': <type 'float'>,
 'aVRToManualLead': <type 'float'>,
 'baseQ': <type 'float'>,
 'condenserP': <type 'float'>,
 'coolantCondition': <type 'float'>,
 'coolantType': <type 'str'>,
 'damping': <type 'float'>,
 'inertia': <type 'float'>,
...

_attrs

Value:
['ratedS',
 'r2',
 'r0',
 'manualToAVR',
 'qPercent',
 'coolantCondition',
 'condenserP',
 'xQuadTrans',
...

_defaults

Value:
{'aVRToManualLag': 0.0,
 'aVRToManualLead': 0.0,
 'baseQ': 0.0,
 'condenserP': 0.0,
 'coolantCondition': 0.0,
 'coolantType': 'air',
 'damping': 0.0,
 'inertia': 0.0,
...

_enums

Value:
{'coolantType': 'CoolantType',
 'operatingMode': 'SynchronousMachineOperatingMode',
 'type': 'SynchronousMachineType'}

_refs

Value:
['PrimeMovers',
 'GeneratingUnit',
 'ReactiveCapabilityCurves',
 'HydroPump',
 'InitialReactiveCapabilityCurve']

Property Details [hide private]

GeneratingUnit

A synchronous machine may operate as a generator and as such becomes a member of a generating unit

Get Method:
getGeneratingUnit(self) - A synchronous machine may operate as a generator and as such becomes a member of a generating unit
Set Method:
setGeneratingUnit(self, value)

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.

Get Method:
getHydroPump(self) - The synchronous machine drives the turbine which moves the water from a low elevation to a higher elevation.
Set Method:
setHydroPump(self, value)

InitialReactiveCapabilityCurve

The default ReactiveCapabilityCurve for use by a SynchronousMachine

Get Method:
getInitialReactiveCapabilityCurve(self) - The default ReactiveCapabilityCurve for use by a SynchronousMachine
Set Method:
setInitialReactiveCapabilityCurve(self, value)

PrimeMovers

Prime movers that drive this SynchronousMachine.

Get Method:
getPrimeMovers(self) - Prime movers that drive this SynchronousMachine.
Set Method:
setPrimeMovers(self, value)

ReactiveCapabilityCurves

All available Reactive capability curves for this SynchronousMachine.

Get Method:
getReactiveCapabilityCurves(self) - All available Reactive capability curves for this SynchronousMachine.
Set Method:
setReactiveCapabilityCurves(self, value)