CIM14/IEC61970/Generation/Production/HydroGeneratingEfficiencyCurve.py

   1 # Copyright (C) 2010-2011 Richard Lincoln
   2 #
   3 # Permission is hereby granted, free of charge, to any person obtaining a copy
   4 # of this software and associated documentation files (the "Software"), to
   5 # deal in the Software without restriction, including without limitation the
   6 # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   7 # sell copies of the Software, and to permit persons to whom the Software is
   8 # furnished to do so, subject to the following conditions:
   9 #
  10 # The above copyright notice and this permission notice shall be included in
  11 # all copies or substantial portions of the Software.
  12 #
  13 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  18 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  19 # IN THE SOFTWARE.
  20
  21 from CIM14.IEC61970.Core.Curve import Curve
  22
  23 class HydroGeneratingEfficiencyCurve(Curve):
  24     """Relationship between unit efficiency in percent and unit output active power for a given net head in meters. The relationship between efficiency, discharge, head, and power output is expressed as follows:   E =KP/HQ Where:  (E=percentage)  (P=active power)  (H=height)  (Q=volume/time unit)  (K=constant) For example, a curve instance for a given net head could relate efficiency (Y-axis) versus active power output (X-axis) or versus discharge on the X-axis.
  25     """
  26
  27     def __init__(self, HydroGeneratingUnit=None, *args, **kw_args):
  28         """Initialises a new 'HydroGeneratingEfficiencyCurve' instance.
  29
  30         @param HydroGeneratingUnit: A hydro generating unit has an efficiency curve
  31         """
  32         self._HydroGeneratingUnit = None
  33         self.HydroGeneratingUnit = HydroGeneratingUnit
  34
  35         super(HydroGeneratingEfficiencyCurve, self).__init__(*args, **kw_args)
  36
  37     _attrs = []
  38     _attr_types = {}
  39     _defaults = {}
  40     _enums = {}
  41     _refs = ["HydroGeneratingUnit"]
  42     _many_refs = []
  43
  44     def getHydroGeneratingUnit(self):
  45         """A hydro generating unit has an efficiency curve
  46         """
  47         return self._HydroGeneratingUnit
  48
  49     def setHydroGeneratingUnit(self, value):
  50         if self._HydroGeneratingUnit is not None:
  51             filtered = [x for x in self.HydroGeneratingUnit.HydroGeneratingEfficiencyCurves if x != self]
  52             self._HydroGeneratingUnit._HydroGeneratingEfficiencyCurves = filtered
  53
  54         self._HydroGeneratingUnit = value
  55         if self._HydroGeneratingUnit is not None:
  56             if self not in self._HydroGeneratingUnit._HydroGeneratingEfficiencyCurves:
  57                 self._HydroGeneratingUnit._HydroGeneratingEfficiencyCurves.append(self)
  58
  59     HydroGeneratingUnit = property(getHydroGeneratingUnit, setHydroGeneratingUnit)
  60