Package CIM15 :: Package IEC61970 :: Package Generation :: Package Production :: Module GeneratingUnit' :: Class GeneratingUnit
[hide private]
[frames] | no frames]

Class GeneratingUnit

                           object --+                
                                    |                
                     Element'.Element --+            
                                        |            
  Core.IdentifiedObject'.IdentifiedObject --+        
                                            |        
Core.PowerSystemResource'.PowerSystemResource --+    
                                                |    
                        Core.Equipment'.Equipment --+
                                                    |
                                                   GeneratingUnit
Known Subclasses:

A single or set of synchronous machines for converting mechanical power into alternating-current power. For example, individual machines within a set may be defined for scheduling purposes while a single control signal is derived for the set. In this case there would be a GeneratingUnit for each member of the set and an additional GeneratingUnit corresponding to the set.A single or set of synchronous machines for converting mechanical power into alternating-current power. For example, individual machines within a set may be defined for scheduling purposes while a single control signal is derived for the set. In this case there would be a GeneratingUnit for each member of the set and an additional GeneratingUnit corresponding to the set.

Instance Methods [hide private]
 
__init__(self, ratedGrossMinP=0.0, efficiency=0.0, stepChange=0.0, ratedNetMaxP=0.0, tieLinePF=0.0, dispReserveFlag=False, controlPulseHigh=0.0, startupTime=0.0, maxOperatingP=0.0, genControlSource='plantControl', normalPF=0.0, initialP=0.0, spinReserveRamp=0.0, allocSpinResP=0.0, minEconomicP=0.0, longPF=0.0, nominalP=0.0, controlResponseRate=0.0, ratedGrossMaxP=0.0, penaltyFactor=0.0, fastStartFlag=False, minimumOffTime=0.0, shortPF=0.0, governorMPL=0.0, energyMinP=0.0, fuelPriority=0, maxEconomicP=0.0, autoCntrlMarginP=0.0, highControlLimit=0.0, modelDetail='', controlPulseLow=0.0, raiseRampRate=0.0, controlDeadband=0.0, baseP=0.0, startupCost=0.0, variableCost=0.0, genOperatingMode='MRN', lowerRampRate=0.0, minOperatingP=0.0, lowControlLimit=0.0, maximumAllowableSpinningReserve=0.0, genControlMode='setpoint', governorSCD=0.0, ControlAreaGeneratingUnit=None, SynchronousMachines=None, GenUnitOpSchedule=None, GrossToNetActivePowerCurves=None, GenUnitOpCostCurves=None, *args, **kw_args)
Initialises a new 'GeneratingUnit' instance.
 
addControlAreaGeneratingUnit(self, *ControlAreaGeneratingUnit)
 
addGenUnitOpCostCurves(self, *GenUnitOpCostCurves)
 
addGrossToNetActivePowerCurves(self, *GrossToNetActivePowerCurves)
 
addSynchronousMachines(self, *SynchronousMachines)
 
getControlAreaGeneratingUnit(self)
ControlArea specifications for this generating unit.
 
getGenUnitOpCostCurves(self)
A generating unit may have one or more cost curves, depending upon fuel mixture and fuel cost.
 
getGenUnitOpSchedule(self)
A generating unit may have an operating schedule, indicating the planned operation of the unit
 
getGrossToNetActivePowerCurves(self)
A generating unit may have a gross active power to net active power curve, describing the losses and auxiliary power requirements of the unit
 
getSynchronousMachines(self)
A synchronous machine may operate as a generator and as such becomes a member of a generating unit
 
removeControlAreaGeneratingUnit(self, *ControlAreaGeneratingUnit)
 
removeGenUnitOpCostCurves(self, *GenUnitOpCostCurves)
 
removeGrossToNetActivePowerCurves(self, *GrossToNetActivePowerCurves)
 
removeSynchronousMachines(self, *SynchronousMachines)
 
setControlAreaGeneratingUnit(self, value)
 
setGenUnitOpCostCurves(self, value)
 
setGenUnitOpSchedule(self, value)
 
setGrossToNetActivePowerCurves(self, value)
 
