schemata/CIM14/IEC61970/Generation/Production/HydroPowerPlant.py

   1 # Copyright (C) 2010 Richard Lincoln
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA, USA
  16
  17 from CIM14.IEC61970.Core.PowerSystemResource import PowerSystemResource
  18
  19 class HydroPowerPlant(PowerSystemResource):
  20     """A hydro power station which can generate or pump. When generating, the generator turbines receive there water from an upper reservoir. When pumping, the pumps receive their water from a lower reservoir.
  21     """
  22
  23     def __init__(self, hydroPlantType="runOfRiver", penstockType="", surgeTankCode="", plantRatedHead=0.0, plantDischargeCapacity=0.0, surgeTankCrestLevel=0.0, dischargeTravelDelay=0.0, pumpRatedP=0.0, genRatedP=0.0, HydroGeneratingUnits=None, HydroPumps=None, Reservoir=None, GenSourcePumpDischargeReservoir=None, *args, **kw_args):
  24         """Initialises a new 'HydroPowerPlant' instance.
  25
  26         @param hydroPlantType: The type of hydro power plant. Values are: "runOfRiver", "minorStorage", "majorStorage", "pumpedStorage"
  27         @param penstockType: Type and configuration of hydro plant penstock(s)
  28         @param surgeTankCode: A code describing the type (or absence) of surge tank that is associated with the hydro power plant
  29         @param plantRatedHead: The plant's rated gross head
  30         @param plantDischargeCapacity: Total plant discharge capacity in cubic meters per second
  31         @param surgeTankCrestLevel: The level at which the surge tank spills
  32         @param dischargeTravelDelay: Water travel delay from tailbay to next downstream hydro power station
  33         @param pumpRatedP: The hydro plant's pumping rating active power for rated head conditions
  34         @param genRatedP: The hydro plant's generating rating active power for rated head conditions
  35         @param HydroGeneratingUnits: The hydro generating unit belongs to a hydro power plant
  36         @param HydroPumps: The hydro pump may be a member of a pumped storage plant or a pump for distributing water
  37         @param Reservoir: Generators discharge water to or pumps are supplied water from a downstream reservoir
  38         @param GenSourcePumpDischargeReservoir: Generators are supplied water from or pumps discharge water to an upstream reservoir
  39         """
  40         #: The type of hydro power plant. Values are: "runOfRiver", "minorStorage", "majorStorage", "pumpedStorage"
  41         self.hydroPlantType = hydroPlantType
  42
  43         #: Type and configuration of hydro plant penstock(s)
  44         self.penstockType = penstockType
  45
  46         #: A code describing the type (or absence) of surge tank that is associated with the hydro power plant
  47         self.surgeTankCode = surgeTankCode
  48
  49         #: The plant's rated gross head
  50         self.plantRatedHead = plantRatedHead
  51
  52         #: Total plant discharge capacity in cubic meters per second
  53         self.plantDischargeCapacity = plantDischargeCapacity
  54
  55         #: The level at which the surge tank spills
  56         self.surgeTankCrestLevel = surgeTankCrestLevel
  57
  58         #: Water travel delay from tailbay to next downstream hydro power station
  59         self.dischargeTravelDelay = dischargeTravelDelay
  60
  61         #: The hydro plant's pumping rating active power for rated head conditions
  62         self.pumpRatedP = pumpRatedP
  63
  64         #: The hydro plant's generating rating active power for rated head conditions
  65         self.genRatedP = genRatedP
  66
  67         self._HydroGeneratingUnits = []
  68         self.HydroGeneratingUnits = [] if HydroGeneratingUnits is None else HydroGeneratingUnits
  69
  70         self._HydroPumps = []
  71         self.HydroPumps = [] if HydroPumps is None else HydroPumps
  72
  73         self._Reservoir = None
  74         self.Reservoir = Reservoir
  75
  76         self._GenSourcePumpDischargeReservoir = None
  77         self.GenSourcePumpDischargeReservoir = GenSourcePumpDischargeReservoir
  78
  79         super(HydroPowerPlant, self).__init__(*args, **kw_args)
  80
  81     _attrs = ["hydroPlantType", "penstockType", "surgeTankCode", "plantRatedHead", "plantDischargeCapacity", "surgeTankCrestLevel", "dischargeTravelDelay", "pumpRatedP", "genRatedP"]
  82     _attr_types = {"hydroPlantType": str, "penstockType": str, "surgeTankCode": str, "plantRatedHead": float, "plantDischargeCapacity": float, "surgeTankCrestLevel": float, "dischargeTravelDelay": float, "pumpRatedP": float, "genRatedP": float}
  83     _defaults = {"hydroPlantType": "runOfRiver", "penstockType": "", "surgeTankCode": "", "plantRatedHead": 0.0, "plantDischargeCapacity": 0.0, "surgeTankCrestLevel": 0.0, "dischargeTravelDelay": 0.0, "pumpRatedP": 0.0, "genRatedP": 0.0}
  84     _enums = {"hydroPlantType": "HydroPlantType", "penstockType": "PenstockType", "surgeTankCode": "SurgeTankCode"}
  85     _refs = ["HydroGeneratingUnits", "HydroPumps", "Reservoir", "GenSourcePumpDischargeReservoir"]
  86     _many_refs = ["HydroGeneratingUnits", "HydroPumps"]
  87
  88     def getHydroGeneratingUnits(self):
  89         """The hydro generating unit belongs to a hydro power plant
  90         """
  91         return self._HydroGeneratingUnits
  92
  93     def setHydroGeneratingUnits(self, value):
  94         for x in self._HydroGeneratingUnits:
  95             x._HydroPowerPlant = None
  96         for y in value:
  97             y._HydroPowerPlant = self
  98         self._HydroGeneratingUnits = value
  99
 100     HydroGeneratingUnits = property(getHydroGeneratingUnits, setHydroGeneratingUnits)
 101
 102     def addHydroGeneratingUnits(self, *HydroGeneratingUnits):
 103         for obj in HydroGeneratingUnits:
 104             obj._HydroPowerPlant = self
 105             self._HydroGeneratingUnits.append(obj)
 106
 107     def removeHydroGeneratingUnits(self, *HydroGeneratingUnits):
 108         for obj in HydroGeneratingUnits:
 109             obj._HydroPowerPlant = None
 110             self._HydroGeneratingUnits.remove(obj)
 111
 112     def getHydroPumps(self):
 113         """The hydro pump may be a member of a pumped storage plant or a pump for distributing water
 114         """
 115         return self._HydroPumps
 116
 117     def setHydroPumps(self, value):
 118         for x in self._HydroPumps:
 119             x._HydroPowerPlant = None
 120         for y in value:
 121             y._HydroPowerPlant = self
 122         self._HydroPumps = value
 123
 124     HydroPumps = property(getHydroPumps, setHydroPumps)
 125
 126     def addHydroPumps(self, *HydroPumps):
 127         for obj in HydroPumps:
 128             obj._HydroPowerPlant = self
 129             self._HydroPumps.append(obj)
 130
 131     def removeHydroPumps(self, *HydroPumps):
 132         for obj in HydroPumps:
 133             obj._HydroPowerPlant = None
 134             self._HydroPumps.remove(obj)
 135
 136     def getReservoir(self):
 137         """Generators discharge water to or pumps are supplied water from a downstream reservoir
 138         """
 139         return self._Reservoir
 140
 141     def setReservoir(self, value):
 142         if self._Reservoir is not None:
 143             filtered = [x for x in self.Reservoir.HydroPowerPlants if x != self]
 144             self._Reservoir._HydroPowerPlants = filtered
 145
 146         self._Reservoir = value
 147         if self._Reservoir is not None:
 148             self._Reservoir._HydroPowerPlants.append(self)
 149
 150     Reservoir = property(getReservoir, setReservoir)
 151
 152     def getGenSourcePumpDischargeReservoir(self):
 153         """Generators are supplied water from or pumps discharge water to an upstream reservoir
 154         """
 155         return self._GenSourcePumpDischargeReservoir
 156
 157     def setGenSourcePumpDischargeReservoir(self, value):
 158         if self._GenSourcePumpDischargeReservoir is not None:
 159             filtered = [x for x in self.GenSourcePumpDischargeReservoir.UpstreamFromHydroPowerPlants if x != self]
 160             self._GenSourcePumpDischargeReservoir._UpstreamFromHydroPowerPlants = filtered
 161
 162         self._GenSourcePumpDischargeReservoir = value
 163         if self._GenSourcePumpDischargeReservoir is not None:
 164             self._GenSourcePumpDischargeReservoir._UpstreamFromHydroPowerPlants.append(self)
 165
 166     GenSourcePumpDischargeReservoir = property(getGenSourcePumpDischargeReservoir, setGenSourcePumpDischargeReservoir)
 167