CIM14/IEC61968/WiresExt/DistributionTapChanger.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.Wires.RatioTapChanger import RatioTapChanger
  22
  23 class DistributionTapChanger(RatioTapChanger):
  24     """Additional ratio tap changer parameters common to distribution line regulators. 'tculControlMode' would always be 'volt'. If 'monitoredPhase' is not specified, then if the controlled DistributionTransformerWinding is single-phase, the PT primary is assumed to be connected across that winding, which is the normal case. If the controlled winding is three-phase, then the 'monitoredPhase' is assumed to be 'AN', unless otherwise specified. Whenever 'ctRatio' and 'ptRatio' are specified, it's customary to specify the R and X in 'volts' referred to the PT secondary circuit, otherwise R and X are in feeder primary ohms. If 'ptRatio' is not specified, then 'targetVoltage', 'limitVoltage', and 'bandVoltage' are on the feeder primary base, phase-neutral or phase-phase depending on the 'monitoredPhase'. Otherwise, these attributes are all on the PT secondary base.
  25     """
  26
  27     def __init__(self, monitoredPhase="A", ptRatio=0.0, reverseLineDropX=0.0, ctRating=0.0, reverseLineDropR=0.0, lineDropCompensation=False, ctRatio=0.0, targetVoltage=0.0, limitVoltage=0.0, lineDropR=0.0, lineDropX=0.0, bandVoltage=0.0, *args, **kw_args):
  28         """Initialises a new 'DistributionTapChanger' instance.
  29
  30         @param monitoredPhase: Phase voltage controlling this regulator, measured at regulator location. Values are: "A", "AC", "AN", "ABCN", "B", "C", "BN", "CN", "splitSecondary12N", "ABC", "splitSecondary2N", "N", "ABN", "BC", "BCN", "AB", "splitSecondary1N", "ACN"
  31         @param ptRatio: Built-in voltage transducer ratio.
  32         @param reverseLineDropX: Line drop compensator reactance setting for reverse power flow.
  33         @param ctRating: Built-in current transformer primary rating.
  34         @param reverseLineDropR: Line drop compensator resistance setting for reverse power flow.
  35         @param lineDropCompensation: If true, the line drop compensation is to be applied.
  36         @param ctRatio: Built-in current transducer ratio.
  37         @param targetVoltage: Target voltage on the PT secondary base.
  38         @param limitVoltage: Maximum allowed regulated voltage on the PT secondary base, regardless of line drop compensation. Sometimes referred to as first-house protection.
  39         @param lineDropR: Line drop compensator resistance setting for normal (forward) power flow.
  40         @param lineDropX: Line drop compensator reactance setting for normal (forward) power flow.
  41         @param bandVoltage: Voltage range (max - min) on the PT secondary base, centered on 'targetVoltage'.
  42         """
  43         #: Phase voltage controlling this regulator, measured at regulator location. Values are: "A", "AC", "AN", "ABCN", "B", "C", "BN", "CN", "splitSecondary12N", "ABC", "splitSecondary2N", "N", "ABN", "BC", "BCN", "AB", "splitSecondary1N", "ACN"
  44         self.monitoredPhase = monitoredPhase
  45
  46         #: Built-in voltage transducer ratio.
  47         self.ptRatio = ptRatio
  48
  49         #: Line drop compensator reactance setting for reverse power flow.
  50         self.reverseLineDropX = reverseLineDropX
  51
  52         #: Built-in current transformer primary rating.
  53         self.ctRating = ctRating
  54
  55         #: Line drop compensator resistance setting for reverse power flow.
  56         self.reverseLineDropR = reverseLineDropR
  57
  58         #: If true, the line drop compensation is to be applied.
  59         self.lineDropCompensation = lineDropCompensation
  60
  61         #: Built-in current transducer ratio.
  62         self.ctRatio = ctRatio
  63
  64         #: Target voltage on the PT secondary base.
  65         self.targetVoltage = targetVoltage
  66
  67         #: Maximum allowed regulated voltage on the PT secondary base, regardless of line drop compensation. Sometimes referred to as first-house protection.
  68         self.limitVoltage = limitVoltage
  69
  70         #: Line drop compensator resistance setting for normal (forward) power flow.
  71         self.lineDropR = lineDropR
  72
  73         #: Line drop compensator reactance setting for normal (forward) power flow.
  74         self.lineDropX = lineDropX
  75
  76         #: Voltage range (max - min) on the PT secondary base, centered on 'targetVoltage'.
  77         self.bandVoltage = bandVoltage
  78
  79         super(DistributionTapChanger, self).__init__(*args, **kw_args)
  80
  81     _attrs = ["monitoredPhase", "ptRatio", "reverseLineDropX", "ctRating", "reverseLineDropR", "lineDropCompensation", "ctRatio", "targetVoltage", "limitVoltage", "lineDropR", "lineDropX", "bandVoltage"]
  82     _attr_types = {"monitoredPhase": str, "ptRatio": float, "reverseLineDropX": float, "ctRating": float, "reverseLineDropR": float, "lineDropCompensation": bool, "ctRatio": float, "targetVoltage": float, "limitVoltage": float, "lineDropR": float, "lineDropX": float, "bandVoltage": float}
  83     _defaults = {"monitoredPhase": "A", "ptRatio": 0.0, "reverseLineDropX": 0.0, "ctRating": 0.0, "reverseLineDropR": 0.0, "lineDropCompensation": False, "ctRatio": 0.0, "targetVoltage": 0.0, "limitVoltage": 0.0, "lineDropR": 0.0, "lineDropX": 0.0, "bandVoltage": 0.0}
  84     _enums = {"monitoredPhase": "PhaseCode"}
  85     _refs = []
  86     _many_refs = []
  87