CIM14/IEC61970/Generation/Production/HeatInputCurve.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 HeatInputCurve(Curve):
  24     """Relationship between unit heat input in energy per time for main fuel (Y1-axis) and supplemental fuel (Y2-axis) versus unit output in active power (X-axis). The quantity of main fuel used to sustain generation at this output level is prorated for throttling between definition points. The quantity of supplemental fuel used at this output level is fixed and not prorated.
  25     """
  26
  27     def __init__(self, heatInputEff=0.0, auxPowerMult=0.0, heatInputOffset=0.0, isNetGrossP=False, auxPowerOffset=0.0, ThermalGeneratingUnit=None, *args, **kw_args):
  28         """Initialises a new 'HeatInputCurve' instance.
  29
  30         @param heatInputEff: Heat input - efficiency multiplier adjustment factor.
  31         @param auxPowerMult: Power output - auxiliary power multiplier adjustment factor.
  32         @param heatInputOffset: Heat input - offset adjustment factor.
  33         @param isNetGrossP: Flag is set to true when output is expressed in net active power
  34         @param auxPowerOffset: Power output - auxiliary power offset adjustment factor
  35         @param ThermalGeneratingUnit: A thermal generating unit may have a heat input curve
  36         """
  37         #: Heat input - efficiency multiplier adjustment factor.
  38         self.heatInputEff = heatInputEff
  39
  40         #: Power output - auxiliary power multiplier adjustment factor.
  41         self.auxPowerMult = auxPowerMult
  42
  43         #: Heat input - offset adjustment factor.
  44         self.heatInputOffset = heatInputOffset
  45
  46         #: Flag is set to true when output is expressed in net active power
  47         self.isNetGrossP = isNetGrossP
  48
  49         #: Power output - auxiliary power offset adjustment factor
  50         self.auxPowerOffset = auxPowerOffset
  51
  52         self._ThermalGeneratingUnit = None
  53         self.ThermalGeneratingUnit = ThermalGeneratingUnit
  54
  55         super(HeatInputCurve, self).__init__(*args, **kw_args)
  56
  57     _attrs = ["heatInputEff", "auxPowerMult", "heatInputOffset", "isNetGrossP", "auxPowerOffset"]
  58     _attr_types = {"heatInputEff": float, "auxPowerMult": float, "heatInputOffset": float, "isNetGrossP": bool, "auxPowerOffset": float}
  59     _defaults = {"heatInputEff": 0.0, "auxPowerMult": 0.0, "heatInputOffset": 0.0, "isNetGrossP": False, "auxPowerOffset": 0.0}
  60     _enums = {}
  61     _refs = ["ThermalGeneratingUnit"]
  62     _many_refs = []
  63
  64     def getThermalGeneratingUnit(self):
  65         """A thermal generating unit may have a heat input curve
  66         """
  67         return self._ThermalGeneratingUnit
  68
  69     def setThermalGeneratingUnit(self, value):
  70         if self._ThermalGeneratingUnit is not None:
  71             self._ThermalGeneratingUnit._HeatInputCurve = None
  72
  73         self._ThermalGeneratingUnit = value
  74         if self._ThermalGeneratingUnit is not None:
  75             self._ThermalGeneratingUnit.HeatInputCurve = None
  76             self._ThermalGeneratingUnit._HeatInputCurve = self
  77
  78     ThermalGeneratingUnit = property(getThermalGeneratingUnit, setThermalGeneratingUnit)
  79