setSynchronousMachines(self, value)

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 = {'allocSpinResP': <type 'float'>, 'autoCntrlMarg...
  _attrs = ['ratedGrossMinP', 'efficiency', 'stepChange', 'rated...
  _defaults = {'allocSpinResP': 0.0, 'autoCntrlMarginP': 0.0, 'b...
  _enums = {'genControlMode': 'GeneratorControlMode', 'genContro...
  _many_refs = ['ControlAreaGeneratingUnit', 'SynchronousMachine...
  _refs = ['ControlAreaGeneratingUnit', 'SynchronousMachines', '...
Properties [hide private]
  ControlAreaGeneratingUnit
ControlArea specifications for this generating unit.
  GenUnitOpCostCurves
A generating unit may have one or more cost curves, depending upon fuel mixture and fuel cost.
  GenUnitOpSchedule
A generating unit may have an operating schedule, indicating the planned operation of the unit
  GrossToNetActivePowerCurves
A generating unit may have a gross active power to net active power curve, describing the losses and auxiliary power requirements of the unit
  SynchronousMachines
A synchronous machine may operate as a generator and as such becomes a member of a generating unit

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, ratedGrossMinP=0.0, efficiency=0.0, stepChange=0.0, ratedNetMaxP=0.0, tieLinePF=0.0, dispReserveFlag=False, controlPulseHigh=0.0, startupTime=0.0, maxOperatingP=0.0, genControlSource='plantControl', normalPF=0.0, initialP=0.0, spinReserveRamp=0.0, allocSpinResP=0.0, minEconomicP=0.0, longPF=0.0, nominalP=0.0, controlResponseRate=0.0, ratedGrossMaxP=0.0, penaltyFactor=0.0, fastStartFlag=False, minimumOffTime=0.0, shortPF=0.0, governorMPL=0.0, energyMinP=0.0, fuelPriority=0, maxEconomicP=0.0, autoCntrlMarginP=0.0, highControlLimit=0.0, modelDetail='', controlPulseLow=0.0, raiseRampRate=0.0, controlDeadband=0.0, baseP=0.0, startupCost=0.0, variableCost=0.0, genOperatingMode='MRN', lowerRampRate=0.0, minOperatingP=0.0, lowControlLimit=0.0, maximumAllowableSpinningReserve=0.0, genControlMode='setpoint', governorSCD=0.0, ControlAreaGeneratingUnit=None, SynchronousMachines=None, GenUnitOpSchedule=None, GrossToNetActivePowerCurves=None, GenUnitOpCostCurves=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'GeneratingUnit' instance.

Parameters:
  • ratedGrossMinP - The gross rated minimum generation level which the unit can safely operate at while delivering power to the transmission grid
  • efficiency - The efficiency of the unit in converting mechanical energy, from the prime mover, into electrical energy.
  • stepChange
  • ratedNetMaxP - The net rated maximum capacity determined by subtracting the auxiliary power used to operate the internal plant machinery from the rated gross maximum capacity
  • tieLinePF - Generating unit economic participation factor
  • dispReserveFlag
  • controlPulseHigh - Pulse high limit which is the largest control pulse that the unit can respond to
  • startupTime - Time it takes to get the unit on-line, from the time that the prime mover mechanical power is applied
  • maxOperatingP - This is the maximum operating active power limit the dispatcher can enter for this unit
  • genControlSource - The source of controls for a generating unit. Values are: "plantControl", "offAGC", "unavailable", "onAGC"
  • normalPF - Generating unit economic participation factor
  • initialP - Default Initial active power which is used to store a powerflow result for the initial active power for this unit in this network configuration
  • spinReserveRamp
  • allocSpinResP - The planned unused capacity (spinning reserve) which can be used to support emergency load
  • minEconomicP - Low economic active power limit that must be greater than or equal to the minimum operating active power limit
  • longPF - Generating unit economic participation factor
  • nominalP - The nominal power of the generating unit. Used to give precise meaning to percentage based attributes such as the govenor speed change droop (govenorSCD attribute).
  • controlResponseRate - Unit response rate which specifies the active power change for a control pulse of one second in the most responsive loading level of the unit.
  • ratedGrossMaxP - The unit's gross rated maximum capacity (Book Value).
  • penaltyFactor - Defined as: 1 / ( 1 - Incremental Transmission Loss); with the Incremental Transmission Loss expressed as a plus or minus value. The typical range of penalty factors is (0.9 to 1.1).
  • fastStartFlag
  • minimumOffTime - Minimum time interval between unit shutdown and startup
  • shortPF - Generating unit economic participation factor
  • governorMPL - Governor Motor Position Limit
  • energyMinP
  • fuelPriority
  • maxEconomicP - Maximum high economic active power limit, that should not exceed the maximum operating active power limit
  • autoCntrlMarginP - The planned unused capacity which can be used to support automatic control overruns.
  • highControlLimit - High limit for secondary (AGC) control
  • modelDetail - Detail level of the generator model data
  • controlPulseLow - Pulse low limit which is the smallest control pulse that the unit can respond to
  • raiseRampRate
  • controlDeadband - Unit control error deadband. When a unit's desired active power change is less than this deadband, then no control pulses will be sent to the unit.
  • baseP - For dispatchable units, this value represents the economic active power basepoint, for units that are not dispatchable, this value represents the fixed generation value. The value must be between the operating low and high limits.
  • startupCost - The initial startup cost incurred for each start of the GeneratingUnit.
  • variableCost - The variable cost component of production per unit of ActivePower.
  • genOperatingMode - Operating mode for secondary control. Values are: "MRN", "EDC", "LFC", "fixed", "REG", "AGC", "manual", "off"
  • lowerRampRate
  • minOperatingP - This is the minimum operating active power limit the dispatcher can enter for this unit.
  • lowControlLimit - Low limit for secondary (AGC) control
  • maximumAllowableSpinningReserve - Maximum allowable spinning reserve. Spinning reserve will never be considered greater than this value regardless of the current operating point.
  • genControlMode - The unit control mode. Values are: "setpoint", "pulse"
  • governorSCD - Governor Speed Changer Droop. This is the change in generator power output divided by the change in frequency normalized by the nominal power of the generator and the nominal frequency and expressed in percent and negated. A positive value of speed change droop provides additional generator output upon a drop in frequency.
  • ControlAreaGeneratingUnit - ControlArea specifications for this generating unit.
  • SynchronousMachines - A synchronous machine may operate as a generator and as such becomes a member of a generating unit
  • GenUnitOpSchedule - A generating unit may have an operating schedule, indicating the planned operation of the unit
  • GrossToNetActivePowerCurves - A generating unit may have a gross active power to net active power curve, describing the losses and auxiliary power requirements of the unit
  • GenUnitOpCostCurves - A generating unit may have one or more cost curves, depending upon fuel mixture and fuel cost.
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'allocSpinResP': <type 'float'>,
 'autoCntrlMarginP': <type 'float'>,
 'baseP': <type 'float'>,
 'controlDeadband': <type 'float'>,
 'controlPulseHigh': <type 'float'>,
 'controlPulseLow': <type 'float'>,
 'controlResponseRate': <type 'float'>,
 'dispReserveFlag': <type 'bool'>,
...

_attrs

Value:
['ratedGrossMinP',
 'efficiency',
 'stepChange',
 'ratedNetMaxP',
 'tieLinePF',
 'dispReserveFlag',
 'controlPulseHigh',
 'startupTime',
...

_defaults

Value:
{'allocSpinResP': 0.0,
 'autoCntrlMarginP': 0.0,
 'baseP': 0.0,
 'controlDeadband': 0.0,
 'controlPulseHigh': 0.0,
 'controlPulseLow': 0.0,
 'controlResponseRate': 0.0,
 'dispReserveFlag': False,
...

_enums

Value:
{'genControlMode': 'GeneratorControlMode',
 'genControlSource': 'GeneratorControlSource',
 'genOperatingMode': 'GeneratorOperatingMode'}

_many_refs

Value:
['ControlAreaGeneratingUnit',
 'SynchronousMachines',
 'GrossToNetActivePowerCurves',
 'GenUnitOpCostCurves']

_refs

Value:
['ControlAreaGeneratingUnit',
 'SynchronousMachines',
 'GenUnitOpSchedule',
 'GrossToNetActivePowerCurves',
 'GenUnitOpCostCurves']

Property Details [hide private]

ControlAreaGeneratingUnit

ControlArea specifications for this generating unit.

Get Method:
getControlAreaGeneratingUnit(self) - ControlArea specifications for this generating unit.
Set Method:
setControlAreaGeneratingUnit(self, value)

GenUnitOpCostCurves

A generating unit may have one or more cost curves, depending upon fuel mixture and fuel cost.

Get Method:
getGenUnitOpCostCurves(self) - A generating unit may have one or more cost curves, depending upon fuel mixture and fuel cost.
Set Method:
setGenUnitOpCostCurves(self, value)

GenUnitOpSchedule

A generating unit may have an operating schedule, indicating the planned operation of the unit

Get Method:
getGenUnitOpSchedule(self) - A generating unit may have an operating schedule, indicating the planned operation of the unit
Set Method:
setGenUnitOpSchedule(self, value)

GrossToNetActivePowerCurves

A generating unit may have a gross active power to net active power curve, describing the losses and auxiliary power requirements of the unit

Get Method:
getGrossToNetActivePowerCurves(self) - A generating unit may have a gross active power to net active power curve, describing the losses and auxiliary power requirements of the unit
Set Method:
setGrossToNetActivePowerCurves(self, value)

SynchronousMachines

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

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