Package CIM14 :: Package IEC61970 :: Package Generation :: Package Production :: Module Reservoir' :: Class Reservoir

Class Reservoir

                           object --+            
                                    |            
                     Element'.Element --+        
                                        |        
  Core.IdentifiedObject'.IdentifiedObject --+    
                                            |    
Core.PowerSystemResource'.PowerSystemResource --+
                                                |
                                               Reservoir

A water storage facility within a hydro system, including: ponds, lakes, lagoons, and rivers. The storage is usually behind some type of dam.

Instance Methods

[hide private]

__init__(self, spillWayGateType='', fullSupplyLevel=0.0, spillTravelDelay=0.0, spillwayCrestLength=0.0, grossCapacity=0.0, riverOutletWorks='', spillwayCapacity=0.0, spillwayCrestLevel=0.0, normalMinOperateLevel=0.0, energyStorageRating=0.0, activeStorageCapacity=0.0, LevelVsVolumeCurves=None, InflowForecasts=None, TargetLevelSchedule=None, HydroPowerPlants=None, UpstreamFromHydroPowerPlants=None, SpillsFromReservoir=None, SpillsIntoReservoirs=None, *args, **kw_args)
Initialises a new 'Reservoir' instance.

addHydroPowerPlants(self, *HydroPowerPlants)

addInflowForecasts(self, *InflowForecasts)

addLevelVsVolumeCurves(self, *LevelVsVolumeCurves)

addSpillsIntoReservoirs(self, *SpillsIntoReservoirs)

addUpstreamFromHydroPowerPlants(self, *UpstreamFromHydroPowerPlants)

getHydroPowerPlants(self)
Generators discharge water to or pumps are supplied water from a downstream reservoir

getInflowForecasts(self)
A reservoir may have a 'natural' inflow forecast.

getLevelVsVolumeCurves(self)
A reservoir may have a level versus volume relationship.

getSpillsFromReservoir(self)
A reservoir may spill into a downstream reservoir

getSpillsIntoReservoirs(self)
A reservoir may spill into a downstream reservoir

getTargetLevelSchedule(self)
A reservoir may have a water level target schedule.

getUpstreamFromHydroPowerPlants(self)
Generators are supplied water from or pumps discharge water to an upstream reservoir

removeHydroPowerPlants(self, *HydroPowerPlants)

removeInflowForecasts(self, *InflowForecasts)

removeLevelVsVolumeCurves(self, *LevelVsVolumeCurves)

removeSpillsIntoReservoirs(self, *SpillsIntoReservoirs)

removeUpstreamFromHydroPowerPlants(self, *UpstreamFromHydroPowerPlants)

setHydroPowerPlants(self, value)

setInflowForecasts(self, value)

setLevelVsVolumeCurves(self, value)

setSpillsFromReservoir(self, value)

setSpillsIntoReservoirs(self, value)

setTargetLevelSchedule(self, value)

setUpstreamFromHydroPowerPlants(self, value)

Inherited from Core.PowerSystemResource'.PowerSystemResource: addAssets, addBlock, addMeasurements, addOperatingShare, addPsrLists, addReportingGroup, getAssets, getBlock, getLocation, getMeasurements, getOperatingShare, getOutageSchedule, getPSRType, getPsrLists, getReportingGroup, removeAssets, removeBlock, removeMeasurements, removeOperatingShare, removePsrLists, removeReportingGroup, setAssets, setBlock, setLocation, setMeasurements, setOperatingShare, setOutageSchedule, setPSRType, setPsrLists, setReportingGroup

Inherited from Core.IdentifiedObject'.IdentifiedObject: getModelingAuthoritySet, setModelingAuthoritySet

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

Class Variables

[hide private]

_attr_types = {'activeStorageCapacity': <type 'float'>, 'energ...

_attrs = ['spillWayGateType', 'fullSupplyLevel', 'spillTravelD...

_defaults = {'activeStorageCapacity': 0.0, 'energyStorageRatin...

_enums = {'spillWayGateType': 'SpillwayGateType'}

_many_refs = ['LevelVsVolumeCurves', 'InflowForecasts', 'Hydro...

_refs = ['LevelVsVolumeCurves', 'InflowForecasts', 'TargetLeve...

Properties

[hide private]

HydroPowerPlants
Generators discharge water to or pumps are supplied water from a downstream reservoir

InflowForecasts
A reservoir may have a 'natural' inflow forecast.

LevelVsVolumeCurves
A reservoir may have a level versus volume relationship.

SpillsFromReservoir
A reservoir may spill into a downstream reservoir

SpillsIntoReservoirs
A reservoir may spill into a downstream reservoir

TargetLevelSchedule
A reservoir may have a water level target schedule.

UpstreamFromHydroPowerPlants
Generators are supplied water from or pumps discharge water to an upstream reservoir

Inherited from Core.PowerSystemResource'.PowerSystemResource: Assets, Block, Location, Measurements, OperatingShare, OutageSchedule, PSRType, PsrLists, ReportingGroup

Inherited from Core.IdentifiedObject'.IdentifiedObject: ModelingAuthoritySet

Inherited from object: __class__

Method Details

[hide private]

init(self, spillWayGateType=`''`, fullSupplyLevel=0.0, spillTravelDelay=0.0, spillwayCrestLength=0.0, grossCapacity=0.0, riverOutletWorks=`''`, spillwayCapacity=0.0, spillwayCrestLevel=0.0, normalMinOperateLevel=0.0, energyStorageRating=0.0, activeStorageCapacity=0.0, LevelVsVolumeCurves=None, InflowForecasts=None, TargetLevelSchedule=None, HydroPowerPlants=None, UpstreamFromHydroPowerPlants=None, SpillsFromReservoir=None, SpillsIntoReservoirs=None, *args, **kw_args)
(Constructor)

Initialises a new 'Reservoir' instance.

Parameters:

spillWayGateType - Type of spillway gate, including parameters
fullSupplyLevel - Full supply level, above which water will spill. This can be the spillway crest level or the top of closed gates.
spillTravelDelay - The spillway water travel delay to the next downstream reservoir
spillwayCrestLength - The length of the spillway crest
grossCapacity - Total capacity of reservoir
riverOutletWorks - River outlet works for riparian right releases or other purposes
spillwayCapacity - The flow capacity of the spillway in cubic meters per second
spillwayCrestLevel - Spillway crest level above which water will spill
normalMinOperateLevel - Normal minimum operating level below which the penstocks will draw air
energyStorageRating - The reservoir's energy storage rating in energy for given head conditions
activeStorageCapacity - Storage volume between the full supply level and the normal minimum operating level
LevelVsVolumeCurves - A reservoir may have a level versus volume relationship.
InflowForecasts - A reservoir may have a 'natural' inflow forecast.
TargetLevelSchedule - A reservoir may have a water level target schedule.
HydroPowerPlants - Generators discharge water to or pumps are supplied water from a downstream reservoir
UpstreamFromHydroPowerPlants - Generators are supplied water from or pumps discharge water to an upstream reservoir
SpillsFromReservoir - A reservoir may spill into a downstream reservoir
SpillsIntoReservoirs - A reservoir may spill into a downstream reservoir

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'activeStorageCapacity': <type 'float'>,
 'energyStorageRating': <type 'float'>,
 'fullSupplyLevel': <type 'float'>,
 'grossCapacity': <type 'float'>,
 'normalMinOperateLevel': <type 'float'>,
 'riverOutletWorks': <type 'str'>,
 'spillTravelDelay': <type 'float'>,
 'spillWayGateType': <type 'str'>,
...

_attrs

Value:

['spillWayGateType',
 'fullSupplyLevel',
 'spillTravelDelay',
 'spillwayCrestLength',
 'grossCapacity',
 'riverOutletWorks',
 'spillwayCapacity',
 'spillwayCrestLevel',
...

_defaults

Value:

{'activeStorageCapacity': 0.0,
 'energyStorageRating': 0.0,
 'fullSupplyLevel': 0.0,
 'grossCapacity': 0.0,
 'normalMinOperateLevel': 0.0,
 'riverOutletWorks': '',
 'spillTravelDelay': 0.0,
 'spillWayGateType': '',
...

_many_refs

Value:

['LevelVsVolumeCurves',
 'InflowForecasts',
 'HydroPowerPlants',
 'UpstreamFromHydroPowerPlants',
 'SpillsIntoReservoirs']

_refs

Value:

['LevelVsVolumeCurves',
 'InflowForecasts',
 'TargetLevelSchedule',
 'HydroPowerPlants',
 'UpstreamFromHydroPowerPlants',
 'SpillsFromReservoir',
 'SpillsIntoReservoirs']

Property Details

[hide private]

HydroPowerPlants

Generators discharge water to or pumps are supplied water from a downstream reservoir

Get Method:: getHydroPowerPlants(self) - Generators discharge water to or pumps are supplied water from a downstream reservoir
Set Method:: setHydroPowerPlants(self, value)

InflowForecasts

A reservoir may have a 'natural' inflow forecast.

Get Method:: getInflowForecasts(self) - A reservoir may have a 'natural' inflow forecast.
Set Method:: setInflowForecasts(self, value)

LevelVsVolumeCurves

A reservoir may have a level versus volume relationship.

Get Method:: getLevelVsVolumeCurves(self) - A reservoir may have a level versus volume relationship.
Set Method:: setLevelVsVolumeCurves(self, value)

SpillsFromReservoir

A reservoir may spill into a downstream reservoir

Get Method:: getSpillsFromReservoir(self) - A reservoir may spill into a downstream reservoir
Set Method:: setSpillsFromReservoir(self, value)

SpillsIntoReservoirs

A reservoir may spill into a downstream reservoir

Get Method:: getSpillsIntoReservoirs(self) - A reservoir may spill into a downstream reservoir
Set Method:: setSpillsIntoReservoirs(self, value)

TargetLevelSchedule

A reservoir may have a water level target schedule.

Get Method:: getTargetLevelSchedule(self) - A reservoir may have a water level target schedule.
Set Method:: setTargetLevelSchedule(self, value)

UpstreamFromHydroPowerPlants

Generators are supplied water from or pumps discharge water to an upstream reservoir

Get Method:: getUpstreamFromHydroPowerPlants(self) - Generators are supplied water from or pumps discharge water to an upstream reservoir
Set Method:: setUpstreamFromHydroPowerPlants(self, value)