diff --git a/.github/workflows/pre-commit.yaml b/.github/workflows/pre-commit.yaml index d5b273ed..88aa3b9b 100644 --- a/.github/workflows/pre-commit.yaml +++ b/.github/workflows/pre-commit.yaml @@ -3,7 +3,8 @@ name: pre-commit on: pull_request: push: - branches: [main] + branches: + - master jobs: pre-commit: diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 6cbc1fc0..e5dd8357 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -14,16 +14,11 @@ jobs: - name: Checkout repository uses: actions/checkout@v4 - - name: Setup python + - name: Setup Python uses: actions/setup-python@v5 with: python-version: 3.8 - - name: Install Graphviz - shell: bash - run: | - sudo apt-get -y install graphviz - - name: Install Python dependencies run: | pip install .[dev] @@ -37,4 +32,4 @@ jobs: if: ${{ always() }} with: name: pytest-results - path: cimpy/report.xml + path: report.xml diff --git a/.gitignore b/.gitignore index 9b3c8620..f1c128e1 100644 --- a/.gitignore +++ b/.gitignore @@ -3,12 +3,12 @@ __pycache__ .idea .venv -./cimpy/__pycache__ *.egg build/ dist/ - *.log +/.pytest_cache +/report.xml # VSCode .vscode/* diff --git a/cimpy/__init__.py b/cimpy/__init__.py index 061e9d82..551c1167 100644 --- a/cimpy/__init__.py +++ b/cimpy/__init__.py @@ -2,6 +2,7 @@ from cimpy.cimexport import cim_export from cimpy.cimimport import cim_import +from cimpy.cimexport import cim_export_to_string_array import cimpy.utils from cimpy.cimexamples import import_example from cimpy.cimexamples import export_example diff --git a/cimpy/cgmes_v2_4_15/ACDCConverter.py b/cimpy/cgmes_v2_4_15/ACDCConverter.py index c5f471c5..a2e86279 100644 --- a/cimpy/cgmes_v2_4_15/ACDCConverter.py +++ b/cimpy/cgmes_v2_4_15/ACDCConverter.py @@ -1,85 +1,87 @@ -from .ConductingEquipment import ConductingEquipment - - -class ACDCConverter(ConductingEquipment): - ''' - A unit with valves for three phases, together with unit control equipment, essential protective and switching devices, DC storage capacitors, phase reactors and auxiliaries, if any, used for conversion. - - :baseS: Base apparent power of the converter pole. Default: 0.0 - :idleLoss: Active power loss in pole at no power transfer. Converter configuration data used in power flow. Default: 0.0 - :maxUdc: The maximum voltage on the DC side at which the converter should operate. Converter configuration data used in power flow. Default: 0.0 - :minUdc: Min allowed converter DC voltage. Converter configuration data used in power flow. Default: 0.0 - :numberOfValves: Number of valves in the converter. Used in loss calculations. Default: 0 - :ratedUdc: Rated converter DC voltage, also called UdN. Converter configuration data used in power flow. Default: 0.0 - :resistiveLoss: Converter configuration data used in power flow. Refer to poleLossP. Default: 0.0 - :switchingLoss: Switching losses, relative to the base apparent power `baseS`. Refer to poleLossP. Default: 0.0 - :valveU0: Valve threshold voltage. Forward voltage drop when the valve is conducting. Used in loss calculations, i.e. the switchLoss depend on numberOfValves * valveU0. Default: 0.0 - :DCTerminals: Default: "list" - :PccTerminal: All converters` DC sides linked to this point of common coupling terminal. Default: None - :p: Active power at the point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution in the case a simplified power flow model is used. Default: 0.0 - :q: Reactive power at the point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution in the case a simplified power flow model is used. Default: 0.0 - :targetPpcc: Real power injection target in AC grid, at point of common coupling. Default: 0.0 - :targetUdc: Target value for DC voltage magnitude. Default: 0.0 - :idc: Converter DC current, also called Id. Converter state variable, result from power flow. Default: 0.0 - :poleLossP: The active power loss at a DC Pole = idleLoss + switchingLoss*|Idc| + resitiveLoss*Idc^2 For lossless operation Pdc=Pac For rectifier operation with losses Pdc=Pac-lossP For inverter operation with losses Pdc=Pac+lossP Converter state variable used in power flow. Default: 0.0 - :uc: Converter voltage, the voltage at the AC side of the bridge. Converter state variable, result from power flow. Default: 0.0 - :udc: Converter voltage at the DC side, also called Ud. Converter state variable, result from power flow. Default: 0.0 - ''' - - cgmesProfile = ConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, ], - 'baseS': [cgmesProfile.EQ.value, ], - 'idleLoss': [cgmesProfile.EQ.value, ], - 'maxUdc': [cgmesProfile.EQ.value, ], - 'minUdc': [cgmesProfile.EQ.value, ], - 'numberOfValves': [cgmesProfile.EQ.value, ], - 'ratedUdc': [cgmesProfile.EQ.value, ], - 'resistiveLoss': [cgmesProfile.EQ.value, ], - 'switchingLoss': [cgmesProfile.EQ.value, ], - 'valveU0': [cgmesProfile.EQ.value, ], - 'DCTerminals': [cgmesProfile.EQ.value, ], - 'PccTerminal': [cgmesProfile.EQ.value, ], - 'p': [cgmesProfile.SSH.value, ], - 'q': [cgmesProfile.SSH.value, ], - 'targetPpcc': [cgmesProfile.SSH.value, ], - 'targetUdc': [cgmesProfile.SSH.value, ], - 'idc': [cgmesProfile.SV.value, ], - 'poleLossP': [cgmesProfile.SV.value, ], - 'uc': [cgmesProfile.SV.value, ], - 'udc': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConductingEquipment: \n' + ConductingEquipment.__doc__ - - def __init__(self, baseS = 0.0, idleLoss = 0.0, maxUdc = 0.0, minUdc = 0.0, numberOfValves = 0, ratedUdc = 0.0, resistiveLoss = 0.0, switchingLoss = 0.0, valveU0 = 0.0, DCTerminals = "list", PccTerminal = None, p = 0.0, q = 0.0, targetPpcc = 0.0, targetUdc = 0.0, idc = 0.0, poleLossP = 0.0, uc = 0.0, udc = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.baseS = baseS - self.idleLoss = idleLoss - self.maxUdc = maxUdc - self.minUdc = minUdc - self.numberOfValves = numberOfValves - self.ratedUdc = ratedUdc - self.resistiveLoss = resistiveLoss - self.switchingLoss = switchingLoss - self.valveU0 = valveU0 - self.DCTerminals = DCTerminals - self.PccTerminal = PccTerminal - self.p = p - self.q = q - self.targetPpcc = targetPpcc - self.targetUdc = targetUdc - self.idc = idc - self.poleLossP = poleLossP - self.uc = uc - self.udc = udc - - def __str__(self): - str = 'class=ACDCConverter\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConductingEquipment import ConductingEquipment +from .CGMESProfile import Profile + + +class ACDCConverter(ConductingEquipment): + """ + A unit with valves for three phases, together with unit control equipment, essential protective and switching devices, DC storage capacitors, phase reactors and auxiliaries, if any, used for conversion. + + :DCTerminals: Default: "list" + :PccTerminal: All converters` DC sides linked to this point of common coupling terminal. Default: None + :baseS: Base apparent power of the converter pole. Default: 0.0 + :idc: Converter DC current, also called Id. Converter state variable, result from power flow. Default: 0.0 + :idleLoss: Active power loss in pole at no power transfer. Converter configuration data used in power flow. Default: 0.0 + :maxUdc: The maximum voltage on the DC side at which the converter should operate. Converter configuration data used in power flow. Default: 0.0 + :minUdc: Min allowed converter DC voltage. Converter configuration data used in power flow. Default: 0.0 + :numberOfValves: Number of valves in the converter. Used in loss calculations. Default: 0 + :p: Active power at the point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution in the case a simplified power flow model is used. Default: 0.0 + :poleLossP: The active power loss at a DC Pole = idleLoss + switchingLoss*|Idc| + resitiveLoss*Idc^2 For lossless operation Pdc=Pac For rectifier operation with losses Pdc=Pac-lossP For inverter operation with losses Pdc=Pac+lossP Converter state variable used in power flow. Default: 0.0 + :q: Reactive power at the point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution in the case a simplified power flow model is used. Default: 0.0 + :ratedUdc: Rated converter DC voltage, also called UdN. Converter configuration data used in power flow. Default: 0.0 + :resistiveLoss: Converter configuration data used in power flow. Refer to poleLossP. Default: 0.0 + :switchingLoss: Switching losses, relative to the base apparent power `baseS`. Refer to poleLossP. Default: 0.0 + :targetPpcc: Real power injection target in AC grid, at point of common coupling. Default: 0.0 + :targetUdc: Target value for DC voltage magnitude. Default: 0.0 + :uc: Converter voltage, the voltage at the AC side of the bridge. Converter state variable, result from power flow. Default: 0.0 + :udc: Converter voltage at the DC side, also called Ud. Converter state variable, result from power flow. Default: 0.0 + :valveU0: Valve threshold voltage. Forward voltage drop when the valve is conducting. Used in loss calculations, i.e. the switchLoss depend on numberOfValves * valveU0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "DCTerminals": [Profile.EQ.value, ], + "PccTerminal": [Profile.EQ.value, ], + "baseS": [Profile.EQ.value, ], + "idc": [Profile.SV.value, ], + "idleLoss": [Profile.EQ.value, ], + "maxUdc": [Profile.EQ.value, ], + "minUdc": [Profile.EQ.value, ], + "numberOfValves": [Profile.EQ.value, ], + "p": [Profile.SSH.value, ], + "poleLossP": [Profile.SV.value, ], + "q": [Profile.SSH.value, ], + "ratedUdc": [Profile.EQ.value, ], + "resistiveLoss": [Profile.EQ.value, ], + "switchingLoss": [Profile.EQ.value, ], + "targetPpcc": [Profile.SSH.value, ], + "targetUdc": [Profile.SSH.value, ], + "uc": [Profile.SV.value, ], + "udc": [Profile.SV.value, ], + "valveU0": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConductingEquipment:\n" + ConductingEquipment.__doc__ + + def __init__(self, DCTerminals = "list", PccTerminal = None, baseS = 0.0, idc = 0.0, idleLoss = 0.0, maxUdc = 0.0, minUdc = 0.0, numberOfValves = 0, p = 0.0, poleLossP = 0.0, q = 0.0, ratedUdc = 0.0, resistiveLoss = 0.0, switchingLoss = 0.0, targetPpcc = 0.0, targetUdc = 0.0, uc = 0.0, udc = 0.0, valveU0 = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DCTerminals = DCTerminals + self.PccTerminal = PccTerminal + self.baseS = baseS + self.idc = idc + self.idleLoss = idleLoss + self.maxUdc = maxUdc + self.minUdc = minUdc + self.numberOfValves = numberOfValves + self.p = p + self.poleLossP = poleLossP + self.q = q + self.ratedUdc = ratedUdc + self.resistiveLoss = resistiveLoss + self.switchingLoss = switchingLoss + self.targetPpcc = targetPpcc + self.targetUdc = targetUdc + self.uc = uc + self.udc = udc + self.valveU0 = valveU0 + + def __str__(self): + str = "class=ACDCConverter\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ACDCConverterDCTerminal.py b/cimpy/cgmes_v2_4_15/ACDCConverterDCTerminal.py index 46474cd1..ecc2758b 100644 --- a/cimpy/cgmes_v2_4_15/ACDCConverterDCTerminal.py +++ b/cimpy/cgmes_v2_4_15/ACDCConverterDCTerminal.py @@ -1,34 +1,36 @@ -from .DCBaseTerminal import DCBaseTerminal - - -class ACDCConverterDCTerminal(DCBaseTerminal): - ''' - A DC electrical connection point at the AC/DC converter. The AC/DC converter is electrically connected also to the AC side. The AC connection is inherited from the AC conducting equipment in the same way as any other AC equipment. The AC/DC converter DC terminal is separate from generic DC terminal to restrict the connection with the AC side to AC/DC converter and so that no other DC conducting equipment can be connected to the AC side. - - :DCConductingEquipment: Default: None - :polarity: Represents the normal network polarity condition. Default: None - ''' - - cgmesProfile = DCBaseTerminal.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.TP.value, ], - 'DCConductingEquipment': [cgmesProfile.EQ.value, ], - 'polarity': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DCBaseTerminal: \n' + DCBaseTerminal.__doc__ - - def __init__(self, DCConductingEquipment = None, polarity = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.DCConductingEquipment = DCConductingEquipment - self.polarity = polarity - - def __str__(self): - str = 'class=ACDCConverterDCTerminal\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DCBaseTerminal import DCBaseTerminal +from .CGMESProfile import Profile + + +class ACDCConverterDCTerminal(DCBaseTerminal): + """ + A DC electrical connection point at the AC/DC converter. The AC/DC converter is electrically connected also to the AC side. The AC connection is inherited from the AC conducting equipment in the same way as any other AC equipment. The AC/DC converter DC terminal is separate from generic DC terminal to restrict the connection with the AC side to AC/DC converter and so that no other DC conducting equipment can be connected to the AC side. + + :DCConductingEquipment: Default: None + :polarity: Represents the normal network polarity condition. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, Profile.TP.value, ], + "DCConductingEquipment": [Profile.EQ.value, ], + "polarity": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class DCBaseTerminal:\n" + DCBaseTerminal.__doc__ + + def __init__(self, DCConductingEquipment = None, polarity = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DCConductingEquipment = DCConductingEquipment + self.polarity = polarity + + def __str__(self): + str = "class=ACDCConverterDCTerminal\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ACDCTerminal.py b/cimpy/cgmes_v2_4_15/ACDCTerminal.py index ebc76c62..81236dca 100644 --- a/cimpy/cgmes_v2_4_15/ACDCTerminal.py +++ b/cimpy/cgmes_v2_4_15/ACDCTerminal.py @@ -1,43 +1,45 @@ -from .IdentifiedObject import IdentifiedObject - - -class ACDCTerminal(IdentifiedObject): - ''' - An electrical connection point (AC or DC) to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes. - - :BusNameMarker: The bus name marker used to name the bus (topological node). Default: None - :sequenceNumber: The orientation of the terminal connections for a multiple terminal conducting equipment. The sequence numbering starts with 1 and additional terminals should follow in increasing order. The first terminal is the `starting point` for a two terminal branch. Default: 0 - :OperationalLimitSet: Default: "list" - :Measurements: Measurements associated with this terminal defining where the measurement is placed in the network topology. It may be used, for instance, to capture the sensor position, such as a voltage transformer (PT) at a busbar or a current transformer (CT) at the bar between a breaker and an isolator. Default: "list" - :connected: The connected status is related to a bus-branch model and the topological node to terminal relation. True implies the terminal is connected to the related topological node and false implies it is not. In a bus-branch model, the connected status is used to tell if equipment is disconnected without having to change the connectivity described by the topological node to terminal relation. A valid case is that conducting equipment can be connected in one end and open in the other. In particular for an AC line segment, where the reactive line charging can be significant, this is a relevant case. Default: False - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, cgmesProfile.TP.value, ], - 'BusNameMarker': [cgmesProfile.EQ.value, ], - 'sequenceNumber': [cgmesProfile.EQ.value, ], - 'OperationalLimitSet': [cgmesProfile.EQ.value, ], - 'Measurements': [cgmesProfile.EQ.value, ], - 'connected': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, BusNameMarker = None, sequenceNumber = 0, OperationalLimitSet = "list", Measurements = "list", connected = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.BusNameMarker = BusNameMarker - self.sequenceNumber = sequenceNumber - self.OperationalLimitSet = OperationalLimitSet - self.Measurements = Measurements - self.connected = connected - - def __str__(self): - str = 'class=ACDCTerminal\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class ACDCTerminal(IdentifiedObject): + """ + An electrical connection point (AC or DC) to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes. + + :BusNameMarker: The bus name marker used to name the bus (topological node). Default: None + :Measurements: Measurements associated with this terminal defining where the measurement is placed in the network topology. It may be used, for instance, to capture the sensor position, such as a voltage transformer (PT) at a busbar or a current transformer (CT) at the bar between a breaker and an isolator. Default: "list" + :OperationalLimitSet: Default: "list" + :connected: The connected status is related to a bus-branch model and the topological node to terminal relation. True implies the terminal is connected to the related topological node and false implies it is not. In a bus-branch model, the connected status is used to tell if equipment is disconnected without having to change the connectivity described by the topological node to terminal relation. A valid case is that conducting equipment can be connected in one end and open in the other. In particular for an AC line segment, where the reactive line charging can be significant, this is a relevant case. Default: False + :sequenceNumber: The orientation of the terminal connections for a multiple terminal conducting equipment. The sequence numbering starts with 1 and additional terminals should follow in increasing order. The first terminal is the `starting point` for a two terminal branch. Default: 0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, Profile.TP.value, ], + "BusNameMarker": [Profile.EQ.value, ], + "Measurements": [Profile.EQ.value, ], + "OperationalLimitSet": [Profile.EQ.value, ], + "connected": [Profile.SSH.value, ], + "sequenceNumber": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, BusNameMarker = None, Measurements = "list", OperationalLimitSet = "list", connected = False, sequenceNumber = 0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.BusNameMarker = BusNameMarker + self.Measurements = Measurements + self.OperationalLimitSet = OperationalLimitSet + self.connected = connected + self.sequenceNumber = sequenceNumber + + def __str__(self): + str = "class=ACDCTerminal\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ACLineSegment.py b/cimpy/cgmes_v2_4_15/ACLineSegment.py index 994113b2..71df2572 100644 --- a/cimpy/cgmes_v2_4_15/ACLineSegment.py +++ b/cimpy/cgmes_v2_4_15/ACLineSegment.py @@ -1,55 +1,57 @@ -from .Conductor import Conductor - - -class ACLineSegment(Conductor): - ''' - A wire or combination of wires, with consistent electrical characteristics, building a single electrical system, used to carry alternating current between points in the power system. For symmetrical, transposed 3ph lines, it is sufficient to use attributes of the line segment, which describe impedances and admittances for the entire length of the segment. Additionally impedances can be computed by using length and associated per length impedances. The BaseVoltage at the two ends of ACLineSegments in a Line shall have the same BaseVoltage.nominalVoltage. However, boundary lines may have slightly different BaseVoltage.nominalVoltages and variation is allowed. Larger voltage difference in general requires use of an equivalent branch. - - :bch: Positive sequence shunt (charging) susceptance, uniformly distributed, of the entire line section. This value represents the full charging over the full length of the line. Default: 0.0 - :gch: Positive sequence shunt (charging) conductance, uniformly distributed, of the entire line section. Default: 0.0 - :r: Positive sequence series resistance of the entire line section. Default: 0.0 - :x: Positive sequence series reactance of the entire line section. Default: 0.0 - :b0ch: Zero sequence shunt (charging) susceptance, uniformly distributed, of the entire line section. Default: 0.0 - :g0ch: Zero sequence shunt (charging) conductance, uniformly distributed, of the entire line section. Default: 0.0 - :r0: Zero sequence series resistance of the entire line section. Default: 0.0 - :shortCircuitEndTemperature: Maximum permitted temperature at the end of SC for the calculation of minimum short-circuit currents. Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :x0: Zero sequence series reactance of the entire line section. Default: 0.0 - ''' - - cgmesProfile = Conductor.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'bch': [cgmesProfile.EQ.value, ], - 'gch': [cgmesProfile.EQ.value, ], - 'r': [cgmesProfile.EQ.value, ], - 'x': [cgmesProfile.EQ.value, ], - 'b0ch': [cgmesProfile.EQ.value, ], - 'g0ch': [cgmesProfile.EQ.value, ], - 'r0': [cgmesProfile.EQ.value, ], - 'shortCircuitEndTemperature': [cgmesProfile.EQ.value, ], - 'x0': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Conductor: \n' + Conductor.__doc__ - - def __init__(self, bch = 0.0, gch = 0.0, r = 0.0, x = 0.0, b0ch = 0.0, g0ch = 0.0, r0 = 0.0, shortCircuitEndTemperature = 0.0, x0 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.bch = bch - self.gch = gch - self.r = r - self.x = x - self.b0ch = b0ch - self.g0ch = g0ch - self.r0 = r0 - self.shortCircuitEndTemperature = shortCircuitEndTemperature - self.x0 = x0 - - def __str__(self): - str = 'class=ACLineSegment\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Conductor import Conductor +from .CGMESProfile import Profile + + +class ACLineSegment(Conductor): + """ + A wire or combination of wires, with consistent electrical characteristics, building a single electrical system, used to carry alternating current between points in the power system. For symmetrical, transposed 3ph lines, it is sufficient to use attributes of the line segment, which describe impedances and admittances for the entire length of the segment. Additionally impedances can be computed by using length and associated per length impedances. The BaseVoltage at the two ends of ACLineSegments in a Line shall have the same BaseVoltage.nominalVoltage. However, boundary lines may have slightly different BaseVoltage.nominalVoltages and variation is allowed. Larger voltage difference in general requires use of an equivalent branch. + + :b0ch: Zero sequence shunt (charging) susceptance, uniformly distributed, of the entire line section. Default: 0.0 + :bch: Positive sequence shunt (charging) susceptance, uniformly distributed, of the entire line section. This value represents the full charging over the full length of the line. Default: 0.0 + :g0ch: Zero sequence shunt (charging) conductance, uniformly distributed, of the entire line section. Default: 0.0 + :gch: Positive sequence shunt (charging) conductance, uniformly distributed, of the entire line section. Default: 0.0 + :r: Positive sequence series resistance of the entire line section. Default: 0.0 + :r0: Zero sequence series resistance of the entire line section. Default: 0.0 + :shortCircuitEndTemperature: Maximum permitted temperature at the end of SC for the calculation of minimum short-circuit currents. Used for short circuit data exchange according to IEC 60909 Default: 0.0 + :x: Positive sequence series reactance of the entire line section. Default: 0.0 + :x0: Zero sequence series reactance of the entire line section. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "b0ch": [Profile.EQ.value, ], + "bch": [Profile.EQ.value, ], + "g0ch": [Profile.EQ.value, ], + "gch": [Profile.EQ.value, ], + "r": [Profile.EQ.value, ], + "r0": [Profile.EQ.value, ], + "shortCircuitEndTemperature": [Profile.EQ.value, ], + "x": [Profile.EQ.value, ], + "x0": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Conductor:\n" + Conductor.__doc__ + + def __init__(self, b0ch = 0.0, bch = 0.0, g0ch = 0.0, gch = 0.0, r = 0.0, r0 = 0.0, shortCircuitEndTemperature = 0.0, x = 0.0, x0 = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.b0ch = b0ch + self.bch = bch + self.g0ch = g0ch + self.gch = gch + self.r = r + self.r0 = r0 + self.shortCircuitEndTemperature = shortCircuitEndTemperature + self.x = x + self.x0 = x0 + + def __str__(self): + str = "class=ACLineSegment\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Accumulator.py b/cimpy/cgmes_v2_4_15/Accumulator.py index 3c1e4e27..06cec75b 100644 --- a/cimpy/cgmes_v2_4_15/Accumulator.py +++ b/cimpy/cgmes_v2_4_15/Accumulator.py @@ -1,34 +1,36 @@ -from .Measurement import Measurement - - -class Accumulator(Measurement): - ''' - Accumulator represents an accumulated (counted) Measurement, e.g. an energy value. - - :LimitSets: The Measurements using the LimitSet. Default: "list" - :AccumulatorValues: Measurement to which this value is connected. Default: "list" - ''' - - cgmesProfile = Measurement.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'LimitSets': [cgmesProfile.EQ.value, ], - 'AccumulatorValues': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Measurement: \n' + Measurement.__doc__ - - def __init__(self, LimitSets = "list", AccumulatorValues = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.LimitSets = LimitSets - self.AccumulatorValues = AccumulatorValues - - def __str__(self): - str = 'class=Accumulator\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Measurement import Measurement +from .CGMESProfile import Profile + + +class Accumulator(Measurement): + """ + Accumulator represents an accumulated (counted) Measurement, e.g. an energy value. + + :AccumulatorValues: Measurement to which this value is connected. Default: "list" + :LimitSets: The Measurements using the LimitSet. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "AccumulatorValues": [Profile.EQ.value, ], + "LimitSets": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Measurement:\n" + Measurement.__doc__ + + def __init__(self, AccumulatorValues = "list", LimitSets = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.AccumulatorValues = AccumulatorValues + self.LimitSets = LimitSets + + def __str__(self): + str = "class=Accumulator\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AccumulatorLimit.py b/cimpy/cgmes_v2_4_15/AccumulatorLimit.py index 0cc2134e..c8c93bc2 100644 --- a/cimpy/cgmes_v2_4_15/AccumulatorLimit.py +++ b/cimpy/cgmes_v2_4_15/AccumulatorLimit.py @@ -1,34 +1,36 @@ -from .Limit import Limit - - -class AccumulatorLimit(Limit): - ''' - Limit values for Accumulator measurements. - - :value: The value to supervise against. The value is positive. Default: 0 - :LimitSet: The limit values used for supervision of Measurements. Default: None - ''' - - cgmesProfile = Limit.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'LimitSet': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Limit: \n' + Limit.__doc__ - - def __init__(self, value = 0, LimitSet = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.value = value - self.LimitSet = LimitSet - - def __str__(self): - str = 'class=AccumulatorLimit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Limit import Limit +from .CGMESProfile import Profile + + +class AccumulatorLimit(Limit): + """ + Limit values for Accumulator measurements. + + :LimitSet: The limit values used for supervision of Measurements. Default: None + :value: The value to supervise against. The value is positive. Default: 0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "LimitSet": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Limit:\n" + Limit.__doc__ + + def __init__(self, LimitSet = None, value = 0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.LimitSet = LimitSet + self.value = value + + def __str__(self): + str = "class=AccumulatorLimit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AccumulatorLimitSet.py b/cimpy/cgmes_v2_4_15/AccumulatorLimitSet.py index 723fdc17..27c4be86 100644 --- a/cimpy/cgmes_v2_4_15/AccumulatorLimitSet.py +++ b/cimpy/cgmes_v2_4_15/AccumulatorLimitSet.py @@ -1,34 +1,36 @@ -from .LimitSet import LimitSet - - -class AccumulatorLimitSet(LimitSet): - ''' - An AccumulatorLimitSet specifies a set of Limits that are associated with an Accumulator measurement. - - :Measurements: A measurement may have zero or more limit ranges defined for it. Default: "list" - :Limits: The set of limits. Default: "list" - ''' - - cgmesProfile = LimitSet.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'Measurements': [cgmesProfile.EQ.value, ], - 'Limits': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class LimitSet: \n' + LimitSet.__doc__ - - def __init__(self, Measurements = "list", Limits = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Measurements = Measurements - self.Limits = Limits - - def __str__(self): - str = 'class=AccumulatorLimitSet\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .LimitSet import LimitSet +from .CGMESProfile import Profile + + +class AccumulatorLimitSet(LimitSet): + """ + An AccumulatorLimitSet specifies a set of Limits that are associated with an Accumulator measurement. + + :Limits: The set of limits. Default: "list" + :Measurements: A measurement may have zero or more limit ranges defined for it. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "Limits": [Profile.EQ.value, ], + "Measurements": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class LimitSet:\n" + LimitSet.__doc__ + + def __init__(self, Limits = "list", Measurements = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Limits = Limits + self.Measurements = Measurements + + def __str__(self): + str = "class=AccumulatorLimitSet\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AccumulatorReset.py b/cimpy/cgmes_v2_4_15/AccumulatorReset.py index 4b860b02..00c041e9 100644 --- a/cimpy/cgmes_v2_4_15/AccumulatorReset.py +++ b/cimpy/cgmes_v2_4_15/AccumulatorReset.py @@ -1,31 +1,33 @@ -from .Control import Control - - -class AccumulatorReset(Control): - ''' - This command reset the counter value to zero. - - :AccumulatorValue: The accumulator value that is reset by the command. Default: None - ''' - - cgmesProfile = Control.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'AccumulatorValue': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Control: \n' + Control.__doc__ - - def __init__(self, AccumulatorValue = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.AccumulatorValue = AccumulatorValue - - def __str__(self): - str = 'class=AccumulatorReset\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Control import Control +from .CGMESProfile import Profile + + +class AccumulatorReset(Control): + """ + This command reset the counter value to zero. + + :AccumulatorValue: The accumulator value that is reset by the command. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "AccumulatorValue": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Control:\n" + Control.__doc__ + + def __init__(self, AccumulatorValue = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.AccumulatorValue = AccumulatorValue + + def __str__(self): + str = "class=AccumulatorReset\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AccumulatorValue.py b/cimpy/cgmes_v2_4_15/AccumulatorValue.py index 2bb3c79f..d670f593 100644 --- a/cimpy/cgmes_v2_4_15/AccumulatorValue.py +++ b/cimpy/cgmes_v2_4_15/AccumulatorValue.py @@ -1,37 +1,39 @@ -from .MeasurementValue import MeasurementValue - - -class AccumulatorValue(MeasurementValue): - ''' - AccumulatorValue represents an accumulated (counted) MeasurementValue. - - :Accumulator: The values connected to this measurement. Default: None - :AccumulatorReset: The command that reset the accumulator value. Default: None - :value: The value to supervise. The value is positive. Default: 0 - ''' - - cgmesProfile = MeasurementValue.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'Accumulator': [cgmesProfile.EQ.value, ], - 'AccumulatorReset': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class MeasurementValue: \n' + MeasurementValue.__doc__ - - def __init__(self, Accumulator = None, AccumulatorReset = None, value = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Accumulator = Accumulator - self.AccumulatorReset = AccumulatorReset - self.value = value - - def __str__(self): - str = 'class=AccumulatorValue\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .MeasurementValue import MeasurementValue +from .CGMESProfile import Profile + + +class AccumulatorValue(MeasurementValue): + """ + AccumulatorValue represents an accumulated (counted) MeasurementValue. + + :Accumulator: The values connected to this measurement. Default: None + :AccumulatorReset: The command that reset the accumulator value. Default: None + :value: The value to supervise. The value is positive. Default: 0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "Accumulator": [Profile.EQ.value, ], + "AccumulatorReset": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class MeasurementValue:\n" + MeasurementValue.__doc__ + + def __init__(self, Accumulator = None, AccumulatorReset = None, value = 0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Accumulator = Accumulator + self.AccumulatorReset = AccumulatorReset + self.value = value + + def __str__(self): + str = "class=AccumulatorValue\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ActivePower.py b/cimpy/cgmes_v2_4_15/ActivePower.py index f8d6db3a..b92697a5 100644 --- a/cimpy/cgmes_v2_4_15/ActivePower.py +++ b/cimpy/cgmes_v2_4_15/ActivePower.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class ActivePower(Base): - ''' - Product of RMS value of the voltage and the RMS value of the in-phase component of the current. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - 'value': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - 'unit': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - 'multiplier': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=ActivePower\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ActivePower(Base): + """ + Product of RMS value of the voltage and the RMS value of the in-phase component of the current. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "multiplier": [Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "unit": [Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "value": [Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=ActivePower\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ActivePowerLimit.py b/cimpy/cgmes_v2_4_15/ActivePowerLimit.py index 48ed971c..f9b97593 100644 --- a/cimpy/cgmes_v2_4_15/ActivePowerLimit.py +++ b/cimpy/cgmes_v2_4_15/ActivePowerLimit.py @@ -1,31 +1,33 @@ -from .OperationalLimit import OperationalLimit - - -class ActivePowerLimit(OperationalLimit): - ''' - Limit on active power flow. - - :value: Value of active power limit. Default: 0.0 - ''' - - cgmesProfile = OperationalLimit.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class OperationalLimit: \n' + OperationalLimit.__doc__ - - def __init__(self, value = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.value = value - - def __str__(self): - str = 'class=ActivePowerLimit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .OperationalLimit import OperationalLimit +from .CGMESProfile import Profile + + +class ActivePowerLimit(OperationalLimit): + """ + Limit on active power flow. + + :value: Value of active power limit. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class OperationalLimit:\n" + OperationalLimit.__doc__ + + def __init__(self, value = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.value = value + + def __str__(self): + str = "class=ActivePowerLimit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ActivePowerPerCurrentFlow.py b/cimpy/cgmes_v2_4_15/ActivePowerPerCurrentFlow.py index 37d2ec20..25f8f87f 100644 --- a/cimpy/cgmes_v2_4_15/ActivePowerPerCurrentFlow.py +++ b/cimpy/cgmes_v2_4_15/ActivePowerPerCurrentFlow.py @@ -1,42 +1,43 @@ -from .Base import Base - - -class ActivePowerPerCurrentFlow(Base): - ''' - - - :denominatorMultiplier: Default: None - :denominatorUnit: Default: None - :multiplier: Default: None - :unit: Default: None - :value: Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'denominatorMultiplier': [cgmesProfile.EQ.value, ], - 'denominatorUnit': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, denominatorMultiplier = None, denominatorUnit = None, multiplier = None, unit = None, value = 0.0, ): - - self.denominatorMultiplier = denominatorMultiplier - self.denominatorUnit = denominatorUnit - self.multiplier = multiplier - self.unit = unit - self.value = value - - def __str__(self): - str = 'class=ActivePowerPerCurrentFlow\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ActivePowerPerCurrentFlow(Base): + """ + + + :denominatorMultiplier: Default: None + :denominatorUnit: Default: None + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "denominatorMultiplier": [Profile.EQ.value, ], + "denominatorUnit": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, denominatorMultiplier = None, denominatorUnit = None, multiplier = None, unit = None, value = 0.0): + + self.denominatorMultiplier = denominatorMultiplier + self.denominatorUnit = denominatorUnit + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=ActivePowerPerCurrentFlow\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ActivePowerPerFrequency.py b/cimpy/cgmes_v2_4_15/ActivePowerPerFrequency.py index f0e4f80c..dbada5d8 100644 --- a/cimpy/cgmes_v2_4_15/ActivePowerPerFrequency.py +++ b/cimpy/cgmes_v2_4_15/ActivePowerPerFrequency.py @@ -1,42 +1,43 @@ -from .Base import Base - - -class ActivePowerPerFrequency(Base): - ''' - Active power variation with frequency. - - :denominatorMultiplier: Default: None - :denominatorUnit: Default: None - :multiplier: Default: None - :unit: Default: None - :value: Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'denominatorMultiplier': [cgmesProfile.EQ.value, ], - 'denominatorUnit': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, denominatorMultiplier = None, denominatorUnit = None, multiplier = None, unit = None, value = 0.0, ): - - self.denominatorMultiplier = denominatorMultiplier - self.denominatorUnit = denominatorUnit - self.multiplier = multiplier - self.unit = unit - self.value = value - - def __str__(self): - str = 'class=ActivePowerPerFrequency\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ActivePowerPerFrequency(Base): + """ + Active power variation with frequency. + + :denominatorMultiplier: Default: None + :denominatorUnit: Default: None + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "denominatorMultiplier": [Profile.EQ.value, ], + "denominatorUnit": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, denominatorMultiplier = None, denominatorUnit = None, multiplier = None, unit = None, value = 0.0): + + self.denominatorMultiplier = denominatorMultiplier + self.denominatorUnit = denominatorUnit + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=ActivePowerPerFrequency\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Analog.py b/cimpy/cgmes_v2_4_15/Analog.py index 9da6ca35..1aef7736 100644 --- a/cimpy/cgmes_v2_4_15/Analog.py +++ b/cimpy/cgmes_v2_4_15/Analog.py @@ -1,37 +1,39 @@ -from .Measurement import Measurement - - -class Analog(Measurement): - ''' - Analog represents an analog Measurement. - - :positiveFlowIn: If true then this measurement is an active power, reactive power or current with the convention that a positive value measured at the Terminal means power is flowing into the related PowerSystemResource. Default: False - :AnalogValues: Measurement to which this value is connected. Default: "list" - :LimitSets: The Measurements using the LimitSet. Default: "list" - ''' - - cgmesProfile = Measurement.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'positiveFlowIn': [cgmesProfile.EQ.value, ], - 'AnalogValues': [cgmesProfile.EQ.value, ], - 'LimitSets': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Measurement: \n' + Measurement.__doc__ - - def __init__(self, positiveFlowIn = False, AnalogValues = "list", LimitSets = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.positiveFlowIn = positiveFlowIn - self.AnalogValues = AnalogValues - self.LimitSets = LimitSets - - def __str__(self): - str = 'class=Analog\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Measurement import Measurement +from .CGMESProfile import Profile + + +class Analog(Measurement): + """ + Analog represents an analog Measurement. + + :AnalogValues: Measurement to which this value is connected. Default: "list" + :LimitSets: The Measurements using the LimitSet. Default: "list" + :positiveFlowIn: If true then this measurement is an active power, reactive power or current with the convention that a positive value measured at the Terminal means power is flowing into the related PowerSystemResource. Default: False + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "AnalogValues": [Profile.EQ.value, ], + "LimitSets": [Profile.EQ.value, ], + "positiveFlowIn": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Measurement:\n" + Measurement.__doc__ + + def __init__(self, AnalogValues = "list", LimitSets = "list", positiveFlowIn = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.AnalogValues = AnalogValues + self.LimitSets = LimitSets + self.positiveFlowIn = positiveFlowIn + + def __str__(self): + str = "class=Analog\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AnalogControl.py b/cimpy/cgmes_v2_4_15/AnalogControl.py index f68f3945..7e6d88ee 100644 --- a/cimpy/cgmes_v2_4_15/AnalogControl.py +++ b/cimpy/cgmes_v2_4_15/AnalogControl.py @@ -1,37 +1,39 @@ -from .Control import Control - - -class AnalogControl(Control): - ''' - An analog control used for supervisory control. - - :maxValue: Normal value range maximum for any of the Control.value. Used for scaling, e.g. in bar graphs. Default: 0.0 - :minValue: Normal value range minimum for any of the Control.value. Used for scaling, e.g. in bar graphs. Default: 0.0 - :AnalogValue: The Control variable associated with the MeasurementValue. Default: None - ''' - - cgmesProfile = Control.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'maxValue': [cgmesProfile.EQ.value, ], - 'minValue': [cgmesProfile.EQ.value, ], - 'AnalogValue': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Control: \n' + Control.__doc__ - - def __init__(self, maxValue = 0.0, minValue = 0.0, AnalogValue = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.maxValue = maxValue - self.minValue = minValue - self.AnalogValue = AnalogValue - - def __str__(self): - str = 'class=AnalogControl\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Control import Control +from .CGMESProfile import Profile + + +class AnalogControl(Control): + """ + An analog control used for supervisory control. + + :AnalogValue: The Control variable associated with the MeasurementValue. Default: None + :maxValue: Normal value range maximum for any of the Control.value. Used for scaling, e.g. in bar graphs. Default: 0.0 + :minValue: Normal value range minimum for any of the Control.value. Used for scaling, e.g. in bar graphs. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "AnalogValue": [Profile.EQ.value, ], + "maxValue": [Profile.EQ.value, ], + "minValue": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Control:\n" + Control.__doc__ + + def __init__(self, AnalogValue = None, maxValue = 0.0, minValue = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.AnalogValue = AnalogValue + self.maxValue = maxValue + self.minValue = minValue + + def __str__(self): + str = "class=AnalogControl\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AnalogLimit.py b/cimpy/cgmes_v2_4_15/AnalogLimit.py index e60bec52..b6b594eb 100644 --- a/cimpy/cgmes_v2_4_15/AnalogLimit.py +++ b/cimpy/cgmes_v2_4_15/AnalogLimit.py @@ -1,34 +1,36 @@ -from .Limit import Limit - - -class AnalogLimit(Limit): - ''' - Limit values for Analog measurements. - - :value: The value to supervise against. Default: 0.0 - :LimitSet: The limit values used for supervision of Measurements. Default: None - ''' - - cgmesProfile = Limit.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'LimitSet': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Limit: \n' + Limit.__doc__ - - def __init__(self, value = 0.0, LimitSet = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.value = value - self.LimitSet = LimitSet - - def __str__(self): - str = 'class=AnalogLimit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Limit import Limit +from .CGMESProfile import Profile + + +class AnalogLimit(Limit): + """ + Limit values for Analog measurements. + + :LimitSet: The limit values used for supervision of Measurements. Default: None + :value: The value to supervise against. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "LimitSet": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Limit:\n" + Limit.__doc__ + + def __init__(self, LimitSet = None, value = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.LimitSet = LimitSet + self.value = value + + def __str__(self): + str = "class=AnalogLimit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AnalogLimitSet.py b/cimpy/cgmes_v2_4_15/AnalogLimitSet.py index 31301b9f..24457b9e 100644 --- a/cimpy/cgmes_v2_4_15/AnalogLimitSet.py +++ b/cimpy/cgmes_v2_4_15/AnalogLimitSet.py @@ -1,34 +1,36 @@ -from .LimitSet import LimitSet - - -class AnalogLimitSet(LimitSet): - ''' - An AnalogLimitSet specifies a set of Limits that are associated with an Analog measurement. - - :Measurements: A measurement may have zero or more limit ranges defined for it. Default: "list" - :Limits: The set of limits. Default: "list" - ''' - - cgmesProfile = LimitSet.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'Measurements': [cgmesProfile.EQ.value, ], - 'Limits': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class LimitSet: \n' + LimitSet.__doc__ - - def __init__(self, Measurements = "list", Limits = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Measurements = Measurements - self.Limits = Limits - - def __str__(self): - str = 'class=AnalogLimitSet\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .LimitSet import LimitSet +from .CGMESProfile import Profile + + +class AnalogLimitSet(LimitSet): + """ + An AnalogLimitSet specifies a set of Limits that are associated with an Analog measurement. + + :Limits: The set of limits. Default: "list" + :Measurements: A measurement may have zero or more limit ranges defined for it. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "Limits": [Profile.EQ.value, ], + "Measurements": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class LimitSet:\n" + LimitSet.__doc__ + + def __init__(self, Limits = "list", Measurements = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Limits = Limits + self.Measurements = Measurements + + def __str__(self): + str = "class=AnalogLimitSet\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AnalogValue.py b/cimpy/cgmes_v2_4_15/AnalogValue.py index 7c738f56..dbb31587 100644 --- a/cimpy/cgmes_v2_4_15/AnalogValue.py +++ b/cimpy/cgmes_v2_4_15/AnalogValue.py @@ -1,37 +1,39 @@ -from .MeasurementValue import MeasurementValue - - -class AnalogValue(MeasurementValue): - ''' - AnalogValue represents an analog MeasurementValue. - - :Analog: The values connected to this measurement. Default: None - :AnalogControl: The MeasurementValue that is controlled. Default: None - :value: The value to supervise. Default: 0.0 - ''' - - cgmesProfile = MeasurementValue.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'Analog': [cgmesProfile.EQ.value, ], - 'AnalogControl': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class MeasurementValue: \n' + MeasurementValue.__doc__ - - def __init__(self, Analog = None, AnalogControl = None, value = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Analog = Analog - self.AnalogControl = AnalogControl - self.value = value - - def __str__(self): - str = 'class=AnalogValue\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .MeasurementValue import MeasurementValue +from .CGMESProfile import Profile + + +class AnalogValue(MeasurementValue): + """ + AnalogValue represents an analog MeasurementValue. + + :Analog: The values connected to this measurement. Default: None + :AnalogControl: The MeasurementValue that is controlled. Default: None + :value: The value to supervise. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "Analog": [Profile.EQ.value, ], + "AnalogControl": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class MeasurementValue:\n" + MeasurementValue.__doc__ + + def __init__(self, Analog = None, AnalogControl = None, value = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Analog = Analog + self.AnalogControl = AnalogControl + self.value = value + + def __str__(self): + str = "class=AnalogValue\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AngleDegrees.py b/cimpy/cgmes_v2_4_15/AngleDegrees.py index 26bb7606..d22fdec6 100644 --- a/cimpy/cgmes_v2_4_15/AngleDegrees.py +++ b/cimpy/cgmes_v2_4_15/AngleDegrees.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class AngleDegrees(Base): - ''' - Measurement of angle in degrees. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - 'value': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - 'unit': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - 'multiplier': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=AngleDegrees\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class AngleDegrees(Base): + """ + Measurement of angle in degrees. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DL.value, Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "multiplier": [Profile.DL.value, Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "unit": [Profile.DL.value, Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "value": [Profile.DL.value, Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=AngleDegrees\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AngleRadians.py b/cimpy/cgmes_v2_4_15/AngleRadians.py index e19cf56c..80fbab89 100644 --- a/cimpy/cgmes_v2_4_15/AngleRadians.py +++ b/cimpy/cgmes_v2_4_15/AngleRadians.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class AngleRadians(Base): - ''' - Phase angle in radians. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=AngleRadians\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class AngleRadians(Base): + """ + Phase angle in radians. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=AngleRadians\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ApparentPower.py b/cimpy/cgmes_v2_4_15/ApparentPower.py index 4fb401a6..ec652945 100644 --- a/cimpy/cgmes_v2_4_15/ApparentPower.py +++ b/cimpy/cgmes_v2_4_15/ApparentPower.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class ApparentPower(Base): - ''' - Product of the RMS value of the voltage and the RMS value of the current. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'value': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'unit': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'multiplier': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=ApparentPower\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ApparentPower(Base): + """ + Product of the RMS value of the voltage and the RMS value of the current. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, ], + "multiplier": [Profile.DY.value, Profile.EQ.value, ], + "unit": [Profile.DY.value, Profile.EQ.value, ], + "value": [Profile.DY.value, Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=ApparentPower\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ApparentPowerLimit.py b/cimpy/cgmes_v2_4_15/ApparentPowerLimit.py index d442accb..8b235b8f 100644 --- a/cimpy/cgmes_v2_4_15/ApparentPowerLimit.py +++ b/cimpy/cgmes_v2_4_15/ApparentPowerLimit.py @@ -1,31 +1,33 @@ -from .OperationalLimit import OperationalLimit - - -class ApparentPowerLimit(OperationalLimit): - ''' - Apparent power limit. - - :value: The apparent power limit. Default: 0.0 - ''' - - cgmesProfile = OperationalLimit.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class OperationalLimit: \n' + OperationalLimit.__doc__ - - def __init__(self, value = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.value = value - - def __str__(self): - str = 'class=ApparentPowerLimit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .OperationalLimit import OperationalLimit +from .CGMESProfile import Profile + + +class ApparentPowerLimit(OperationalLimit): + """ + Apparent power limit. + + :value: The apparent power limit. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class OperationalLimit:\n" + OperationalLimit.__doc__ + + def __init__(self, value = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.value = value + + def __str__(self): + str = "class=ApparentPowerLimit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Area.py b/cimpy/cgmes_v2_4_15/Area.py index 98325450..5c014a73 100644 --- a/cimpy/cgmes_v2_4_15/Area.py +++ b/cimpy/cgmes_v2_4_15/Area.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class Area(Base): - ''' - Area. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'value': [cgmesProfile.DY.value, ], - 'unit': [cgmesProfile.DY.value, ], - 'multiplier': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=Area\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Area(Base): + """ + Area. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "multiplier": [Profile.DY.value, ], + "unit": [Profile.DY.value, ], + "value": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=Area\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AsynchronousMachine.py b/cimpy/cgmes_v2_4_15/AsynchronousMachine.py index 4ffe7d29..dced376f 100644 --- a/cimpy/cgmes_v2_4_15/AsynchronousMachine.py +++ b/cimpy/cgmes_v2_4_15/AsynchronousMachine.py @@ -1,61 +1,63 @@ -from .RotatingMachine import RotatingMachine - - -class AsynchronousMachine(RotatingMachine): - ''' - A rotating machine whose shaft rotates asynchronously with the electrical field. Also known as an induction machine with no external connection to the rotor windings, e.g squirrel-cage induction machine. - - :nominalFrequency: Nameplate data indicates if the machine is 50 or 60 Hz. Default: 0.0 - :nominalSpeed: Nameplate data. Depends on the slip and number of pole pairs. Default: 0.0 - :converterFedDrive: Indicates whether the machine is a converter fed drive. Used for short circuit data exchange according to IEC 60909 Default: False - :efficiency: Efficiency of the asynchronous machine at nominal operation in percent. Indicator for converter drive motors. Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :iaIrRatio: Ratio of locked-rotor current to the rated current of the motor (Ia/Ir). Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :polePairNumber: Number of pole pairs of stator. Used for short circuit data exchange according to IEC 60909 Default: 0 - :ratedMechanicalPower: Rated mechanical power (Pr in the IEC 60909-0). Used for short circuit data exchange according to IEC 60909. Default: 0.0 - :reversible: Indicates for converter drive motors if the power can be reversible. Used for short circuit data exchange according to IEC 60909 Default: False - :rxLockedRotorRatio: Locked rotor ratio (R/X). Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :asynchronousMachineType: Indicates the type of Asynchronous Machine (motor or generator). Default: None - :AsynchronousMachineDynamics: Asynchronous machine dynamics model used to describe dynamic behavior of this asynchronous machine. Default: None - ''' - - cgmesProfile = RotatingMachine.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.DY.value, ], - 'nominalFrequency': [cgmesProfile.EQ.value, ], - 'nominalSpeed': [cgmesProfile.EQ.value, ], - 'converterFedDrive': [cgmesProfile.EQ.value, ], - 'efficiency': [cgmesProfile.EQ.value, ], - 'iaIrRatio': [cgmesProfile.EQ.value, ], - 'polePairNumber': [cgmesProfile.EQ.value, ], - 'ratedMechanicalPower': [cgmesProfile.EQ.value, ], - 'reversible': [cgmesProfile.EQ.value, ], - 'rxLockedRotorRatio': [cgmesProfile.EQ.value, ], - 'asynchronousMachineType': [cgmesProfile.SSH.value, ], - 'AsynchronousMachineDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class RotatingMachine: \n' + RotatingMachine.__doc__ - - def __init__(self, nominalFrequency = 0.0, nominalSpeed = 0.0, converterFedDrive = False, efficiency = 0.0, iaIrRatio = 0.0, polePairNumber = 0, ratedMechanicalPower = 0.0, reversible = False, rxLockedRotorRatio = 0.0, asynchronousMachineType = None, AsynchronousMachineDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.nominalFrequency = nominalFrequency - self.nominalSpeed = nominalSpeed - self.converterFedDrive = converterFedDrive - self.efficiency = efficiency - self.iaIrRatio = iaIrRatio - self.polePairNumber = polePairNumber - self.ratedMechanicalPower = ratedMechanicalPower - self.reversible = reversible - self.rxLockedRotorRatio = rxLockedRotorRatio - self.asynchronousMachineType = asynchronousMachineType - self.AsynchronousMachineDynamics = AsynchronousMachineDynamics - - def __str__(self): - str = 'class=AsynchronousMachine\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .RotatingMachine import RotatingMachine +from .CGMESProfile import Profile + + +class AsynchronousMachine(RotatingMachine): + """ + A rotating machine whose shaft rotates asynchronously with the electrical field. Also known as an induction machine with no external connection to the rotor windings, e.g squirrel-cage induction machine. + + :AsynchronousMachineDynamics: Asynchronous machine dynamics model used to describe dynamic behavior of this asynchronous machine. Default: None + :asynchronousMachineType: Indicates the type of Asynchronous Machine (motor or generator). Default: None + :converterFedDrive: Indicates whether the machine is a converter fed drive. Used for short circuit data exchange according to IEC 60909 Default: False + :efficiency: Efficiency of the asynchronous machine at nominal operation in percent. Indicator for converter drive motors. Used for short circuit data exchange according to IEC 60909 Default: 0.0 + :iaIrRatio: Ratio of locked-rotor current to the rated current of the motor (Ia/Ir). Used for short circuit data exchange according to IEC 60909 Default: 0.0 + :nominalFrequency: Nameplate data indicates if the machine is 50 or 60 Hz. Default: 0.0 + :nominalSpeed: Nameplate data. Depends on the slip and number of pole pairs. Default: 0.0 + :polePairNumber: Number of pole pairs of stator. Used for short circuit data exchange according to IEC 60909 Default: 0 + :ratedMechanicalPower: Rated mechanical power (Pr in the IEC 60909-0). Used for short circuit data exchange according to IEC 60909. Default: 0.0 + :reversible: Indicates for converter drive motors if the power can be reversible. Used for short circuit data exchange according to IEC 60909 Default: False + :rxLockedRotorRatio: Locked rotor ratio (R/X). Used for short circuit data exchange according to IEC 60909 Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, Profile.SSH.value, ], + "AsynchronousMachineDynamics": [Profile.DY.value, ], + "asynchronousMachineType": [Profile.SSH.value, ], + "converterFedDrive": [Profile.EQ.value, ], + "efficiency": [Profile.EQ.value, ], + "iaIrRatio": [Profile.EQ.value, ], + "nominalFrequency": [Profile.EQ.value, ], + "nominalSpeed": [Profile.EQ.value, ], + "polePairNumber": [Profile.EQ.value, ], + "ratedMechanicalPower": [Profile.EQ.value, ], + "reversible": [Profile.EQ.value, ], + "rxLockedRotorRatio": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class RotatingMachine:\n" + RotatingMachine.__doc__ + + def __init__(self, AsynchronousMachineDynamics = None, asynchronousMachineType = None, converterFedDrive = False, efficiency = 0.0, iaIrRatio = 0.0, nominalFrequency = 0.0, nominalSpeed = 0.0, polePairNumber = 0, ratedMechanicalPower = 0.0, reversible = False, rxLockedRotorRatio = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.AsynchronousMachineDynamics = AsynchronousMachineDynamics + self.asynchronousMachineType = asynchronousMachineType + self.converterFedDrive = converterFedDrive + self.efficiency = efficiency + self.iaIrRatio = iaIrRatio + self.nominalFrequency = nominalFrequency + self.nominalSpeed = nominalSpeed + self.polePairNumber = polePairNumber + self.ratedMechanicalPower = ratedMechanicalPower + self.reversible = reversible + self.rxLockedRotorRatio = rxLockedRotorRatio + + def __str__(self): + str = "class=AsynchronousMachine\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AsynchronousMachineDynamics.py b/cimpy/cgmes_v2_4_15/AsynchronousMachineDynamics.py index aab3bd49..c1c62983 100644 --- a/cimpy/cgmes_v2_4_15/AsynchronousMachineDynamics.py +++ b/cimpy/cgmes_v2_4_15/AsynchronousMachineDynamics.py @@ -1,40 +1,42 @@ -from .RotatingMachineDynamics import RotatingMachineDynamics - - -class AsynchronousMachineDynamics(RotatingMachineDynamics): - ''' - Asynchronous machine whose behaviour is described by reference to a standard model expressed in either time constant reactance form or equivalent circuit form - - :AsynchronousMachine: Asynchronous machine to which this asynchronous machine dynamics model applies. Default: None - :MechanicalLoadDynamics: Mechanical load model associated with this asynchronous machine model. Default: None - :WindTurbineType1or2Dynamics: Wind generator type 1 or 2 model associated with this asynchronous machine model. Default: None - :TurbineGovernorDynamics: Turbine-governor model associated with this asynchronous machine model. Default: None - ''' - - cgmesProfile = RotatingMachineDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'AsynchronousMachine': [cgmesProfile.DY.value, ], - 'MechanicalLoadDynamics': [cgmesProfile.DY.value, ], - 'WindTurbineType1or2Dynamics': [cgmesProfile.DY.value, ], - 'TurbineGovernorDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class RotatingMachineDynamics: \n' + RotatingMachineDynamics.__doc__ - - def __init__(self, AsynchronousMachine = None, MechanicalLoadDynamics = None, WindTurbineType1or2Dynamics = None, TurbineGovernorDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.AsynchronousMachine = AsynchronousMachine - self.MechanicalLoadDynamics = MechanicalLoadDynamics - self.WindTurbineType1or2Dynamics = WindTurbineType1or2Dynamics - self.TurbineGovernorDynamics = TurbineGovernorDynamics - - def __str__(self): - str = 'class=AsynchronousMachineDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .RotatingMachineDynamics import RotatingMachineDynamics +from .CGMESProfile import Profile + + +class AsynchronousMachineDynamics(RotatingMachineDynamics): + """ + Asynchronous machine whose behaviour is described by reference to a standard model expressed in either time constant reactance form or equivalent circuit form + + :AsynchronousMachine: Asynchronous machine to which this asynchronous machine dynamics model applies. Default: None + :MechanicalLoadDynamics: Mechanical load model associated with this asynchronous machine model. Default: None + :TurbineGovernorDynamics: Turbine-governor model associated with this asynchronous machine model. Default: None + :WindTurbineType1or2Dynamics: Wind generator type 1 or 2 model associated with this asynchronous machine model. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "AsynchronousMachine": [Profile.DY.value, ], + "MechanicalLoadDynamics": [Profile.DY.value, ], + "TurbineGovernorDynamics": [Profile.DY.value, ], + "WindTurbineType1or2Dynamics": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class RotatingMachineDynamics:\n" + RotatingMachineDynamics.__doc__ + + def __init__(self, AsynchronousMachine = None, MechanicalLoadDynamics = None, TurbineGovernorDynamics = None, WindTurbineType1or2Dynamics = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.AsynchronousMachine = AsynchronousMachine + self.MechanicalLoadDynamics = MechanicalLoadDynamics + self.TurbineGovernorDynamics = TurbineGovernorDynamics + self.WindTurbineType1or2Dynamics = WindTurbineType1or2Dynamics + + def __str__(self): + str = "class=AsynchronousMachineDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AsynchronousMachineEquivalentCircuit.py b/cimpy/cgmes_v2_4_15/AsynchronousMachineEquivalentCircuit.py index 45c9d72d..34c645a8 100644 --- a/cimpy/cgmes_v2_4_15/AsynchronousMachineEquivalentCircuit.py +++ b/cimpy/cgmes_v2_4_15/AsynchronousMachineEquivalentCircuit.py @@ -1,43 +1,45 @@ -from .AsynchronousMachineDynamics import AsynchronousMachineDynamics - - -class AsynchronousMachineEquivalentCircuit(AsynchronousMachineDynamics): - ''' - The electrical equations of all variations of the asynchronous model are based on the AsynchronousEquivalentCircuit diagram for the direct and quadrature axes, with two equivalent rotor windings in each axis. = + = + * / ( + ) = + * * / ( * + * + * ) = ( + ) / ( * ) = ( * + * + * ) / ( * * (+ ) Same equations using CIM attributes from AsynchronousMachineTimeConstantReactance class on left of = sign and AsynchronousMachineEquivalentCircuit class on right (except as noted): xs = xm + RotatingMachineDynamics.statorLeakageReactance xp = RotatingMachineDynamics.statorLeakageReactance + xm * xlr1 / (xm + xlr1) xpp = RotatingMachineDynamics.statorLeakageReactance + xm * xlr1* xlr2 / (xm * xlr1 + xm * xlr2 + xlr1 * xlr2) tpo = (xm + xlr1) / (2*pi*nominal frequency * rr1) tppo = (xm * xlr1 + xm * xlr2 + xlr1 * xlr2) / (2*pi*nominal frequency * rr2 * (xm + xlr1). - - :xm: Magnetizing reactance. Default: 0.0 - :rr1: Damper 1 winding resistance. Default: 0.0 - :xlr1: Damper 1 winding leakage reactance. Default: 0.0 - :rr2: Damper 2 winding resistance. Default: 0.0 - :xlr2: Damper 2 winding leakage reactance. Default: 0.0 - ''' - - cgmesProfile = AsynchronousMachineDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'xm': [cgmesProfile.DY.value, ], - 'rr1': [cgmesProfile.DY.value, ], - 'xlr1': [cgmesProfile.DY.value, ], - 'rr2': [cgmesProfile.DY.value, ], - 'xlr2': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class AsynchronousMachineDynamics: \n' + AsynchronousMachineDynamics.__doc__ - - def __init__(self, xm = 0.0, rr1 = 0.0, xlr1 = 0.0, rr2 = 0.0, xlr2 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.xm = xm - self.rr1 = rr1 - self.xlr1 = xlr1 - self.rr2 = rr2 - self.xlr2 = xlr2 - - def __str__(self): - str = 'class=AsynchronousMachineEquivalentCircuit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .AsynchronousMachineDynamics import AsynchronousMachineDynamics +from .CGMESProfile import Profile + + +class AsynchronousMachineEquivalentCircuit(AsynchronousMachineDynamics): + """ + The electrical equations of all variations of the asynchronous model are based on the AsynchronousEquivalentCircuit diagram for the direct and quadrature axes, with two equivalent rotor windings in each axis. = + = + * / ( + ) = + * * / ( * + * + * ) = ( + ) / ( * ) = ( * + * + * ) / ( * * (+ ) Same equations using CIM attributes from AsynchronousMachineTimeConstantReactance class on left of = sign and AsynchronousMachineEquivalentCircuit class on right (except as noted): xs = xm + RotatingMachineDynamics.statorLeakageReactance xp = RotatingMachineDynamics.statorLeakageReactance + xm * xlr1 / (xm + xlr1) xpp = RotatingMachineDynamics.statorLeakageReactance + xm * xlr1* xlr2 / (xm * xlr1 + xm * xlr2 + xlr1 * xlr2) tpo = (xm + xlr1) / (2*pi*nominal frequency * rr1) tppo = (xm * xlr1 + xm * xlr2 + xlr1 * xlr2) / (2*pi*nominal frequency * rr2 * (xm + xlr1). + + :rr1: Damper 1 winding resistance. Default: 0.0 + :rr2: Damper 2 winding resistance. Default: 0.0 + :xlr1: Damper 1 winding leakage reactance. Default: 0.0 + :xlr2: Damper 2 winding leakage reactance. Default: 0.0 + :xm: Magnetizing reactance. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "rr1": [Profile.DY.value, ], + "rr2": [Profile.DY.value, ], + "xlr1": [Profile.DY.value, ], + "xlr2": [Profile.DY.value, ], + "xm": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class AsynchronousMachineDynamics:\n" + AsynchronousMachineDynamics.__doc__ + + def __init__(self, rr1 = 0.0, rr2 = 0.0, xlr1 = 0.0, xlr2 = 0.0, xm = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.rr1 = rr1 + self.rr2 = rr2 + self.xlr1 = xlr1 + self.xlr2 = xlr2 + self.xm = xm + + def __str__(self): + str = "class=AsynchronousMachineEquivalentCircuit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AsynchronousMachineKind.py b/cimpy/cgmes_v2_4_15/AsynchronousMachineKind.py index 68e19be3..a629eeb5 100644 --- a/cimpy/cgmes_v2_4_15/AsynchronousMachineKind.py +++ b/cimpy/cgmes_v2_4_15/AsynchronousMachineKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class AsynchronousMachineKind(Base): - ''' - Kind of Asynchronous Machine. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=AsynchronousMachineKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class AsynchronousMachineKind(Base): + """ + Kind of Asynchronous Machine. + + """ + + possibleProfileList = { + "class": [Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SSH.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=AsynchronousMachineKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AsynchronousMachineTimeConstantReactance.py b/cimpy/cgmes_v2_4_15/AsynchronousMachineTimeConstantReactance.py index 4c82181f..693fb767 100644 --- a/cimpy/cgmes_v2_4_15/AsynchronousMachineTimeConstantReactance.py +++ b/cimpy/cgmes_v2_4_15/AsynchronousMachineTimeConstantReactance.py @@ -1,43 +1,45 @@ -from .AsynchronousMachineDynamics import AsynchronousMachineDynamics - - -class AsynchronousMachineTimeConstantReactance(AsynchronousMachineDynamics): - ''' - The parameters used for models expressed in time constant reactance form include: - - :xs: Synchronous reactance (Xs) (>= X`). Typical Value = 1.8. Default: 0.0 - :xp: Transient reactance (unsaturated) (X`) (>=X``). Typical Value = 0.5. Default: 0.0 - :xpp: Subtransient reactance (unsaturated) (X``) (> Xl). Typical Value = 0.2. Default: 0.0 - :tpo: Transient rotor time constant (T`o) (> T``o). Typical Value = 5. Default: 0 - :tppo: Subtransient rotor time constant (T``o) (> 0). Typical Value = 0.03. Default: 0 - ''' - - cgmesProfile = AsynchronousMachineDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'xs': [cgmesProfile.DY.value, ], - 'xp': [cgmesProfile.DY.value, ], - 'xpp': [cgmesProfile.DY.value, ], - 'tpo': [cgmesProfile.DY.value, ], - 'tppo': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class AsynchronousMachineDynamics: \n' + AsynchronousMachineDynamics.__doc__ - - def __init__(self, xs = 0.0, xp = 0.0, xpp = 0.0, tpo = 0, tppo = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.xs = xs - self.xp = xp - self.xpp = xpp - self.tpo = tpo - self.tppo = tppo - - def __str__(self): - str = 'class=AsynchronousMachineTimeConstantReactance\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .AsynchronousMachineDynamics import AsynchronousMachineDynamics +from .CGMESProfile import Profile + + +class AsynchronousMachineTimeConstantReactance(AsynchronousMachineDynamics): + """ + The parameters used for models expressed in time constant reactance form include: + + :tpo: Transient rotor time constant (T`o) (> T``o). Typical Value = 5. Default: 0.0 + :tppo: Subtransient rotor time constant (T``o) (> 0). Typical Value = 0.03. Default: 0.0 + :xp: Transient reactance (unsaturated) (X`) (>=X``). Typical Value = 0.5. Default: 0.0 + :xpp: Subtransient reactance (unsaturated) (X``) (> Xl). Typical Value = 0.2. Default: 0.0 + :xs: Synchronous reactance (Xs) (>= X`). Typical Value = 1.8. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "tpo": [Profile.DY.value, ], + "tppo": [Profile.DY.value, ], + "xp": [Profile.DY.value, ], + "xpp": [Profile.DY.value, ], + "xs": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class AsynchronousMachineDynamics:\n" + AsynchronousMachineDynamics.__doc__ + + def __init__(self, tpo = 0.0, tppo = 0.0, xp = 0.0, xpp = 0.0, xs = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.tpo = tpo + self.tppo = tppo + self.xp = xp + self.xpp = xpp + self.xs = xs + + def __str__(self): + str = "class=AsynchronousMachineTimeConstantReactance\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/AsynchronousMachineUserDefined.py b/cimpy/cgmes_v2_4_15/AsynchronousMachineUserDefined.py index b7dfe177..9ac89d7f 100644 --- a/cimpy/cgmes_v2_4_15/AsynchronousMachineUserDefined.py +++ b/cimpy/cgmes_v2_4_15/AsynchronousMachineUserDefined.py @@ -1,34 +1,36 @@ -from .AsynchronousMachineDynamics import AsynchronousMachineDynamics - - -class AsynchronousMachineUserDefined(AsynchronousMachineDynamics): - ''' - Asynchronous machine whose dynamic behaviour is described by a user-defined model. - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = AsynchronousMachineDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class AsynchronousMachineDynamics: \n' + AsynchronousMachineDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=AsynchronousMachineUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .AsynchronousMachineDynamics import AsynchronousMachineDynamics +from .CGMESProfile import Profile + + +class AsynchronousMachineUserDefined(AsynchronousMachineDynamics): + """ + Asynchronous machine whose dynamic behaviour is described by a user-defined model. + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class AsynchronousMachineDynamics:\n" + AsynchronousMachineDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=AsynchronousMachineUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Base.py b/cimpy/cgmes_v2_4_15/Base.py index 0ae0d705..ddccd416 100644 --- a/cimpy/cgmes_v2_4_15/Base.py +++ b/cimpy/cgmes_v2_4_15/Base.py @@ -1,60 +1,7 @@ -from enum import Enum - -# Mapping between the profiles and their short names -short_profile_name = { - "DiagramLayout": 'DL', - "Dynamics": "DY", - "Equipment": "EQ", - "GeographicalLocation": "GL", - "StateVariables": "SV", - "SteadyStateHypothesis": "SSH", - "Topology": "TP" -} -long_profile_name = { - 'DL': "DiagramLayout", - 'DI': "DiagramLayout", - "DY": "Dynamics", - "EQ": "Equipment", - "GL": "GeographicalLocation", - "SV": "StateVariables", - "SSH": "SteadyStateHypothesis", - "TP": "Topology", -} - - -class Profile (Enum): - """ Enum containing all CGMES profiles and their export priority. - """ - EQ = 0 - SSH = 1 - TP = 2 - SV = 3 - DY = 4 - GL = 5 - DI = 6 - DL = 7 - TP_BD = 8 - EQ_BD = 9 - - def long_name(self): - """Testdocumentation - """ - return long_profile_name[self.name] - - @classmethod - def from_long_name(cls, long_name): - return cls[short_profile_name[long_name]] - - -class Base(): - """ - Base Class for CIM - """ - - cgmesProfile = Profile - - def __init__(self, *args, **kw_args): - pass - - def printxml(self, dict={}): - return dict +class Base: + """ + Base Class for CIM + """ + + def printxml(self, dict={}): + return dict diff --git a/cimpy/cgmes_v2_4_15/BaseVoltage.py b/cimpy/cgmes_v2_4_15/BaseVoltage.py index 7e1f3aa7..6283e22a 100644 --- a/cimpy/cgmes_v2_4_15/BaseVoltage.py +++ b/cimpy/cgmes_v2_4_15/BaseVoltage.py @@ -1,43 +1,45 @@ -from .IdentifiedObject import IdentifiedObject - - -class BaseVoltage(IdentifiedObject): - ''' - Defines a system base voltage which is referenced. - - :nominalVoltage: The power system resource`s base voltage. Default: 0.0 - :ConductingEquipment: Base voltage of this conducting equipment. Use only when there is no voltage level container used and only one base voltage applies. For example, not used for transformers. Default: "list" - :VoltageLevel: The voltage levels having this base voltage. Default: "list" - :TransformerEnds: Transformer ends at the base voltage. This is essential for PU calculation. Default: "list" - :TopologicalNode: The topological nodes at the base voltage. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.TP.value, cgmesProfile.TP_BD.value, cgmesProfile.EQ_BD.value, ], - 'nominalVoltage': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - 'ConductingEquipment': [cgmesProfile.EQ.value, ], - 'VoltageLevel': [cgmesProfile.EQ.value, ], - 'TransformerEnds': [cgmesProfile.EQ.value, ], - 'TopologicalNode': [cgmesProfile.TP.value, cgmesProfile.TP_BD.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, nominalVoltage = 0.0, ConductingEquipment = "list", VoltageLevel = "list", TransformerEnds = "list", TopologicalNode = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.nominalVoltage = nominalVoltage - self.ConductingEquipment = ConductingEquipment - self.VoltageLevel = VoltageLevel - self.TransformerEnds = TransformerEnds - self.TopologicalNode = TopologicalNode - - def __str__(self): - str = 'class=BaseVoltage\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class BaseVoltage(IdentifiedObject): + """ + Defines a system base voltage which is referenced. + + :ConductingEquipment: Base voltage of this conducting equipment. Use only when there is no voltage level container used and only one base voltage applies. For example, not used for transformers. Default: "list" + :TopologicalNode: The topological nodes at the base voltage. Default: "list" + :TransformerEnds: Transformer ends at the base voltage. This is essential for PU calculation. Default: "list" + :VoltageLevel: The voltage levels having this base voltage. Default: "list" + :nominalVoltage: The power system resource`s base voltage. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ_BD.value, Profile.EQ.value, Profile.TP_BD.value, Profile.TP.value, ], + "ConductingEquipment": [Profile.EQ.value, ], + "TopologicalNode": [Profile.TP_BD.value, Profile.TP.value, ], + "TransformerEnds": [Profile.EQ.value, ], + "VoltageLevel": [Profile.EQ.value, ], + "nominalVoltage": [Profile.EQ_BD.value, Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, ConductingEquipment = "list", TopologicalNode = "list", TransformerEnds = "list", VoltageLevel = "list", nominalVoltage = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ConductingEquipment = ConductingEquipment + self.TopologicalNode = TopologicalNode + self.TransformerEnds = TransformerEnds + self.VoltageLevel = VoltageLevel + self.nominalVoltage = nominalVoltage + + def __str__(self): + str = "class=BaseVoltage\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/BasicIntervalSchedule.py b/cimpy/cgmes_v2_4_15/BasicIntervalSchedule.py index 47a1c55e..13a7e7fc 100644 --- a/cimpy/cgmes_v2_4_15/BasicIntervalSchedule.py +++ b/cimpy/cgmes_v2_4_15/BasicIntervalSchedule.py @@ -1,37 +1,39 @@ -from .IdentifiedObject import IdentifiedObject - - -class BasicIntervalSchedule(IdentifiedObject): - ''' - Schedule of values at points in time. - - :startTime: The time for the first time point. Default: '' - :value1Unit: Value1 units of measure. Default: None - :value2Unit: Value2 units of measure. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'startTime': [cgmesProfile.EQ.value, ], - 'value1Unit': [cgmesProfile.EQ.value, ], - 'value2Unit': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, startTime = '', value1Unit = None, value2Unit = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.startTime = startTime - self.value1Unit = value1Unit - self.value2Unit = value2Unit - - def __str__(self): - str = 'class=BasicIntervalSchedule\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class BasicIntervalSchedule(IdentifiedObject): + """ + Schedule of values at points in time. + + :startTime: The time for the first time point. Default: '' + :value1Unit: Value1 units of measure. Default: None + :value2Unit: Value2 units of measure. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "startTime": [Profile.EQ.value, ], + "value1Unit": [Profile.EQ.value, ], + "value2Unit": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, startTime = '', value1Unit = None, value2Unit = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.startTime = startTime + self.value1Unit = value1Unit + self.value2Unit = value2Unit + + def __str__(self): + str = "class=BasicIntervalSchedule\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Bay.py b/cimpy/cgmes_v2_4_15/Bay.py index 9d4fddb0..4061b8dc 100644 --- a/cimpy/cgmes_v2_4_15/Bay.py +++ b/cimpy/cgmes_v2_4_15/Bay.py @@ -1,31 +1,33 @@ -from .EquipmentContainer import EquipmentContainer - - -class Bay(EquipmentContainer): - ''' - A collection of power system resources (within a given substation) including conducting equipment, protection relays, measurements, and telemetry. A bay typically represents a physical grouping related to modularization of equipment. - - :VoltageLevel: The voltage level containing this bay. Default: None - ''' - - cgmesProfile = EquipmentContainer.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'VoltageLevel': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EquipmentContainer: \n' + EquipmentContainer.__doc__ - - def __init__(self, VoltageLevel = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.VoltageLevel = VoltageLevel - - def __str__(self): - str = 'class=Bay\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EquipmentContainer import EquipmentContainer +from .CGMESProfile import Profile + + +class Bay(EquipmentContainer): + """ + A collection of power system resources (within a given substation) including conducting equipment, protection relays, measurements, and telemetry. A bay typically represents a physical grouping related to modularization of equipment. + + :VoltageLevel: The voltage level containing this bay. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "VoltageLevel": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EquipmentContainer:\n" + EquipmentContainer.__doc__ + + def __init__(self, VoltageLevel = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.VoltageLevel = VoltageLevel + + def __str__(self): + str = "class=Bay\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Boolean.py b/cimpy/cgmes_v2_4_15/Boolean.py index 77b933c6..dcb68ece 100644 --- a/cimpy/cgmes_v2_4_15/Boolean.py +++ b/cimpy/cgmes_v2_4_15/Boolean.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class Boolean(Base): - ''' - A type with the value space "true" and "false". - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, cgmesProfile.TP_BD.value, cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=Boolean\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Boolean(Base): + """ + A type with the value space "true" and "false". + + """ + + possibleProfileList = { + "class": [Profile.DL.value, Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, Profile.TP_BD.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=Boolean\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Breaker.py b/cimpy/cgmes_v2_4_15/Breaker.py index bbe5ceed..10383bed 100644 --- a/cimpy/cgmes_v2_4_15/Breaker.py +++ b/cimpy/cgmes_v2_4_15/Breaker.py @@ -1,29 +1,31 @@ -from .ProtectedSwitch import ProtectedSwitch - - -class Breaker(ProtectedSwitch): - ''' - A mechanical switching device capable of making, carrying, and breaking currents under normal circuit conditions and also making, carrying for a specified time, and breaking currents under specified abnormal circuit conditions e.g. those of short circuit. - - ''' - - cgmesProfile = ProtectedSwitch.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ProtectedSwitch: \n' + ProtectedSwitch.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=Breaker\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ProtectedSwitch import ProtectedSwitch +from .CGMESProfile import Profile + + +class Breaker(ProtectedSwitch): + """ + A mechanical switching device capable of making, carrying, and breaking currents under normal circuit conditions and also making, carrying for a specified time, and breaking currents under specified abnormal circuit conditions e.g. those of short circuit. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ProtectedSwitch:\n" + ProtectedSwitch.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=Breaker\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/BusNameMarker.py b/cimpy/cgmes_v2_4_15/BusNameMarker.py index 22c79118..067e3088 100644 --- a/cimpy/cgmes_v2_4_15/BusNameMarker.py +++ b/cimpy/cgmes_v2_4_15/BusNameMarker.py @@ -1,37 +1,39 @@ -from .IdentifiedObject import IdentifiedObject - - -class BusNameMarker(IdentifiedObject): - ''' - Used to apply user standard names to topology buses. Typically used for "bus/branch" case generation. Associated with one or more terminals that are normally connected with the bus name. The associated terminals are normally connected by non-retained switches. For a ring bus station configuration, all busbar terminals in the ring are typically associated. For a breaker and a half scheme, both busbars would normally be associated. For a ring bus, all busbars would normally be associated. For a "straight" busbar configuration, normally only the main terminal at the busbar would be associated. - - :priority: Priority of bus name marker for use as topology bus name. Use 0 for don t care. Use 1 for highest priority. Use 2 as priority is less than 1 and so on. Default: 0 - :ReportingGroup: The bus name markers that belong to this reporting group. Default: None - :Terminal: The terminals associated with this bus name marker. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'priority': [cgmesProfile.EQ.value, ], - 'ReportingGroup': [cgmesProfile.EQ.value, ], - 'Terminal': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, priority = 0, ReportingGroup = None, Terminal = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.priority = priority - self.ReportingGroup = ReportingGroup - self.Terminal = Terminal - - def __str__(self): - str = 'class=BusNameMarker\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class BusNameMarker(IdentifiedObject): + """ + Used to apply user standard names to topology buses. Typically used for "bus/branch" case generation. Associated with one or more terminals that are normally connected with the bus name. The associated terminals are normally connected by non-retained switches. For a ring bus station configuration, all busbar terminals in the ring are typically associated. For a breaker and a half scheme, both busbars would normally be associated. For a ring bus, all busbars would normally be associated. For a "straight" busbar configuration, normally only the main terminal at the busbar would be associated. + + :ReportingGroup: The bus name markers that belong to this reporting group. Default: None + :Terminal: The terminals associated with this bus name marker. Default: "list" + :priority: Priority of bus name marker for use as topology bus name. Use 0 for don t care. Use 1 for highest priority. Use 2 as priority is less than 1 and so on. Default: 0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "ReportingGroup": [Profile.EQ.value, ], + "Terminal": [Profile.EQ.value, ], + "priority": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, ReportingGroup = None, Terminal = "list", priority = 0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ReportingGroup = ReportingGroup + self.Terminal = Terminal + self.priority = priority + + def __str__(self): + str = "class=BusNameMarker\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/BusbarSection.py b/cimpy/cgmes_v2_4_15/BusbarSection.py index b00c5e86..7aa3ff4e 100644 --- a/cimpy/cgmes_v2_4_15/BusbarSection.py +++ b/cimpy/cgmes_v2_4_15/BusbarSection.py @@ -1,31 +1,33 @@ -from .Connector import Connector - - -class BusbarSection(Connector): - ''' - A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation. Voltage measurements are typically obtained from VoltageTransformers that are connected to busbar sections. A bus bar section may have many physical terminals but for analysis is modelled with exactly one logical terminal. - - :ipMax: Maximum allowable peak short-circuit current of busbar (Ipmax in the IEC 60909-0). Mechanical limit of the busbar in the substation itself. Used for short circuit data exchange according to IEC 60909 Default: 0.0 - ''' - - cgmesProfile = Connector.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'ipMax': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Connector: \n' + Connector.__doc__ - - def __init__(self, ipMax = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ipMax = ipMax - - def __str__(self): - str = 'class=BusbarSection\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Connector import Connector +from .CGMESProfile import Profile + + +class BusbarSection(Connector): + """ + A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation. Voltage measurements are typically obtained from VoltageTransformers that are connected to busbar sections. A bus bar section may have many physical terminals but for analysis is modelled with exactly one logical terminal. + + :ipMax: Maximum allowable peak short-circuit current of busbar (Ipmax in the IEC 60909-0). Mechanical limit of the busbar in the substation itself. Used for short circuit data exchange according to IEC 60909 Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "ipMax": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Connector:\n" + Connector.__doc__ + + def __init__(self, ipMax = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ipMax = ipMax + + def __str__(self): + str = "class=BusbarSection\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/CGMESProfile.py b/cimpy/cgmes_v2_4_15/CGMESProfile.py new file mode 100644 index 00000000..98d15ae8 --- /dev/null +++ b/cimpy/cgmes_v2_4_15/CGMESProfile.py @@ -0,0 +1,85 @@ +from enum import Enum + + +# Mapping between the profiles and their short names +short_profile_name = { + "Equipment": "EQ", + "DiagramLayout": "DL", + "Dynamics": "DY", + "EquipmentBoundary": "EQ_BD", + "GeographicalLocation": "GL", + "SteadyStateHypothesis": "SSH", + "StateVariables": "SV", + "Topology": "TP", + "TopologyBoundary": "TP_BD", +} +long_profile_name = { + "EQ": "Equipment", + "DL": "DiagramLayout", + "DY": "Dynamics", + "EQ_BD": "EquipmentBoundary", + "GL": "GeographicalLocation", + "SSH": "SteadyStateHypothesis", + "SV": "StateVariables", + "TP": "Topology", + "TP_BD": "TopologyBoundary", +} +profile_uris = { # Those are strings, not real addresses, hence the NOSONAR. + "EQ": [ + "http://entsoe.eu/CIM/EquipmentCore/3/1", # NOSONAR + "http://entsoe.eu/CIM/EquipmentOperation/3/1", # NOSONAR + "http://entsoe.eu/CIM/EquipmentShortCircuit/3/1", # NOSONAR + ], + "DL": [ + "http://entsoe.eu/CIM/DiagramLayout/3/1", # NOSONAR + ], + "DY": [ + "http://entsoe.eu/CIM/Dynamics/3/1", # NOSONAR + ], + "EQ_BD": [ + "http://entsoe.eu/CIM/EquipmentBoundary/3/1", # NOSONAR + "http://entsoe.eu/CIM/EquipmentBoundaryOperation/3/1", # NOSONAR + ], + "GL": [ + "http://entsoe.eu/CIM/GeographicalLocation/2/1", # NOSONAR + ], + "SSH": [ + "http://entsoe.eu/CIM/SteadyStateHypothesis/1/1", # NOSONAR + ], + "SV": [ + "http://entsoe.eu/CIM/StateVariables/4/1", # NOSONAR + ], + "TP": [ + "http://entsoe.eu/CIM/Topology/4/1", # NOSONAR + ], + "TP_BD": [ + "http://entsoe.eu/CIM/TopologyBoundary/3/1", # NOSONAR + ], +} + + +class Profile(Enum): + """Enum containing all CGMES profiles and their export priority.""" + + EQ = 0 + DL = 1 + DY = 2 + EQ_BD = 3 + GL = 4 + SSH = 5 + SV = 6 + TP = 7 + TP_BD = 8 + + def long_name(self): + return long_profile_name[self.name] + + def uris(self): + return profile_uris[self.name] + + @classmethod + def from_long_name(cls, long_name): + return cls[short_profile_name[long_name]] + + +cim_namespace = "http://iec.ch/TC57/2013/CIM-schema-cim16#" # NOSONAR diff --git a/cimpy/cgmes_v2_4_15/Capacitance.py b/cimpy/cgmes_v2_4_15/Capacitance.py index 59be872a..0495ded9 100644 --- a/cimpy/cgmes_v2_4_15/Capacitance.py +++ b/cimpy/cgmes_v2_4_15/Capacitance.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class Capacitance(Base): - ''' - Capacitive part of reactance (imaginary part of impedance), at rated frequency. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=Capacitance\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Capacitance(Base): + """ + Capacitive part of reactance (imaginary part of impedance), at rated frequency. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=Capacitance\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/CapacitancePerLength.py b/cimpy/cgmes_v2_4_15/CapacitancePerLength.py index 127daa89..df91bd79 100644 --- a/cimpy/cgmes_v2_4_15/CapacitancePerLength.py +++ b/cimpy/cgmes_v2_4_15/CapacitancePerLength.py @@ -1,42 +1,43 @@ -from .Base import Base - - -class CapacitancePerLength(Base): - ''' - Capacitance per unit of length. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - :denominatorUnit: Default: None - :denominatorMultiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - 'denominatorUnit': [cgmesProfile.EQ.value, ], - 'denominatorMultiplier': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, denominatorUnit = None, denominatorMultiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - self.denominatorUnit = denominatorUnit - self.denominatorMultiplier = denominatorMultiplier - - def __str__(self): - str = 'class=CapacitancePerLength\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class CapacitancePerLength(Base): + """ + Capacitance per unit of length. + + :denominatorMultiplier: Default: None + :denominatorUnit: Default: None + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "denominatorMultiplier": [Profile.EQ.value, ], + "denominatorUnit": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, denominatorMultiplier = None, denominatorUnit = None, multiplier = None, unit = None, value = 0.0): + + self.denominatorMultiplier = denominatorMultiplier + self.denominatorUnit = denominatorUnit + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=CapacitancePerLength\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Command.py b/cimpy/cgmes_v2_4_15/Command.py index a8b02e1e..346bb6c2 100644 --- a/cimpy/cgmes_v2_4_15/Command.py +++ b/cimpy/cgmes_v2_4_15/Command.py @@ -1,40 +1,42 @@ -from .Control import Control - - -class Command(Control): - ''' - A Command is a discrete control used for supervisory control. - - :normalValue: Normal value for Control.value e.g. used for percentage scaling. Default: 0 - :value: The value representing the actuator output. Default: 0 - :DiscreteValue: The Control variable associated with the MeasurementValue. Default: None - :ValueAliasSet: The ValueAliasSet used for translation of a Control value to a name. Default: None - ''' - - cgmesProfile = Control.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'normalValue': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'DiscreteValue': [cgmesProfile.EQ.value, ], - 'ValueAliasSet': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Control: \n' + Control.__doc__ - - def __init__(self, normalValue = 0, value = 0, DiscreteValue = None, ValueAliasSet = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.normalValue = normalValue - self.value = value - self.DiscreteValue = DiscreteValue - self.ValueAliasSet = ValueAliasSet - - def __str__(self): - str = 'class=Command\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Control import Control +from .CGMESProfile import Profile + + +class Command(Control): + """ + A Command is a discrete control used for supervisory control. + + :DiscreteValue: The Control variable associated with the MeasurementValue. Default: None + :ValueAliasSet: The ValueAliasSet used for translation of a Control value to a name. Default: None + :normalValue: Normal value for Control.value e.g. used for percentage scaling. Default: 0 + :value: The value representing the actuator output. Default: 0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "DiscreteValue": [Profile.EQ.value, ], + "ValueAliasSet": [Profile.EQ.value, ], + "normalValue": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Control:\n" + Control.__doc__ + + def __init__(self, DiscreteValue = None, ValueAliasSet = None, normalValue = 0, value = 0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DiscreteValue = DiscreteValue + self.ValueAliasSet = ValueAliasSet + self.normalValue = normalValue + self.value = value + + def __str__(self): + str = "class=Command\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Conductance.py b/cimpy/cgmes_v2_4_15/Conductance.py index 75926d9f..555bf7a5 100644 --- a/cimpy/cgmes_v2_4_15/Conductance.py +++ b/cimpy/cgmes_v2_4_15/Conductance.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class Conductance(Base): - ''' - Factor by which voltage must be multiplied to give corresponding power lost from a circuit. Real part of admittance. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=Conductance\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Conductance(Base): + """ + Factor by which voltage must be multiplied to give corresponding power lost from a circuit. Real part of admittance. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=Conductance\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ConductingEquipment.py b/cimpy/cgmes_v2_4_15/ConductingEquipment.py index b3ebe23d..240b74ff 100644 --- a/cimpy/cgmes_v2_4_15/ConductingEquipment.py +++ b/cimpy/cgmes_v2_4_15/ConductingEquipment.py @@ -1,37 +1,39 @@ -from .Equipment import Equipment - - -class ConductingEquipment(Equipment): - ''' - The parts of the AC power system that are designed to carry current or that are conductively connected through terminals. - - :BaseVoltage: All conducting equipment with this base voltage. Use only when there is no voltage level container used and only one base voltage applies. For example, not used for transformers. Default: None - :Terminals: Conducting equipment have terminals that may be connected to other conducting equipment terminals via connectivity nodes or topological nodes. Default: "list" - :SvStatus: The status state variable associated with this conducting equipment. Default: None - ''' - - cgmesProfile = Equipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, cgmesProfile.EQ_BD.value, ], - 'BaseVoltage': [cgmesProfile.EQ.value, ], - 'Terminals': [cgmesProfile.EQ.value, cgmesProfile.DY.value, cgmesProfile.EQ_BD.value, ], - 'SvStatus': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Equipment: \n' + Equipment.__doc__ - - def __init__(self, BaseVoltage = None, Terminals = "list", SvStatus = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.BaseVoltage = BaseVoltage - self.Terminals = Terminals - self.SvStatus = SvStatus - - def __str__(self): - str = 'class=ConductingEquipment\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Equipment import Equipment +from .CGMESProfile import Profile + + +class ConductingEquipment(Equipment): + """ + The parts of the AC power system that are designed to carry current or that are conductively connected through terminals. + + :BaseVoltage: All conducting equipment with this base voltage. Use only when there is no voltage level container used and only one base voltage applies. For example, not used for transformers. Default: None + :SvStatus: The status state variable associated with this conducting equipment. Default: None + :Terminals: Conducting equipment have terminals that may be connected to other conducting equipment terminals via connectivity nodes or topological nodes. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "BaseVoltage": [Profile.EQ.value, ], + "SvStatus": [Profile.SV.value, ], + "Terminals": [Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Equipment:\n" + Equipment.__doc__ + + def __init__(self, BaseVoltage = None, SvStatus = None, Terminals = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.BaseVoltage = BaseVoltage + self.SvStatus = SvStatus + self.Terminals = Terminals + + def __str__(self): + str = "class=ConductingEquipment\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Conductor.py b/cimpy/cgmes_v2_4_15/Conductor.py index 1b6895e8..44a6555e 100644 --- a/cimpy/cgmes_v2_4_15/Conductor.py +++ b/cimpy/cgmes_v2_4_15/Conductor.py @@ -1,31 +1,33 @@ -from .ConductingEquipment import ConductingEquipment - - -class Conductor(ConductingEquipment): - ''' - Combination of conducting material with consistent electrical characteristics, building a single electrical system, used to carry current between points in the power system. - - :length: Segment length for calculating line section capabilities Default: 0.0 - ''' - - cgmesProfile = ConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'length': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConductingEquipment: \n' + ConductingEquipment.__doc__ - - def __init__(self, length = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.length = length - - def __str__(self): - str = 'class=Conductor\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConductingEquipment import ConductingEquipment +from .CGMESProfile import Profile + + +class Conductor(ConductingEquipment): + """ + Combination of conducting material with consistent electrical characteristics, building a single electrical system, used to carry current between points in the power system. + + :length: Segment length for calculating line section capabilities Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "length": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConductingEquipment:\n" + ConductingEquipment.__doc__ + + def __init__(self, length = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.length = length + + def __str__(self): + str = "class=Conductor\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ConformLoad.py b/cimpy/cgmes_v2_4_15/ConformLoad.py index b915b36b..ec2120d0 100644 --- a/cimpy/cgmes_v2_4_15/ConformLoad.py +++ b/cimpy/cgmes_v2_4_15/ConformLoad.py @@ -1,31 +1,33 @@ -from .EnergyConsumer import EnergyConsumer - - -class ConformLoad(EnergyConsumer): - ''' - ConformLoad represent loads that follow a daily load change pattern where the pattern can be used to scale the load with a system load. - - :LoadGroup: Group of this ConformLoad. Default: None - ''' - - cgmesProfile = EnergyConsumer.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'LoadGroup': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EnergyConsumer: \n' + EnergyConsumer.__doc__ - - def __init__(self, LoadGroup = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.LoadGroup = LoadGroup - - def __str__(self): - str = 'class=ConformLoad\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EnergyConsumer import EnergyConsumer +from .CGMESProfile import Profile + + +class ConformLoad(EnergyConsumer): + """ + ConformLoad represent loads that follow a daily load change pattern where the pattern can be used to scale the load with a system load. + + :LoadGroup: Group of this ConformLoad. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "LoadGroup": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EnergyConsumer:\n" + EnergyConsumer.__doc__ + + def __init__(self, LoadGroup = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.LoadGroup = LoadGroup + + def __str__(self): + str = "class=ConformLoad\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ConformLoadGroup.py b/cimpy/cgmes_v2_4_15/ConformLoadGroup.py index 2238862d..dcc16cdd 100644 --- a/cimpy/cgmes_v2_4_15/ConformLoadGroup.py +++ b/cimpy/cgmes_v2_4_15/ConformLoadGroup.py @@ -1,34 +1,36 @@ -from .LoadGroup import LoadGroup - - -class ConformLoadGroup(LoadGroup): - ''' - A group of loads conforming to an allocation pattern. - - :EnergyConsumers: Conform loads assigned to this ConformLoadGroup. Default: "list" - :ConformLoadSchedules: The ConformLoadSchedules in the ConformLoadGroup. Default: "list" - ''' - - cgmesProfile = LoadGroup.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'EnergyConsumers': [cgmesProfile.EQ.value, ], - 'ConformLoadSchedules': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class LoadGroup: \n' + LoadGroup.__doc__ - - def __init__(self, EnergyConsumers = "list", ConformLoadSchedules = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.EnergyConsumers = EnergyConsumers - self.ConformLoadSchedules = ConformLoadSchedules - - def __str__(self): - str = 'class=ConformLoadGroup\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .LoadGroup import LoadGroup +from .CGMESProfile import Profile + + +class ConformLoadGroup(LoadGroup): + """ + A group of loads conforming to an allocation pattern. + + :ConformLoadSchedules: The ConformLoadSchedules in the ConformLoadGroup. Default: "list" + :EnergyConsumers: Conform loads assigned to this ConformLoadGroup. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "ConformLoadSchedules": [Profile.EQ.value, ], + "EnergyConsumers": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class LoadGroup:\n" + LoadGroup.__doc__ + + def __init__(self, ConformLoadSchedules = "list", EnergyConsumers = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ConformLoadSchedules = ConformLoadSchedules + self.EnergyConsumers = EnergyConsumers + + def __str__(self): + str = "class=ConformLoadGroup\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ConformLoadSchedule.py b/cimpy/cgmes_v2_4_15/ConformLoadSchedule.py index a949382a..77b92ff8 100644 --- a/cimpy/cgmes_v2_4_15/ConformLoadSchedule.py +++ b/cimpy/cgmes_v2_4_15/ConformLoadSchedule.py @@ -1,31 +1,33 @@ -from .SeasonDayTypeSchedule import SeasonDayTypeSchedule - - -class ConformLoadSchedule(SeasonDayTypeSchedule): - ''' - A curve of load versus time (X-axis) showing the active power values (Y1-axis) and reactive power (Y2-axis) for each unit of the period covered. This curve represents a typical pattern of load over the time period for a given day type and season. - - :ConformLoadGroup: The ConformLoadGroup where the ConformLoadSchedule belongs. Default: None - ''' - - cgmesProfile = SeasonDayTypeSchedule.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'ConformLoadGroup': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class SeasonDayTypeSchedule: \n' + SeasonDayTypeSchedule.__doc__ - - def __init__(self, ConformLoadGroup = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ConformLoadGroup = ConformLoadGroup - - def __str__(self): - str = 'class=ConformLoadSchedule\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .SeasonDayTypeSchedule import SeasonDayTypeSchedule +from .CGMESProfile import Profile + + +class ConformLoadSchedule(SeasonDayTypeSchedule): + """ + A curve of load versus time (X-axis) showing the active power values (Y1-axis) and reactive power (Y2-axis) for each unit of the period covered. This curve represents a typical pattern of load over the time period for a given day type and season. + + :ConformLoadGroup: The ConformLoadGroup where the ConformLoadSchedule belongs. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "ConformLoadGroup": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class SeasonDayTypeSchedule:\n" + SeasonDayTypeSchedule.__doc__ + + def __init__(self, ConformLoadGroup = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ConformLoadGroup = ConformLoadGroup + + def __str__(self): + str = "class=ConformLoadSchedule\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ConnectivityNode.py b/cimpy/cgmes_v2_4_15/ConnectivityNode.py index 382637e6..f28a0072 100644 --- a/cimpy/cgmes_v2_4_15/ConnectivityNode.py +++ b/cimpy/cgmes_v2_4_15/ConnectivityNode.py @@ -1,58 +1,60 @@ -from .IdentifiedObject import IdentifiedObject - - -class ConnectivityNode(IdentifiedObject): - ''' - Connectivity nodes are points where terminals of AC conducting equipment are connected together with zero impedance. - - :Terminals: The connectivity node to which this terminal connects with zero impedance. Default: "list" - :ConnectivityNodeContainer: Container of this connectivity node. Default: None - :TopologicalNode: The connectivity nodes combine together to form this topological node. May depend on the current state of switches in the network. Default: None - :boundaryPoint: Identifies if a node is a BoundaryPoint. If boundaryPoint=true the ConnectivityNode or the TopologicalNode represents a BoundaryPoint. Default: False - :fromEndIsoCode: The attribute is used for an exchange of the ISO code of the region to which the `From` side of the Boundary point belongs to or it is connected to. The ISO code is two characters country code as defined by ISO 3166 (). The length of the string is 2 characters maximum. The attribute is a required for the Boundary Model Authority Set where this attribute is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' - :fromEndName: The attribute is used for an exchange of a human readable name with length of the string 32 characters maximum. The attribute covers two cases: The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' - :fromEndNameTso: The attribute is used for an exchange of the name of the TSO to which the `From` side of the Boundary point belongs to or it is connected to. The length of the string is 32 characters maximum. The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' - :toEndIsoCode: The attribute is used for an exchange of the ISO code of the region to which the `To` side of the Boundary point belongs to or it is connected to. The ISO code is two characters country code as defined by ISO 3166 (). The length of the string is 2 characters maximum. The attribute is a required for the Boundary Model Authority Set where this attribute is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' - :toEndName: The attribute is used for an exchange of a human readable name with length of the string 32 characters maximum. The attribute covers two cases: The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' - :toEndNameTso: The attribute is used for an exchange of the name of the TSO to which the `To` side of the Boundary point belongs to or it is connected to. The length of the string is 32 characters maximum. The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.TP.value, cgmesProfile.TP_BD.value, cgmesProfile.EQ_BD.value, ], - 'Terminals': [cgmesProfile.EQ.value, ], - 'ConnectivityNodeContainer': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - 'TopologicalNode': [cgmesProfile.TP.value, cgmesProfile.TP_BD.value, ], - 'boundaryPoint': [cgmesProfile.EQ_BD.value, ], - 'fromEndIsoCode': [cgmesProfile.EQ_BD.value, ], - 'fromEndName': [cgmesProfile.EQ_BD.value, ], - 'fromEndNameTso': [cgmesProfile.EQ_BD.value, ], - 'toEndIsoCode': [cgmesProfile.EQ_BD.value, ], - 'toEndName': [cgmesProfile.EQ_BD.value, ], - 'toEndNameTso': [cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, Terminals = "list", ConnectivityNodeContainer = None, TopologicalNode = None, boundaryPoint = False, fromEndIsoCode = '', fromEndName = '', fromEndNameTso = '', toEndIsoCode = '', toEndName = '', toEndNameTso = '', *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Terminals = Terminals - self.ConnectivityNodeContainer = ConnectivityNodeContainer - self.TopologicalNode = TopologicalNode - self.boundaryPoint = boundaryPoint - self.fromEndIsoCode = fromEndIsoCode - self.fromEndName = fromEndName - self.fromEndNameTso = fromEndNameTso - self.toEndIsoCode = toEndIsoCode - self.toEndName = toEndName - self.toEndNameTso = toEndNameTso - - def __str__(self): - str = 'class=ConnectivityNode\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class ConnectivityNode(IdentifiedObject): + """ + Connectivity nodes are points where terminals of AC conducting equipment are connected together with zero impedance. + + :ConnectivityNodeContainer: Container of this connectivity node. Default: None + :Terminals: The connectivity node to which this terminal connects with zero impedance. Default: "list" + :TopologicalNode: The topological node to which this connectivity node is assigned. May depend on the current state of switches in the network. Default: None + :boundaryPoint: Identifies if a node is a BoundaryPoint. If boundaryPoint=true the ConnectivityNode or the TopologicalNode represents a BoundaryPoint. Default: False + :fromEndIsoCode: The attribute is used for an exchange of the ISO code of the region to which the `From` side of the Boundary point belongs to or it is connected to. The ISO code is two characters country code as defined by ISO 3166 (). The length of the string is 2 characters maximum. The attribute is a required for the Boundary Model Authority Set where this attribute is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' + :fromEndName: The attribute is used for an exchange of a human readable name with length of the string 32 characters maximum. The attribute covers two cases: The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' + :fromEndNameTso: The attribute is used for an exchange of the name of the TSO to which the `From` side of the Boundary point belongs to or it is connected to. The length of the string is 32 characters maximum. The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' + :toEndIsoCode: The attribute is used for an exchange of the ISO code of the region to which the `To` side of the Boundary point belongs to or it is connected to. The ISO code is two characters country code as defined by ISO 3166 (). The length of the string is 2 characters maximum. The attribute is a required for the Boundary Model Authority Set where this attribute is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' + :toEndName: The attribute is used for an exchange of a human readable name with length of the string 32 characters maximum. The attribute covers two cases: The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' + :toEndNameTso: The attribute is used for an exchange of the name of the TSO to which the `To` side of the Boundary point belongs to or it is connected to. The length of the string is 32 characters maximum. The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' + """ + + possibleProfileList = { + "class": [Profile.EQ_BD.value, Profile.EQ.value, Profile.TP_BD.value, Profile.TP.value, ], + "ConnectivityNodeContainer": [Profile.EQ_BD.value, Profile.EQ.value, ], + "Terminals": [Profile.EQ.value, ], + "TopologicalNode": [Profile.TP_BD.value, Profile.TP.value, ], + "boundaryPoint": [Profile.EQ_BD.value, ], + "fromEndIsoCode": [Profile.EQ_BD.value, ], + "fromEndName": [Profile.EQ_BD.value, ], + "fromEndNameTso": [Profile.EQ_BD.value, ], + "toEndIsoCode": [Profile.EQ_BD.value, ], + "toEndName": [Profile.EQ_BD.value, ], + "toEndNameTso": [Profile.EQ_BD.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, ConnectivityNodeContainer = None, Terminals = "list", TopologicalNode = None, boundaryPoint = False, fromEndIsoCode = '', fromEndName = '', fromEndNameTso = '', toEndIsoCode = '', toEndName = '', toEndNameTso = '', *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ConnectivityNodeContainer = ConnectivityNodeContainer + self.Terminals = Terminals + self.TopologicalNode = TopologicalNode + self.boundaryPoint = boundaryPoint + self.fromEndIsoCode = fromEndIsoCode + self.fromEndName = fromEndName + self.fromEndNameTso = fromEndNameTso + self.toEndIsoCode = toEndIsoCode + self.toEndName = toEndName + self.toEndNameTso = toEndNameTso + + def __str__(self): + str = "class=ConnectivityNode\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ConnectivityNodeContainer.py b/cimpy/cgmes_v2_4_15/ConnectivityNodeContainer.py index 31bef056..1453cf22 100644 --- a/cimpy/cgmes_v2_4_15/ConnectivityNodeContainer.py +++ b/cimpy/cgmes_v2_4_15/ConnectivityNodeContainer.py @@ -1,34 +1,36 @@ -from .PowerSystemResource import PowerSystemResource - - -class ConnectivityNodeContainer(PowerSystemResource): - ''' - A base class for all objects that may contain connectivity nodes or topological nodes. - - :ConnectivityNodes: Connectivity nodes which belong to this connectivity node container. Default: "list" - :TopologicalNode: The topological nodes which belong to this connectivity node container. Default: "list" - ''' - - cgmesProfile = PowerSystemResource.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.TP.value, cgmesProfile.TP_BD.value, cgmesProfile.EQ_BD.value, ], - 'ConnectivityNodes': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - 'TopologicalNode': [cgmesProfile.TP.value, cgmesProfile.TP_BD.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemResource: \n' + PowerSystemResource.__doc__ - - def __init__(self, ConnectivityNodes = "list", TopologicalNode = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ConnectivityNodes = ConnectivityNodes - self.TopologicalNode = TopologicalNode - - def __str__(self): - str = 'class=ConnectivityNodeContainer\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemResource import PowerSystemResource +from .CGMESProfile import Profile + + +class ConnectivityNodeContainer(PowerSystemResource): + """ + A base class for all objects that may contain connectivity nodes or topological nodes. + + :ConnectivityNodes: Connectivity nodes which belong to this connectivity node container. Default: "list" + :TopologicalNode: The topological nodes which belong to this connectivity node container. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ_BD.value, Profile.EQ.value, Profile.TP_BD.value, Profile.TP.value, ], + "ConnectivityNodes": [Profile.EQ_BD.value, Profile.EQ.value, ], + "TopologicalNode": [Profile.TP_BD.value, Profile.TP.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class PowerSystemResource:\n" + PowerSystemResource.__doc__ + + def __init__(self, ConnectivityNodes = "list", TopologicalNode = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ConnectivityNodes = ConnectivityNodes + self.TopologicalNode = TopologicalNode + + def __str__(self): + str = "class=ConnectivityNodeContainer\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Connector.py b/cimpy/cgmes_v2_4_15/Connector.py index 0aa039c4..b2681d31 100644 --- a/cimpy/cgmes_v2_4_15/Connector.py +++ b/cimpy/cgmes_v2_4_15/Connector.py @@ -1,29 +1,31 @@ -from .ConductingEquipment import ConductingEquipment - - -class Connector(ConductingEquipment): - ''' - A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation and are modelled with a single logical terminal. - - ''' - - cgmesProfile = ConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConductingEquipment: \n' + ConductingEquipment.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=Connector\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConductingEquipment import ConductingEquipment +from .CGMESProfile import Profile + + +class Connector(ConductingEquipment): + """ + A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation and are modelled with a single logical terminal. + + """ + + possibleProfileList = { + "class": [Profile.EQ_BD.value, Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConductingEquipment:\n" + ConductingEquipment.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=Connector\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Control.py b/cimpy/cgmes_v2_4_15/Control.py index 470766d7..0f046f4c 100644 --- a/cimpy/cgmes_v2_4_15/Control.py +++ b/cimpy/cgmes_v2_4_15/Control.py @@ -1,46 +1,48 @@ -from .IdentifiedObject import IdentifiedObject - - -class Control(IdentifiedObject): - ''' - Control is used for supervisory/device control. It represents control outputs that are used to change the state in a process, e.g. close or open breaker, a set point value or a raise lower command. - - :controlType: Specifies the type of Control, e.g. BreakerOn/Off, GeneratorVoltageSetPoint, TieLineFlow etc. The ControlType.name shall be unique among all specified types and describe the type. Default: '' - :operationInProgress: Indicates that a client is currently sending control commands that has not completed. Default: False - :timeStamp: The last time a control output was sent. Default: '' - :unitMultiplier: The unit multiplier of the controlled quantity. Default: None - :unitSymbol: The unit of measure of the controlled quantity. Default: None - :PowerSystemResource: The controller outputs used to actually govern a regulating device, e.g. the magnetization of a synchronous machine or capacitor bank breaker actuator. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'controlType': [cgmesProfile.EQ.value, ], - 'operationInProgress': [cgmesProfile.EQ.value, ], - 'timeStamp': [cgmesProfile.EQ.value, ], - 'unitMultiplier': [cgmesProfile.EQ.value, ], - 'unitSymbol': [cgmesProfile.EQ.value, ], - 'PowerSystemResource': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, controlType = '', operationInProgress = False, timeStamp = '', unitMultiplier = None, unitSymbol = None, PowerSystemResource = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.controlType = controlType - self.operationInProgress = operationInProgress - self.timeStamp = timeStamp - self.unitMultiplier = unitMultiplier - self.unitSymbol = unitSymbol - self.PowerSystemResource = PowerSystemResource - - def __str__(self): - str = 'class=Control\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class Control(IdentifiedObject): + """ + Control is used for supervisory/device control. It represents control outputs that are used to change the state in a process, e.g. close or open breaker, a set point value or a raise lower command. + + :PowerSystemResource: The controller outputs used to actually govern a regulating device, e.g. the magnetization of a synchronous machine or capacitor bank breaker actuator. Default: None + :controlType: Specifies the type of Control, e.g. BreakerOn/Off, GeneratorVoltageSetPoint, TieLineFlow etc. The ControlType.name shall be unique among all specified types and describe the type. Default: '' + :operationInProgress: Indicates that a client is currently sending control commands that has not completed. Default: False + :timeStamp: The last time a control output was sent. Default: '' + :unitMultiplier: The unit multiplier of the controlled quantity. Default: None + :unitSymbol: The unit of measure of the controlled quantity. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "PowerSystemResource": [Profile.EQ.value, ], + "controlType": [Profile.EQ.value, ], + "operationInProgress": [Profile.EQ.value, ], + "timeStamp": [Profile.EQ.value, ], + "unitMultiplier": [Profile.EQ.value, ], + "unitSymbol": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, PowerSystemResource = None, controlType = '', operationInProgress = False, timeStamp = '', unitMultiplier = None, unitSymbol = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.PowerSystemResource = PowerSystemResource + self.controlType = controlType + self.operationInProgress = operationInProgress + self.timeStamp = timeStamp + self.unitMultiplier = unitMultiplier + self.unitSymbol = unitSymbol + + def __str__(self): + str = "class=Control\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ControlArea.py b/cimpy/cgmes_v2_4_15/ControlArea.py index 5ea90e3f..edb1ef84 100644 --- a/cimpy/cgmes_v2_4_15/ControlArea.py +++ b/cimpy/cgmes_v2_4_15/ControlArea.py @@ -1,46 +1,48 @@ -from .PowerSystemResource import PowerSystemResource - - -class ControlArea(PowerSystemResource): - ''' - A control areais a grouping of generating units and/or loads and a cutset of tie lines (as terminals) which may be used for a variety of purposes including automatic generation control, powerflow solution area interchange control specification, and input to load forecasting. Note that any number of overlapping control area specifications can be superimposed on the physical model. - - :type: The primary type of control area definition used to determine if this is used for automatic generation control, for planning interchange control, or other purposes. A control area specified with primary type of automatic generation control could still be forecast and used as an interchange area in power flow analysis. Default: None - :TieFlow: The tie flows associated with the control area. Default: "list" - :ControlAreaGeneratingUnit: The generating unit specificaitons for the control area. Default: "list" - :EnergyArea: The energy area that is forecast from this control area specification. Default: None - :netInterchange: The specified positive net interchange into the control area, i.e. positive sign means flow in to the area. Default: 0.0 - :pTolerance: Active power net interchange tolerance Default: 0.0 - ''' - - cgmesProfile = PowerSystemResource.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'type': [cgmesProfile.EQ.value, ], - 'TieFlow': [cgmesProfile.EQ.value, ], - 'ControlAreaGeneratingUnit': [cgmesProfile.EQ.value, ], - 'EnergyArea': [cgmesProfile.EQ.value, ], - 'netInterchange': [cgmesProfile.SSH.value, ], - 'pTolerance': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemResource: \n' + PowerSystemResource.__doc__ - - def __init__(self, type = None, TieFlow = "list", ControlAreaGeneratingUnit = "list", EnergyArea = None, netInterchange = 0.0, pTolerance = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.type = type - self.TieFlow = TieFlow - self.ControlAreaGeneratingUnit = ControlAreaGeneratingUnit - self.EnergyArea = EnergyArea - self.netInterchange = netInterchange - self.pTolerance = pTolerance - - def __str__(self): - str = 'class=ControlArea\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemResource import PowerSystemResource +from .CGMESProfile import Profile + + +class ControlArea(PowerSystemResource): + """ + A control areais a grouping of generating units and/or loads and a cutset of tie lines (as terminals) which may be used for a variety of purposes including automatic generation control, powerflow solution area interchange control specification, and input to load forecasting. Note that any number of overlapping control area specifications can be superimposed on the physical model. + + :ControlAreaGeneratingUnit: The generating unit specificaitons for the control area. Default: "list" + :EnergyArea: The energy area that is forecast from this control area specification. Default: None + :TieFlow: The tie flows associated with the control area. Default: "list" + :netInterchange: The specified positive net interchange into the control area, i.e. positive sign means flow in to the area. Default: 0.0 + :pTolerance: Active power net interchange tolerance Default: 0.0 + :type: The primary type of control area definition used to determine if this is used for automatic generation control, for planning interchange control, or other purposes. A control area specified with primary type of automatic generation control could still be forecast and used as an interchange area in power flow analysis. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "ControlAreaGeneratingUnit": [Profile.EQ.value, ], + "EnergyArea": [Profile.EQ.value, ], + "TieFlow": [Profile.EQ.value, ], + "netInterchange": [Profile.SSH.value, ], + "pTolerance": [Profile.SSH.value, ], + "type": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class PowerSystemResource:\n" + PowerSystemResource.__doc__ + + def __init__(self, ControlAreaGeneratingUnit = "list", EnergyArea = None, TieFlow = "list", netInterchange = 0.0, pTolerance = 0.0, type = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ControlAreaGeneratingUnit = ControlAreaGeneratingUnit + self.EnergyArea = EnergyArea + self.TieFlow = TieFlow + self.netInterchange = netInterchange + self.pTolerance = pTolerance + self.type = type + + def __str__(self): + str = "class=ControlArea\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ControlAreaGeneratingUnit.py b/cimpy/cgmes_v2_4_15/ControlAreaGeneratingUnit.py index 0797664b..072cdea8 100644 --- a/cimpy/cgmes_v2_4_15/ControlAreaGeneratingUnit.py +++ b/cimpy/cgmes_v2_4_15/ControlAreaGeneratingUnit.py @@ -1,34 +1,36 @@ -from .IdentifiedObject import IdentifiedObject - - -class ControlAreaGeneratingUnit(IdentifiedObject): - ''' - A control area generating unit. This class is needed so that alternate control area definitions may include the same generating unit. Note only one instance within a control area should reference a specific generating unit. - - :GeneratingUnit: The generating unit specified for this control area. Note that a control area should include a GeneratingUnit only once. Default: None - :ControlArea: The parent control area for the generating unit specifications. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'GeneratingUnit': [cgmesProfile.EQ.value, ], - 'ControlArea': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, GeneratingUnit = None, ControlArea = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.GeneratingUnit = GeneratingUnit - self.ControlArea = ControlArea - - def __str__(self): - str = 'class=ControlAreaGeneratingUnit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class ControlAreaGeneratingUnit(IdentifiedObject): + """ + A control area generating unit. This class is needed so that alternate control area definitions may include the same generating unit. Note only one instance within a control area should reference a specific generating unit. + + :ControlArea: The parent control area for the generating unit specifications. Default: None + :GeneratingUnit: The generating unit specified for this control area. Note that a control area should include a GeneratingUnit only once. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "ControlArea": [Profile.EQ.value, ], + "GeneratingUnit": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, ControlArea = None, GeneratingUnit = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ControlArea = ControlArea + self.GeneratingUnit = GeneratingUnit + + def __str__(self): + str = "class=ControlAreaGeneratingUnit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ControlAreaTypeKind.py b/cimpy/cgmes_v2_4_15/ControlAreaTypeKind.py index 3962f487..4f1cf2f5 100644 --- a/cimpy/cgmes_v2_4_15/ControlAreaTypeKind.py +++ b/cimpy/cgmes_v2_4_15/ControlAreaTypeKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class ControlAreaTypeKind(Base): - ''' - The type of control area. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=ControlAreaTypeKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ControlAreaTypeKind(Base): + """ + The type of control area. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=ControlAreaTypeKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/CoordinateSystem.py b/cimpy/cgmes_v2_4_15/CoordinateSystem.py index 40cb167a..125b3a3e 100644 --- a/cimpy/cgmes_v2_4_15/CoordinateSystem.py +++ b/cimpy/cgmes_v2_4_15/CoordinateSystem.py @@ -1,34 +1,36 @@ -from .IdentifiedObject import IdentifiedObject - - -class CoordinateSystem(IdentifiedObject): - ''' - Coordinate reference system. - - :crsUrn: A Uniform Resource Name (URN) for the coordinate reference system (crs) used to define `Location.PositionPoints`. An example would be the European Petroleum Survey Group (EPSG) code for a coordinate reference system, defined in URN under the Open Geospatial Consortium (OGC) namespace as: urn:ogc:def:uom:EPSG::XXXX, where XXXX is an EPSG code (a full list of codes can be found at the EPSG Registry web site http://www.epsg-registry.org/). To define the coordinate system as being WGS84 (latitude, longitude) using an EPSG OGC, this attribute would be urn:ogc:def:uom:EPSG::4236. A profile should limit this code to a set of allowed URNs agreed to by all sending and receiving parties. Default: '' - :Location: All locations described with position points in this coordinate system. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.GL.value, ], - 'crsUrn': [cgmesProfile.GL.value, ], - 'Location': [cgmesProfile.GL.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, crsUrn = '', Location = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.crsUrn = crsUrn - self.Location = Location - - def __str__(self): - str = 'class=CoordinateSystem\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class CoordinateSystem(IdentifiedObject): + """ + Coordinate reference system. + + :Location: All locations described with position points in this coordinate system. Default: "list" + :crsUrn: A Uniform Resource Name (URN) for the coordinate reference system (crs) used to define `Location.PositionPoints`. An example would be the European Petroleum Survey Group (EPSG) code for a coordinate reference system, defined in URN under the Open Geospatial Consortium (OGC) namespace as: urn:ogc:def:uom:EPSG::XXXX, where XXXX is an EPSG code (a full list of codes can be found at the EPSG Registry web site http://www.epsg-registry.org/). To define the coordinate system as being WGS84 (latitude, longitude) using an EPSG OGC, this attribute would be urn:ogc:def:uom:EPSG::4236. A profile should limit this code to a set of allowed URNs agreed to by all sending and receiving parties. Default: '' + """ + + possibleProfileList = { + "class": [Profile.GL.value, ], + "Location": [Profile.GL.value, ], + "crsUrn": [Profile.GL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.GL.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, Location = "list", crsUrn = '', *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Location = Location + self.crsUrn = crsUrn + + def __str__(self): + str = "class=CoordinateSystem\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/CsConverter.py b/cimpy/cgmes_v2_4_15/CsConverter.py index 390ac600..b9b53ef2 100644 --- a/cimpy/cgmes_v2_4_15/CsConverter.py +++ b/cimpy/cgmes_v2_4_15/CsConverter.py @@ -1,70 +1,72 @@ -from .ACDCConverter import ACDCConverter - - -class CsConverter(ACDCConverter): - ''' - DC side of the current source converter (CSC). - - :maxAlpha: Maximum firing angle. CSC configuration data used in power flow. Default: 0.0 - :maxGamma: Maximum extinction angle. CSC configuration data used in power flow. Default: 0.0 - :maxIdc: The maximum direct current (Id) on the DC side at which the converter should operate. Converter configuration data use in power flow. Default: 0.0 - :minAlpha: Minimum firing angle. CSC configuration data used in power flow. Default: 0.0 - :minGamma: Minimum extinction angle. CSC configuration data used in power flow. Default: 0.0 - :minIdc: The minimum direct current (Id) on the DC side at which the converter should operate. CSC configuration data used in power flow. Default: 0.0 - :ratedIdc: Rated converter DC current, also called IdN. Converter configuration data used in power flow. Default: 0.0 - :operatingMode: Indicates whether the DC pole is operating as an inverter or as a rectifier. CSC control variable used in power flow. Default: None - :pPccControl: Default: None - :targetAlpha: Target firing angle. CSC control variable used in power flow. Default: 0.0 - :targetGamma: Target extinction angle. CSC control variable used in power flow. Default: 0.0 - :targetIdc: DC current target value. CSC control variable used in power flow. Default: 0.0 - :alpha: Firing angle, typical value between 10 and 18 degrees for a rectifier. CSC state variable, result from power flow. Default: 0.0 - :gamma: Extinction angle. CSC state variable, result from power flow. Default: 0.0 - ''' - - cgmesProfile = ACDCConverter.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, ], - 'maxAlpha': [cgmesProfile.EQ.value, ], - 'maxGamma': [cgmesProfile.EQ.value, ], - 'maxIdc': [cgmesProfile.EQ.value, ], - 'minAlpha': [cgmesProfile.EQ.value, ], - 'minGamma': [cgmesProfile.EQ.value, ], - 'minIdc': [cgmesProfile.EQ.value, ], - 'ratedIdc': [cgmesProfile.EQ.value, ], - 'operatingMode': [cgmesProfile.SSH.value, ], - 'pPccControl': [cgmesProfile.SSH.value, ], - 'targetAlpha': [cgmesProfile.SSH.value, ], - 'targetGamma': [cgmesProfile.SSH.value, ], - 'targetIdc': [cgmesProfile.SSH.value, ], - 'alpha': [cgmesProfile.SV.value, ], - 'gamma': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ACDCConverter: \n' + ACDCConverter.__doc__ - - def __init__(self, maxAlpha = 0.0, maxGamma = 0.0, maxIdc = 0.0, minAlpha = 0.0, minGamma = 0.0, minIdc = 0.0, ratedIdc = 0.0, operatingMode = None, pPccControl = None, targetAlpha = 0.0, targetGamma = 0.0, targetIdc = 0.0, alpha = 0.0, gamma = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.maxAlpha = maxAlpha - self.maxGamma = maxGamma - self.maxIdc = maxIdc - self.minAlpha = minAlpha - self.minGamma = minGamma - self.minIdc = minIdc - self.ratedIdc = ratedIdc - self.operatingMode = operatingMode - self.pPccControl = pPccControl - self.targetAlpha = targetAlpha - self.targetGamma = targetGamma - self.targetIdc = targetIdc - self.alpha = alpha - self.gamma = gamma - - def __str__(self): - str = 'class=CsConverter\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ACDCConverter import ACDCConverter +from .CGMESProfile import Profile + + +class CsConverter(ACDCConverter): + """ + DC side of the current source converter (CSC). + + :alpha: Firing angle, typical value between 10 and 18 degrees for a rectifier. CSC state variable, result from power flow. Default: 0.0 + :gamma: Extinction angle. CSC state variable, result from power flow. Default: 0.0 + :maxAlpha: Maximum firing angle. CSC configuration data used in power flow. Default: 0.0 + :maxGamma: Maximum extinction angle. CSC configuration data used in power flow. Default: 0.0 + :maxIdc: The maximum direct current (Id) on the DC side at which the converter should operate. Converter configuration data use in power flow. Default: 0.0 + :minAlpha: Minimum firing angle. CSC configuration data used in power flow. Default: 0.0 + :minGamma: Minimum extinction angle. CSC configuration data used in power flow. Default: 0.0 + :minIdc: The minimum direct current (Id) on the DC side at which the converter should operate. CSC configuration data used in power flow. Default: 0.0 + :operatingMode: Indicates whether the DC pole is operating as an inverter or as a rectifier. CSC control variable used in power flow. Default: None + :pPccControl: Default: None + :ratedIdc: Rated converter DC current, also called IdN. Converter configuration data used in power flow. Default: 0.0 + :targetAlpha: Target firing angle. CSC control variable used in power flow. Default: 0.0 + :targetGamma: Target extinction angle. CSC control variable used in power flow. Default: 0.0 + :targetIdc: DC current target value. CSC control variable used in power flow. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "alpha": [Profile.SV.value, ], + "gamma": [Profile.SV.value, ], + "maxAlpha": [Profile.EQ.value, ], + "maxGamma": [Profile.EQ.value, ], + "maxIdc": [Profile.EQ.value, ], + "minAlpha": [Profile.EQ.value, ], + "minGamma": [Profile.EQ.value, ], + "minIdc": [Profile.EQ.value, ], + "operatingMode": [Profile.SSH.value, ], + "pPccControl": [Profile.SSH.value, ], + "ratedIdc": [Profile.EQ.value, ], + "targetAlpha": [Profile.SSH.value, ], + "targetGamma": [Profile.SSH.value, ], + "targetIdc": [Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ACDCConverter:\n" + ACDCConverter.__doc__ + + def __init__(self, alpha = 0.0, gamma = 0.0, maxAlpha = 0.0, maxGamma = 0.0, maxIdc = 0.0, minAlpha = 0.0, minGamma = 0.0, minIdc = 0.0, operatingMode = None, pPccControl = None, ratedIdc = 0.0, targetAlpha = 0.0, targetGamma = 0.0, targetIdc = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.alpha = alpha + self.gamma = gamma + self.maxAlpha = maxAlpha + self.maxGamma = maxGamma + self.maxIdc = maxIdc + self.minAlpha = minAlpha + self.minGamma = minGamma + self.minIdc = minIdc + self.operatingMode = operatingMode + self.pPccControl = pPccControl + self.ratedIdc = ratedIdc + self.targetAlpha = targetAlpha + self.targetGamma = targetGamma + self.targetIdc = targetIdc + + def __str__(self): + str = "class=CsConverter\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/CsOperatingModeKind.py b/cimpy/cgmes_v2_4_15/CsOperatingModeKind.py index 0ea27a6e..47a323af 100644 --- a/cimpy/cgmes_v2_4_15/CsOperatingModeKind.py +++ b/cimpy/cgmes_v2_4_15/CsOperatingModeKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class CsOperatingModeKind(Base): - ''' - Operating mode for HVDC line operating as Current Source Converter. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=CsOperatingModeKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class CsOperatingModeKind(Base): + """ + Operating mode for HVDC line operating as Current Source Converter. + + """ + + possibleProfileList = { + "class": [Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SSH.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=CsOperatingModeKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/CsPpccControlKind.py b/cimpy/cgmes_v2_4_15/CsPpccControlKind.py index 738a9495..8211400f 100644 --- a/cimpy/cgmes_v2_4_15/CsPpccControlKind.py +++ b/cimpy/cgmes_v2_4_15/CsPpccControlKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class CsPpccControlKind(Base): - ''' - Active power control modes for HVDC line operating as Current Source Converter. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=CsPpccControlKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class CsPpccControlKind(Base): + """ + Active power control modes for HVDC line operating as Current Source Converter. + + """ + + possibleProfileList = { + "class": [Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SSH.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=CsPpccControlKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Currency.py b/cimpy/cgmes_v2_4_15/Currency.py index c6443b25..28c72c8b 100644 --- a/cimpy/cgmes_v2_4_15/Currency.py +++ b/cimpy/cgmes_v2_4_15/Currency.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class Currency(Base): - ''' - Monetary currencies. Apologies for this list not being exhaustive. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=Currency\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Currency(Base): + """ + Monetary currencies. Apologies for this list not being exhaustive. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=Currency\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/CurrentFlow.py b/cimpy/cgmes_v2_4_15/CurrentFlow.py index 5a3f4070..a10e1de2 100644 --- a/cimpy/cgmes_v2_4_15/CurrentFlow.py +++ b/cimpy/cgmes_v2_4_15/CurrentFlow.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class CurrentFlow(Base): - ''' - Electrical current with sign convention: positive flow is out of the conducting equipment into the connectivity node. Can be both AC and DC. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - 'value': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - 'unit': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - 'multiplier': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=CurrentFlow\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class CurrentFlow(Base): + """ + Electrical current with sign convention: positive flow is out of the conducting equipment into the connectivity node. Can be both AC and DC. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "multiplier": [Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "unit": [Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "value": [Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=CurrentFlow\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/CurrentLimit.py b/cimpy/cgmes_v2_4_15/CurrentLimit.py index 12523c10..3f573fe8 100644 --- a/cimpy/cgmes_v2_4_15/CurrentLimit.py +++ b/cimpy/cgmes_v2_4_15/CurrentLimit.py @@ -1,31 +1,33 @@ -from .OperationalLimit import OperationalLimit - - -class CurrentLimit(OperationalLimit): - ''' - Operational limit on current. - - :value: Limit on current flow. Default: 0.0 - ''' - - cgmesProfile = OperationalLimit.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class OperationalLimit: \n' + OperationalLimit.__doc__ - - def __init__(self, value = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.value = value - - def __str__(self): - str = 'class=CurrentLimit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .OperationalLimit import OperationalLimit +from .CGMESProfile import Profile + + +class CurrentLimit(OperationalLimit): + """ + Operational limit on current. + + :value: Limit on current flow. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class OperationalLimit:\n" + OperationalLimit.__doc__ + + def __init__(self, value = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.value = value + + def __str__(self): + str = "class=CurrentLimit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Curve.py b/cimpy/cgmes_v2_4_15/Curve.py index 07fda2fc..8ac34017 100644 --- a/cimpy/cgmes_v2_4_15/Curve.py +++ b/cimpy/cgmes_v2_4_15/Curve.py @@ -1,43 +1,45 @@ -from .IdentifiedObject import IdentifiedObject - - -class Curve(IdentifiedObject): - ''' - A multi-purpose curve or functional relationship between an independent variable (X-axis) and dependent (Y-axis) variables. - - :curveStyle: The style or shape of the curve. Default: None - :xUnit: The X-axis units of measure. Default: None - :y1Unit: The Y1-axis units of measure. Default: None - :y2Unit: The Y2-axis units of measure. Default: None - :CurveDatas: The curve of this curve data point. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'curveStyle': [cgmesProfile.EQ.value, ], - 'xUnit': [cgmesProfile.EQ.value, ], - 'y1Unit': [cgmesProfile.EQ.value, ], - 'y2Unit': [cgmesProfile.EQ.value, ], - 'CurveDatas': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, curveStyle = None, xUnit = None, y1Unit = None, y2Unit = None, CurveDatas = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.curveStyle = curveStyle - self.xUnit = xUnit - self.y1Unit = y1Unit - self.y2Unit = y2Unit - self.CurveDatas = CurveDatas - - def __str__(self): - str = 'class=Curve\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class Curve(IdentifiedObject): + """ + A multi-purpose curve or functional relationship between an independent variable (X-axis) and dependent (Y-axis) variables. + + :CurveDatas: The curve of this curve data point. Default: "list" + :curveStyle: The style or shape of the curve. Default: None + :xUnit: The X-axis units of measure. Default: None + :y1Unit: The Y1-axis units of measure. Default: None + :y2Unit: The Y2-axis units of measure. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "CurveDatas": [Profile.EQ.value, ], + "curveStyle": [Profile.EQ.value, ], + "xUnit": [Profile.EQ.value, ], + "y1Unit": [Profile.EQ.value, ], + "y2Unit": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, CurveDatas = "list", curveStyle = None, xUnit = None, y1Unit = None, y2Unit = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.CurveDatas = CurveDatas + self.curveStyle = curveStyle + self.xUnit = xUnit + self.y1Unit = y1Unit + self.y2Unit = y2Unit + + def __str__(self): + str = "class=Curve\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/CurveData.py b/cimpy/cgmes_v2_4_15/CurveData.py index 009f9c52..dcf0457e 100644 --- a/cimpy/cgmes_v2_4_15/CurveData.py +++ b/cimpy/cgmes_v2_4_15/CurveData.py @@ -1,39 +1,40 @@ -from .Base import Base - - -class CurveData(Base): - ''' - Multi-purpose data points for defining a curve. The use of this generic class is discouraged if a more specific class can be used to specify the x and y axis values along with their specific data types. - - :Curve: The point data values that define this curve. Default: None - :xvalue: The data value of the X-axis variable, depending on the X-axis units. Default: 0.0 - :y1value: The data value of the first Y-axis variable, depending on the Y-axis units. Default: 0.0 - :y2value: The data value of the second Y-axis variable (if present), depending on the Y-axis units. Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'Curve': [cgmesProfile.EQ.value, ], - 'xvalue': [cgmesProfile.EQ.value, ], - 'y1value': [cgmesProfile.EQ.value, ], - 'y2value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, Curve = None, xvalue = 0.0, y1value = 0.0, y2value = 0.0, ): - - self.Curve = Curve - self.xvalue = xvalue - self.y1value = y1value - self.y2value = y2value - - def __str__(self): - str = 'class=CurveData\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class CurveData(Base): + """ + Multi-purpose data points for defining a curve. The use of this generic class is discouraged if a more specific class can be used to specify the x and y axis values along with their specific data types. + + :Curve: The point data values that define this curve. Default: None + :xvalue: The data value of the X-axis variable, depending on the X-axis units. Default: 0.0 + :y1value: The data value of the first Y-axis variable, depending on the Y-axis units. Default: 0.0 + :y2value: The data value of the second Y-axis variable (if present), depending on the Y-axis units. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "Curve": [Profile.EQ.value, ], + "xvalue": [Profile.EQ.value, ], + "y1value": [Profile.EQ.value, ], + "y2value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, Curve = None, xvalue = 0.0, y1value = 0.0, y2value = 0.0): + + self.Curve = Curve + self.xvalue = xvalue + self.y1value = y1value + self.y2value = y2value + + def __str__(self): + str = "class=CurveData\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/CurveStyle.py b/cimpy/cgmes_v2_4_15/CurveStyle.py index 2e3904d2..9105b9cb 100644 --- a/cimpy/cgmes_v2_4_15/CurveStyle.py +++ b/cimpy/cgmes_v2_4_15/CurveStyle.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class CurveStyle(Base): - ''' - Style or shape of curve. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=CurveStyle\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class CurveStyle(Base): + """ + Style or shape of curve. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=CurveStyle\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCBaseTerminal.py b/cimpy/cgmes_v2_4_15/DCBaseTerminal.py index 02c74248..82433624 100644 --- a/cimpy/cgmes_v2_4_15/DCBaseTerminal.py +++ b/cimpy/cgmes_v2_4_15/DCBaseTerminal.py @@ -1,34 +1,36 @@ -from .ACDCTerminal import ACDCTerminal - - -class DCBaseTerminal(ACDCTerminal): - ''' - An electrical connection point at a piece of DC conducting equipment. DC terminals are connected at one physical DC node that may have multiple DC terminals connected. A DC node is similar to an AC connectivity node. The model enforces that DC connections are distinct from AC connections. - - :DCNode: Default: None - :DCTopologicalNode: See association end TopologicalNode.Terminal. Default: None - ''' - - cgmesProfile = ACDCTerminal.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.TP.value, ], - 'DCNode': [cgmesProfile.EQ.value, ], - 'DCTopologicalNode': [cgmesProfile.TP.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ACDCTerminal: \n' + ACDCTerminal.__doc__ - - def __init__(self, DCNode = None, DCTopologicalNode = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.DCNode = DCNode - self.DCTopologicalNode = DCTopologicalNode - - def __str__(self): - str = 'class=DCBaseTerminal\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ACDCTerminal import ACDCTerminal +from .CGMESProfile import Profile + + +class DCBaseTerminal(ACDCTerminal): + """ + An electrical connection point at a piece of DC conducting equipment. DC terminals are connected at one physical DC node that may have multiple DC terminals connected. A DC node is similar to an AC connectivity node. The model enforces that DC connections are distinct from AC connections. + + :DCNode: Default: None + :DCTopologicalNode: See association end TopologicalNode.Terminal. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, Profile.TP.value, ], + "DCNode": [Profile.EQ.value, ], + "DCTopologicalNode": [Profile.TP.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ACDCTerminal:\n" + ACDCTerminal.__doc__ + + def __init__(self, DCNode = None, DCTopologicalNode = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DCNode = DCNode + self.DCTopologicalNode = DCTopologicalNode + + def __str__(self): + str = "class=DCBaseTerminal\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCBreaker.py b/cimpy/cgmes_v2_4_15/DCBreaker.py index 279b4e96..2e2717e1 100644 --- a/cimpy/cgmes_v2_4_15/DCBreaker.py +++ b/cimpy/cgmes_v2_4_15/DCBreaker.py @@ -1,29 +1,31 @@ -from .DCSwitch import DCSwitch - - -class DCBreaker(DCSwitch): - ''' - A breaker within a DC system. - - ''' - - cgmesProfile = DCSwitch.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DCSwitch: \n' + DCSwitch.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=DCBreaker\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DCSwitch import DCSwitch +from .CGMESProfile import Profile + + +class DCBreaker(DCSwitch): + """ + A breaker within a DC system. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class DCSwitch:\n" + DCSwitch.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=DCBreaker\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCBusbar.py b/cimpy/cgmes_v2_4_15/DCBusbar.py index 71d38948..f918be5a 100644 --- a/cimpy/cgmes_v2_4_15/DCBusbar.py +++ b/cimpy/cgmes_v2_4_15/DCBusbar.py @@ -1,29 +1,31 @@ -from .DCConductingEquipment import DCConductingEquipment - - -class DCBusbar(DCConductingEquipment): - ''' - A busbar within a DC system. - - ''' - - cgmesProfile = DCConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DCConductingEquipment: \n' + DCConductingEquipment.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=DCBusbar\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DCConductingEquipment import DCConductingEquipment +from .CGMESProfile import Profile + + +class DCBusbar(DCConductingEquipment): + """ + A busbar within a DC system. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class DCConductingEquipment:\n" + DCConductingEquipment.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=DCBusbar\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCChopper.py b/cimpy/cgmes_v2_4_15/DCChopper.py index fa6ec0c7..4ea34ec3 100644 --- a/cimpy/cgmes_v2_4_15/DCChopper.py +++ b/cimpy/cgmes_v2_4_15/DCChopper.py @@ -1,29 +1,31 @@ -from .DCConductingEquipment import DCConductingEquipment - - -class DCChopper(DCConductingEquipment): - ''' - Low resistance equipment used in the internal DC circuit to balance voltages. It has typically positive and negative pole terminals and a ground. - - ''' - - cgmesProfile = DCConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DCConductingEquipment: \n' + DCConductingEquipment.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=DCChopper\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DCConductingEquipment import DCConductingEquipment +from .CGMESProfile import Profile + + +class DCChopper(DCConductingEquipment): + """ + Low resistance equipment used in the internal DC circuit to balance voltages. It has typically positive and negative pole terminals and a ground. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class DCConductingEquipment:\n" + DCConductingEquipment.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=DCChopper\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCConductingEquipment.py b/cimpy/cgmes_v2_4_15/DCConductingEquipment.py index 5bfca3a1..c37df82c 100644 --- a/cimpy/cgmes_v2_4_15/DCConductingEquipment.py +++ b/cimpy/cgmes_v2_4_15/DCConductingEquipment.py @@ -1,31 +1,33 @@ -from .Equipment import Equipment - - -class DCConductingEquipment(Equipment): - ''' - The parts of the DC power system that are designed to carry current or that are conductively connected through DC terminals. - - :DCTerminals: Default: "list" - ''' - - cgmesProfile = Equipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'DCTerminals': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Equipment: \n' + Equipment.__doc__ - - def __init__(self, DCTerminals = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.DCTerminals = DCTerminals - - def __str__(self): - str = 'class=DCConductingEquipment\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Equipment import Equipment +from .CGMESProfile import Profile + + +class DCConductingEquipment(Equipment): + """ + The parts of the DC power system that are designed to carry current or that are conductively connected through DC terminals. + + :DCTerminals: Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "DCTerminals": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Equipment:\n" + Equipment.__doc__ + + def __init__(self, DCTerminals = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DCTerminals = DCTerminals + + def __str__(self): + str = "class=DCConductingEquipment\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCConverterOperatingModeKind.py b/cimpy/cgmes_v2_4_15/DCConverterOperatingModeKind.py index ea01fc06..c4527129 100644 --- a/cimpy/cgmes_v2_4_15/DCConverterOperatingModeKind.py +++ b/cimpy/cgmes_v2_4_15/DCConverterOperatingModeKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class DCConverterOperatingModeKind(Base): - ''' - The operating mode of an HVDC bipole. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=DCConverterOperatingModeKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class DCConverterOperatingModeKind(Base): + """ + The operating mode of an HVDC bipole. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=DCConverterOperatingModeKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCConverterUnit.py b/cimpy/cgmes_v2_4_15/DCConverterUnit.py index 145e4ddc..3dfa9c09 100644 --- a/cimpy/cgmes_v2_4_15/DCConverterUnit.py +++ b/cimpy/cgmes_v2_4_15/DCConverterUnit.py @@ -1,34 +1,36 @@ -from .DCEquipmentContainer import DCEquipmentContainer - - -class DCConverterUnit(DCEquipmentContainer): - ''' - Indivisible operative unit comprising all equipment between the point of common coupling on the AC side and the point of common coupling - DC side, essentially one or more converters, together with one or more converter transformers, converter control equipment, essential protective and switching devices and auxiliaries, if any, used for conversion. - - :operationMode: Default: None - :Substation: Default: None - ''' - - cgmesProfile = DCEquipmentContainer.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'operationMode': [cgmesProfile.EQ.value, ], - 'Substation': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DCEquipmentContainer: \n' + DCEquipmentContainer.__doc__ - - def __init__(self, operationMode = None, Substation = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.operationMode = operationMode - self.Substation = Substation - - def __str__(self): - str = 'class=DCConverterUnit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DCEquipmentContainer import DCEquipmentContainer +from .CGMESProfile import Profile + + +class DCConverterUnit(DCEquipmentContainer): + """ + Indivisible operative unit comprising all equipment between the point of common coupling on the AC side and the point of common coupling - DC side, essentially one or more converters, together with one or more converter transformers, converter control equipment, essential protective and switching devices and auxiliaries, if any, used for conversion. + + :Substation: Default: None + :operationMode: Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "Substation": [Profile.EQ.value, ], + "operationMode": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class DCEquipmentContainer:\n" + DCEquipmentContainer.__doc__ + + def __init__(self, Substation = None, operationMode = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Substation = Substation + self.operationMode = operationMode + + def __str__(self): + str = "class=DCConverterUnit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCDisconnector.py b/cimpy/cgmes_v2_4_15/DCDisconnector.py index 6be928d0..f432d03d 100644 --- a/cimpy/cgmes_v2_4_15/DCDisconnector.py +++ b/cimpy/cgmes_v2_4_15/DCDisconnector.py @@ -1,29 +1,31 @@ -from .DCSwitch import DCSwitch - - -class DCDisconnector(DCSwitch): - ''' - A disconnector within a DC system. - - ''' - - cgmesProfile = DCSwitch.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DCSwitch: \n' + DCSwitch.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=DCDisconnector\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DCSwitch import DCSwitch +from .CGMESProfile import Profile + + +class DCDisconnector(DCSwitch): + """ + A disconnector within a DC system. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class DCSwitch:\n" + DCSwitch.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=DCDisconnector\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCEquipmentContainer.py b/cimpy/cgmes_v2_4_15/DCEquipmentContainer.py index 627aeaf6..e25ee4e4 100644 --- a/cimpy/cgmes_v2_4_15/DCEquipmentContainer.py +++ b/cimpy/cgmes_v2_4_15/DCEquipmentContainer.py @@ -1,34 +1,36 @@ -from .EquipmentContainer import EquipmentContainer - - -class DCEquipmentContainer(EquipmentContainer): - ''' - A modeling construct to provide a root class for containment of DC as well as AC equipment. The class differ from the EquipmentContaner for AC in that it may also contain DCNodes. Hence it can contain both AC and DC equipment. - - :DCNodes: Default: "list" - :DCTopologicalNode: Default: "list" - ''' - - cgmesProfile = EquipmentContainer.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.TP.value, ], - 'DCNodes': [cgmesProfile.EQ.value, ], - 'DCTopologicalNode': [cgmesProfile.TP.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EquipmentContainer: \n' + EquipmentContainer.__doc__ - - def __init__(self, DCNodes = "list", DCTopologicalNode = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.DCNodes = DCNodes - self.DCTopologicalNode = DCTopologicalNode - - def __str__(self): - str = 'class=DCEquipmentContainer\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EquipmentContainer import EquipmentContainer +from .CGMESProfile import Profile + + +class DCEquipmentContainer(EquipmentContainer): + """ + A modeling construct to provide a root class for containment of DC as well as AC equipment. The class differ from the EquipmentContaner for AC in that it may also contain DCNodes. Hence it can contain both AC and DC equipment. + + :DCNodes: Default: "list" + :DCTopologicalNode: Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.TP.value, ], + "DCNodes": [Profile.EQ.value, ], + "DCTopologicalNode": [Profile.TP.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EquipmentContainer:\n" + EquipmentContainer.__doc__ + + def __init__(self, DCNodes = "list", DCTopologicalNode = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DCNodes = DCNodes + self.DCTopologicalNode = DCTopologicalNode + + def __str__(self): + str = "class=DCEquipmentContainer\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCGround.py b/cimpy/cgmes_v2_4_15/DCGround.py index 8331961c..a89ab53d 100644 --- a/cimpy/cgmes_v2_4_15/DCGround.py +++ b/cimpy/cgmes_v2_4_15/DCGround.py @@ -1,34 +1,36 @@ -from .DCConductingEquipment import DCConductingEquipment - - -class DCGround(DCConductingEquipment): - ''' - A ground within a DC system. - - :inductance: Inductance to ground. Default: 0.0 - :r: Resistance to ground. Default: 0.0 - ''' - - cgmesProfile = DCConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'inductance': [cgmesProfile.EQ.value, ], - 'r': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DCConductingEquipment: \n' + DCConductingEquipment.__doc__ - - def __init__(self, inductance = 0.0, r = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.inductance = inductance - self.r = r - - def __str__(self): - str = 'class=DCGround\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DCConductingEquipment import DCConductingEquipment +from .CGMESProfile import Profile + + +class DCGround(DCConductingEquipment): + """ + A ground within a DC system. + + :inductance: Inductance to ground. Default: 0.0 + :r: Resistance to ground. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "inductance": [Profile.EQ.value, ], + "r": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class DCConductingEquipment:\n" + DCConductingEquipment.__doc__ + + def __init__(self, inductance = 0.0, r = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.inductance = inductance + self.r = r + + def __str__(self): + str = "class=DCGround\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCLine.py b/cimpy/cgmes_v2_4_15/DCLine.py index 930ac603..cc94b080 100644 --- a/cimpy/cgmes_v2_4_15/DCLine.py +++ b/cimpy/cgmes_v2_4_15/DCLine.py @@ -1,31 +1,33 @@ -from .DCEquipmentContainer import DCEquipmentContainer - - -class DCLine(DCEquipmentContainer): - ''' - Overhead lines and/or cables connecting two or more HVDC substations. - - :Region: Default: None - ''' - - cgmesProfile = DCEquipmentContainer.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'Region': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DCEquipmentContainer: \n' + DCEquipmentContainer.__doc__ - - def __init__(self, Region = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Region = Region - - def __str__(self): - str = 'class=DCLine\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DCEquipmentContainer import DCEquipmentContainer +from .CGMESProfile import Profile + + +class DCLine(DCEquipmentContainer): + """ + Overhead lines and/or cables connecting two or more HVDC substations. + + :Region: Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "Region": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class DCEquipmentContainer:\n" + DCEquipmentContainer.__doc__ + + def __init__(self, Region = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Region = Region + + def __str__(self): + str = "class=DCLine\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCLineSegment.py b/cimpy/cgmes_v2_4_15/DCLineSegment.py index 4316adbe..808e75a2 100644 --- a/cimpy/cgmes_v2_4_15/DCLineSegment.py +++ b/cimpy/cgmes_v2_4_15/DCLineSegment.py @@ -1,43 +1,45 @@ -from .DCConductingEquipment import DCConductingEquipment - - -class DCLineSegment(DCConductingEquipment): - ''' - A wire or combination of wires not insulated from one another, with consistent electrical characteristics, used to carry direct current between points in the DC region of the power system. - - :capacitance: Capacitance of the DC line segment. Significant for cables only. Default: 0.0 - :inductance: Inductance of the DC line segment. Neglectable compared with DCSeriesDevice used for smoothing. Default: 0.0 - :resistance: Resistance of the DC line segment. Default: 0.0 - :length: Segment length for calculating line section capabilities. Default: 0.0 - :PerLengthParameter: Set of per-length parameters for this line segment. Default: None - ''' - - cgmesProfile = DCConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'capacitance': [cgmesProfile.EQ.value, ], - 'inductance': [cgmesProfile.EQ.value, ], - 'resistance': [cgmesProfile.EQ.value, ], - 'length': [cgmesProfile.EQ.value, ], - 'PerLengthParameter': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DCConductingEquipment: \n' + DCConductingEquipment.__doc__ - - def __init__(self, capacitance = 0.0, inductance = 0.0, resistance = 0.0, length = 0.0, PerLengthParameter = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.capacitance = capacitance - self.inductance = inductance - self.resistance = resistance - self.length = length - self.PerLengthParameter = PerLengthParameter - - def __str__(self): - str = 'class=DCLineSegment\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DCConductingEquipment import DCConductingEquipment +from .CGMESProfile import Profile + + +class DCLineSegment(DCConductingEquipment): + """ + A wire or combination of wires not insulated from one another, with consistent electrical characteristics, used to carry direct current between points in the DC region of the power system. + + :PerLengthParameter: Set of per-length parameters for this line segment. Default: None + :capacitance: Capacitance of the DC line segment. Significant for cables only. Default: 0.0 + :inductance: Inductance of the DC line segment. Neglectable compared with DCSeriesDevice used for smoothing. Default: 0.0 + :length: Segment length for calculating line section capabilities. Default: 0.0 + :resistance: Resistance of the DC line segment. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "PerLengthParameter": [Profile.EQ.value, ], + "capacitance": [Profile.EQ.value, ], + "inductance": [Profile.EQ.value, ], + "length": [Profile.EQ.value, ], + "resistance": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class DCConductingEquipment:\n" + DCConductingEquipment.__doc__ + + def __init__(self, PerLengthParameter = None, capacitance = 0.0, inductance = 0.0, length = 0.0, resistance = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.PerLengthParameter = PerLengthParameter + self.capacitance = capacitance + self.inductance = inductance + self.length = length + self.resistance = resistance + + def __str__(self): + str = "class=DCLineSegment\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCNode.py b/cimpy/cgmes_v2_4_15/DCNode.py index e143fdae..9cf859dd 100644 --- a/cimpy/cgmes_v2_4_15/DCNode.py +++ b/cimpy/cgmes_v2_4_15/DCNode.py @@ -1,37 +1,39 @@ -from .IdentifiedObject import IdentifiedObject - - -class DCNode(IdentifiedObject): - ''' - DC nodes are points where terminals of DC conducting equipment are connected together with zero impedance. - - :DCTerminals: Default: "list" - :DCEquipmentContainer: Default: None - :DCTopologicalNode: See association end TopologicalNode.ConnectivityNodes. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.TP.value, ], - 'DCTerminals': [cgmesProfile.EQ.value, ], - 'DCEquipmentContainer': [cgmesProfile.EQ.value, ], - 'DCTopologicalNode': [cgmesProfile.TP.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, DCTerminals = "list", DCEquipmentContainer = None, DCTopologicalNode = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.DCTerminals = DCTerminals - self.DCEquipmentContainer = DCEquipmentContainer - self.DCTopologicalNode = DCTopologicalNode - - def __str__(self): - str = 'class=DCNode\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class DCNode(IdentifiedObject): + """ + DC nodes are points where terminals of DC conducting equipment are connected together with zero impedance. + + :DCEquipmentContainer: Default: None + :DCTerminals: Default: "list" + :DCTopologicalNode: See association end TopologicalNode.ConnectivityNodes. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.TP.value, ], + "DCEquipmentContainer": [Profile.EQ.value, ], + "DCTerminals": [Profile.EQ.value, ], + "DCTopologicalNode": [Profile.TP.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, DCEquipmentContainer = None, DCTerminals = "list", DCTopologicalNode = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DCEquipmentContainer = DCEquipmentContainer + self.DCTerminals = DCTerminals + self.DCTopologicalNode = DCTopologicalNode + + def __str__(self): + str = "class=DCNode\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCPolarityKind.py b/cimpy/cgmes_v2_4_15/DCPolarityKind.py index 7c60bf15..a1054a43 100644 --- a/cimpy/cgmes_v2_4_15/DCPolarityKind.py +++ b/cimpy/cgmes_v2_4_15/DCPolarityKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class DCPolarityKind(Base): - ''' - Polarity for DC circuits. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=DCPolarityKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class DCPolarityKind(Base): + """ + Polarity for DC circuits. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=DCPolarityKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCSeriesDevice.py b/cimpy/cgmes_v2_4_15/DCSeriesDevice.py index 1dae1ea7..c72d138f 100644 --- a/cimpy/cgmes_v2_4_15/DCSeriesDevice.py +++ b/cimpy/cgmes_v2_4_15/DCSeriesDevice.py @@ -1,37 +1,39 @@ -from .DCConductingEquipment import DCConductingEquipment - - -class DCSeriesDevice(DCConductingEquipment): - ''' - A series device within the DC system, typically a reactor used for filtering or smoothing. Needed for transient and short circuit studies. - - :inductance: Inductance of the device. Default: 0.0 - :resistance: Resistance of the DC device. Default: 0.0 - :ratedUdc: Rated DC device voltage. Converter configuration data used in power flow. Default: 0.0 - ''' - - cgmesProfile = DCConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'inductance': [cgmesProfile.EQ.value, ], - 'resistance': [cgmesProfile.EQ.value, ], - 'ratedUdc': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DCConductingEquipment: \n' + DCConductingEquipment.__doc__ - - def __init__(self, inductance = 0.0, resistance = 0.0, ratedUdc = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.inductance = inductance - self.resistance = resistance - self.ratedUdc = ratedUdc - - def __str__(self): - str = 'class=DCSeriesDevice\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DCConductingEquipment import DCConductingEquipment +from .CGMESProfile import Profile + + +class DCSeriesDevice(DCConductingEquipment): + """ + A series device within the DC system, typically a reactor used for filtering or smoothing. Needed for transient and short circuit studies. + + :inductance: Inductance of the device. Default: 0.0 + :ratedUdc: Rated DC device voltage. Converter configuration data used in power flow. Default: 0.0 + :resistance: Resistance of the DC device. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "inductance": [Profile.EQ.value, ], + "ratedUdc": [Profile.EQ.value, ], + "resistance": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class DCConductingEquipment:\n" + DCConductingEquipment.__doc__ + + def __init__(self, inductance = 0.0, ratedUdc = 0.0, resistance = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.inductance = inductance + self.ratedUdc = ratedUdc + self.resistance = resistance + + def __str__(self): + str = "class=DCSeriesDevice\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCShunt.py b/cimpy/cgmes_v2_4_15/DCShunt.py index 8ac0d8fc..02cf6c64 100644 --- a/cimpy/cgmes_v2_4_15/DCShunt.py +++ b/cimpy/cgmes_v2_4_15/DCShunt.py @@ -1,37 +1,39 @@ -from .DCConductingEquipment import DCConductingEquipment - - -class DCShunt(DCConductingEquipment): - ''' - A shunt device within the DC system, typically used for filtering. Needed for transient and short circuit studies. - - :capacitance: Capacitance of the DC shunt. Default: 0.0 - :resistance: Resistance of the DC device. Default: 0.0 - :ratedUdc: Rated DC device voltage. Converter configuration data used in power flow. Default: 0.0 - ''' - - cgmesProfile = DCConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'capacitance': [cgmesProfile.EQ.value, ], - 'resistance': [cgmesProfile.EQ.value, ], - 'ratedUdc': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DCConductingEquipment: \n' + DCConductingEquipment.__doc__ - - def __init__(self, capacitance = 0.0, resistance = 0.0, ratedUdc = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.capacitance = capacitance - self.resistance = resistance - self.ratedUdc = ratedUdc - - def __str__(self): - str = 'class=DCShunt\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DCConductingEquipment import DCConductingEquipment +from .CGMESProfile import Profile + + +class DCShunt(DCConductingEquipment): + """ + A shunt device within the DC system, typically used for filtering. Needed for transient and short circuit studies. + + :capacitance: Capacitance of the DC shunt. Default: 0.0 + :ratedUdc: Rated DC device voltage. Converter configuration data used in power flow. Default: 0.0 + :resistance: Resistance of the DC device. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "capacitance": [Profile.EQ.value, ], + "ratedUdc": [Profile.EQ.value, ], + "resistance": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class DCConductingEquipment:\n" + DCConductingEquipment.__doc__ + + def __init__(self, capacitance = 0.0, ratedUdc = 0.0, resistance = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.capacitance = capacitance + self.ratedUdc = ratedUdc + self.resistance = resistance + + def __str__(self): + str = "class=DCShunt\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCSwitch.py b/cimpy/cgmes_v2_4_15/DCSwitch.py index b3efbf57..ef665e5f 100644 --- a/cimpy/cgmes_v2_4_15/DCSwitch.py +++ b/cimpy/cgmes_v2_4_15/DCSwitch.py @@ -1,29 +1,31 @@ -from .DCConductingEquipment import DCConductingEquipment - - -class DCSwitch(DCConductingEquipment): - ''' - A switch within the DC system. - - ''' - - cgmesProfile = DCConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DCConductingEquipment: \n' + DCConductingEquipment.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=DCSwitch\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DCConductingEquipment import DCConductingEquipment +from .CGMESProfile import Profile + + +class DCSwitch(DCConductingEquipment): + """ + A switch within the DC system. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class DCConductingEquipment:\n" + DCConductingEquipment.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=DCSwitch\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCTerminal.py b/cimpy/cgmes_v2_4_15/DCTerminal.py index a4319060..7feb61ce 100644 --- a/cimpy/cgmes_v2_4_15/DCTerminal.py +++ b/cimpy/cgmes_v2_4_15/DCTerminal.py @@ -1,31 +1,33 @@ -from .DCBaseTerminal import DCBaseTerminal - - -class DCTerminal(DCBaseTerminal): - ''' - An electrical connection point to generic DC conducting equipment. - - :DCConductingEquipment: Default: None - ''' - - cgmesProfile = DCBaseTerminal.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.TP.value, ], - 'DCConductingEquipment': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DCBaseTerminal: \n' + DCBaseTerminal.__doc__ - - def __init__(self, DCConductingEquipment = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.DCConductingEquipment = DCConductingEquipment - - def __str__(self): - str = 'class=DCTerminal\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DCBaseTerminal import DCBaseTerminal +from .CGMESProfile import Profile + + +class DCTerminal(DCBaseTerminal): + """ + An electrical connection point to generic DC conducting equipment. + + :DCConductingEquipment: Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, Profile.TP.value, ], + "DCConductingEquipment": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class DCBaseTerminal:\n" + DCBaseTerminal.__doc__ + + def __init__(self, DCConductingEquipment = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DCConductingEquipment = DCConductingEquipment + + def __str__(self): + str = "class=DCTerminal\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCTopologicalIsland.py b/cimpy/cgmes_v2_4_15/DCTopologicalIsland.py index 2a0ec7e5..6b37612d 100644 --- a/cimpy/cgmes_v2_4_15/DCTopologicalIsland.py +++ b/cimpy/cgmes_v2_4_15/DCTopologicalIsland.py @@ -1,31 +1,33 @@ -from .IdentifiedObject import IdentifiedObject - - -class DCTopologicalIsland(IdentifiedObject): - ''' - An electrically connected subset of the network. DC topological islands can change as the current network state changes: e.g. due to - disconnect switches or breakers change state in a SCADA/EMS - manual creation, change or deletion of topological nodes in a planning tool. - - :DCTopologicalNodes: Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SV.value, ], - 'DCTopologicalNodes': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, DCTopologicalNodes = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.DCTopologicalNodes = DCTopologicalNodes - - def __str__(self): - str = 'class=DCTopologicalIsland\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class DCTopologicalIsland(IdentifiedObject): + """ + An electrically connected subset of the network. DC topological islands can change as the current network state changes: e.g. due to - disconnect switches or breakers change state in a SCADA/EMS - manual creation, change or deletion of topological nodes in a planning tool. + + :DCTopologicalNodes: Default: "list" + """ + + possibleProfileList = { + "class": [Profile.SV.value, ], + "DCTopologicalNodes": [Profile.SV.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SV.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, DCTopologicalNodes = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DCTopologicalNodes = DCTopologicalNodes + + def __str__(self): + str = "class=DCTopologicalIsland\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DCTopologicalNode.py b/cimpy/cgmes_v2_4_15/DCTopologicalNode.py index eb15008e..80c8fae4 100644 --- a/cimpy/cgmes_v2_4_15/DCTopologicalNode.py +++ b/cimpy/cgmes_v2_4_15/DCTopologicalNode.py @@ -1,40 +1,42 @@ -from .IdentifiedObject import IdentifiedObject - - -class DCTopologicalNode(IdentifiedObject): - ''' - DC bus. - - :DCTopologicalIsland: Default: None - :DCTerminals: See association end Terminal.TopologicalNode. Default: "list" - :DCEquipmentContainer: Default: None - :DCNodes: See association end ConnectivityNode.TopologicalNode. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SV.value, cgmesProfile.TP.value, ], - 'DCTopologicalIsland': [cgmesProfile.SV.value, ], - 'DCTerminals': [cgmesProfile.TP.value, ], - 'DCEquipmentContainer': [cgmesProfile.TP.value, ], - 'DCNodes': [cgmesProfile.TP.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, DCTopologicalIsland = None, DCTerminals = "list", DCEquipmentContainer = None, DCNodes = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.DCTopologicalIsland = DCTopologicalIsland - self.DCTerminals = DCTerminals - self.DCEquipmentContainer = DCEquipmentContainer - self.DCNodes = DCNodes - - def __str__(self): - str = 'class=DCTopologicalNode\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class DCTopologicalNode(IdentifiedObject): + """ + DC bus. + + :DCEquipmentContainer: Default: None + :DCNodes: See association end ConnectivityNode.TopologicalNode. Default: "list" + :DCTerminals: See association end Terminal.TopologicalNode. Default: "list" + :DCTopologicalIsland: Default: None + """ + + possibleProfileList = { + "class": [Profile.SV.value, Profile.TP.value, ], + "DCEquipmentContainer": [Profile.TP.value, ], + "DCNodes": [Profile.TP.value, ], + "DCTerminals": [Profile.TP.value, ], + "DCTopologicalIsland": [Profile.SV.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.TP.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, DCEquipmentContainer = None, DCNodes = "list", DCTerminals = "list", DCTopologicalIsland = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DCEquipmentContainer = DCEquipmentContainer + self.DCNodes = DCNodes + self.DCTerminals = DCTerminals + self.DCTopologicalIsland = DCTopologicalIsland + + def __str__(self): + str = "class=DCTopologicalNode\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Date.py b/cimpy/cgmes_v2_4_15/Date.py index b2ea8681..ccdba17e 100644 --- a/cimpy/cgmes_v2_4_15/Date.py +++ b/cimpy/cgmes_v2_4_15/Date.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class Date(Base): - ''' - Date as "yyyy-mm-dd", which conforms with ISO 8601. UTC time zone is specified as "yyyy-mm-ddZ". A local timezone relative UTC is specified as "yyyy-mm-dd(+/-)hh:mm". - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.GL.value, cgmesProfile.DY.value, cgmesProfile.TP.value, cgmesProfile.TP_BD.value, cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=Date\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Date(Base): + """ + Date as "yyyy-mm-dd", which conforms with ISO 8601. UTC time zone is specified as "yyyy-mm-ddZ". A local timezone relative UTC is specified as "yyyy-mm-dd(+/-)hh:mm". + + """ + + possibleProfileList = { + "class": [Profile.DL.value, Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.GL.value, Profile.SV.value, Profile.SSH.value, Profile.TP_BD.value, Profile.TP.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=Date\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DateTime.py b/cimpy/cgmes_v2_4_15/DateTime.py index 8d430f80..3c82aed2 100644 --- a/cimpy/cgmes_v2_4_15/DateTime.py +++ b/cimpy/cgmes_v2_4_15/DateTime.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class DateTime(Base): - ''' - Date and time as "yyyy-mm-ddThh:mm:ss.sss", which conforms with ISO 8601. UTC time zone is specified as "yyyy-mm-ddThh:mm:ss.sssZ". A local timezone relative UTC is specified as "yyyy-mm-ddThh:mm:ss.sss-hh:mm". The second component (shown here as "ss.sss") could have any number of digits in its fractional part to allow any kind of precision beyond seconds. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=DateTime\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class DateTime(Base): + """ + Date and time as "yyyy-mm-ddThh:mm:ss.sss", which conforms with ISO 8601. UTC time zone is specified as "yyyy-mm-ddThh:mm:ss.sssZ". A local timezone relative UTC is specified as "yyyy-mm-ddThh:mm:ss.sss-hh:mm". The second component (shown here as "ss.sss") could have any number of digits in its fractional part to allow any kind of precision beyond seconds. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=DateTime\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DayType.py b/cimpy/cgmes_v2_4_15/DayType.py index bbe04fbc..c5e82c3d 100644 --- a/cimpy/cgmes_v2_4_15/DayType.py +++ b/cimpy/cgmes_v2_4_15/DayType.py @@ -1,31 +1,33 @@ -from .IdentifiedObject import IdentifiedObject - - -class DayType(IdentifiedObject): - ''' - Group of similar days. For example it could be used to represent weekdays, weekend, or holidays. - - :SeasonDayTypeSchedules: DayType for the Schedule. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'SeasonDayTypeSchedules': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, SeasonDayTypeSchedules = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.SeasonDayTypeSchedules = SeasonDayTypeSchedules - - def __str__(self): - str = 'class=DayType\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class DayType(IdentifiedObject): + """ + Group of similar days. For example it could be used to represent weekdays, weekend, or holidays. + + :SeasonDayTypeSchedules: DayType for the Schedule. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "SeasonDayTypeSchedules": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, SeasonDayTypeSchedules = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.SeasonDayTypeSchedules = SeasonDayTypeSchedules + + def __str__(self): + str = "class=DayType\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Decimal.py b/cimpy/cgmes_v2_4_15/Decimal.py index 4e205714..70f1df09 100644 --- a/cimpy/cgmes_v2_4_15/Decimal.py +++ b/cimpy/cgmes_v2_4_15/Decimal.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class Decimal(Base): - ''' - Decimal is the base-10 notational system for representing real numbers. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=Decimal\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Decimal(Base): + """ + Decimal is the base-10 notational system for representing real numbers. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=Decimal\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Diagram.py b/cimpy/cgmes_v2_4_15/Diagram.py index e7125fc5..a360e251 100644 --- a/cimpy/cgmes_v2_4_15/Diagram.py +++ b/cimpy/cgmes_v2_4_15/Diagram.py @@ -1,49 +1,51 @@ -from .IdentifiedObject import IdentifiedObject - - -class Diagram(IdentifiedObject): - ''' - The diagram being exchanged. The coordinate system is a standard Cartesian coordinate system and the orientation attribute defines the orientation. - - :DiagramStyle: A Diagram may have a DiagramStyle. Default: None - :orientation: Coordinate system orientation of the diagram. Default: None - :x1InitialView: X coordinate of the first corner of the initial view. Default: 0.0 - :x2InitialView: X coordinate of the second corner of the initial view. Default: 0.0 - :y1InitialView: Y coordinate of the first corner of the initial view. Default: 0.0 - :y2InitialView: Y coordinate of the second corner of the initial view. Default: 0.0 - :DiagramElements: A diagram is made up of multiple diagram objects. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, ], - 'DiagramStyle': [cgmesProfile.DL.value, ], - 'orientation': [cgmesProfile.DL.value, ], - 'x1InitialView': [cgmesProfile.DL.value, ], - 'x2InitialView': [cgmesProfile.DL.value, ], - 'y1InitialView': [cgmesProfile.DL.value, ], - 'y2InitialView': [cgmesProfile.DL.value, ], - 'DiagramElements': [cgmesProfile.DL.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, DiagramStyle = None, orientation = None, x1InitialView = 0.0, x2InitialView = 0.0, y1InitialView = 0.0, y2InitialView = 0.0, DiagramElements = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.DiagramStyle = DiagramStyle - self.orientation = orientation - self.x1InitialView = x1InitialView - self.x2InitialView = x2InitialView - self.y1InitialView = y1InitialView - self.y2InitialView = y2InitialView - self.DiagramElements = DiagramElements - - def __str__(self): - str = 'class=Diagram\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class Diagram(IdentifiedObject): + """ + The diagram being exchanged. The coordinate system is a standard Cartesian coordinate system and the orientation attribute defines the orientation. + + :DiagramElements: A diagram is made up of multiple diagram objects. Default: "list" + :DiagramStyle: A Diagram may have a DiagramStyle. Default: None + :orientation: Coordinate system orientation of the diagram. Default: None + :x1InitialView: X coordinate of the first corner of the initial view. Default: 0.0 + :x2InitialView: X coordinate of the second corner of the initial view. Default: 0.0 + :y1InitialView: Y coordinate of the first corner of the initial view. Default: 0.0 + :y2InitialView: Y coordinate of the second corner of the initial view. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DL.value, ], + "DiagramElements": [Profile.DL.value, ], + "DiagramStyle": [Profile.DL.value, ], + "orientation": [Profile.DL.value, ], + "x1InitialView": [Profile.DL.value, ], + "x2InitialView": [Profile.DL.value, ], + "y1InitialView": [Profile.DL.value, ], + "y2InitialView": [Profile.DL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DL.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, DiagramElements = "list", DiagramStyle = None, orientation = None, x1InitialView = 0.0, x2InitialView = 0.0, y1InitialView = 0.0, y2InitialView = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DiagramElements = DiagramElements + self.DiagramStyle = DiagramStyle + self.orientation = orientation + self.x1InitialView = x1InitialView + self.x2InitialView = x2InitialView + self.y1InitialView = y1InitialView + self.y2InitialView = y2InitialView + + def __str__(self): + str = "class=Diagram\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DiagramLayoutVersion.py b/cimpy/cgmes_v2_4_15/DiagramLayoutVersion.py index dbe01d90..29449810 100644 --- a/cimpy/cgmes_v2_4_15/DiagramLayoutVersion.py +++ b/cimpy/cgmes_v2_4_15/DiagramLayoutVersion.py @@ -1,57 +1,58 @@ -from .Base import Base - - -class DiagramLayoutVersion(Base): - ''' - Version details. - - :baseUML: Base UML provided by CIM model manager. Default: '' - :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' - :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' - :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' - :entsoeUML: UML provided by ENTSO-E. Default: '' - :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/DiagramLayout/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' - :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' - :namespaceRDF: RDF namespace. Default: '' - :namespaceUML: CIM UML namespace. Default: '' - :shortName: The short name of the profile used in profile documentation. Default: '' - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, ], - 'baseUML': [cgmesProfile.DL.value, ], - 'baseURI': [cgmesProfile.DL.value, ], - 'date': [cgmesProfile.DL.value, ], - 'differenceModelURI': [cgmesProfile.DL.value, ], - 'entsoeUML': [cgmesProfile.DL.value, ], - 'entsoeURI': [cgmesProfile.DL.value, ], - 'modelDescriptionURI': [cgmesProfile.DL.value, ], - 'namespaceRDF': [cgmesProfile.DL.value, ], - 'namespaceUML': [cgmesProfile.DL.value, ], - 'shortName': [cgmesProfile.DL.value, ], - } - - serializationProfile = {} - - - - def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = '', ): - - self.baseUML = baseUML - self.baseURI = baseURI - self.date = date - self.differenceModelURI = differenceModelURI - self.entsoeUML = entsoeUML - self.entsoeURI = entsoeURI - self.modelDescriptionURI = modelDescriptionURI - self.namespaceRDF = namespaceRDF - self.namespaceUML = namespaceUML - self.shortName = shortName - - def __str__(self): - str = 'class=DiagramLayoutVersion\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class DiagramLayoutVersion(Base): + """ + Version details. + + :baseUML: Base UML provided by CIM model manager. Default: '' + :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' + :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' + :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' + :entsoeUML: UML provided by ENTSO-E. Default: '' + :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/DiagramLayout/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' + :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' + :namespaceRDF: RDF namespace. Default: '' + :namespaceUML: CIM UML namespace. Default: '' + :shortName: The short name of the profile used in profile documentation. Default: '' + """ + + possibleProfileList = { + "class": [Profile.DL.value, ], + "baseUML": [Profile.DL.value, ], + "baseURI": [Profile.DL.value, ], + "date": [Profile.DL.value, ], + "differenceModelURI": [Profile.DL.value, ], + "entsoeUML": [Profile.DL.value, ], + "entsoeURI": [Profile.DL.value, ], + "modelDescriptionURI": [Profile.DL.value, ], + "namespaceRDF": [Profile.DL.value, ], + "namespaceUML": [Profile.DL.value, ], + "shortName": [Profile.DL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DL.value + + + def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = ''): + + self.baseUML = baseUML + self.baseURI = baseURI + self.date = date + self.differenceModelURI = differenceModelURI + self.entsoeUML = entsoeUML + self.entsoeURI = entsoeURI + self.modelDescriptionURI = modelDescriptionURI + self.namespaceRDF = namespaceRDF + self.namespaceUML = namespaceUML + self.shortName = shortName + + def __str__(self): + str = "class=DiagramLayoutVersion\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DiagramObject.py b/cimpy/cgmes_v2_4_15/DiagramObject.py index ba34864b..8061c996 100644 --- a/cimpy/cgmes_v2_4_15/DiagramObject.py +++ b/cimpy/cgmes_v2_4_15/DiagramObject.py @@ -1,58 +1,60 @@ -from .IdentifiedObject import IdentifiedObject - - -class DiagramObject(IdentifiedObject): - ''' - An object that defines one or more points in a given space. This object can be associated with anything that specializes IdentifiedObject. For single line diagrams such objects typically include such items as analog values, breakers, disconnectors, power transformers, and transmission lines. - - :Diagram: A diagram object is part of a diagram. Default: None - :drawingOrder: The drawing order of this element. The higher the number, the later the element is drawn in sequence. This is used to ensure that elements that overlap are rendered in the correct order. Default: 0 - :isPolygon: Defines whether or not the diagram objects points define the boundaries of a polygon or the routing of a polyline. If this value is true then a receiving application should consider the first and last points to be connected. Default: False - :offsetX: The offset in the X direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon). The offset is in per-unit with 0 indicating there is no offset from the horizontal centre of the icon. -0.5 indicates it is offset by 50% to the left and 0.5 indicates an offset of 50% to the right. Default: 0.0 - :offsetY: The offset in the Y direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon). The offset is in per-unit with 0 indicating there is no offset from the vertical centre of the icon. The offset direction is dependent on the orientation of the diagram, with -0.5 and 0.5 indicating an offset of +/- 50% on the vertical axis. Default: 0.0 - :rotation: Sets the angle of rotation of the diagram object. Zero degrees is pointing to the top of the diagram. Rotation is clockwise. Default: 0.0 - :IdentifiedObject: The diagram objects that are associated with the domain object. Default: None - :DiagramObjectPoints: A diagram object can have 0 or more points to reflect its layout position, routing (for polylines) or boundary (for polygons). Default: "list" - :VisibilityLayers: A diagram object can be part of multiple visibility layers. Default: "list" - :DiagramObjectStyle: A diagram object has a style associated that provides a reference for the style used in the originating system. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, ], - 'Diagram': [cgmesProfile.DL.value, ], - 'drawingOrder': [cgmesProfile.DL.value, ], - 'isPolygon': [cgmesProfile.DL.value, ], - 'offsetX': [cgmesProfile.DL.value, ], - 'offsetY': [cgmesProfile.DL.value, ], - 'rotation': [cgmesProfile.DL.value, ], - 'IdentifiedObject': [cgmesProfile.DL.value, ], - 'DiagramObjectPoints': [cgmesProfile.DL.value, ], - 'VisibilityLayers': [cgmesProfile.DL.value, ], - 'DiagramObjectStyle': [cgmesProfile.DL.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, Diagram = None, drawingOrder = 0, isPolygon = False, offsetX = 0.0, offsetY = 0.0, rotation = 0.0, IdentifiedObject = None, DiagramObjectPoints = "list", VisibilityLayers = "list", DiagramObjectStyle = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Diagram = Diagram - self.drawingOrder = drawingOrder - self.isPolygon = isPolygon - self.offsetX = offsetX - self.offsetY = offsetY - self.rotation = rotation - self.IdentifiedObject = IdentifiedObject - self.DiagramObjectPoints = DiagramObjectPoints - self.VisibilityLayers = VisibilityLayers - self.DiagramObjectStyle = DiagramObjectStyle - - def __str__(self): - str = 'class=DiagramObject\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class DiagramObject(IdentifiedObject): + """ + An object that defines one or more points in a given space. This object can be associated with anything that specializes IdentifiedObject. For single line diagrams such objects typically include such items as analog values, breakers, disconnectors, power transformers, and transmission lines. + + :Diagram: A diagram object is part of a diagram. Default: None + :DiagramObjectPoints: A diagram object can have 0 or more points to reflect its layout position, routing (for polylines) or boundary (for polygons). Default: "list" + :DiagramObjectStyle: A diagram object has a style associated that provides a reference for the style used in the originating system. Default: None + :IdentifiedObject: The diagram objects that are associated with the domain object. Default: None + :VisibilityLayers: A diagram object can be part of multiple visibility layers. Default: "list" + :drawingOrder: The drawing order of this element. The higher the number, the later the element is drawn in sequence. This is used to ensure that elements that overlap are rendered in the correct order. Default: 0 + :isPolygon: Defines whether or not the diagram objects points define the boundaries of a polygon or the routing of a polyline. If this value is true then a receiving application should consider the first and last points to be connected. Default: False + :offsetX: The offset in the X direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon). The offset is in per-unit with 0 indicating there is no offset from the horizontal centre of the icon. -0.5 indicates it is offset by 50% to the left and 0.5 indicates an offset of 50% to the right. Default: 0.0 + :offsetY: The offset in the Y direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon). The offset is in per-unit with 0 indicating there is no offset from the vertical centre of the icon. The offset direction is dependent on the orientation of the diagram, with -0.5 and 0.5 indicating an offset of +/- 50% on the vertical axis. Default: 0.0 + :rotation: Sets the angle of rotation of the diagram object. Zero degrees is pointing to the top of the diagram. Rotation is clockwise. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DL.value, ], + "Diagram": [Profile.DL.value, ], + "DiagramObjectPoints": [Profile.DL.value, ], + "DiagramObjectStyle": [Profile.DL.value, ], + "IdentifiedObject": [Profile.DL.value, ], + "VisibilityLayers": [Profile.DL.value, ], + "drawingOrder": [Profile.DL.value, ], + "isPolygon": [Profile.DL.value, ], + "offsetX": [Profile.DL.value, ], + "offsetY": [Profile.DL.value, ], + "rotation": [Profile.DL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DL.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, Diagram = None, DiagramObjectPoints = "list", DiagramObjectStyle = None, IdentifiedObject = None, VisibilityLayers = "list", drawingOrder = 0, isPolygon = False, offsetX = 0.0, offsetY = 0.0, rotation = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Diagram = Diagram + self.DiagramObjectPoints = DiagramObjectPoints + self.DiagramObjectStyle = DiagramObjectStyle + self.IdentifiedObject = IdentifiedObject + self.VisibilityLayers = VisibilityLayers + self.drawingOrder = drawingOrder + self.isPolygon = isPolygon + self.offsetX = offsetX + self.offsetY = offsetY + self.rotation = rotation + + def __str__(self): + str = "class=DiagramObject\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DiagramObjectGluePoint.py b/cimpy/cgmes_v2_4_15/DiagramObjectGluePoint.py index deebf1c7..6dec154b 100644 --- a/cimpy/cgmes_v2_4_15/DiagramObjectGluePoint.py +++ b/cimpy/cgmes_v2_4_15/DiagramObjectGluePoint.py @@ -1,30 +1,31 @@ -from .Base import Base - - -class DiagramObjectGluePoint(Base): - ''' - This is used for grouping diagram object points from different diagram objects that are considered to be glued together in a diagram even if they are not at the exact same coordinates. - - :DiagramObjectPoints: The `glue` point to which this point is associated. Default: "list" - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, ], - 'DiagramObjectPoints': [cgmesProfile.DL.value, ], - } - - serializationProfile = {} - - - - def __init__(self, DiagramObjectPoints = "list", ): - - self.DiagramObjectPoints = DiagramObjectPoints - - def __str__(self): - str = 'class=DiagramObjectGluePoint\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class DiagramObjectGluePoint(Base): + """ + This is used for grouping diagram object points from different diagram objects that are considered to be glued together in a diagram even if they are not at the exact same coordinates. + + :DiagramObjectPoints: The `glue` point to which this point is associated. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.DL.value, ], + "DiagramObjectPoints": [Profile.DL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DL.value + + + def __init__(self, DiagramObjectPoints = "list"): + + self.DiagramObjectPoints = DiagramObjectPoints + + def __str__(self): + str = "class=DiagramObjectGluePoint\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DiagramObjectPoint.py b/cimpy/cgmes_v2_4_15/DiagramObjectPoint.py index eba28e40..7c876359 100644 --- a/cimpy/cgmes_v2_4_15/DiagramObjectPoint.py +++ b/cimpy/cgmes_v2_4_15/DiagramObjectPoint.py @@ -1,45 +1,46 @@ -from .Base import Base - - -class DiagramObjectPoint(Base): - ''' - A point in a given space defined by 3 coordinates and associated to a diagram object. The coordinates may be positive or negative as the origin does not have to be in the corner of a diagram. - - :DiagramObject: The diagram object with which the points are associated. Default: None - :DiagramObjectGluePoint: A diagram object glue point is associated with 2 or more object points that are considered to be `glued` together. Default: None - :sequenceNumber: The sequence position of the point, used for defining the order of points for diagram objects acting as a polyline or polygon with more than one point. Default: 0 - :xPosition: The X coordinate of this point. Default: 0.0 - :yPosition: The Y coordinate of this point. Default: 0.0 - :zPosition: The Z coordinate of this point. Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, ], - 'DiagramObject': [cgmesProfile.DL.value, ], - 'DiagramObjectGluePoint': [cgmesProfile.DL.value, ], - 'sequenceNumber': [cgmesProfile.DL.value, ], - 'xPosition': [cgmesProfile.DL.value, ], - 'yPosition': [cgmesProfile.DL.value, ], - 'zPosition': [cgmesProfile.DL.value, ], - } - - serializationProfile = {} - - - - def __init__(self, DiagramObject = None, DiagramObjectGluePoint = None, sequenceNumber = 0, xPosition = 0.0, yPosition = 0.0, zPosition = 0.0, ): - - self.DiagramObject = DiagramObject - self.DiagramObjectGluePoint = DiagramObjectGluePoint - self.sequenceNumber = sequenceNumber - self.xPosition = xPosition - self.yPosition = yPosition - self.zPosition = zPosition - - def __str__(self): - str = 'class=DiagramObjectPoint\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class DiagramObjectPoint(Base): + """ + A point in a given space defined by 3 coordinates and associated to a diagram object. The coordinates may be positive or negative as the origin does not have to be in the corner of a diagram. + + :DiagramObject: The diagram object with which the points are associated. Default: None + :DiagramObjectGluePoint: A diagram object glue point is associated with 2 or more object points that are considered to be `glued` together. Default: None + :sequenceNumber: The sequence position of the point, used for defining the order of points for diagram objects acting as a polyline or polygon with more than one point. Default: 0 + :xPosition: The X coordinate of this point. Default: 0.0 + :yPosition: The Y coordinate of this point. Default: 0.0 + :zPosition: The Z coordinate of this point. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DL.value, ], + "DiagramObject": [Profile.DL.value, ], + "DiagramObjectGluePoint": [Profile.DL.value, ], + "sequenceNumber": [Profile.DL.value, ], + "xPosition": [Profile.DL.value, ], + "yPosition": [Profile.DL.value, ], + "zPosition": [Profile.DL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DL.value + + + def __init__(self, DiagramObject = None, DiagramObjectGluePoint = None, sequenceNumber = 0, xPosition = 0.0, yPosition = 0.0, zPosition = 0.0): + + self.DiagramObject = DiagramObject + self.DiagramObjectGluePoint = DiagramObjectGluePoint + self.sequenceNumber = sequenceNumber + self.xPosition = xPosition + self.yPosition = yPosition + self.zPosition = zPosition + + def __str__(self): + str = "class=DiagramObjectPoint\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DiagramObjectStyle.py b/cimpy/cgmes_v2_4_15/DiagramObjectStyle.py index 4c98c962..43783ec9 100644 --- a/cimpy/cgmes_v2_4_15/DiagramObjectStyle.py +++ b/cimpy/cgmes_v2_4_15/DiagramObjectStyle.py @@ -1,31 +1,33 @@ -from .IdentifiedObject import IdentifiedObject - - -class DiagramObjectStyle(IdentifiedObject): - ''' - A reference to a style used by the originating system for a diagram object. A diagram object style describes information such as line thickness, shape such as circle or rectangle etc, and color. - - :StyledObjects: A style can be assigned to multiple diagram objects. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, ], - 'StyledObjects': [cgmesProfile.DL.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, StyledObjects = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.StyledObjects = StyledObjects - - def __str__(self): - str = 'class=DiagramObjectStyle\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class DiagramObjectStyle(IdentifiedObject): + """ + A reference to a style used by the originating system for a diagram object. A diagram object style describes information such as line thickness, shape such as circle or rectangle etc, and color. + + :StyledObjects: A style can be assigned to multiple diagram objects. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.DL.value, ], + "StyledObjects": [Profile.DL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DL.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, StyledObjects = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.StyledObjects = StyledObjects + + def __str__(self): + str = "class=DiagramObjectStyle\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DiagramStyle.py b/cimpy/cgmes_v2_4_15/DiagramStyle.py index 347a269c..a8114014 100644 --- a/cimpy/cgmes_v2_4_15/DiagramStyle.py +++ b/cimpy/cgmes_v2_4_15/DiagramStyle.py @@ -1,31 +1,33 @@ -from .IdentifiedObject import IdentifiedObject - - -class DiagramStyle(IdentifiedObject): - ''' - The diagram style refer to a style used by the originating system for a diagram. A diagram style describes information such as schematic, geographic, bus-branch etc. - - :Diagram: A DiagramStyle can be used by many Diagrams. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, ], - 'Diagram': [cgmesProfile.DL.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, Diagram = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Diagram = Diagram - - def __str__(self): - str = 'class=DiagramStyle\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class DiagramStyle(IdentifiedObject): + """ + The diagram style refer to a style used by the originating system for a diagram. A diagram style describes information such as schematic, geographic, bus-branch etc. + + :Diagram: A DiagramStyle can be used by many Diagrams. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.DL.value, ], + "Diagram": [Profile.DL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DL.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, Diagram = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Diagram = Diagram + + def __str__(self): + str = "class=DiagramStyle\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DiscExcContIEEEDEC1A.py b/cimpy/cgmes_v2_4_15/DiscExcContIEEEDEC1A.py index ef57c519..d2c355da 100644 --- a/cimpy/cgmes_v2_4_15/DiscExcContIEEEDEC1A.py +++ b/cimpy/cgmes_v2_4_15/DiscExcContIEEEDEC1A.py @@ -1,82 +1,84 @@ -from .DiscontinuousExcitationControlDynamics import DiscontinuousExcitationControlDynamics - - -class DiscExcContIEEEDEC1A(DiscontinuousExcitationControlDynamics): - ''' - The class represents IEEE Type DEC1A discontinuous excitation control model that boosts generator excitation to a level higher than that demanded by the voltage regulator and stabilizer immediately following a system fault. Reference: IEEE Standard 421.5-2005 Section 12.2. - - :vtlmt: Voltage reference (). Typical Value = 1.1. Default: 0.0 - :vomax: Limiter (). Typical Value = 0.3. Default: 0.0 - :vomin: Limiter (). Typical Value = 0.1. Default: 0.0 - :ketl: Terminal voltage limiter gain (). Typical Value = 47. Default: 0.0 - :vtc: Terminal voltage level reference (). Typical Value = 0.95. Default: 0.0 - :val: Regulator voltage reference (). Typical Value = 5.5. Default: 0.0 - :esc: Speed change reference (). Typical Value = 0.0015. Default: 0.0 - :kan: Discontinuous controller gain (). Typical Value = 400. Default: 0.0 - :tan: Discontinuous controller time constant (). Typical Value = 0.08. Default: 0 - :tw5: DEC washout time constant (). Typical Value = 5. Default: 0 - :vsmax: Limiter (). Typical Value = 0.2. Default: 0.0 - :vsmin: Limiter (). Typical Value = -0.066. Default: 0.0 - :td: Time constant (). Typical Value = 0.03. Default: 0 - :tl1: Time constant (). Typical Value = 0.025. Default: 0 - :tl2: Time constant (). Typical Value = 1.25. Default: 0 - :vtm: Voltage limits (). Typical Value = 1.13. Default: 0.0 - :vtn: Voltage limits (). Typical Value = 1.12. Default: 0.0 - :vanmax: Limiter for Van (). Default: 0.0 - ''' - - cgmesProfile = DiscontinuousExcitationControlDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'vtlmt': [cgmesProfile.DY.value, ], - 'vomax': [cgmesProfile.DY.value, ], - 'vomin': [cgmesProfile.DY.value, ], - 'ketl': [cgmesProfile.DY.value, ], - 'vtc': [cgmesProfile.DY.value, ], - 'val': [cgmesProfile.DY.value, ], - 'esc': [cgmesProfile.DY.value, ], - 'kan': [cgmesProfile.DY.value, ], - 'tan': [cgmesProfile.DY.value, ], - 'tw5': [cgmesProfile.DY.value, ], - 'vsmax': [cgmesProfile.DY.value, ], - 'vsmin': [cgmesProfile.DY.value, ], - 'td': [cgmesProfile.DY.value, ], - 'tl1': [cgmesProfile.DY.value, ], - 'tl2': [cgmesProfile.DY.value, ], - 'vtm': [cgmesProfile.DY.value, ], - 'vtn': [cgmesProfile.DY.value, ], - 'vanmax': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DiscontinuousExcitationControlDynamics: \n' + DiscontinuousExcitationControlDynamics.__doc__ - - def __init__(self, vtlmt = 0.0, vomax = 0.0, vomin = 0.0, ketl = 0.0, vtc = 0.0, val = 0.0, esc = 0.0, kan = 0.0, tan = 0, tw5 = 0, vsmax = 0.0, vsmin = 0.0, td = 0, tl1 = 0, tl2 = 0, vtm = 0.0, vtn = 0.0, vanmax = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.vtlmt = vtlmt - self.vomax = vomax - self.vomin = vomin - self.ketl = ketl - self.vtc = vtc - self.val = val - self.esc = esc - self.kan = kan - self.tan = tan - self.tw5 = tw5 - self.vsmax = vsmax - self.vsmin = vsmin - self.td = td - self.tl1 = tl1 - self.tl2 = tl2 - self.vtm = vtm - self.vtn = vtn - self.vanmax = vanmax - - def __str__(self): - str = 'class=DiscExcContIEEEDEC1A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DiscontinuousExcitationControlDynamics import DiscontinuousExcitationControlDynamics +from .CGMESProfile import Profile + + +class DiscExcContIEEEDEC1A(DiscontinuousExcitationControlDynamics): + """ + The class represents IEEE Type DEC1A discontinuous excitation control model that boosts generator excitation to a level higher than that demanded by the voltage regulator and stabilizer immediately following a system fault. Reference: IEEE Standard 421.5-2005 Section 12.2. + + :esc: Speed change reference (). Typical Value = 0.0015. Default: 0.0 + :kan: Discontinuous controller gain (). Typical Value = 400. Default: 0.0 + :ketl: Terminal voltage limiter gain (). Typical Value = 47. Default: 0.0 + :tan: Discontinuous controller time constant (). Typical Value = 0.08. Default: 0.0 + :td: Time constant (). Typical Value = 0.03. Default: 0.0 + :tl1: Time constant (). Typical Value = 0.025. Default: 0.0 + :tl2: Time constant (). Typical Value = 1.25. Default: 0.0 + :tw5: DEC washout time constant (). Typical Value = 5. Default: 0.0 + :val: Regulator voltage reference (). Typical Value = 5.5. Default: 0.0 + :vanmax: Limiter for Van (). Default: 0.0 + :vomax: Limiter (). Typical Value = 0.3. Default: 0.0 + :vomin: Limiter (). Typical Value = 0.1. Default: 0.0 + :vsmax: Limiter (). Typical Value = 0.2. Default: 0.0 + :vsmin: Limiter (). Typical Value = -0.066. Default: 0.0 + :vtc: Terminal voltage level reference (). Typical Value = 0.95. Default: 0.0 + :vtlmt: Voltage reference (). Typical Value = 1.1. Default: 0.0 + :vtm: Voltage limits (). Typical Value = 1.13. Default: 0.0 + :vtn: Voltage limits (). Typical Value = 1.12. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "esc": [Profile.DY.value, ], + "kan": [Profile.DY.value, ], + "ketl": [Profile.DY.value, ], + "tan": [Profile.DY.value, ], + "td": [Profile.DY.value, ], + "tl1": [Profile.DY.value, ], + "tl2": [Profile.DY.value, ], + "tw5": [Profile.DY.value, ], + "val": [Profile.DY.value, ], + "vanmax": [Profile.DY.value, ], + "vomax": [Profile.DY.value, ], + "vomin": [Profile.DY.value, ], + "vsmax": [Profile.DY.value, ], + "vsmin": [Profile.DY.value, ], + "vtc": [Profile.DY.value, ], + "vtlmt": [Profile.DY.value, ], + "vtm": [Profile.DY.value, ], + "vtn": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DiscontinuousExcitationControlDynamics:\n" + DiscontinuousExcitationControlDynamics.__doc__ + + def __init__(self, esc = 0.0, kan = 0.0, ketl = 0.0, tan = 0.0, td = 0.0, tl1 = 0.0, tl2 = 0.0, tw5 = 0.0, val = 0.0, vanmax = 0.0, vomax = 0.0, vomin = 0.0, vsmax = 0.0, vsmin = 0.0, vtc = 0.0, vtlmt = 0.0, vtm = 0.0, vtn = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.esc = esc + self.kan = kan + self.ketl = ketl + self.tan = tan + self.td = td + self.tl1 = tl1 + self.tl2 = tl2 + self.tw5 = tw5 + self.val = val + self.vanmax = vanmax + self.vomax = vomax + self.vomin = vomin + self.vsmax = vsmax + self.vsmin = vsmin + self.vtc = vtc + self.vtlmt = vtlmt + self.vtm = vtm + self.vtn = vtn + + def __str__(self): + str = "class=DiscExcContIEEEDEC1A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DiscExcContIEEEDEC2A.py b/cimpy/cgmes_v2_4_15/DiscExcContIEEEDEC2A.py index c036f9a4..655eb645 100644 --- a/cimpy/cgmes_v2_4_15/DiscExcContIEEEDEC2A.py +++ b/cimpy/cgmes_v2_4_15/DiscExcContIEEEDEC2A.py @@ -1,43 +1,45 @@ -from .DiscontinuousExcitationControlDynamics import DiscontinuousExcitationControlDynamics - - -class DiscExcContIEEEDEC2A(DiscontinuousExcitationControlDynamics): - ''' - The class represents IEEE Type DEC2A model for the discontinuous excitation control. This system provides transient excitation boosting via an open-loop control as initiated by a trigger signal generated remotely. Reference: IEEE Standard 421.5-2005 Section 12.3. - - :vk: Discontinuous controller input reference (). Default: 0.0 - :td1: Discontinuous controller time constant (). Default: 0 - :td2: Discontinuous controller washout time constant (). Default: 0 - :vdmin: Limiter (). Default: 0.0 - :vdmax: Limiter (). Default: 0.0 - ''' - - cgmesProfile = DiscontinuousExcitationControlDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'vk': [cgmesProfile.DY.value, ], - 'td1': [cgmesProfile.DY.value, ], - 'td2': [cgmesProfile.DY.value, ], - 'vdmin': [cgmesProfile.DY.value, ], - 'vdmax': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DiscontinuousExcitationControlDynamics: \n' + DiscontinuousExcitationControlDynamics.__doc__ - - def __init__(self, vk = 0.0, td1 = 0, td2 = 0, vdmin = 0.0, vdmax = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.vk = vk - self.td1 = td1 - self.td2 = td2 - self.vdmin = vdmin - self.vdmax = vdmax - - def __str__(self): - str = 'class=DiscExcContIEEEDEC2A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DiscontinuousExcitationControlDynamics import DiscontinuousExcitationControlDynamics +from .CGMESProfile import Profile + + +class DiscExcContIEEEDEC2A(DiscontinuousExcitationControlDynamics): + """ + The class represents IEEE Type DEC2A model for the discontinuous excitation control. This system provides transient excitation boosting via an open-loop control as initiated by a trigger signal generated remotely. Reference: IEEE Standard 421.5-2005 Section 12.3. + + :td1: Discontinuous controller time constant (). Default: 0.0 + :td2: Discontinuous controller washout time constant (). Default: 0.0 + :vdmax: Limiter (). Default: 0.0 + :vdmin: Limiter (). Default: 0.0 + :vk: Discontinuous controller input reference (). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "td1": [Profile.DY.value, ], + "td2": [Profile.DY.value, ], + "vdmax": [Profile.DY.value, ], + "vdmin": [Profile.DY.value, ], + "vk": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DiscontinuousExcitationControlDynamics:\n" + DiscontinuousExcitationControlDynamics.__doc__ + + def __init__(self, td1 = 0.0, td2 = 0.0, vdmax = 0.0, vdmin = 0.0, vk = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.td1 = td1 + self.td2 = td2 + self.vdmax = vdmax + self.vdmin = vdmin + self.vk = vk + + def __str__(self): + str = "class=DiscExcContIEEEDEC2A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DiscExcContIEEEDEC3A.py b/cimpy/cgmes_v2_4_15/DiscExcContIEEEDEC3A.py index 88bbd7e3..61473f99 100644 --- a/cimpy/cgmes_v2_4_15/DiscExcContIEEEDEC3A.py +++ b/cimpy/cgmes_v2_4_15/DiscExcContIEEEDEC3A.py @@ -1,34 +1,36 @@ -from .DiscontinuousExcitationControlDynamics import DiscontinuousExcitationControlDynamics - - -class DiscExcContIEEEDEC3A(DiscontinuousExcitationControlDynamics): - ''' - The class represents IEEE Type DEC3A model. In some systems, the stabilizer output is disconnected from the regulator immediately following a severe fault to prevent the stabilizer from competing with action of voltage regulator during the first swing. Reference: IEEE Standard 421.5-2005 Section 12.4. - - :vtmin: Terminal undervoltage comparison level (). Default: 0.0 - :tdr: Reset time delay (). Default: 0 - ''' - - cgmesProfile = DiscontinuousExcitationControlDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'vtmin': [cgmesProfile.DY.value, ], - 'tdr': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DiscontinuousExcitationControlDynamics: \n' + DiscontinuousExcitationControlDynamics.__doc__ - - def __init__(self, vtmin = 0.0, tdr = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.vtmin = vtmin - self.tdr = tdr - - def __str__(self): - str = 'class=DiscExcContIEEEDEC3A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DiscontinuousExcitationControlDynamics import DiscontinuousExcitationControlDynamics +from .CGMESProfile import Profile + + +class DiscExcContIEEEDEC3A(DiscontinuousExcitationControlDynamics): + """ + The class represents IEEE Type DEC3A model. In some systems, the stabilizer output is disconnected from the regulator immediately following a severe fault to prevent the stabilizer from competing with action of voltage regulator during the first swing. Reference: IEEE Standard 421.5-2005 Section 12.4. + + :tdr: Reset time delay (). Default: 0.0 + :vtmin: Terminal undervoltage comparison level (). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "tdr": [Profile.DY.value, ], + "vtmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DiscontinuousExcitationControlDynamics:\n" + DiscontinuousExcitationControlDynamics.__doc__ + + def __init__(self, tdr = 0.0, vtmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.tdr = tdr + self.vtmin = vtmin + + def __str__(self): + str = "class=DiscExcContIEEEDEC3A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Disconnector.py b/cimpy/cgmes_v2_4_15/Disconnector.py index 4b83c741..72d456c8 100644 --- a/cimpy/cgmes_v2_4_15/Disconnector.py +++ b/cimpy/cgmes_v2_4_15/Disconnector.py @@ -1,29 +1,31 @@ -from .Switch import Switch - - -class Disconnector(Switch): - ''' - A manually operated or motor operated mechanical switching device used for changing the connections in a circuit, or for isolating a circuit or equipment from a source of power. It is required to open or close circuits when negligible current is broken or made. - - ''' - - cgmesProfile = Switch.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Switch: \n' + Switch.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=Disconnector\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Switch import Switch +from .CGMESProfile import Profile + + +class Disconnector(Switch): + """ + A manually operated or motor operated mechanical switching device used for changing the connections in a circuit, or for isolating a circuit or equipment from a source of power. It is required to open or close circuits when negligible current is broken or made. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Switch:\n" + Switch.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=Disconnector\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DiscontinuousExcitationControlDynamics.py b/cimpy/cgmes_v2_4_15/DiscontinuousExcitationControlDynamics.py index 0183db20..6b33022e 100644 --- a/cimpy/cgmes_v2_4_15/DiscontinuousExcitationControlDynamics.py +++ b/cimpy/cgmes_v2_4_15/DiscontinuousExcitationControlDynamics.py @@ -1,34 +1,36 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class DiscontinuousExcitationControlDynamics(DynamicsFunctionBlock): - ''' - Discontinuous excitation control function block whose behaviour is described by reference to a standard model . - - :RemoteInputSignal: Remote input signal used by this discontinuous excitation control system model. Default: None - :ExcitationSystemDynamics: Excitation system model with which this discontinuous excitation control model is associated. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'RemoteInputSignal': [cgmesProfile.DY.value, ], - 'ExcitationSystemDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, RemoteInputSignal = None, ExcitationSystemDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.RemoteInputSignal = RemoteInputSignal - self.ExcitationSystemDynamics = ExcitationSystemDynamics - - def __str__(self): - str = 'class=DiscontinuousExcitationControlDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class DiscontinuousExcitationControlDynamics(DynamicsFunctionBlock): + """ + Discontinuous excitation control function block whose behaviour is described by reference to a standard model . + + :ExcitationSystemDynamics: Excitation system model with which this discontinuous excitation control model is associated. Default: None + :RemoteInputSignal: Remote input signal used by this discontinuous excitation control system model. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ExcitationSystemDynamics": [Profile.DY.value, ], + "RemoteInputSignal": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, ExcitationSystemDynamics = None, RemoteInputSignal = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ExcitationSystemDynamics = ExcitationSystemDynamics + self.RemoteInputSignal = RemoteInputSignal + + def __str__(self): + str = "class=DiscontinuousExcitationControlDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DiscontinuousExcitationControlUserDefined.py b/cimpy/cgmes_v2_4_15/DiscontinuousExcitationControlUserDefined.py index c4f8c72f..882d5c5e 100644 --- a/cimpy/cgmes_v2_4_15/DiscontinuousExcitationControlUserDefined.py +++ b/cimpy/cgmes_v2_4_15/DiscontinuousExcitationControlUserDefined.py @@ -1,34 +1,36 @@ -from .DiscontinuousExcitationControlDynamics import DiscontinuousExcitationControlDynamics - - -class DiscontinuousExcitationControlUserDefined(DiscontinuousExcitationControlDynamics): - ''' - Discontinuous excitation control function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = DiscontinuousExcitationControlDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DiscontinuousExcitationControlDynamics: \n' + DiscontinuousExcitationControlDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=DiscontinuousExcitationControlUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DiscontinuousExcitationControlDynamics import DiscontinuousExcitationControlDynamics +from .CGMESProfile import Profile + + +class DiscontinuousExcitationControlUserDefined(DiscontinuousExcitationControlDynamics): + """ + Discontinuous excitation control function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DiscontinuousExcitationControlDynamics:\n" + DiscontinuousExcitationControlDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=DiscontinuousExcitationControlUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Discrete.py b/cimpy/cgmes_v2_4_15/Discrete.py index 68a6a202..27ce9dbd 100644 --- a/cimpy/cgmes_v2_4_15/Discrete.py +++ b/cimpy/cgmes_v2_4_15/Discrete.py @@ -1,34 +1,36 @@ -from .Measurement import Measurement - - -class Discrete(Measurement): - ''' - Discrete represents a discrete Measurement, i.e. a Measurement representing discrete values, e.g. a Breaker position. - - :DiscreteValues: Measurement to which this value is connected. Default: "list" - :ValueAliasSet: The ValueAliasSet used for translation of a MeasurementValue.value to a name. Default: None - ''' - - cgmesProfile = Measurement.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'DiscreteValues': [cgmesProfile.EQ.value, ], - 'ValueAliasSet': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Measurement: \n' + Measurement.__doc__ - - def __init__(self, DiscreteValues = "list", ValueAliasSet = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.DiscreteValues = DiscreteValues - self.ValueAliasSet = ValueAliasSet - - def __str__(self): - str = 'class=Discrete\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Measurement import Measurement +from .CGMESProfile import Profile + + +class Discrete(Measurement): + """ + Discrete represents a discrete Measurement, i.e. a Measurement representing discrete values, e.g. a Breaker position. + + :DiscreteValues: Measurement to which this value is connected. Default: "list" + :ValueAliasSet: The ValueAliasSet used for translation of a MeasurementValue.value to a name. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "DiscreteValues": [Profile.EQ.value, ], + "ValueAliasSet": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Measurement:\n" + Measurement.__doc__ + + def __init__(self, DiscreteValues = "list", ValueAliasSet = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DiscreteValues = DiscreteValues + self.ValueAliasSet = ValueAliasSet + + def __str__(self): + str = "class=Discrete\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DiscreteValue.py b/cimpy/cgmes_v2_4_15/DiscreteValue.py index caba0eaf..7c853c70 100644 --- a/cimpy/cgmes_v2_4_15/DiscreteValue.py +++ b/cimpy/cgmes_v2_4_15/DiscreteValue.py @@ -1,37 +1,39 @@ -from .MeasurementValue import MeasurementValue - - -class DiscreteValue(MeasurementValue): - ''' - DiscreteValue represents a discrete MeasurementValue. - - :Command: The MeasurementValue that is controlled. Default: None - :Discrete: The values connected to this measurement. Default: None - :value: The value to supervise. Default: 0 - ''' - - cgmesProfile = MeasurementValue.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'Command': [cgmesProfile.EQ.value, ], - 'Discrete': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class MeasurementValue: \n' + MeasurementValue.__doc__ - - def __init__(self, Command = None, Discrete = None, value = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Command = Command - self.Discrete = Discrete - self.value = value - - def __str__(self): - str = 'class=DiscreteValue\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .MeasurementValue import MeasurementValue +from .CGMESProfile import Profile + + +class DiscreteValue(MeasurementValue): + """ + DiscreteValue represents a discrete MeasurementValue. + + :Command: The MeasurementValue that is controlled. Default: None + :Discrete: The values connected to this measurement. Default: None + :value: The value to supervise. Default: 0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "Command": [Profile.EQ.value, ], + "Discrete": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class MeasurementValue:\n" + MeasurementValue.__doc__ + + def __init__(self, Command = None, Discrete = None, value = 0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Command = Command + self.Discrete = Discrete + self.value = value + + def __str__(self): + str = "class=DiscreteValue\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DroopSignalFeedbackKind.py b/cimpy/cgmes_v2_4_15/DroopSignalFeedbackKind.py index 9dc1e882..5ea23ad6 100644 --- a/cimpy/cgmes_v2_4_15/DroopSignalFeedbackKind.py +++ b/cimpy/cgmes_v2_4_15/DroopSignalFeedbackKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class DroopSignalFeedbackKind(Base): - ''' - Governor droop signal feedback source. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=DroopSignalFeedbackKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class DroopSignalFeedbackKind(Base): + """ + Governor droop signal feedback source. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=DroopSignalFeedbackKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DynamicsFunctionBlock.py b/cimpy/cgmes_v2_4_15/DynamicsFunctionBlock.py index d9585391..07aaed83 100644 --- a/cimpy/cgmes_v2_4_15/DynamicsFunctionBlock.py +++ b/cimpy/cgmes_v2_4_15/DynamicsFunctionBlock.py @@ -1,31 +1,33 @@ -from .IdentifiedObject import IdentifiedObject - - -class DynamicsFunctionBlock(IdentifiedObject): - ''' - Abstract parent class for all Dynamics function blocks. - - :enabled: Function block used indicator. true = use of function block is enabled false = use of function block is disabled. Default: False - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'enabled': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, enabled = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.enabled = enabled - - def __str__(self): - str = 'class=DynamicsFunctionBlock\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class DynamicsFunctionBlock(IdentifiedObject): + """ + Abstract parent class for all Dynamics function blocks. + + :enabled: Function block used indicator. true = use of function block is enabled false = use of function block is disabled. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "enabled": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, enabled = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.enabled = enabled + + def __str__(self): + str = "class=DynamicsFunctionBlock\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/DynamicsVersion.py b/cimpy/cgmes_v2_4_15/DynamicsVersion.py index 73a6bec2..befca8b4 100644 --- a/cimpy/cgmes_v2_4_15/DynamicsVersion.py +++ b/cimpy/cgmes_v2_4_15/DynamicsVersion.py @@ -1,57 +1,58 @@ -from .Base import Base - - -class DynamicsVersion(Base): - ''' - Version details. - - :baseUML: Base UML provided by CIM model manager. Default: '' - :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' - :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' - :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' - :entsoeUML: UML provided by ENTSO-E. Default: '' - :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/Dynamics/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' - :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' - :namespaceRDF: RDF namespace. Default: '' - :namespaceUML: CIM UML namespace. Default: '' - :shortName: The short name of the profile used in profile documentation. Default: '' - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'baseUML': [cgmesProfile.DY.value, ], - 'baseURI': [cgmesProfile.DY.value, ], - 'date': [cgmesProfile.DY.value, ], - 'differenceModelURI': [cgmesProfile.DY.value, ], - 'entsoeUML': [cgmesProfile.DY.value, ], - 'entsoeURI': [cgmesProfile.DY.value, ], - 'modelDescriptionURI': [cgmesProfile.DY.value, ], - 'namespaceRDF': [cgmesProfile.DY.value, ], - 'namespaceUML': [cgmesProfile.DY.value, ], - 'shortName': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = '', ): - - self.baseUML = baseUML - self.baseURI = baseURI - self.date = date - self.differenceModelURI = differenceModelURI - self.entsoeUML = entsoeUML - self.entsoeURI = entsoeURI - self.modelDescriptionURI = modelDescriptionURI - self.namespaceRDF = namespaceRDF - self.namespaceUML = namespaceUML - self.shortName = shortName - - def __str__(self): - str = 'class=DynamicsVersion\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class DynamicsVersion(Base): + """ + Version details. + + :baseUML: Base UML provided by CIM model manager. Default: '' + :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' + :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' + :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' + :entsoeUML: UML provided by ENTSO-E. Default: '' + :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/Dynamics/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' + :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' + :namespaceRDF: RDF namespace. Default: '' + :namespaceUML: CIM UML namespace. Default: '' + :shortName: The short name of the profile used in profile documentation. Default: '' + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "baseUML": [Profile.DY.value, ], + "baseURI": [Profile.DY.value, ], + "date": [Profile.DY.value, ], + "differenceModelURI": [Profile.DY.value, ], + "entsoeUML": [Profile.DY.value, ], + "entsoeURI": [Profile.DY.value, ], + "modelDescriptionURI": [Profile.DY.value, ], + "namespaceRDF": [Profile.DY.value, ], + "namespaceUML": [Profile.DY.value, ], + "shortName": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = ''): + + self.baseUML = baseUML + self.baseURI = baseURI + self.date = date + self.differenceModelURI = differenceModelURI + self.entsoeUML = entsoeUML + self.entsoeURI = entsoeURI + self.modelDescriptionURI = modelDescriptionURI + self.namespaceRDF = namespaceRDF + self.namespaceUML = namespaceUML + self.shortName = shortName + + def __str__(self): + str = "class=DynamicsVersion\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/EarthFaultCompensator.py b/cimpy/cgmes_v2_4_15/EarthFaultCompensator.py index 524dca78..ac687305 100644 --- a/cimpy/cgmes_v2_4_15/EarthFaultCompensator.py +++ b/cimpy/cgmes_v2_4_15/EarthFaultCompensator.py @@ -1,31 +1,33 @@ -from .ConductingEquipment import ConductingEquipment - - -class EarthFaultCompensator(ConductingEquipment): - ''' - A conducting equipment used to represent a connection to ground which is typically used to compensate earth faults.. An earth fault compensator device modeled with a single terminal implies a second terminal solidly connected to ground. If two terminals are modeled, the ground is not assumed and normal connection rules apply. - - :r: Nominal resistance of device. Default: 0.0 - ''' - - cgmesProfile = ConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'r': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConductingEquipment: \n' + ConductingEquipment.__doc__ - - def __init__(self, r = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.r = r - - def __str__(self): - str = 'class=EarthFaultCompensator\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConductingEquipment import ConductingEquipment +from .CGMESProfile import Profile + + +class EarthFaultCompensator(ConductingEquipment): + """ + A conducting equipment used to represent a connection to ground which is typically used to compensate earth faults.. An earth fault compensator device modeled with a single terminal implies a second terminal solidly connected to ground. If two terminals are modeled, the ground is not assumed and normal connection rules apply. + + :r: Nominal resistance of device. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "r": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConductingEquipment:\n" + ConductingEquipment.__doc__ + + def __init__(self, r = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.r = r + + def __str__(self): + str = "class=EarthFaultCompensator\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/EnergyArea.py b/cimpy/cgmes_v2_4_15/EnergyArea.py index 18d2c74d..9e2a0154 100644 --- a/cimpy/cgmes_v2_4_15/EnergyArea.py +++ b/cimpy/cgmes_v2_4_15/EnergyArea.py @@ -1,31 +1,33 @@ -from .IdentifiedObject import IdentifiedObject - - -class EnergyArea(IdentifiedObject): - ''' - Describes an area having energy production or consumption. Specializations are intended to support the load allocation function as typically required in energy management systems or planning studies to allocate hypothesized load levels to individual load points for power flow analysis. Often the energy area can be linked to both measured and forecast load levels. - - :ControlArea: The control area specification that is used for the load forecast. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'ControlArea': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, ControlArea = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ControlArea = ControlArea - - def __str__(self): - str = 'class=EnergyArea\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class EnergyArea(IdentifiedObject): + """ + Describes an area having energy production or consumption. Specializations are intended to support the load allocation function as typically required in energy management systems or planning studies to allocate hypothesized load levels to individual load points for power flow analysis. Often the energy area can be linked to both measured and forecast load levels. + + :ControlArea: The control area specification that is used for the load forecast. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "ControlArea": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, ControlArea = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ControlArea = ControlArea + + def __str__(self): + str = "class=EnergyArea\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/EnergyConsumer.py b/cimpy/cgmes_v2_4_15/EnergyConsumer.py index f168f4f3..22b29569 100644 --- a/cimpy/cgmes_v2_4_15/EnergyConsumer.py +++ b/cimpy/cgmes_v2_4_15/EnergyConsumer.py @@ -1,52 +1,54 @@ -from .ConductingEquipment import ConductingEquipment - - -class EnergyConsumer(ConductingEquipment): - ''' - Generic user of energy - a point of consumption on the power system model. - - :LoadResponse: The load response characteristic of this load. If missing, this load is assumed to be constant power. Default: None - :pfixed: Active power of the load that is a fixed quantity. Load sign convention is used, i.e. positive sign means flow out from a node. Default: 0.0 - :pfixedPct: Fixed active power as per cent of load group fixed active power. Load sign convention is used, i.e. positive sign means flow out from a node. Default: 0.0 - :qfixed: Reactive power of the load that is a fixed quantity. Load sign convention is used, i.e. positive sign means flow out from a node. Default: 0.0 - :qfixedPct: Fixed reactive power as per cent of load group fixed reactive power. Load sign convention is used, i.e. positive sign means flow out from a node. Default: 0.0 - :p: Active power of the load. Load sign convention is used, i.e. positive sign means flow out from a node. For voltage dependent loads the value is at rated voltage. Starting value for a steady state solution. Default: 0.0 - :q: Reactive power of the load. Load sign convention is used, i.e. positive sign means flow out from a node. For voltage dependent loads the value is at rated voltage. Starting value for a steady state solution. Default: 0.0 - :LoadDynamics: Load dynamics model used to describe dynamic behavior of this energy consumer. Default: None - ''' - - cgmesProfile = ConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.DY.value, ], - 'LoadResponse': [cgmesProfile.EQ.value, ], - 'pfixed': [cgmesProfile.EQ.value, ], - 'pfixedPct': [cgmesProfile.EQ.value, ], - 'qfixed': [cgmesProfile.EQ.value, ], - 'qfixedPct': [cgmesProfile.EQ.value, ], - 'p': [cgmesProfile.SSH.value, ], - 'q': [cgmesProfile.SSH.value, ], - 'LoadDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConductingEquipment: \n' + ConductingEquipment.__doc__ - - def __init__(self, LoadResponse = None, pfixed = 0.0, pfixedPct = 0.0, qfixed = 0.0, qfixedPct = 0.0, p = 0.0, q = 0.0, LoadDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.LoadResponse = LoadResponse - self.pfixed = pfixed - self.pfixedPct = pfixedPct - self.qfixed = qfixed - self.qfixedPct = qfixedPct - self.p = p - self.q = q - self.LoadDynamics = LoadDynamics - - def __str__(self): - str = 'class=EnergyConsumer\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConductingEquipment import ConductingEquipment +from .CGMESProfile import Profile + + +class EnergyConsumer(ConductingEquipment): + """ + Generic user of energy - a point of consumption on the power system model. + + :LoadDynamics: Load dynamics model used to describe dynamic behavior of this energy consumer. Default: None + :LoadResponse: The load response characteristic of this load. If missing, this load is assumed to be constant power. Default: None + :p: Active power of the load. Load sign convention is used, i.e. positive sign means flow out from a node. For voltage dependent loads the value is at rated voltage. Starting value for a steady state solution. Default: 0.0 + :pfixed: Active power of the load that is a fixed quantity. Load sign convention is used, i.e. positive sign means flow out from a node. Default: 0.0 + :pfixedPct: Fixed active power as per cent of load group fixed active power. Load sign convention is used, i.e. positive sign means flow out from a node. Default: 0.0 + :q: Reactive power of the load. Load sign convention is used, i.e. positive sign means flow out from a node. For voltage dependent loads the value is at rated voltage. Starting value for a steady state solution. Default: 0.0 + :qfixed: Reactive power of the load that is a fixed quantity. Load sign convention is used, i.e. positive sign means flow out from a node. Default: 0.0 + :qfixedPct: Fixed reactive power as per cent of load group fixed reactive power. Load sign convention is used, i.e. positive sign means flow out from a node. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, Profile.SSH.value, ], + "LoadDynamics": [Profile.DY.value, ], + "LoadResponse": [Profile.EQ.value, ], + "p": [Profile.SSH.value, ], + "pfixed": [Profile.EQ.value, ], + "pfixedPct": [Profile.EQ.value, ], + "q": [Profile.SSH.value, ], + "qfixed": [Profile.EQ.value, ], + "qfixedPct": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConductingEquipment:\n" + ConductingEquipment.__doc__ + + def __init__(self, LoadDynamics = None, LoadResponse = None, p = 0.0, pfixed = 0.0, pfixedPct = 0.0, q = 0.0, qfixed = 0.0, qfixedPct = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.LoadDynamics = LoadDynamics + self.LoadResponse = LoadResponse + self.p = p + self.pfixed = pfixed + self.pfixedPct = pfixedPct + self.q = q + self.qfixed = qfixed + self.qfixedPct = qfixedPct + + def __str__(self): + str = "class=EnergyConsumer\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/EnergySchedulingType.py b/cimpy/cgmes_v2_4_15/EnergySchedulingType.py index 49a7088e..4cef05d8 100644 --- a/cimpy/cgmes_v2_4_15/EnergySchedulingType.py +++ b/cimpy/cgmes_v2_4_15/EnergySchedulingType.py @@ -1,31 +1,33 @@ -from .IdentifiedObject import IdentifiedObject - - -class EnergySchedulingType(IdentifiedObject): - ''' - Used to define the type of generation for scheduling purposes. - - :EnergySource: Energy Scheduling Type of an Energy Source Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - 'EnergySource': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, EnergySource = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.EnergySource = EnergySource - - def __str__(self): - str = 'class=EnergySchedulingType\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class EnergySchedulingType(IdentifiedObject): + """ + Used to define the type of generation for scheduling purposes. + + :EnergySource: Energy Source of a particular Energy Scheduling Type Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ_BD.value, Profile.EQ.value, ], + "EnergySource": [Profile.EQ_BD.value, Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, EnergySource = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.EnergySource = EnergySource + + def __str__(self): + str = "class=EnergySchedulingType\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/EnergySource.py b/cimpy/cgmes_v2_4_15/EnergySource.py index e835eafb..473779de 100644 --- a/cimpy/cgmes_v2_4_15/EnergySource.py +++ b/cimpy/cgmes_v2_4_15/EnergySource.py @@ -1,67 +1,69 @@ -from .ConductingEquipment import ConductingEquipment - - -class EnergySource(ConductingEquipment): - ''' - A generic equivalent for an energy supplier on a transmission or distribution voltage level. - - :EnergySchedulingType: Energy Source of a particular Energy Scheduling Type Default: None - :nominalVoltage: Phase-to-phase nominal voltage. Default: 0.0 - :r: Positive sequence Thevenin resistance. Default: 0.0 - :r0: Zero sequence Thevenin resistance. Default: 0.0 - :rn: Negative sequence Thevenin resistance. Default: 0.0 - :voltageAngle: Phase angle of a-phase open circuit. Default: 0.0 - :voltageMagnitude: Phase-to-phase open circuit voltage magnitude. Default: 0.0 - :x: Positive sequence Thevenin reactance. Default: 0.0 - :x0: Zero sequence Thevenin reactance. Default: 0.0 - :xn: Negative sequence Thevenin reactance. Default: 0.0 - :activePower: High voltage source active injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions. Default: 0.0 - :reactivePower: High voltage source reactive injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions. Default: 0.0 - :WindTurbineType3or4Dynamics: Wind generator Type 3 or 4 dynamics model associated with this energy source. Default: None - ''' - - cgmesProfile = ConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.DY.value, cgmesProfile.EQ_BD.value, ], - 'EnergySchedulingType': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - 'nominalVoltage': [cgmesProfile.EQ.value, ], - 'r': [cgmesProfile.EQ.value, ], - 'r0': [cgmesProfile.EQ.value, ], - 'rn': [cgmesProfile.EQ.value, ], - 'voltageAngle': [cgmesProfile.EQ.value, ], - 'voltageMagnitude': [cgmesProfile.EQ.value, ], - 'x': [cgmesProfile.EQ.value, ], - 'x0': [cgmesProfile.EQ.value, ], - 'xn': [cgmesProfile.EQ.value, ], - 'activePower': [cgmesProfile.SSH.value, ], - 'reactivePower': [cgmesProfile.SSH.value, ], - 'WindTurbineType3or4Dynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConductingEquipment: \n' + ConductingEquipment.__doc__ - - def __init__(self, EnergySchedulingType = None, nominalVoltage = 0.0, r = 0.0, r0 = 0.0, rn = 0.0, voltageAngle = 0.0, voltageMagnitude = 0.0, x = 0.0, x0 = 0.0, xn = 0.0, activePower = 0.0, reactivePower = 0.0, WindTurbineType3or4Dynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.EnergySchedulingType = EnergySchedulingType - self.nominalVoltage = nominalVoltage - self.r = r - self.r0 = r0 - self.rn = rn - self.voltageAngle = voltageAngle - self.voltageMagnitude = voltageMagnitude - self.x = x - self.x0 = x0 - self.xn = xn - self.activePower = activePower - self.reactivePower = reactivePower - self.WindTurbineType3or4Dynamics = WindTurbineType3or4Dynamics - - def __str__(self): - str = 'class=EnergySource\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConductingEquipment import ConductingEquipment +from .CGMESProfile import Profile + + +class EnergySource(ConductingEquipment): + """ + A generic equivalent for an energy supplier on a transmission or distribution voltage level. + + :EnergySchedulingType: Energy Scheduling Type of an Energy Source Default: None + :WindTurbineType3or4Dynamics: Wind generator Type 3 or 4 dynamics model associated with this energy source. Default: None + :activePower: High voltage source active injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions. Default: 0.0 + :nominalVoltage: Phase-to-phase nominal voltage. Default: 0.0 + :r: Positive sequence Thevenin resistance. Default: 0.0 + :r0: Zero sequence Thevenin resistance. Default: 0.0 + :reactivePower: High voltage source reactive injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions. Default: 0.0 + :rn: Negative sequence Thevenin resistance. Default: 0.0 + :voltageAngle: Phase angle of a-phase open circuit. Default: 0.0 + :voltageMagnitude: Phase-to-phase open circuit voltage magnitude. Default: 0.0 + :x: Positive sequence Thevenin reactance. Default: 0.0 + :x0: Zero sequence Thevenin reactance. Default: 0.0 + :xn: Negative sequence Thevenin reactance. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.SSH.value, ], + "EnergySchedulingType": [Profile.EQ_BD.value, Profile.EQ.value, ], + "WindTurbineType3or4Dynamics": [Profile.DY.value, ], + "activePower": [Profile.SSH.value, ], + "nominalVoltage": [Profile.EQ.value, ], + "r": [Profile.EQ.value, ], + "r0": [Profile.EQ.value, ], + "reactivePower": [Profile.SSH.value, ], + "rn": [Profile.EQ.value, ], + "voltageAngle": [Profile.EQ.value, ], + "voltageMagnitude": [Profile.EQ.value, ], + "x": [Profile.EQ.value, ], + "x0": [Profile.EQ.value, ], + "xn": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConductingEquipment:\n" + ConductingEquipment.__doc__ + + def __init__(self, EnergySchedulingType = None, WindTurbineType3or4Dynamics = None, activePower = 0.0, nominalVoltage = 0.0, r = 0.0, r0 = 0.0, reactivePower = 0.0, rn = 0.0, voltageAngle = 0.0, voltageMagnitude = 0.0, x = 0.0, x0 = 0.0, xn = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.EnergySchedulingType = EnergySchedulingType + self.WindTurbineType3or4Dynamics = WindTurbineType3or4Dynamics + self.activePower = activePower + self.nominalVoltage = nominalVoltage + self.r = r + self.r0 = r0 + self.reactivePower = reactivePower + self.rn = rn + self.voltageAngle = voltageAngle + self.voltageMagnitude = voltageMagnitude + self.x = x + self.x0 = x0 + self.xn = xn + + def __str__(self): + str = "class=EnergySource\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Equipment.py b/cimpy/cgmes_v2_4_15/Equipment.py index 6f032e55..16c96400 100644 --- a/cimpy/cgmes_v2_4_15/Equipment.py +++ b/cimpy/cgmes_v2_4_15/Equipment.py @@ -1,37 +1,39 @@ -from .PowerSystemResource import PowerSystemResource - - -class Equipment(PowerSystemResource): - ''' - The parts of a power system that are physical devices, electronic or mechanical. - - :aggregate: The single instance of equipment represents multiple pieces of equipment that have been modeled together as an aggregate. Examples would be power transformers or synchronous machines operating in parallel modeled as a single aggregate power transformer or aggregate synchronous machine. This is not to be used to indicate equipment that is part of a group of interdependent equipment produced by a network production program. Default: False - :EquipmentContainer: Container of this equipment. Default: None - :OperationalLimitSet: The operational limit sets associated with this equipment. Default: "list" - ''' - - cgmesProfile = PowerSystemResource.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.DY.value, cgmesProfile.EQ_BD.value, ], - 'aggregate': [cgmesProfile.EQ.value, ], - 'EquipmentContainer': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - 'OperationalLimitSet': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemResource: \n' + PowerSystemResource.__doc__ - - def __init__(self, aggregate = False, EquipmentContainer = None, OperationalLimitSet = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.aggregate = aggregate - self.EquipmentContainer = EquipmentContainer - self.OperationalLimitSet = OperationalLimitSet - - def __str__(self): - str = 'class=Equipment\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemResource import PowerSystemResource +from .CGMESProfile import Profile + + +class Equipment(PowerSystemResource): + """ + The parts of a power system that are physical devices, electronic or mechanical. + + :EquipmentContainer: Container of this equipment. Default: None + :OperationalLimitSet: The operational limit sets associated with this equipment. Default: "list" + :aggregate: The single instance of equipment represents multiple pieces of equipment that have been modeled together as an aggregate. Examples would be power transformers or synchronous machines operating in parallel modeled as a single aggregate power transformer or aggregate synchronous machine. This is not to be used to indicate equipment that is part of a group of interdependent equipment produced by a network production program. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.SSH.value, ], + "EquipmentContainer": [Profile.EQ_BD.value, Profile.EQ.value, ], + "OperationalLimitSet": [Profile.EQ.value, ], + "aggregate": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class PowerSystemResource:\n" + PowerSystemResource.__doc__ + + def __init__(self, EquipmentContainer = None, OperationalLimitSet = "list", aggregate = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.EquipmentContainer = EquipmentContainer + self.OperationalLimitSet = OperationalLimitSet + self.aggregate = aggregate + + def __str__(self): + str = "class=Equipment\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/EquipmentBoundaryVersion.py b/cimpy/cgmes_v2_4_15/EquipmentBoundaryVersion.py index 989d5ce9..1bb9c17a 100644 --- a/cimpy/cgmes_v2_4_15/EquipmentBoundaryVersion.py +++ b/cimpy/cgmes_v2_4_15/EquipmentBoundaryVersion.py @@ -1,60 +1,61 @@ -from .Base import Base - - -class EquipmentBoundaryVersion(Base): - ''' - Profile version details. - - :baseUML: Base UML provided by CIM model manager. Default: '' - :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' - :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' - :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' - :entsoeUML: UML provided by ENTSO-E. Default: '' - :entsoeURIcore: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/EquipmentBoundary/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' - :entsoeURIoperation: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/EquipmentBoundaryOperation/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' - :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' - :namespaceRDF: RDF namespace. Default: '' - :namespaceUML: CIM UML namespace. Default: '' - :shortName: The short name of the profile used in profile documentation. Default: '' - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ_BD.value, ], - 'baseUML': [cgmesProfile.EQ_BD.value, ], - 'baseURI': [cgmesProfile.EQ_BD.value, ], - 'date': [cgmesProfile.EQ_BD.value, ], - 'differenceModelURI': [cgmesProfile.EQ_BD.value, ], - 'entsoeUML': [cgmesProfile.EQ_BD.value, ], - 'entsoeURIcore': [cgmesProfile.EQ_BD.value, ], - 'entsoeURIoperation': [cgmesProfile.EQ_BD.value, ], - 'modelDescriptionURI': [cgmesProfile.EQ_BD.value, ], - 'namespaceRDF': [cgmesProfile.EQ_BD.value, ], - 'namespaceUML': [cgmesProfile.EQ_BD.value, ], - 'shortName': [cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - - - def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURIcore = '', entsoeURIoperation = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = '', ): - - self.baseUML = baseUML - self.baseURI = baseURI - self.date = date - self.differenceModelURI = differenceModelURI - self.entsoeUML = entsoeUML - self.entsoeURIcore = entsoeURIcore - self.entsoeURIoperation = entsoeURIoperation - self.modelDescriptionURI = modelDescriptionURI - self.namespaceRDF = namespaceRDF - self.namespaceUML = namespaceUML - self.shortName = shortName - - def __str__(self): - str = 'class=EquipmentBoundaryVersion\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class EquipmentBoundaryVersion(Base): + """ + Profile version details. + + :baseUML: Base UML provided by CIM model manager. Default: '' + :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' + :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' + :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' + :entsoeUML: UML provided by ENTSO-E. Default: '' + :entsoeURIcore: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/EquipmentBoundary/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' + :entsoeURIoperation: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/EquipmentBoundaryOperation/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' + :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' + :namespaceRDF: RDF namespace. Default: '' + :namespaceUML: CIM UML namespace. Default: '' + :shortName: The short name of the profile used in profile documentation. Default: '' + """ + + possibleProfileList = { + "class": [Profile.EQ_BD.value, ], + "baseUML": [Profile.EQ_BD.value, ], + "baseURI": [Profile.EQ_BD.value, ], + "date": [Profile.EQ_BD.value, ], + "differenceModelURI": [Profile.EQ_BD.value, ], + "entsoeUML": [Profile.EQ_BD.value, ], + "entsoeURIcore": [Profile.EQ_BD.value, ], + "entsoeURIoperation": [Profile.EQ_BD.value, ], + "modelDescriptionURI": [Profile.EQ_BD.value, ], + "namespaceRDF": [Profile.EQ_BD.value, ], + "namespaceUML": [Profile.EQ_BD.value, ], + "shortName": [Profile.EQ_BD.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ_BD.value + + + def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURIcore = '', entsoeURIoperation = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = ''): + + self.baseUML = baseUML + self.baseURI = baseURI + self.date = date + self.differenceModelURI = differenceModelURI + self.entsoeUML = entsoeUML + self.entsoeURIcore = entsoeURIcore + self.entsoeURIoperation = entsoeURIoperation + self.modelDescriptionURI = modelDescriptionURI + self.namespaceRDF = namespaceRDF + self.namespaceUML = namespaceUML + self.shortName = shortName + + def __str__(self): + str = "class=EquipmentBoundaryVersion\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/EquipmentContainer.py b/cimpy/cgmes_v2_4_15/EquipmentContainer.py index ee6ad74c..b5e82867 100644 --- a/cimpy/cgmes_v2_4_15/EquipmentContainer.py +++ b/cimpy/cgmes_v2_4_15/EquipmentContainer.py @@ -1,31 +1,33 @@ -from .ConnectivityNodeContainer import ConnectivityNodeContainer - - -class EquipmentContainer(ConnectivityNodeContainer): - ''' - A modeling construct to provide a root class for containing equipment. - - :Equipments: Contained equipment. Default: "list" - ''' - - cgmesProfile = ConnectivityNodeContainer.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - 'Equipments': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConnectivityNodeContainer: \n' + ConnectivityNodeContainer.__doc__ - - def __init__(self, Equipments = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Equipments = Equipments - - def __str__(self): - str = 'class=EquipmentContainer\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConnectivityNodeContainer import ConnectivityNodeContainer +from .CGMESProfile import Profile + + +class EquipmentContainer(ConnectivityNodeContainer): + """ + A modeling construct to provide a root class for containing equipment. + + :Equipments: Contained equipment. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ_BD.value, Profile.EQ.value, ], + "Equipments": [Profile.EQ_BD.value, Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConnectivityNodeContainer:\n" + ConnectivityNodeContainer.__doc__ + + def __init__(self, Equipments = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Equipments = Equipments + + def __str__(self): + str = "class=EquipmentContainer\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/EquipmentVersion.py b/cimpy/cgmes_v2_4_15/EquipmentVersion.py index 386c2cd4..75e301ad 100644 --- a/cimpy/cgmes_v2_4_15/EquipmentVersion.py +++ b/cimpy/cgmes_v2_4_15/EquipmentVersion.py @@ -1,69 +1,70 @@ -from .Base import Base - - -class EquipmentVersion(Base): - ''' - Version details. - - :baseUML: Base UML provided by CIM model manager. Default: '' - :baseURIcore: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' - :baseURIoperation: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' - :baseURIshortCircuit: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' - :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' - :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' - :entsoeUML: UML provided by ENTSO-E. Default: '' - :entsoeURIcore: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/EquipmentCore/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' - :entsoeURIoperation: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/EquipmentOperation/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' - :entsoeURIshortCircuit: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/EquipmentShortCircuit/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' - :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' - :namespaceRDF: RDF namespace. Default: '' - :namespaceUML: CIM UML namespace. Default: '' - :shortName: The short name of the profile used in profile documentation. Default: '' - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'baseUML': [cgmesProfile.EQ.value, ], - 'baseURIcore': [cgmesProfile.EQ.value, ], - 'baseURIoperation': [cgmesProfile.EQ.value, ], - 'baseURIshortCircuit': [cgmesProfile.EQ.value, ], - 'date': [cgmesProfile.EQ.value, ], - 'differenceModelURI': [cgmesProfile.EQ.value, ], - 'entsoeUML': [cgmesProfile.EQ.value, ], - 'entsoeURIcore': [cgmesProfile.EQ.value, ], - 'entsoeURIoperation': [cgmesProfile.EQ.value, ], - 'entsoeURIshortCircuit': [cgmesProfile.EQ.value, ], - 'modelDescriptionURI': [cgmesProfile.EQ.value, ], - 'namespaceRDF': [cgmesProfile.EQ.value, ], - 'namespaceUML': [cgmesProfile.EQ.value, ], - 'shortName': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, baseUML = '', baseURIcore = '', baseURIoperation = '', baseURIshortCircuit = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURIcore = '', entsoeURIoperation = '', entsoeURIshortCircuit = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = '', ): - - self.baseUML = baseUML - self.baseURIcore = baseURIcore - self.baseURIoperation = baseURIoperation - self.baseURIshortCircuit = baseURIshortCircuit - self.date = date - self.differenceModelURI = differenceModelURI - self.entsoeUML = entsoeUML - self.entsoeURIcore = entsoeURIcore - self.entsoeURIoperation = entsoeURIoperation - self.entsoeURIshortCircuit = entsoeURIshortCircuit - self.modelDescriptionURI = modelDescriptionURI - self.namespaceRDF = namespaceRDF - self.namespaceUML = namespaceUML - self.shortName = shortName - - def __str__(self): - str = 'class=EquipmentVersion\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class EquipmentVersion(Base): + """ + Version details. + + :baseUML: Base UML provided by CIM model manager. Default: '' + :baseURIcore: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' + :baseURIoperation: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' + :baseURIshortCircuit: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' + :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' + :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' + :entsoeUML: UML provided by ENTSO-E. Default: '' + :entsoeURIcore: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/EquipmentCore/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' + :entsoeURIoperation: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/EquipmentOperation/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' + :entsoeURIshortCircuit: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/EquipmentShortCircuit/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' + :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' + :namespaceRDF: RDF namespace. Default: '' + :namespaceUML: CIM UML namespace. Default: '' + :shortName: The short name of the profile used in profile documentation. Default: '' + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "baseUML": [Profile.EQ.value, ], + "baseURIcore": [Profile.EQ.value, ], + "baseURIoperation": [Profile.EQ.value, ], + "baseURIshortCircuit": [Profile.EQ.value, ], + "date": [Profile.EQ.value, ], + "differenceModelURI": [Profile.EQ.value, ], + "entsoeUML": [Profile.EQ.value, ], + "entsoeURIcore": [Profile.EQ.value, ], + "entsoeURIoperation": [Profile.EQ.value, ], + "entsoeURIshortCircuit": [Profile.EQ.value, ], + "modelDescriptionURI": [Profile.EQ.value, ], + "namespaceRDF": [Profile.EQ.value, ], + "namespaceUML": [Profile.EQ.value, ], + "shortName": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, baseUML = '', baseURIcore = '', baseURIoperation = '', baseURIshortCircuit = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURIcore = '', entsoeURIoperation = '', entsoeURIshortCircuit = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = ''): + + self.baseUML = baseUML + self.baseURIcore = baseURIcore + self.baseURIoperation = baseURIoperation + self.baseURIshortCircuit = baseURIshortCircuit + self.date = date + self.differenceModelURI = differenceModelURI + self.entsoeUML = entsoeUML + self.entsoeURIcore = entsoeURIcore + self.entsoeURIoperation = entsoeURIoperation + self.entsoeURIshortCircuit = entsoeURIshortCircuit + self.modelDescriptionURI = modelDescriptionURI + self.namespaceRDF = namespaceRDF + self.namespaceUML = namespaceUML + self.shortName = shortName + + def __str__(self): + str = "class=EquipmentVersion\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/EquivalentBranch.py b/cimpy/cgmes_v2_4_15/EquivalentBranch.py index 6e60c993..47a2ebe7 100644 --- a/cimpy/cgmes_v2_4_15/EquivalentBranch.py +++ b/cimpy/cgmes_v2_4_15/EquivalentBranch.py @@ -1,76 +1,78 @@ -from .EquivalentEquipment import EquivalentEquipment - - -class EquivalentBranch(EquivalentEquipment): - ''' - The class represents equivalent branches. - - :r: Positive sequence series resistance of the reduced branch. Default: 0.0 - :r21: Resistance from terminal sequence 2 to terminal sequence 1 .Used for steady state power flow. This attribute is optional and represent unbalanced network such as off-nominal phase shifter. If only EquivalentBranch.r is given, then EquivalentBranch.r21 is assumed equal to EquivalentBranch.r. Usage rule : EquivalentBranch is a result of network reduction prior to the data exchange. Default: 0.0 - :x: Positive sequence series reactance of the reduced branch. Default: 0.0 - :x21: Reactance from terminal sequence 2 to terminal sequence 1 .Used for steady state power flow. This attribute is optional and represent unbalanced network such as off-nominal phase shifter. If only EquivalentBranch.x is given, then EquivalentBranch.x21 is assumed equal to EquivalentBranch.x. Usage rule : EquivalentBranch is a result of network reduction prior to the data exchange. Default: 0.0 - :negativeR12: Negative sequence series resistance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909 EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 - :negativeR21: Negative sequence series resistance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909 EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 - :negativeX12: Negative sequence series reactance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909 Usage : EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 - :negativeX21: Negative sequence series reactance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909. Usage: EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 - :positiveR12: Positive sequence series resistance from terminal sequence 1 to terminal sequence 2 . Used for short circuit data exchange according to IEC 60909. EquivalentBranch is a result of network reduction prior to the data exchange. Default: 0.0 - :positiveR21: Positive sequence series resistance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909 EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 - :positiveX12: Positive sequence series reactance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909 Usage : EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 - :positiveX21: Positive sequence series reactance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909 Usage : EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 - :zeroR12: Zero sequence series resistance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909 EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 - :zeroR21: Zero sequence series resistance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909 Usage : EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 - :zeroX12: Zero sequence series reactance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909 Usage : EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 - :zeroX21: Zero sequence series reactance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909 Usage : EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 - ''' - - cgmesProfile = EquivalentEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'r': [cgmesProfile.EQ.value, ], - 'r21': [cgmesProfile.EQ.value, ], - 'x': [cgmesProfile.EQ.value, ], - 'x21': [cgmesProfile.EQ.value, ], - 'negativeR12': [cgmesProfile.EQ.value, ], - 'negativeR21': [cgmesProfile.EQ.value, ], - 'negativeX12': [cgmesProfile.EQ.value, ], - 'negativeX21': [cgmesProfile.EQ.value, ], - 'positiveR12': [cgmesProfile.EQ.value, ], - 'positiveR21': [cgmesProfile.EQ.value, ], - 'positiveX12': [cgmesProfile.EQ.value, ], - 'positiveX21': [cgmesProfile.EQ.value, ], - 'zeroR12': [cgmesProfile.EQ.value, ], - 'zeroR21': [cgmesProfile.EQ.value, ], - 'zeroX12': [cgmesProfile.EQ.value, ], - 'zeroX21': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EquivalentEquipment: \n' + EquivalentEquipment.__doc__ - - def __init__(self, r = 0.0, r21 = 0.0, x = 0.0, x21 = 0.0, negativeR12 = 0.0, negativeR21 = 0.0, negativeX12 = 0.0, negativeX21 = 0.0, positiveR12 = 0.0, positiveR21 = 0.0, positiveX12 = 0.0, positiveX21 = 0.0, zeroR12 = 0.0, zeroR21 = 0.0, zeroX12 = 0.0, zeroX21 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.r = r - self.r21 = r21 - self.x = x - self.x21 = x21 - self.negativeR12 = negativeR12 - self.negativeR21 = negativeR21 - self.negativeX12 = negativeX12 - self.negativeX21 = negativeX21 - self.positiveR12 = positiveR12 - self.positiveR21 = positiveR21 - self.positiveX12 = positiveX12 - self.positiveX21 = positiveX21 - self.zeroR12 = zeroR12 - self.zeroR21 = zeroR21 - self.zeroX12 = zeroX12 - self.zeroX21 = zeroX21 - - def __str__(self): - str = 'class=EquivalentBranch\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EquivalentEquipment import EquivalentEquipment +from .CGMESProfile import Profile + + +class EquivalentBranch(EquivalentEquipment): + """ + The class represents equivalent branches. + + :negativeR12: Negative sequence series resistance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909 EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 + :negativeR21: Negative sequence series resistance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909 EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 + :negativeX12: Negative sequence series reactance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909 Usage : EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 + :negativeX21: Negative sequence series reactance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909. Usage: EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 + :positiveR12: Positive sequence series resistance from terminal sequence 1 to terminal sequence 2 . Used for short circuit data exchange according to IEC 60909. EquivalentBranch is a result of network reduction prior to the data exchange. Default: 0.0 + :positiveR21: Positive sequence series resistance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909 EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 + :positiveX12: Positive sequence series reactance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909 Usage : EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 + :positiveX21: Positive sequence series reactance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909 Usage : EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 + :r: Positive sequence series resistance of the reduced branch. Default: 0.0 + :r21: Resistance from terminal sequence 2 to terminal sequence 1 .Used for steady state power flow. This attribute is optional and represent unbalanced network such as off-nominal phase shifter. If only EquivalentBranch.r is given, then EquivalentBranch.r21 is assumed equal to EquivalentBranch.r. Usage rule : EquivalentBranch is a result of network reduction prior to the data exchange. Default: 0.0 + :x: Positive sequence series reactance of the reduced branch. Default: 0.0 + :x21: Reactance from terminal sequence 2 to terminal sequence 1 .Used for steady state power flow. This attribute is optional and represent unbalanced network such as off-nominal phase shifter. If only EquivalentBranch.x is given, then EquivalentBranch.x21 is assumed equal to EquivalentBranch.x. Usage rule : EquivalentBranch is a result of network reduction prior to the data exchange. Default: 0.0 + :zeroR12: Zero sequence series resistance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909 EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 + :zeroR21: Zero sequence series resistance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909 Usage : EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 + :zeroX12: Zero sequence series reactance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909 Usage : EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 + :zeroX21: Zero sequence series reactance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909 Usage : EquivalentBranch is a result of network reduction prior to the data exchange Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "negativeR12": [Profile.EQ.value, ], + "negativeR21": [Profile.EQ.value, ], + "negativeX12": [Profile.EQ.value, ], + "negativeX21": [Profile.EQ.value, ], + "positiveR12": [Profile.EQ.value, ], + "positiveR21": [Profile.EQ.value, ], + "positiveX12": [Profile.EQ.value, ], + "positiveX21": [Profile.EQ.value, ], + "r": [Profile.EQ.value, ], + "r21": [Profile.EQ.value, ], + "x": [Profile.EQ.value, ], + "x21": [Profile.EQ.value, ], + "zeroR12": [Profile.EQ.value, ], + "zeroR21": [Profile.EQ.value, ], + "zeroX12": [Profile.EQ.value, ], + "zeroX21": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EquivalentEquipment:\n" + EquivalentEquipment.__doc__ + + def __init__(self, negativeR12 = 0.0, negativeR21 = 0.0, negativeX12 = 0.0, negativeX21 = 0.0, positiveR12 = 0.0, positiveR21 = 0.0, positiveX12 = 0.0, positiveX21 = 0.0, r = 0.0, r21 = 0.0, x = 0.0, x21 = 0.0, zeroR12 = 0.0, zeroR21 = 0.0, zeroX12 = 0.0, zeroX21 = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.negativeR12 = negativeR12 + self.negativeR21 = negativeR21 + self.negativeX12 = negativeX12 + self.negativeX21 = negativeX21 + self.positiveR12 = positiveR12 + self.positiveR21 = positiveR21 + self.positiveX12 = positiveX12 + self.positiveX21 = positiveX21 + self.r = r + self.r21 = r21 + self.x = x + self.x21 = x21 + self.zeroR12 = zeroR12 + self.zeroR21 = zeroR21 + self.zeroX12 = zeroX12 + self.zeroX21 = zeroX21 + + def __str__(self): + str = "class=EquivalentBranch\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/EquivalentEquipment.py b/cimpy/cgmes_v2_4_15/EquivalentEquipment.py index 276de421..5f1d2e4c 100644 --- a/cimpy/cgmes_v2_4_15/EquivalentEquipment.py +++ b/cimpy/cgmes_v2_4_15/EquivalentEquipment.py @@ -1,31 +1,33 @@ -from .ConductingEquipment import ConductingEquipment - - -class EquivalentEquipment(ConductingEquipment): - ''' - The class represents equivalent objects that are the result of a network reduction. The class is the base for equivalent objects of different types. - - :EquivalentNetwork: The associated reduced equivalents. Default: None - ''' - - cgmesProfile = ConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'EquivalentNetwork': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConductingEquipment: \n' + ConductingEquipment.__doc__ - - def __init__(self, EquivalentNetwork = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.EquivalentNetwork = EquivalentNetwork - - def __str__(self): - str = 'class=EquivalentEquipment\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConductingEquipment import ConductingEquipment +from .CGMESProfile import Profile + + +class EquivalentEquipment(ConductingEquipment): + """ + The class represents equivalent objects that are the result of a network reduction. The class is the base for equivalent objects of different types. + + :EquivalentNetwork: The associated reduced equivalents. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "EquivalentNetwork": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConductingEquipment:\n" + ConductingEquipment.__doc__ + + def __init__(self, EquivalentNetwork = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.EquivalentNetwork = EquivalentNetwork + + def __str__(self): + str = "class=EquivalentEquipment\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/EquivalentInjection.py b/cimpy/cgmes_v2_4_15/EquivalentInjection.py index e8e47197..13243d87 100644 --- a/cimpy/cgmes_v2_4_15/EquivalentInjection.py +++ b/cimpy/cgmes_v2_4_15/EquivalentInjection.py @@ -1,76 +1,78 @@ -from .EquivalentEquipment import EquivalentEquipment - - -class EquivalentInjection(EquivalentEquipment): - ''' - This class represents equivalent injections (generation or load). Voltage regulation is allowed only at the point of connection. - - :ReactiveCapabilityCurve: The equivalent injection using this reactive capability curve. Default: None - :maxP: Maximum active power of the injection. Default: 0.0 - :maxQ: Used for modeling of infeed for load flow exchange. Not used for short circuit modeling. If maxQ and minQ are not used ReactiveCapabilityCurve can be used. Default: 0.0 - :minP: Minimum active power of the injection. Default: 0.0 - :minQ: Used for modeling of infeed for load flow exchange. Not used for short circuit modeling. If maxQ and minQ are not used ReactiveCapabilityCurve can be used. Default: 0.0 - :regulationCapability: Specifies whether or not the EquivalentInjection has the capability to regulate the local voltage. Default: False - :r: Positive sequence resistance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange. Default: 0.0 - :r0: Zero sequence resistance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange. Default: 0.0 - :r2: Negative sequence resistance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange. Default: 0.0 - :x: Positive sequence reactance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange. Default: 0.0 - :x0: Zero sequence reactance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange. Default: 0.0 - :x2: Negative sequence reactance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange. Default: 0.0 - :regulationStatus: Specifies the default regulation status of the EquivalentInjection. True is regulating. False is not regulating. Default: False - :regulationTarget: The target voltage for voltage regulation. Default: 0.0 - :p: Equivalent active power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions. Default: 0.0 - :q: Equivalent reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions. Default: 0.0 - ''' - - cgmesProfile = EquivalentEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'ReactiveCapabilityCurve': [cgmesProfile.EQ.value, ], - 'maxP': [cgmesProfile.EQ.value, ], - 'maxQ': [cgmesProfile.EQ.value, ], - 'minP': [cgmesProfile.EQ.value, ], - 'minQ': [cgmesProfile.EQ.value, ], - 'regulationCapability': [cgmesProfile.EQ.value, ], - 'r': [cgmesProfile.EQ.value, ], - 'r0': [cgmesProfile.EQ.value, ], - 'r2': [cgmesProfile.EQ.value, ], - 'x': [cgmesProfile.EQ.value, ], - 'x0': [cgmesProfile.EQ.value, ], - 'x2': [cgmesProfile.EQ.value, ], - 'regulationStatus': [cgmesProfile.SSH.value, ], - 'regulationTarget': [cgmesProfile.SSH.value, ], - 'p': [cgmesProfile.SSH.value, ], - 'q': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EquivalentEquipment: \n' + EquivalentEquipment.__doc__ - - def __init__(self, ReactiveCapabilityCurve = None, maxP = 0.0, maxQ = 0.0, minP = 0.0, minQ = 0.0, regulationCapability = False, r = 0.0, r0 = 0.0, r2 = 0.0, x = 0.0, x0 = 0.0, x2 = 0.0, regulationStatus = False, regulationTarget = 0.0, p = 0.0, q = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ReactiveCapabilityCurve = ReactiveCapabilityCurve - self.maxP = maxP - self.maxQ = maxQ - self.minP = minP - self.minQ = minQ - self.regulationCapability = regulationCapability - self.r = r - self.r0 = r0 - self.r2 = r2 - self.x = x - self.x0 = x0 - self.x2 = x2 - self.regulationStatus = regulationStatus - self.regulationTarget = regulationTarget - self.p = p - self.q = q - - def __str__(self): - str = 'class=EquivalentInjection\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EquivalentEquipment import EquivalentEquipment +from .CGMESProfile import Profile + + +class EquivalentInjection(EquivalentEquipment): + """ + This class represents equivalent injections (generation or load). Voltage regulation is allowed only at the point of connection. + + :ReactiveCapabilityCurve: The equivalent injection using this reactive capability curve. Default: None + :maxP: Maximum active power of the injection. Default: 0.0 + :maxQ: Used for modeling of infeed for load flow exchange. Not used for short circuit modeling. If maxQ and minQ are not used ReactiveCapabilityCurve can be used. Default: 0.0 + :minP: Minimum active power of the injection. Default: 0.0 + :minQ: Used for modeling of infeed for load flow exchange. Not used for short circuit modeling. If maxQ and minQ are not used ReactiveCapabilityCurve can be used. Default: 0.0 + :p: Equivalent active power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions. Default: 0.0 + :q: Equivalent reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions. Default: 0.0 + :r: Positive sequence resistance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange. Default: 0.0 + :r0: Zero sequence resistance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange. Default: 0.0 + :r2: Negative sequence resistance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange. Default: 0.0 + :regulationCapability: Specifies whether or not the EquivalentInjection has the capability to regulate the local voltage. Default: False + :regulationStatus: Specifies the default regulation status of the EquivalentInjection. True is regulating. False is not regulating. Default: False + :regulationTarget: The target voltage for voltage regulation. Default: 0.0 + :x: Positive sequence reactance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange. Default: 0.0 + :x0: Zero sequence reactance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange. Default: 0.0 + :x2: Negative sequence reactance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "ReactiveCapabilityCurve": [Profile.EQ.value, ], + "maxP": [Profile.EQ.value, ], + "maxQ": [Profile.EQ.value, ], + "minP": [Profile.EQ.value, ], + "minQ": [Profile.EQ.value, ], + "p": [Profile.SSH.value, ], + "q": [Profile.SSH.value, ], + "r": [Profile.EQ.value, ], + "r0": [Profile.EQ.value, ], + "r2": [Profile.EQ.value, ], + "regulationCapability": [Profile.EQ.value, ], + "regulationStatus": [Profile.SSH.value, ], + "regulationTarget": [Profile.SSH.value, ], + "x": [Profile.EQ.value, ], + "x0": [Profile.EQ.value, ], + "x2": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EquivalentEquipment:\n" + EquivalentEquipment.__doc__ + + def __init__(self, ReactiveCapabilityCurve = None, maxP = 0.0, maxQ = 0.0, minP = 0.0, minQ = 0.0, p = 0.0, q = 0.0, r = 0.0, r0 = 0.0, r2 = 0.0, regulationCapability = False, regulationStatus = False, regulationTarget = 0.0, x = 0.0, x0 = 0.0, x2 = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ReactiveCapabilityCurve = ReactiveCapabilityCurve + self.maxP = maxP + self.maxQ = maxQ + self.minP = minP + self.minQ = minQ + self.p = p + self.q = q + self.r = r + self.r0 = r0 + self.r2 = r2 + self.regulationCapability = regulationCapability + self.regulationStatus = regulationStatus + self.regulationTarget = regulationTarget + self.x = x + self.x0 = x0 + self.x2 = x2 + + def __str__(self): + str = "class=EquivalentInjection\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/EquivalentNetwork.py b/cimpy/cgmes_v2_4_15/EquivalentNetwork.py index 1a5d94bc..6e199276 100644 --- a/cimpy/cgmes_v2_4_15/EquivalentNetwork.py +++ b/cimpy/cgmes_v2_4_15/EquivalentNetwork.py @@ -1,31 +1,33 @@ -from .ConnectivityNodeContainer import ConnectivityNodeContainer - - -class EquivalentNetwork(ConnectivityNodeContainer): - ''' - A class that represents an external meshed network that has been reduced to an electrically equivalent model. The ConnectivityNodes contained in the equivalent are intended to reflect internal nodes of the equivalent. The boundary Connectivity nodes where the equivalent connects outside itself are NOT contained by the equivalent. - - :EquivalentEquipments: The equivalent where the reduced model belongs. Default: "list" - ''' - - cgmesProfile = ConnectivityNodeContainer.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'EquivalentEquipments': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConnectivityNodeContainer: \n' + ConnectivityNodeContainer.__doc__ - - def __init__(self, EquivalentEquipments = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.EquivalentEquipments = EquivalentEquipments - - def __str__(self): - str = 'class=EquivalentNetwork\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConnectivityNodeContainer import ConnectivityNodeContainer +from .CGMESProfile import Profile + + +class EquivalentNetwork(ConnectivityNodeContainer): + """ + A class that represents an external meshed network that has been reduced to an electrically equivalent model. The ConnectivityNodes contained in the equivalent are intended to reflect internal nodes of the equivalent. The boundary Connectivity nodes where the equivalent connects outside itself are NOT contained by the equivalent. + + :EquivalentEquipments: The equivalent where the reduced model belongs. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "EquivalentEquipments": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConnectivityNodeContainer:\n" + ConnectivityNodeContainer.__doc__ + + def __init__(self, EquivalentEquipments = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.EquivalentEquipments = EquivalentEquipments + + def __str__(self): + str = "class=EquivalentNetwork\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/EquivalentShunt.py b/cimpy/cgmes_v2_4_15/EquivalentShunt.py index 93a9f74d..dbd99cbe 100644 --- a/cimpy/cgmes_v2_4_15/EquivalentShunt.py +++ b/cimpy/cgmes_v2_4_15/EquivalentShunt.py @@ -1,34 +1,36 @@ -from .EquivalentEquipment import EquivalentEquipment - - -class EquivalentShunt(EquivalentEquipment): - ''' - The class represents equivalent shunts. - - :b: Positive sequence shunt susceptance. Default: 0.0 - :g: Positive sequence shunt conductance. Default: 0.0 - ''' - - cgmesProfile = EquivalentEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'b': [cgmesProfile.EQ.value, ], - 'g': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EquivalentEquipment: \n' + EquivalentEquipment.__doc__ - - def __init__(self, b = 0.0, g = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.b = b - self.g = g - - def __str__(self): - str = 'class=EquivalentShunt\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EquivalentEquipment import EquivalentEquipment +from .CGMESProfile import Profile + + +class EquivalentShunt(EquivalentEquipment): + """ + The class represents equivalent shunts. + + :b: Positive sequence shunt susceptance. Default: 0.0 + :g: Positive sequence shunt conductance. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "b": [Profile.EQ.value, ], + "g": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EquivalentEquipment:\n" + EquivalentEquipment.__doc__ + + def __init__(self, b = 0.0, g = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.b = b + self.g = g + + def __str__(self): + str = "class=EquivalentShunt\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcAC1A.py b/cimpy/cgmes_v2_4_15/ExcAC1A.py index 2a2fa51d..38ed6acf 100644 --- a/cimpy/cgmes_v2_4_15/ExcAC1A.py +++ b/cimpy/cgmes_v2_4_15/ExcAC1A.py @@ -1,94 +1,96 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcAC1A(ExcitationSystemDynamics): - ''' - Modified IEEE AC1A alternator-supplied rectifier excitation system with different rate feedback source. - - :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0 - :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :ka: Voltage regulator gain (Ka). Typical Value = 400. Default: 0.0 - :ta: Voltage regulator time constant (Ta). Typical Value = 0.02. Default: 0 - :vamax: Maximum voltage regulator output (V). Typical Value = 14.5. Default: 0.0 - :vamin: Minimum voltage regulator output (V). Typical Value = -14.5. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 0.8. Default: 0 - :kf: Excitation control system stabilizer gains (Kf). Typical Value = 0.03. Default: 0.0 - :kf1: Coefficient to allow different usage of the model (Kf1). Typical Value = 0. Default: 0.0 - :kf2: Coefficient to allow different usage of the model (Kf2). Typical Value = 1. Default: 0.0 - :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 - :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 1. Default: 0 - :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.2. Default: 0.0 - :kd: Demagnetizing factor, a function of exciter alternator reactances (Kd). Typical Value = 0.38. Default: 0.0 - :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 - :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve1). Typical Value = 4.18. Default: 0.0 - :seve1: Exciter saturation function value at the corresponding exciter voltage, Ve1, back of commutating reactance (Se[Ve1]). Typical Value = 0.1. Default: 0.0 - :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve2). Typical Value = 3.14. Default: 0.0 - :seve2: Exciter saturation function value at the corresponding exciter voltage, Ve2, back of commutating reactance (Se[Ve2]). Typical Value = 0.03. Default: 0.0 - :vrmax: Maximum voltage regulator outputs (Vrmax). Typical Value = 6.03. Default: 0.0 - :vrmin: Minimum voltage regulator outputs (Rrmin). Typical Value = -5.43. Default: 0.0 - :hvlvgates: Indicates if both HV gate and LV gate are active (HVLVgates). true = gates are used false = gates are not used. Typical Value = true. Default: False - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vamax': [cgmesProfile.DY.value, ], - 'vamin': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'kf1': [cgmesProfile.DY.value, ], - 'kf2': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 've1': [cgmesProfile.DY.value, ], - 'seve1': [cgmesProfile.DY.value, ], - 've2': [cgmesProfile.DY.value, ], - 'seve2': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'hvlvgates': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, tb = 0, tc = 0, ka = 0.0, ta = 0, vamax = 0.0, vamin = 0.0, te = 0, kf = 0.0, kf1 = 0.0, kf2 = 0.0, ks = 0.0, tf = 0, kc = 0.0, kd = 0.0, ke = 0.0, ve1 = 0.0, seve1 = 0.0, ve2 = 0.0, seve2 = 0.0, vrmax = 0.0, vrmin = 0.0, hvlvgates = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tb = tb - self.tc = tc - self.ka = ka - self.ta = ta - self.vamax = vamax - self.vamin = vamin - self.te = te - self.kf = kf - self.kf1 = kf1 - self.kf2 = kf2 - self.ks = ks - self.tf = tf - self.kc = kc - self.kd = kd - self.ke = ke - self.ve1 = ve1 - self.seve1 = seve1 - self.ve2 = ve2 - self.seve2 = seve2 - self.vrmax = vrmax - self.vrmin = vrmin - self.hvlvgates = hvlvgates - - def __str__(self): - str = 'class=ExcAC1A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcAC1A(ExcitationSystemDynamics): + """ + Modified IEEE AC1A alternator-supplied rectifier excitation system with different rate feedback source. + + :hvlvgates: Indicates if both HV gate and LV gate are active (HVLVgates). true = gates are used false = gates are not used. Typical Value = true. Default: False + :ka: Voltage regulator gain (Ka). Typical Value = 400. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.2. Default: 0.0 + :kd: Demagnetizing factor, a function of exciter alternator reactances (Kd). Typical Value = 0.38. Default: 0.0 + :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gains (Kf). Typical Value = 0.03. Default: 0.0 + :kf1: Coefficient to allow different usage of the model (Kf1). Typical Value = 0. Default: 0.0 + :kf2: Coefficient to allow different usage of the model (Kf2). Typical Value = 1. Default: 0.0 + :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 + :seve1: Exciter saturation function value at the corresponding exciter voltage, Ve1, back of commutating reactance (Se[Ve1]). Typical Value = 0.1. Default: 0.0 + :seve2: Exciter saturation function value at the corresponding exciter voltage, Ve2, back of commutating reactance (Se[Ve2]). Typical Value = 0.03. Default: 0.0 + :ta: Voltage regulator time constant (Ta). Typical Value = 0.02. Default: 0.0 + :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 0.8. Default: 0.0 + :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 1. Default: 0.0 + :vamax: Maximum voltage regulator output (V). Typical Value = 14.5. Default: 0.0 + :vamin: Minimum voltage regulator output (V). Typical Value = -14.5. Default: 0.0 + :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve1). Typical Value = 4.18. Default: 0.0 + :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve2). Typical Value = 3.14. Default: 0.0 + :vrmax: Maximum voltage regulator outputs (Vrmax). Typical Value = 6.03. Default: 0.0 + :vrmin: Minimum voltage regulator outputs (Rrmin). Typical Value = -5.43. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "hvlvgates": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "kf1": [Profile.DY.value, ], + "kf2": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "seve1": [Profile.DY.value, ], + "seve2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "vamax": [Profile.DY.value, ], + "vamin": [Profile.DY.value, ], + "ve1": [Profile.DY.value, ], + "ve2": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, hvlvgates = False, ka = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, kf = 0.0, kf1 = 0.0, kf2 = 0.0, ks = 0.0, seve1 = 0.0, seve2 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, tf = 0.0, vamax = 0.0, vamin = 0.0, ve1 = 0.0, ve2 = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.hvlvgates = hvlvgates + self.ka = ka + self.kc = kc + self.kd = kd + self.ke = ke + self.kf = kf + self.kf1 = kf1 + self.kf2 = kf2 + self.ks = ks + self.seve1 = seve1 + self.seve2 = seve2 + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.tf = tf + self.vamax = vamax + self.vamin = vamin + self.ve1 = ve1 + self.ve2 = ve2 + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcAC1A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcAC2A.py b/cimpy/cgmes_v2_4_15/ExcAC2A.py index 948fe929..2213a64e 100644 --- a/cimpy/cgmes_v2_4_15/ExcAC2A.py +++ b/cimpy/cgmes_v2_4_15/ExcAC2A.py @@ -1,112 +1,114 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcAC2A(ExcitationSystemDynamics): - ''' - Modified IEEE AC2A alternator-supplied rectifier excitation system with different field current limit. - - :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0 - :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :ka: Voltage regulator gain (Ka). Typical Value = 400. Default: 0.0 - :ta: Voltage regulator time constant (Ta). Typical Value = 0.02. Default: 0 - :vamax: Maximum voltage regulator output (V). Typical Value = 8. Default: 0.0 - :vamin: Minimum voltage regulator output (V). Typical Value = -8. Default: 0.0 - :kb: Second stage regulator gain (Kb) (>0). Exciter field current controller gain. Typical Value = 25. Default: 0.0 - :kb1: Second stage regulator gain (Kb1). It is exciter field current controller gain used as alternative to Kb to represent a variant of the ExcAC2A model. Typical Value = 25. Default: 0.0 - :vrmax: Maximum voltage regulator outputs (Vrmax). Typical Value = 105. Default: 0.0 - :vrmin: Minimum voltage regulator outputs (Vrmin). Typical Value = -95. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 0.6. Default: 0 - :vfemax: Exciter field current limit reference (Vfemax). Typical Value = 4.4. Default: 0.0 - :kh: Exciter field current feedback gain (Kh). Typical Value = 1. Default: 0.0 - :kf: Excitation control system stabilizer gains (Kf). Typical Value = 0.03. Default: 0.0 - :kl: Exciter field current limiter gain (Kl). Typical Value = 10. Default: 0.0 - :vlr: Maximum exciter field current (Vlr). Typical Value = 4.4. Default: 0.0 - :kl1: Coefficient to allow different usage of the model (Kl1). Typical Value = 1. Default: 0.0 - :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 - :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 1. Default: 0 - :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.28. Default: 0.0 - :kd: Demagnetizing factor, a function of exciter alternator reactances (Kd). Typical Value = 0.35. Default: 0.0 - :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 - :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve). Typical Value = 4.4. Default: 0.0 - :seve1: Exciter saturation function value at the corresponding exciter voltage, Ve, back of commutating reactance (Se[Ve]). Typical Value = 0.037. Default: 0.0 - :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve). Typical Value = 3.3. Default: 0.0 - :seve2: Exciter saturation function value at the corresponding exciter voltage, Ve, back of commutating reactance (Se[Ve]). Typical Value = 0.012. Default: 0.0 - :hvgate: Indicates if HV gate is active (HVgate). true = gate is used false = gate is not used. Typical Value = true. Default: False - :lvgate: Indicates if LV gate is active (LVgate). true = gate is used false = gate is not used. Typical Value = true. Default: False - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vamax': [cgmesProfile.DY.value, ], - 'vamin': [cgmesProfile.DY.value, ], - 'kb': [cgmesProfile.DY.value, ], - 'kb1': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'vfemax': [cgmesProfile.DY.value, ], - 'kh': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'kl': [cgmesProfile.DY.value, ], - 'vlr': [cgmesProfile.DY.value, ], - 'kl1': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 've1': [cgmesProfile.DY.value, ], - 'seve1': [cgmesProfile.DY.value, ], - 've2': [cgmesProfile.DY.value, ], - 'seve2': [cgmesProfile.DY.value, ], - 'hvgate': [cgmesProfile.DY.value, ], - 'lvgate': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, tb = 0, tc = 0, ka = 0.0, ta = 0, vamax = 0.0, vamin = 0.0, kb = 0.0, kb1 = 0.0, vrmax = 0.0, vrmin = 0.0, te = 0, vfemax = 0.0, kh = 0.0, kf = 0.0, kl = 0.0, vlr = 0.0, kl1 = 0.0, ks = 0.0, tf = 0, kc = 0.0, kd = 0.0, ke = 0.0, ve1 = 0.0, seve1 = 0.0, ve2 = 0.0, seve2 = 0.0, hvgate = False, lvgate = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tb = tb - self.tc = tc - self.ka = ka - self.ta = ta - self.vamax = vamax - self.vamin = vamin - self.kb = kb - self.kb1 = kb1 - self.vrmax = vrmax - self.vrmin = vrmin - self.te = te - self.vfemax = vfemax - self.kh = kh - self.kf = kf - self.kl = kl - self.vlr = vlr - self.kl1 = kl1 - self.ks = ks - self.tf = tf - self.kc = kc - self.kd = kd - self.ke = ke - self.ve1 = ve1 - self.seve1 = seve1 - self.ve2 = ve2 - self.seve2 = seve2 - self.hvgate = hvgate - self.lvgate = lvgate - - def __str__(self): - str = 'class=ExcAC2A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcAC2A(ExcitationSystemDynamics): + """ + Modified IEEE AC2A alternator-supplied rectifier excitation system with different field current limit. + + :hvgate: Indicates if HV gate is active (HVgate). true = gate is used false = gate is not used. Typical Value = true. Default: False + :ka: Voltage regulator gain (Ka). Typical Value = 400. Default: 0.0 + :kb: Second stage regulator gain (Kb) (>0). Exciter field current controller gain. Typical Value = 25. Default: 0.0 + :kb1: Second stage regulator gain (Kb1). It is exciter field current controller gain used as alternative to Kb to represent a variant of the ExcAC2A model. Typical Value = 25. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.28. Default: 0.0 + :kd: Demagnetizing factor, a function of exciter alternator reactances (Kd). Typical Value = 0.35. Default: 0.0 + :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gains (Kf). Typical Value = 0.03. Default: 0.0 + :kh: Exciter field current feedback gain (Kh). Typical Value = 1. Default: 0.0 + :kl: Exciter field current limiter gain (Kl). Typical Value = 10. Default: 0.0 + :kl1: Coefficient to allow different usage of the model (Kl1). Typical Value = 1. Default: 0.0 + :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 + :lvgate: Indicates if LV gate is active (LVgate). true = gate is used false = gate is not used. Typical Value = true. Default: False + :seve1: Exciter saturation function value at the corresponding exciter voltage, Ve, back of commutating reactance (Se[Ve]). Typical Value = 0.037. Default: 0.0 + :seve2: Exciter saturation function value at the corresponding exciter voltage, Ve, back of commutating reactance (Se[Ve]). Typical Value = 0.012. Default: 0.0 + :ta: Voltage regulator time constant (Ta). Typical Value = 0.02. Default: 0.0 + :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 0.6. Default: 0.0 + :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 1. Default: 0.0 + :vamax: Maximum voltage regulator output (V). Typical Value = 8. Default: 0.0 + :vamin: Minimum voltage regulator output (V). Typical Value = -8. Default: 0.0 + :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve). Typical Value = 4.4. Default: 0.0 + :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve). Typical Value = 3.3. Default: 0.0 + :vfemax: Exciter field current limit reference (Vfemax). Typical Value = 4.4. Default: 0.0 + :vlr: Maximum exciter field current (Vlr). Typical Value = 4.4. Default: 0.0 + :vrmax: Maximum voltage regulator outputs (Vrmax). Typical Value = 105. Default: 0.0 + :vrmin: Minimum voltage regulator outputs (Vrmin). Typical Value = -95. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "hvgate": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kb": [Profile.DY.value, ], + "kb1": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "kh": [Profile.DY.value, ], + "kl": [Profile.DY.value, ], + "kl1": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "lvgate": [Profile.DY.value, ], + "seve1": [Profile.DY.value, ], + "seve2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "vamax": [Profile.DY.value, ], + "vamin": [Profile.DY.value, ], + "ve1": [Profile.DY.value, ], + "ve2": [Profile.DY.value, ], + "vfemax": [Profile.DY.value, ], + "vlr": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, hvgate = False, ka = 0.0, kb = 0.0, kb1 = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, kf = 0.0, kh = 0.0, kl = 0.0, kl1 = 0.0, ks = 0.0, lvgate = False, seve1 = 0.0, seve2 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, tf = 0.0, vamax = 0.0, vamin = 0.0, ve1 = 0.0, ve2 = 0.0, vfemax = 0.0, vlr = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.hvgate = hvgate + self.ka = ka + self.kb = kb + self.kb1 = kb1 + self.kc = kc + self.kd = kd + self.ke = ke + self.kf = kf + self.kh = kh + self.kl = kl + self.kl1 = kl1 + self.ks = ks + self.lvgate = lvgate + self.seve1 = seve1 + self.seve2 = seve2 + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.tf = tf + self.vamax = vamax + self.vamin = vamin + self.ve1 = ve1 + self.ve2 = ve2 + self.vfemax = vfemax + self.vlr = vlr + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcAC2A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcAC3A.py b/cimpy/cgmes_v2_4_15/ExcAC3A.py index 2d200fc7..232da56a 100644 --- a/cimpy/cgmes_v2_4_15/ExcAC3A.py +++ b/cimpy/cgmes_v2_4_15/ExcAC3A.py @@ -1,106 +1,108 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcAC3A(ExcitationSystemDynamics): - ''' - Modified IEEE AC3A alternator-supplied rectifier excitation system with different field current limit. - - :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0 - :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :ka: Voltage regulator gain (Ka). Typical Value = 45.62. Default: 0 - :ta: Voltage regulator time constant (Ta). Typical Value = 0.013. Default: 0.0 - :vamax: Maximum voltage regulator output (V). Typical Value = 1. Default: 0.0 - :vamin: Minimum voltage regulator output (V). Typical Value = -0.95. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 1.17. Default: 0 - :vemin: Minimum exciter voltage output (Vemin). Typical Value = 0.1. Default: 0.0 - :kr: Constant associated with regulator and alternator field power supply (Kr). Typical Value =3.77. Default: 0.0 - :kf: Excitation control system stabilizer gains (Kf). Typical Value = 0.143. Default: 0.0 - :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 1. Default: 0 - :kn: Excitation control system stabilizer gain (Kn). Typical Value =0.05. Default: 0.0 - :efdn: Value of at which feedback gain changes (Efdn). Typical Value = 2.36. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.104. Default: 0.0 - :kd: Demagnetizing factor, a function of exciter alternator reactances (Kd). Typical Value = 0.499. Default: 0.0 - :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 - :klv: Gain used in the minimum field voltage limiter loop (Klv). Typical Value = 0.194. Default: 0.0 - :kf1: Coefficient to allow different usage of the model (Kf1). Typical Value = 1. Default: 0.0 - :kf2: Coefficient to allow different usage of the model (Kf2). Typical Value = 0. Default: 0.0 - :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 - :vfemax: Exciter field current limit reference (Vfemax). Typical Value = 16. Default: 0.0 - :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve1) equals Vemax (Ve1). Typical Value = 6.24. Default: 0.0 - :seve1: Exciter saturation function value at the corresponding exciter voltage, Ve, back of commutating reactance (Se[Ve]). Typical Value = 1.143. Default: 0.0 - :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve). Typical Value = 4.68. Default: 0.0 - :seve2: Exciter saturation function value at the corresponding exciter voltage, Ve, back of commutating reactance (Se[Ve]). Typical Value = 0.1. Default: 0.0 - :vlv: Field voltage used in the minimum field voltage limiter loop (Vlv). Typical Value = 0.79. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vamax': [cgmesProfile.DY.value, ], - 'vamin': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'vemin': [cgmesProfile.DY.value, ], - 'kr': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'kn': [cgmesProfile.DY.value, ], - 'efdn': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'klv': [cgmesProfile.DY.value, ], - 'kf1': [cgmesProfile.DY.value, ], - 'kf2': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'vfemax': [cgmesProfile.DY.value, ], - 've1': [cgmesProfile.DY.value, ], - 'seve1': [cgmesProfile.DY.value, ], - 've2': [cgmesProfile.DY.value, ], - 'seve2': [cgmesProfile.DY.value, ], - 'vlv': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, tb = 0, tc = 0, ka = 0, ta = 0.0, vamax = 0.0, vamin = 0.0, te = 0, vemin = 0.0, kr = 0.0, kf = 0.0, tf = 0, kn = 0.0, efdn = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, klv = 0.0, kf1 = 0.0, kf2 = 0.0, ks = 0.0, vfemax = 0.0, ve1 = 0.0, seve1 = 0.0, ve2 = 0.0, seve2 = 0.0, vlv = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tb = tb - self.tc = tc - self.ka = ka - self.ta = ta - self.vamax = vamax - self.vamin = vamin - self.te = te - self.vemin = vemin - self.kr = kr - self.kf = kf - self.tf = tf - self.kn = kn - self.efdn = efdn - self.kc = kc - self.kd = kd - self.ke = ke - self.klv = klv - self.kf1 = kf1 - self.kf2 = kf2 - self.ks = ks - self.vfemax = vfemax - self.ve1 = ve1 - self.seve1 = seve1 - self.ve2 = ve2 - self.seve2 = seve2 - self.vlv = vlv - - def __str__(self): - str = 'class=ExcAC3A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcAC3A(ExcitationSystemDynamics): + """ + Modified IEEE AC3A alternator-supplied rectifier excitation system with different field current limit. + + :efdn: Value of at which feedback gain changes (Efdn). Typical Value = 2.36. Default: 0.0 + :ka: Voltage regulator gain (Ka). Typical Value = 45.62. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.104. Default: 0.0 + :kd: Demagnetizing factor, a function of exciter alternator reactances (Kd). Typical Value = 0.499. Default: 0.0 + :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gains (Kf). Typical Value = 0.143. Default: 0.0 + :kf1: Coefficient to allow different usage of the model (Kf1). Typical Value = 1. Default: 0.0 + :kf2: Coefficient to allow different usage of the model (Kf2). Typical Value = 0. Default: 0.0 + :klv: Gain used in the minimum field voltage limiter loop (Klv). Typical Value = 0.194. Default: 0.0 + :kn: Excitation control system stabilizer gain (Kn). Typical Value =0.05. Default: 0.0 + :kr: Constant associated with regulator and alternator field power supply (Kr). Typical Value =3.77. Default: 0.0 + :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 + :seve1: Exciter saturation function value at the corresponding exciter voltage, Ve, back of commutating reactance (Se[Ve]). Typical Value = 1.143. Default: 0.0 + :seve2: Exciter saturation function value at the corresponding exciter voltage, Ve, back of commutating reactance (Se[Ve]). Typical Value = 0.1. Default: 0.0 + :ta: Voltage regulator time constant (Ta). Typical Value = 0.013. Default: 0.0 + :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 1.17. Default: 0.0 + :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 1. Default: 0.0 + :vamax: Maximum voltage regulator output (V). Typical Value = 1. Default: 0.0 + :vamin: Minimum voltage regulator output (V). Typical Value = -0.95. Default: 0.0 + :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve1) equals Vemax (Ve1). Typical Value = 6.24. Default: 0.0 + :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve). Typical Value = 4.68. Default: 0.0 + :vemin: Minimum exciter voltage output (Vemin). Typical Value = 0.1. Default: 0.0 + :vfemax: Exciter field current limit reference (Vfemax). Typical Value = 16. Default: 0.0 + :vlv: Field voltage used in the minimum field voltage limiter loop (Vlv). Typical Value = 0.79. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efdn": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "kf1": [Profile.DY.value, ], + "kf2": [Profile.DY.value, ], + "klv": [Profile.DY.value, ], + "kn": [Profile.DY.value, ], + "kr": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "seve1": [Profile.DY.value, ], + "seve2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "vamax": [Profile.DY.value, ], + "vamin": [Profile.DY.value, ], + "ve1": [Profile.DY.value, ], + "ve2": [Profile.DY.value, ], + "vemin": [Profile.DY.value, ], + "vfemax": [Profile.DY.value, ], + "vlv": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efdn = 0.0, ka = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, kf = 0.0, kf1 = 0.0, kf2 = 0.0, klv = 0.0, kn = 0.0, kr = 0.0, ks = 0.0, seve1 = 0.0, seve2 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, tf = 0.0, vamax = 0.0, vamin = 0.0, ve1 = 0.0, ve2 = 0.0, vemin = 0.0, vfemax = 0.0, vlv = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efdn = efdn + self.ka = ka + self.kc = kc + self.kd = kd + self.ke = ke + self.kf = kf + self.kf1 = kf1 + self.kf2 = kf2 + self.klv = klv + self.kn = kn + self.kr = kr + self.ks = ks + self.seve1 = seve1 + self.seve2 = seve2 + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.tf = tf + self.vamax = vamax + self.vamin = vamin + self.ve1 = ve1 + self.ve2 = ve2 + self.vemin = vemin + self.vfemax = vfemax + self.vlv = vlv + + def __str__(self): + str = "class=ExcAC3A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcAC4A.py b/cimpy/cgmes_v2_4_15/ExcAC4A.py index cfd669fe..6a42ab40 100644 --- a/cimpy/cgmes_v2_4_15/ExcAC4A.py +++ b/cimpy/cgmes_v2_4_15/ExcAC4A.py @@ -1,55 +1,57 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcAC4A(ExcitationSystemDynamics): - ''' - Modified IEEE AC4A alternator-supplied rectifier excitation system with different minimum controller output. - - :vimax: Maximum voltage regulator input limit (Vimax). Typical Value = 10. Default: 0.0 - :vimin: Minimum voltage regulator input limit (Vimin). Typical Value = -10. Default: 0.0 - :tc: Voltage regulator time constant (Tc). Typical Value = 1. Default: 0 - :tb: Voltage regulator time constant (Tb). Typical Value = 10. Default: 0 - :ka: Voltage regulator gain (Ka). Typical Value = 200. Default: 0.0 - :ta: Voltage regulator time constant (Ta). Typical Value = 0.015. Default: 0 - :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 5.64. Default: 0.0 - :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -4.53. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'vimax': [cgmesProfile.DY.value, ], - 'vimin': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, vimax = 0.0, vimin = 0.0, tc = 0, tb = 0, ka = 0.0, ta = 0, vrmax = 0.0, vrmin = 0.0, kc = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.vimax = vimax - self.vimin = vimin - self.tc = tc - self.tb = tb - self.ka = ka - self.ta = ta - self.vrmax = vrmax - self.vrmin = vrmin - self.kc = kc - - def __str__(self): - str = 'class=ExcAC4A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcAC4A(ExcitationSystemDynamics): + """ + Modified IEEE AC4A alternator-supplied rectifier excitation system with different minimum controller output. + + :ka: Voltage regulator gain (Ka). Typical Value = 200. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0. Default: 0.0 + :ta: Voltage regulator time constant (Ta). Typical Value = 0.015. Default: 0.0 + :tb: Voltage regulator time constant (Tb). Typical Value = 10. Default: 0.0 + :tc: Voltage regulator time constant (Tc). Typical Value = 1. Default: 0.0 + :vimax: Maximum voltage regulator input limit (Vimax). Typical Value = 10. Default: 0.0 + :vimin: Minimum voltage regulator input limit (Vimin). Typical Value = -10. Default: 0.0 + :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 5.64. Default: 0.0 + :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -4.53. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "vimax": [Profile.DY.value, ], + "vimin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ka = 0.0, kc = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, vimax = 0.0, vimin = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ka = ka + self.kc = kc + self.ta = ta + self.tb = tb + self.tc = tc + self.vimax = vimax + self.vimin = vimin + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcAC4A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcAC5A.py b/cimpy/cgmes_v2_4_15/ExcAC5A.py index 18cd50e9..f253c9b1 100644 --- a/cimpy/cgmes_v2_4_15/ExcAC5A.py +++ b/cimpy/cgmes_v2_4_15/ExcAC5A.py @@ -1,82 +1,84 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcAC5A(ExcitationSystemDynamics): - ''' - Modified IEEE AC5A alternator-supplied rectifier excitation system with different minimum controller output. - - :ka: Voltage regulator gain (Ka). Typical Value = 400. Default: 0.0 - :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 - :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0 - :tc: Voltage regulator time constant (Tc). Typical Value = 0. Default: 0 - :ta: Voltage regulator time constant (Ta). Typical Value = 0.02. Default: 0 - :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 7.3. Default: 0.0 - :vrmin: Minimum voltage regulator output (Vrmin). Typical Value =-7.3. Default: 0.0 - :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 0.8. Default: 0 - :kf: Excitation control system stabilizer gains (Kf). Typical Value = 0.03. Default: 0.0 - :tf1: Excitation control system stabilizer time constant (Tf1). Typical Value = 1. Default: 0 - :tf2: Excitation control system stabilizer time constant (Tf2). Typical Value = 0.8. Default: 0 - :tf3: Excitation control system stabilizer time constant (Tf3). Typical Value = 0. Default: 0 - :efd1: Exciter voltage at which exciter saturation is defined (Efd1). Typical Value = 5.6. Default: 0.0 - :seefd1: Exciter saturation function value at the corresponding exciter voltage, Efd1 (S[Efd1]). Typical Value = 0.86. Default: 0.0 - :efd2: Exciter voltage at which exciter saturation is defined (Efd2). Typical Value = 4.2. Default: 0.0 - :seefd2: Exciter saturation function value at the corresponding exciter voltage, Efd2 (S[Efd2]). Typical Value = 0.5. Default: 0.0 - :a: Coefficient to allow different usage of the model (a). Typical Value = 1. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf1': [cgmesProfile.DY.value, ], - 'tf2': [cgmesProfile.DY.value, ], - 'tf3': [cgmesProfile.DY.value, ], - 'efd1': [cgmesProfile.DY.value, ], - 'seefd1': [cgmesProfile.DY.value, ], - 'efd2': [cgmesProfile.DY.value, ], - 'seefd2': [cgmesProfile.DY.value, ], - 'a': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, ks = 0.0, tb = 0, tc = 0, ta = 0, vrmax = 0.0, vrmin = 0.0, ke = 0.0, te = 0, kf = 0.0, tf1 = 0, tf2 = 0, tf3 = 0, efd1 = 0.0, seefd1 = 0.0, efd2 = 0.0, seefd2 = 0.0, a = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.ks = ks - self.tb = tb - self.tc = tc - self.ta = ta - self.vrmax = vrmax - self.vrmin = vrmin - self.ke = ke - self.te = te - self.kf = kf - self.tf1 = tf1 - self.tf2 = tf2 - self.tf3 = tf3 - self.efd1 = efd1 - self.seefd1 = seefd1 - self.efd2 = efd2 - self.seefd2 = seefd2 - self.a = a - - def __str__(self): - str = 'class=ExcAC5A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcAC5A(ExcitationSystemDynamics): + """ + Modified IEEE AC5A alternator-supplied rectifier excitation system with different minimum controller output. + + :a: Coefficient to allow different usage of the model (a). Typical Value = 1. Default: 0.0 + :efd1: Exciter voltage at which exciter saturation is defined (Efd1). Typical Value = 5.6. Default: 0.0 + :efd2: Exciter voltage at which exciter saturation is defined (Efd2). Typical Value = 4.2. Default: 0.0 + :ka: Voltage regulator gain (Ka). Typical Value = 400. Default: 0.0 + :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gains (Kf). Typical Value = 0.03. Default: 0.0 + :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 + :seefd1: Exciter saturation function value at the corresponding exciter voltage, Efd1 (S[Efd1]). Typical Value = 0.86. Default: 0.0 + :seefd2: Exciter saturation function value at the corresponding exciter voltage, Efd2 (S[Efd2]). Typical Value = 0.5. Default: 0.0 + :ta: Voltage regulator time constant (Ta). Typical Value = 0.02. Default: 0.0 + :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (Tc). Typical Value = 0. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 0.8. Default: 0.0 + :tf1: Excitation control system stabilizer time constant (Tf1). Typical Value = 1. Default: 0.0 + :tf2: Excitation control system stabilizer time constant (Tf2). Typical Value = 0.8. Default: 0.0 + :tf3: Excitation control system stabilizer time constant (Tf3). Typical Value = 0. Default: 0.0 + :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 7.3. Default: 0.0 + :vrmin: Minimum voltage regulator output (Vrmin). Typical Value =-7.3. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "a": [Profile.DY.value, ], + "efd1": [Profile.DY.value, ], + "efd2": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "seefd1": [Profile.DY.value, ], + "seefd2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf1": [Profile.DY.value, ], + "tf2": [Profile.DY.value, ], + "tf3": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, a = 0.0, efd1 = 0.0, efd2 = 0.0, ka = 0.0, ke = 0.0, kf = 0.0, ks = 0.0, seefd1 = 0.0, seefd2 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, tf1 = 0.0, tf2 = 0.0, tf3 = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.a = a + self.efd1 = efd1 + self.efd2 = efd2 + self.ka = ka + self.ke = ke + self.kf = kf + self.ks = ks + self.seefd1 = seefd1 + self.seefd2 = seefd2 + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.tf1 = tf1 + self.tf2 = tf2 + self.tf3 = tf3 + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcAC5A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcAC6A.py b/cimpy/cgmes_v2_4_15/ExcAC6A.py index 6c405929..62ad5497 100644 --- a/cimpy/cgmes_v2_4_15/ExcAC6A.py +++ b/cimpy/cgmes_v2_4_15/ExcAC6A.py @@ -1,97 +1,99 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcAC6A(ExcitationSystemDynamics): - ''' - Modified IEEE AC6A alternator-supplied rectifier excitation system with speed input. - - :ka: Voltage regulator gain (Ka). Typical Value = 536. Default: 0.0 - :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 - :ta: Voltage regulator time constant (Ta). Typical Value = 0.086. Default: 0 - :tk: Voltage regulator time constant (Tk). Typical Value = 0.18. Default: 0 - :tb: Voltage regulator time constant (Tb). Typical Value = 9. Default: 0 - :tc: Voltage regulator time constant (Tc). Typical Value = 3. Default: 0 - :vamax: Maximum voltage regulator output (Vamax). Typical Value = 75. Default: 0.0 - :vamin: Minimum voltage regulator output (Vamin). Typical Value = -75. Default: 0.0 - :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 44. Default: 0.0 - :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -36. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 1. Default: 0 - :kh: Exciter field current limiter gain (Kh). Typical Value = 92. Default: 0.0 - :tj: Exciter field current limiter time constant (Tj). Typical Value = 0.02. Default: 0 - :th: Exciter field current limiter time constant (Th). Typical Value = 0.08. Default: 0 - :vfelim: Exciter field current limit reference (Vfelim). Typical Value = 19. Default: 0.0 - :vhmax: Maximum field current limiter signal reference (Vhmax). Typical Value = 75. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.173. Default: 0.0 - :kd: Demagnetizing factor, a function of exciter alternator reactances (Kd). Typical Value = 1.91. Default: 0.0 - :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1.6. Default: 0.0 - :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve). Typical Value = 7.4. Default: 0.0 - :seve1: Exciter saturation function value at the corresponding exciter voltage, Ve1, back of commutating reactance (Se[Ve1]). Typical Value = 0.214. Default: 0.0 - :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve2). Typical Value = 5.55. Default: 0.0 - :seve2: Exciter saturation function value at the corresponding exciter voltage, Ve2, back of commutating reactance (Se[Ve2]). Typical Value = 0.044. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tk': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'vamax': [cgmesProfile.DY.value, ], - 'vamin': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kh': [cgmesProfile.DY.value, ], - 'tj': [cgmesProfile.DY.value, ], - 'th': [cgmesProfile.DY.value, ], - 'vfelim': [cgmesProfile.DY.value, ], - 'vhmax': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 've1': [cgmesProfile.DY.value, ], - 'seve1': [cgmesProfile.DY.value, ], - 've2': [cgmesProfile.DY.value, ], - 'seve2': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, ks = 0.0, ta = 0, tk = 0, tb = 0, tc = 0, vamax = 0.0, vamin = 0.0, vrmax = 0.0, vrmin = 0.0, te = 0, kh = 0.0, tj = 0, th = 0, vfelim = 0.0, vhmax = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, ve1 = 0.0, seve1 = 0.0, ve2 = 0.0, seve2 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.ks = ks - self.ta = ta - self.tk = tk - self.tb = tb - self.tc = tc - self.vamax = vamax - self.vamin = vamin - self.vrmax = vrmax - self.vrmin = vrmin - self.te = te - self.kh = kh - self.tj = tj - self.th = th - self.vfelim = vfelim - self.vhmax = vhmax - self.kc = kc - self.kd = kd - self.ke = ke - self.ve1 = ve1 - self.seve1 = seve1 - self.ve2 = ve2 - self.seve2 = seve2 - - def __str__(self): - str = 'class=ExcAC6A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcAC6A(ExcitationSystemDynamics): + """ + Modified IEEE AC6A alternator-supplied rectifier excitation system with speed input. + + :ka: Voltage regulator gain (Ka). Typical Value = 536. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.173. Default: 0.0 + :kd: Demagnetizing factor, a function of exciter alternator reactances (Kd). Typical Value = 1.91. Default: 0.0 + :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1.6. Default: 0.0 + :kh: Exciter field current limiter gain (Kh). Typical Value = 92. Default: 0.0 + :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 + :seve1: Exciter saturation function value at the corresponding exciter voltage, Ve1, back of commutating reactance (Se[Ve1]). Typical Value = 0.214. Default: 0.0 + :seve2: Exciter saturation function value at the corresponding exciter voltage, Ve2, back of commutating reactance (Se[Ve2]). Typical Value = 0.044. Default: 0.0 + :ta: Voltage regulator time constant (Ta). Typical Value = 0.086. Default: 0.0 + :tb: Voltage regulator time constant (Tb). Typical Value = 9. Default: 0.0 + :tc: Voltage regulator time constant (Tc). Typical Value = 3. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 1. Default: 0.0 + :th: Exciter field current limiter time constant (Th). Typical Value = 0.08. Default: 0.0 + :tj: Exciter field current limiter time constant (Tj). Typical Value = 0.02. Default: 0.0 + :tk: Voltage regulator time constant (Tk). Typical Value = 0.18. Default: 0.0 + :vamax: Maximum voltage regulator output (Vamax). Typical Value = 75. Default: 0.0 + :vamin: Minimum voltage regulator output (Vamin). Typical Value = -75. Default: 0.0 + :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve). Typical Value = 7.4. Default: 0.0 + :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve2). Typical Value = 5.55. Default: 0.0 + :vfelim: Exciter field current limit reference (Vfelim). Typical Value = 19. Default: 0.0 + :vhmax: Maximum field current limiter signal reference (Vhmax). Typical Value = 75. Default: 0.0 + :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 44. Default: 0.0 + :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -36. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kh": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "seve1": [Profile.DY.value, ], + "seve2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "th": [Profile.DY.value, ], + "tj": [Profile.DY.value, ], + "tk": [Profile.DY.value, ], + "vamax": [Profile.DY.value, ], + "vamin": [Profile.DY.value, ], + "ve1": [Profile.DY.value, ], + "ve2": [Profile.DY.value, ], + "vfelim": [Profile.DY.value, ], + "vhmax": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ka = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, kh = 0.0, ks = 0.0, seve1 = 0.0, seve2 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, th = 0.0, tj = 0.0, tk = 0.0, vamax = 0.0, vamin = 0.0, ve1 = 0.0, ve2 = 0.0, vfelim = 0.0, vhmax = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ka = ka + self.kc = kc + self.kd = kd + self.ke = ke + self.kh = kh + self.ks = ks + self.seve1 = seve1 + self.seve2 = seve2 + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.th = th + self.tj = tj + self.tk = tk + self.vamax = vamax + self.vamin = vamin + self.ve1 = ve1 + self.ve2 = ve2 + self.vfelim = vfelim + self.vhmax = vhmax + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcAC6A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcAC8B.py b/cimpy/cgmes_v2_4_15/ExcAC8B.py index dbf861a6..9479cdbe 100644 --- a/cimpy/cgmes_v2_4_15/ExcAC8B.py +++ b/cimpy/cgmes_v2_4_15/ExcAC8B.py @@ -1,109 +1,111 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcAC8B(ExcitationSystemDynamics): - ''' - Modified IEEE AC8B alternator-supplied rectifier excitation system with speed input and input limiter. - - :inlim: Input limiter indicator. true = input limiter Vimax and Vimin is considered false = input limiter Vimax and Vimin is not considered. Typical Value = true. Default: False - :ka: Voltage regulator gain (Ka). Typical Value = 1. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.55. Default: 0.0 - :kd: Demagnetizing factor, a function of exciter alternator reactances (Kd). Typical Value = 1.1. Default: 0.0 - :kdr: Voltage regulator derivative gain (Kdr). Typical Value = 10. Default: 0.0 - :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 - :kir: Voltage regulator integral gain (Kir). Typical Value = 5. Default: 0.0 - :kpr: Voltage regulator proportional gain (Kpr). Typical Value = 80. Default: 0.0 - :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 - :pidlim: PID limiter indicator. true = input limiter Vpidmax and Vpidmin is considered false = input limiter Vpidmax and Vpidmin is not considered. Typical Value = true. Default: False - :seve1: Exciter saturation function value at the corresponding exciter voltage, Ve, back of commutating reactance (Se[Ve1]). Typical Value = 0.3. Default: 0.0 - :seve2: Exciter saturation function value at the corresponding exciter voltage, Ve, back of commutating reactance (Se[Ve2]). Typical Value = 3. Default: 0.0 - :ta: Voltage regulator time constant (Ta). Typical Value = 0. Default: 0 - :tdr: Lag time constant (Tdr). Typical Value = 0.1. Default: 0 - :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 1.2. Default: 0 - :telim: Selector for the limiter on the block [1/sTe]. See diagram for meaning of true and false. Typical Value = false. Default: False - :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve) equals V (Ve1). Typical Value = 6.5. Default: 0.0 - :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve). Typical Value = 9. Default: 0.0 - :vemin: Minimum exciter voltage output (Vemin). Typical Value = 0. Default: 0.0 - :vfemax: Exciter field current limit reference (Vfemax). Typical Value = 6. Default: 0.0 - :vimax: Input signal maximum (Vimax). Typical Value = 35. Default: 0.0 - :vimin: Input signal minimum (Vimin). Typical Value = -10. Default: 0.0 - :vpidmax: PID maximum controller output (Vpidmax). Typical Value = 35. Default: 0.0 - :vpidmin: PID minimum controller output (Vpidmin). Typical Value = -10. Default: 0.0 - :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 35. Default: 0.0 - :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = 0. Default: 0.0 - :vtmult: Multiply by generator`s terminal voltage indicator. true =the limits Vrmax and Vrmin are multiplied by the generator`s terminal voltage to represent a thyristor power stage fed from the generator terminals false = limits are not multiplied by generator`s terminal voltage. Typical Value = false. Default: False - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'inlim': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'kdr': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'kir': [cgmesProfile.DY.value, ], - 'kpr': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'pidlim': [cgmesProfile.DY.value, ], - 'seve1': [cgmesProfile.DY.value, ], - 'seve2': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tdr': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'telim': [cgmesProfile.DY.value, ], - 've1': [cgmesProfile.DY.value, ], - 've2': [cgmesProfile.DY.value, ], - 'vemin': [cgmesProfile.DY.value, ], - 'vfemax': [cgmesProfile.DY.value, ], - 'vimax': [cgmesProfile.DY.value, ], - 'vimin': [cgmesProfile.DY.value, ], - 'vpidmax': [cgmesProfile.DY.value, ], - 'vpidmin': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'vtmult': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, inlim = False, ka = 0.0, kc = 0.0, kd = 0.0, kdr = 0.0, ke = 0.0, kir = 0.0, kpr = 0.0, ks = 0.0, pidlim = False, seve1 = 0.0, seve2 = 0.0, ta = 0, tdr = 0, te = 0, telim = False, ve1 = 0.0, ve2 = 0.0, vemin = 0.0, vfemax = 0.0, vimax = 0.0, vimin = 0.0, vpidmax = 0.0, vpidmin = 0.0, vrmax = 0.0, vrmin = 0.0, vtmult = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.inlim = inlim - self.ka = ka - self.kc = kc - self.kd = kd - self.kdr = kdr - self.ke = ke - self.kir = kir - self.kpr = kpr - self.ks = ks - self.pidlim = pidlim - self.seve1 = seve1 - self.seve2 = seve2 - self.ta = ta - self.tdr = tdr - self.te = te - self.telim = telim - self.ve1 = ve1 - self.ve2 = ve2 - self.vemin = vemin - self.vfemax = vfemax - self.vimax = vimax - self.vimin = vimin - self.vpidmax = vpidmax - self.vpidmin = vpidmin - self.vrmax = vrmax - self.vrmin = vrmin - self.vtmult = vtmult - - def __str__(self): - str = 'class=ExcAC8B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcAC8B(ExcitationSystemDynamics): + """ + Modified IEEE AC8B alternator-supplied rectifier excitation system with speed input and input limiter. + + :inlim: Input limiter indicator. true = input limiter Vimax and Vimin is considered false = input limiter Vimax and Vimin is not considered. Typical Value = true. Default: False + :ka: Voltage regulator gain (Ka). Typical Value = 1. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.55. Default: 0.0 + :kd: Demagnetizing factor, a function of exciter alternator reactances (Kd). Typical Value = 1.1. Default: 0.0 + :kdr: Voltage regulator derivative gain (Kdr). Typical Value = 10. Default: 0.0 + :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 + :kir: Voltage regulator integral gain (Kir). Typical Value = 5. Default: 0.0 + :kpr: Voltage regulator proportional gain (Kpr). Typical Value = 80. Default: 0.0 + :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 + :pidlim: PID limiter indicator. true = input limiter Vpidmax and Vpidmin is considered false = input limiter Vpidmax and Vpidmin is not considered. Typical Value = true. Default: False + :seve1: Exciter saturation function value at the corresponding exciter voltage, Ve, back of commutating reactance (Se[Ve1]). Typical Value = 0.3. Default: 0.0 + :seve2: Exciter saturation function value at the corresponding exciter voltage, Ve, back of commutating reactance (Se[Ve2]). Typical Value = 3. Default: 0.0 + :ta: Voltage regulator time constant (Ta). Typical Value = 0. Default: 0.0 + :tdr: Lag time constant (Tdr). Typical Value = 0.1. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 1.2. Default: 0.0 + :telim: Selector for the limiter on the block [1/sTe]. See diagram for meaning of true and false. Typical Value = false. Default: False + :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve) equals V (Ve1). Typical Value = 6.5. Default: 0.0 + :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve). Typical Value = 9. Default: 0.0 + :vemin: Minimum exciter voltage output (Vemin). Typical Value = 0. Default: 0.0 + :vfemax: Exciter field current limit reference (Vfemax). Typical Value = 6. Default: 0.0 + :vimax: Input signal maximum (Vimax). Typical Value = 35. Default: 0.0 + :vimin: Input signal minimum (Vimin). Typical Value = -10. Default: 0.0 + :vpidmax: PID maximum controller output (Vpidmax). Typical Value = 35. Default: 0.0 + :vpidmin: PID minimum controller output (Vpidmin). Typical Value = -10. Default: 0.0 + :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 35. Default: 0.0 + :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = 0. Default: 0.0 + :vtmult: Multiply by generator`s terminal voltage indicator. true =the limits Vrmax and Vrmin are multiplied by the generator`s terminal voltage to represent a thyristor power stage fed from the generator terminals false = limits are not multiplied by generator`s terminal voltage. Typical Value = false. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "inlim": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "kdr": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kir": [Profile.DY.value, ], + "kpr": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "pidlim": [Profile.DY.value, ], + "seve1": [Profile.DY.value, ], + "seve2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tdr": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "telim": [Profile.DY.value, ], + "ve1": [Profile.DY.value, ], + "ve2": [Profile.DY.value, ], + "vemin": [Profile.DY.value, ], + "vfemax": [Profile.DY.value, ], + "vimax": [Profile.DY.value, ], + "vimin": [Profile.DY.value, ], + "vpidmax": [Profile.DY.value, ], + "vpidmin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + "vtmult": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, inlim = False, ka = 0.0, kc = 0.0, kd = 0.0, kdr = 0.0, ke = 0.0, kir = 0.0, kpr = 0.0, ks = 0.0, pidlim = False, seve1 = 0.0, seve2 = 0.0, ta = 0.0, tdr = 0.0, te = 0.0, telim = False, ve1 = 0.0, ve2 = 0.0, vemin = 0.0, vfemax = 0.0, vimax = 0.0, vimin = 0.0, vpidmax = 0.0, vpidmin = 0.0, vrmax = 0.0, vrmin = 0.0, vtmult = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.inlim = inlim + self.ka = ka + self.kc = kc + self.kd = kd + self.kdr = kdr + self.ke = ke + self.kir = kir + self.kpr = kpr + self.ks = ks + self.pidlim = pidlim + self.seve1 = seve1 + self.seve2 = seve2 + self.ta = ta + self.tdr = tdr + self.te = te + self.telim = telim + self.ve1 = ve1 + self.ve2 = ve2 + self.vemin = vemin + self.vfemax = vfemax + self.vimax = vimax + self.vimin = vimin + self.vpidmax = vpidmax + self.vpidmin = vpidmin + self.vrmax = vrmax + self.vrmin = vrmin + self.vtmult = vtmult + + def __str__(self): + str = "class=ExcAC8B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcANS.py b/cimpy/cgmes_v2_4_15/ExcANS.py index 7711af93..fe14d19c 100644 --- a/cimpy/cgmes_v2_4_15/ExcANS.py +++ b/cimpy/cgmes_v2_4_15/ExcANS.py @@ -1,70 +1,72 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcANS(ExcitationSystemDynamics): - ''' - Italian excitation system. It represents static field voltage or excitation current feedback excitation system. - - :k3: AVR gain (K). Typical Value = 1000. Default: 0.0 - :k2: Exciter gain (K). Typical Value = 20. Default: 0.0 - :kce: Ceiling factor (K). Typical Value = 1. Default: 0.0 - :t3: Time constant (T). Typical Value = 1.6. Default: 0 - :t2: Time constant (T). Typical Value = 0.05. Default: 0 - :t1: Time constant (T). Typical Value = 20. Default: 0 - :blint: Governor Control Flag (BLINT). 0 = lead-lag regulator 1 = proportional integral regulator. Typical Value = 0. Default: 0 - :kvfif: Rate feedback signal flag (K). 0 = output voltage of the exciter 1 = exciter field current. Typical Value = 0. Default: 0 - :ifmn: Minimum exciter current (I). Typical Value = -5.2. Default: 0.0 - :ifmx: Maximum exciter current (I). Typical Value = 6.5. Default: 0.0 - :vrmn: Maximum AVR output (V). Typical Value = -5.2. Default: 0.0 - :vrmx: Minimum AVR output (V). Typical Value = 6.5. Default: 0.0 - :krvecc: Feedback enabling (K). 0 = Open loop control 1 = Closed loop control. Typical Value = 1. Default: 0 - :tb: Exciter time constant (T). Typical Value = 0.04. Default: 0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'k3': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - 'kce': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 'blint': [cgmesProfile.DY.value, ], - 'kvfif': [cgmesProfile.DY.value, ], - 'ifmn': [cgmesProfile.DY.value, ], - 'ifmx': [cgmesProfile.DY.value, ], - 'vrmn': [cgmesProfile.DY.value, ], - 'vrmx': [cgmesProfile.DY.value, ], - 'krvecc': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, k3 = 0.0, k2 = 0.0, kce = 0.0, t3 = 0, t2 = 0, t1 = 0, blint = 0, kvfif = 0, ifmn = 0.0, ifmx = 0.0, vrmn = 0.0, vrmx = 0.0, krvecc = 0, tb = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.k3 = k3 - self.k2 = k2 - self.kce = kce - self.t3 = t3 - self.t2 = t2 - self.t1 = t1 - self.blint = blint - self.kvfif = kvfif - self.ifmn = ifmn - self.ifmx = ifmx - self.vrmn = vrmn - self.vrmx = vrmx - self.krvecc = krvecc - self.tb = tb - - def __str__(self): - str = 'class=ExcANS\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcANS(ExcitationSystemDynamics): + """ + Italian excitation system. It represents static field voltage or excitation current feedback excitation system. + + :blint: Governor Control Flag (BLINT). 0 = lead-lag regulator 1 = proportional integral regulator. Typical Value = 0. Default: 0 + :ifmn: Minimum exciter current (I). Typical Value = -5.2. Default: 0.0 + :ifmx: Maximum exciter current (I). Typical Value = 6.5. Default: 0.0 + :k2: Exciter gain (K). Typical Value = 20. Default: 0.0 + :k3: AVR gain (K). Typical Value = 1000. Default: 0.0 + :kce: Ceiling factor (K). Typical Value = 1. Default: 0.0 + :krvecc: Feedback enabling (K). 0 = Open loop control 1 = Closed loop control. Typical Value = 1. Default: 0 + :kvfif: Rate feedback signal flag (K). 0 = output voltage of the exciter 1 = exciter field current. Typical Value = 0. Default: 0 + :t1: Time constant (T). Typical Value = 20. Default: 0.0 + :t2: Time constant (T). Typical Value = 0.05. Default: 0.0 + :t3: Time constant (T). Typical Value = 1.6. Default: 0.0 + :tb: Exciter time constant (T). Typical Value = 0.04. Default: 0.0 + :vrmn: Maximum AVR output (V). Typical Value = -5.2. Default: 0.0 + :vrmx: Minimum AVR output (V). Typical Value = 6.5. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "blint": [Profile.DY.value, ], + "ifmn": [Profile.DY.value, ], + "ifmx": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "k3": [Profile.DY.value, ], + "kce": [Profile.DY.value, ], + "krvecc": [Profile.DY.value, ], + "kvfif": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "vrmn": [Profile.DY.value, ], + "vrmx": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, blint = 0, ifmn = 0.0, ifmx = 0.0, k2 = 0.0, k3 = 0.0, kce = 0.0, krvecc = 0, kvfif = 0, t1 = 0.0, t2 = 0.0, t3 = 0.0, tb = 0.0, vrmn = 0.0, vrmx = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.blint = blint + self.ifmn = ifmn + self.ifmx = ifmx + self.k2 = k2 + self.k3 = k3 + self.kce = kce + self.krvecc = krvecc + self.kvfif = kvfif + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.tb = tb + self.vrmn = vrmn + self.vrmx = vrmx + + def __str__(self): + str = "class=ExcANS\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcAVR1.py b/cimpy/cgmes_v2_4_15/ExcAVR1.py index 7a0d3a01..6c2a5b1f 100644 --- a/cimpy/cgmes_v2_4_15/ExcAVR1.py +++ b/cimpy/cgmes_v2_4_15/ExcAVR1.py @@ -1,64 +1,66 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcAVR1(ExcitationSystemDynamics): - ''' - Italian excitation system corresponding to IEEE (1968) Type 1 Model. It represents exciter dynamo and electromechanical regulator. - - :ka: AVR gain (K). Typical Value = 500. Default: 0.0 - :vrmn: Maximum AVR output (V). Typical Value = -6. Default: 0.0 - :vrmx: Minimum AVR output (V). Typical Value = 7. Default: 0.0 - :ta: AVR time constant (T). Typical Value = 0.2. Default: 0 - :tb: AVR time constant (T). Typical Value = 0. Default: 0 - :te: Exciter time constant (T). Typical Value = 1. Default: 0 - :e1: Field voltage value 1 (E1). Typical Value = 4.18. Default: 0.0 - :se1: Saturation factor at E1 (S(E1)). Typical Value = 0.1. Default: 0.0 - :e2: Field voltage value 2 (E2). Typical Value = 3.14. Default: 0.0 - :se2: Saturation factor at E2 (S(E2)). Typical Value = 0.03. Default: 0.0 - :kf: Rate feedback gain (K). Typical Value = 0.02. Default: 0.0 - :tf: Rate feedback time constant (T). Typical Value = 1. Default: 0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'vrmn': [cgmesProfile.DY.value, ], - 'vrmx': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'e1': [cgmesProfile.DY.value, ], - 'se1': [cgmesProfile.DY.value, ], - 'e2': [cgmesProfile.DY.value, ], - 'se2': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, vrmn = 0.0, vrmx = 0.0, ta = 0, tb = 0, te = 0, e1 = 0.0, se1 = 0.0, e2 = 0.0, se2 = 0.0, kf = 0.0, tf = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.vrmn = vrmn - self.vrmx = vrmx - self.ta = ta - self.tb = tb - self.te = te - self.e1 = e1 - self.se1 = se1 - self.e2 = e2 - self.se2 = se2 - self.kf = kf - self.tf = tf - - def __str__(self): - str = 'class=ExcAVR1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcAVR1(ExcitationSystemDynamics): + """ + Italian excitation system corresponding to IEEE (1968) Type 1 Model. It represents exciter dynamo and electromechanical regulator. + + :e1: Field voltage value 1 (E1). Typical Value = 4.18. Default: 0.0 + :e2: Field voltage value 2 (E2). Typical Value = 3.14. Default: 0.0 + :ka: AVR gain (K). Typical Value = 500. Default: 0.0 + :kf: Rate feedback gain (K). Typical Value = 0.02. Default: 0.0 + :se1: Saturation factor at E1 (S(E1)). Typical Value = 0.1. Default: 0.0 + :se2: Saturation factor at E2 (S(E2)). Typical Value = 0.03. Default: 0.0 + :ta: AVR time constant (T). Typical Value = 0.2. Default: 0.0 + :tb: AVR time constant (T). Typical Value = 0. Default: 0.0 + :te: Exciter time constant (T). Typical Value = 1. Default: 0.0 + :tf: Rate feedback time constant (T). Typical Value = 1. Default: 0.0 + :vrmn: Maximum AVR output (V). Typical Value = -6. Default: 0.0 + :vrmx: Minimum AVR output (V). Typical Value = 7. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "e1": [Profile.DY.value, ], + "e2": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "se1": [Profile.DY.value, ], + "se2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "vrmn": [Profile.DY.value, ], + "vrmx": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, e1 = 0.0, e2 = 0.0, ka = 0.0, kf = 0.0, se1 = 0.0, se2 = 0.0, ta = 0.0, tb = 0.0, te = 0.0, tf = 0.0, vrmn = 0.0, vrmx = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.e1 = e1 + self.e2 = e2 + self.ka = ka + self.kf = kf + self.se1 = se1 + self.se2 = se2 + self.ta = ta + self.tb = tb + self.te = te + self.tf = tf + self.vrmn = vrmn + self.vrmx = vrmx + + def __str__(self): + str = "class=ExcAVR1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcAVR2.py b/cimpy/cgmes_v2_4_15/ExcAVR2.py index 0912ab32..7dcf2c1d 100644 --- a/cimpy/cgmes_v2_4_15/ExcAVR2.py +++ b/cimpy/cgmes_v2_4_15/ExcAVR2.py @@ -1,67 +1,69 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcAVR2(ExcitationSystemDynamics): - ''' - Italian excitation system corresponding to IEEE (1968) Type 2 Model. It represents alternator and rotating diodes and electromechanic voltage regulators. - - :ka: AVR gain (K). Typical Value = 500. Default: 0.0 - :vrmn: Maximum AVR output (V). Typical Value = -6. Default: 0.0 - :vrmx: Minimum AVR output (V). Typical Value = 7. Default: 0.0 - :ta: AVR time constant (T). Typical Value = 0.02. Default: 0 - :tb: AVR time constant (T). Typical Value = 0. Default: 0 - :te: Exciter time constant (T). Typical Value = 1. Default: 0 - :e1: Field voltage value 1 (E1). Typical Value = 4.18. Default: 0.0 - :se1: Saturation factor at E1 (S(E1)). Typical Value = 0.1. Default: 0.0 - :e2: Field voltage value 2 (E2). Typical Value = 3.14. Default: 0.0 - :se2: Saturation factor at E2 (S(E2)). Typical Value = 0.03. Default: 0.0 - :kf: Rate feedback gain (K). Typical Value = 0.02. Default: 0.0 - :tf1: Rate feedback time constant (T). Typical Value = 1. Default: 0 - :tf2: Rate feedback time constant (T). Typical Value = 1. Default: 0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'vrmn': [cgmesProfile.DY.value, ], - 'vrmx': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'e1': [cgmesProfile.DY.value, ], - 'se1': [cgmesProfile.DY.value, ], - 'e2': [cgmesProfile.DY.value, ], - 'se2': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf1': [cgmesProfile.DY.value, ], - 'tf2': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, vrmn = 0.0, vrmx = 0.0, ta = 0, tb = 0, te = 0, e1 = 0.0, se1 = 0.0, e2 = 0.0, se2 = 0.0, kf = 0.0, tf1 = 0, tf2 = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.vrmn = vrmn - self.vrmx = vrmx - self.ta = ta - self.tb = tb - self.te = te - self.e1 = e1 - self.se1 = se1 - self.e2 = e2 - self.se2 = se2 - self.kf = kf - self.tf1 = tf1 - self.tf2 = tf2 - - def __str__(self): - str = 'class=ExcAVR2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcAVR2(ExcitationSystemDynamics): + """ + Italian excitation system corresponding to IEEE (1968) Type 2 Model. It represents alternator and rotating diodes and electromechanic voltage regulators. + + :e1: Field voltage value 1 (E1). Typical Value = 4.18. Default: 0.0 + :e2: Field voltage value 2 (E2). Typical Value = 3.14. Default: 0.0 + :ka: AVR gain (K). Typical Value = 500. Default: 0.0 + :kf: Rate feedback gain (K). Typical Value = 0.02. Default: 0.0 + :se1: Saturation factor at E1 (S(E1)). Typical Value = 0.1. Default: 0.0 + :se2: Saturation factor at E2 (S(E2)). Typical Value = 0.03. Default: 0.0 + :ta: AVR time constant (T). Typical Value = 0.02. Default: 0.0 + :tb: AVR time constant (T). Typical Value = 0. Default: 0.0 + :te: Exciter time constant (T). Typical Value = 1. Default: 0.0 + :tf1: Rate feedback time constant (T). Typical Value = 1. Default: 0.0 + :tf2: Rate feedback time constant (T). Typical Value = 1. Default: 0.0 + :vrmn: Maximum AVR output (V). Typical Value = -6. Default: 0.0 + :vrmx: Minimum AVR output (V). Typical Value = 7. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "e1": [Profile.DY.value, ], + "e2": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "se1": [Profile.DY.value, ], + "se2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf1": [Profile.DY.value, ], + "tf2": [Profile.DY.value, ], + "vrmn": [Profile.DY.value, ], + "vrmx": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, e1 = 0.0, e2 = 0.0, ka = 0.0, kf = 0.0, se1 = 0.0, se2 = 0.0, ta = 0.0, tb = 0.0, te = 0.0, tf1 = 0.0, tf2 = 0.0, vrmn = 0.0, vrmx = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.e1 = e1 + self.e2 = e2 + self.ka = ka + self.kf = kf + self.se1 = se1 + self.se2 = se2 + self.ta = ta + self.tb = tb + self.te = te + self.tf1 = tf1 + self.tf2 = tf2 + self.vrmn = vrmn + self.vrmx = vrmx + + def __str__(self): + str = "class=ExcAVR2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcAVR3.py b/cimpy/cgmes_v2_4_15/ExcAVR3.py index f111b896..609adf03 100644 --- a/cimpy/cgmes_v2_4_15/ExcAVR3.py +++ b/cimpy/cgmes_v2_4_15/ExcAVR3.py @@ -1,64 +1,66 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcAVR3(ExcitationSystemDynamics): - ''' - Italian excitation system. It represents exciter dynamo and electric regulator. - - :ka: AVR gain (K). Typical Value = 3000. Default: 0.0 - :vrmn: Maximum AVR output (V). Typical Value = -7.5. Default: 0.0 - :vrmx: Minimum AVR output (V). Typical Value = 7.5. Default: 0.0 - :t1: AVR time constant (T). Typical Value = 220. Default: 0 - :t2: AVR time constant (T). Typical Value = 1.6. Default: 0 - :t3: AVR time constant (T). Typical Value = 0.66. Default: 0 - :t4: AVR time constant (T). Typical Value = 0.07. Default: 0 - :te: Exciter time constant (T). Typical Value = 1. Default: 0 - :e1: Field voltage value 1 (E1). Typical Value = 4.18. Default: 0.0 - :se1: Saturation factor at E1 (S(E1)). Typical Value = 0.1. Default: 0.0 - :e2: Field voltage value 2 (E2). Typical Value = 3.14. Default: 0.0 - :se2: Saturation factor at E2 (S(E2)). Typical Value = 0.03. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'vrmn': [cgmesProfile.DY.value, ], - 'vrmx': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'e1': [cgmesProfile.DY.value, ], - 'se1': [cgmesProfile.DY.value, ], - 'e2': [cgmesProfile.DY.value, ], - 'se2': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, vrmn = 0.0, vrmx = 0.0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, te = 0, e1 = 0.0, se1 = 0.0, e2 = 0.0, se2 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.vrmn = vrmn - self.vrmx = vrmx - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.te = te - self.e1 = e1 - self.se1 = se1 - self.e2 = e2 - self.se2 = se2 - - def __str__(self): - str = 'class=ExcAVR3\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcAVR3(ExcitationSystemDynamics): + """ + Italian excitation system. It represents exciter dynamo and electric regulator. + + :e1: Field voltage value 1 (E1). Typical Value = 4.18. Default: 0.0 + :e2: Field voltage value 2 (E2). Typical Value = 3.14. Default: 0.0 + :ka: AVR gain (K). Typical Value = 3000. Default: 0.0 + :se1: Saturation factor at E1 (S(E1)). Typical Value = 0.1. Default: 0.0 + :se2: Saturation factor at E2 (S(E2)). Typical Value = 0.03. Default: 0.0 + :t1: AVR time constant (T). Typical Value = 220. Default: 0.0 + :t2: AVR time constant (T). Typical Value = 1.6. Default: 0.0 + :t3: AVR time constant (T). Typical Value = 0.66. Default: 0.0 + :t4: AVR time constant (T). Typical Value = 0.07. Default: 0.0 + :te: Exciter time constant (T). Typical Value = 1. Default: 0.0 + :vrmn: Maximum AVR output (V). Typical Value = -7.5. Default: 0.0 + :vrmx: Minimum AVR output (V). Typical Value = 7.5. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "e1": [Profile.DY.value, ], + "e2": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "se1": [Profile.DY.value, ], + "se2": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "vrmn": [Profile.DY.value, ], + "vrmx": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, e1 = 0.0, e2 = 0.0, ka = 0.0, se1 = 0.0, se2 = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, te = 0.0, vrmn = 0.0, vrmx = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.e1 = e1 + self.e2 = e2 + self.ka = ka + self.se1 = se1 + self.se2 = se2 + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.te = te + self.vrmn = vrmn + self.vrmx = vrmx + + def __str__(self): + str = "class=ExcAVR3\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcAVR4.py b/cimpy/cgmes_v2_4_15/ExcAVR4.py index d51d49f1..52071adb 100644 --- a/cimpy/cgmes_v2_4_15/ExcAVR4.py +++ b/cimpy/cgmes_v2_4_15/ExcAVR4.py @@ -1,70 +1,72 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcAVR4(ExcitationSystemDynamics): - ''' - Italian excitation system. It represents static exciter and electric voltage regulator. - - :ka: AVR gain (K). Typical Value = 300. Default: 0.0 - :vrmn: Maximum AVR output (V). Typical Value = 0. Default: 0.0 - :vrmx: Minimum AVR output (V). Typical Value = 5. Default: 0.0 - :t1: AVR time constant (T). Typical Value = 4.8. Default: 0 - :t2: AVR time constant (T). Typical Value = 1.5. Default: 0 - :t3: AVR time constant (T). Typical Value = 0. Default: 0 - :t4: AVR time constant (T). Typical Value = 0. Default: 0 - :ke: Exciter gain (K). Typical Value = 1. Default: 0.0 - :vfmx: Maximum exciter output (V). Typical Value = 5. Default: 0.0 - :vfmn: Minimum exciter output (V). Typical Value = 0. Default: 0.0 - :kif: Exciter internal reactance (K). Typical Value = 0. Default: 0.0 - :tif: Exciter current feedback time constant (T). Typical Value = 0. Default: 0 - :t1if: Exciter current feedback time constant (T). Typical Value = 60. Default: 0 - :imul: AVR output voltage dependency selector (Imul). true = selector is connected false = selector is not connected. Typical Value = true. Default: False - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'vrmn': [cgmesProfile.DY.value, ], - 'vrmx': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'vfmx': [cgmesProfile.DY.value, ], - 'vfmn': [cgmesProfile.DY.value, ], - 'kif': [cgmesProfile.DY.value, ], - 'tif': [cgmesProfile.DY.value, ], - 't1if': [cgmesProfile.DY.value, ], - 'imul': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, vrmn = 0.0, vrmx = 0.0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, ke = 0.0, vfmx = 0.0, vfmn = 0.0, kif = 0.0, tif = 0, t1if = 0, imul = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.vrmn = vrmn - self.vrmx = vrmx - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.ke = ke - self.vfmx = vfmx - self.vfmn = vfmn - self.kif = kif - self.tif = tif - self.t1if = t1if - self.imul = imul - - def __str__(self): - str = 'class=ExcAVR4\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcAVR4(ExcitationSystemDynamics): + """ + Italian excitation system. It represents static exciter and electric voltage regulator. + + :imul: AVR output voltage dependency selector (Imul). true = selector is connected false = selector is not connected. Typical Value = true. Default: False + :ka: AVR gain (K). Typical Value = 300. Default: 0.0 + :ke: Exciter gain (K). Typical Value = 1. Default: 0.0 + :kif: Exciter internal reactance (K). Typical Value = 0. Default: 0.0 + :t1: AVR time constant (T). Typical Value = 4.8. Default: 0.0 + :t1if: Exciter current feedback time constant (T). Typical Value = 60. Default: 0.0 + :t2: AVR time constant (T). Typical Value = 1.5. Default: 0.0 + :t3: AVR time constant (T). Typical Value = 0. Default: 0.0 + :t4: AVR time constant (T). Typical Value = 0. Default: 0.0 + :tif: Exciter current feedback time constant (T). Typical Value = 0. Default: 0.0 + :vfmn: Minimum exciter output (V). Typical Value = 0. Default: 0.0 + :vfmx: Maximum exciter output (V). Typical Value = 5. Default: 0.0 + :vrmn: Maximum AVR output (V). Typical Value = 0. Default: 0.0 + :vrmx: Minimum AVR output (V). Typical Value = 5. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "imul": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kif": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t1if": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "tif": [Profile.DY.value, ], + "vfmn": [Profile.DY.value, ], + "vfmx": [Profile.DY.value, ], + "vrmn": [Profile.DY.value, ], + "vrmx": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, imul = False, ka = 0.0, ke = 0.0, kif = 0.0, t1 = 0.0, t1if = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, tif = 0.0, vfmn = 0.0, vfmx = 0.0, vrmn = 0.0, vrmx = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.imul = imul + self.ka = ka + self.ke = ke + self.kif = kif + self.t1 = t1 + self.t1if = t1if + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.tif = tif + self.vfmn = vfmn + self.vfmx = vfmx + self.vrmn = vrmn + self.vrmx = vrmx + + def __str__(self): + str = "class=ExcAVR4\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcAVR5.py b/cimpy/cgmes_v2_4_15/ExcAVR5.py index c2a3fc76..5a924bdc 100644 --- a/cimpy/cgmes_v2_4_15/ExcAVR5.py +++ b/cimpy/cgmes_v2_4_15/ExcAVR5.py @@ -1,37 +1,39 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcAVR5(ExcitationSystemDynamics): - ''' - Manual excitation control with field circuit resistance. This model can be used as a very simple representation of manual voltage control. - - :ka: Gain (Ka). Default: 0.0 - :ta: Time constant (Ta). Default: 0 - :rex: Effective Output Resistance (Rex). Rex represents the effective output resistance seen by the excitation system. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'rex': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, ta = 0, rex = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.ta = ta - self.rex = rex - - def __str__(self): - str = 'class=ExcAVR5\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcAVR5(ExcitationSystemDynamics): + """ + Manual excitation control with field circuit resistance. This model can be used as a very simple representation of manual voltage control. + + :ka: Gain (Ka). Default: 0.0 + :rex: Effective Output Resistance (Rex). Rex represents the effective output resistance seen by the excitation system. Default: 0.0 + :ta: Time constant (Ta). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "rex": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ka = 0.0, rex = 0.0, ta = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ka = ka + self.rex = rex + self.ta = ta + + def __str__(self): + str = "class=ExcAVR5\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcAVR7.py b/cimpy/cgmes_v2_4_15/ExcAVR7.py index 6ffd4ae9..108aa5dc 100644 --- a/cimpy/cgmes_v2_4_15/ExcAVR7.py +++ b/cimpy/cgmes_v2_4_15/ExcAVR7.py @@ -1,91 +1,93 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcAVR7(ExcitationSystemDynamics): - ''' - IVO excitation system. - - :k1: Gain (K1). Typical Value = 1. Default: 0.0 - :a1: Lead coefficient (A1). Typical Value = 0.5. Default: 0.0 - :a2: Lag coefficient (A2). Typical Value = 0.5. Default: 0.0 - :t1: Lead time constant (T1). Typical Value = 0.05. Default: 0 - :t2: Lag time constant (T2). Typical Value = 0.1. Default: 0 - :vmax1: Lead-lag max. limit (Vmax1). Typical Value = 5. Default: 0.0 - :vmin1: Lead-lag min. limit (Vmin1). Typical Value = -5. Default: 0.0 - :k3: Gain (K3). Typical Value = 3. Default: 0.0 - :a3: Lead coefficient (A3). Typical Value = 0.5. Default: 0.0 - :a4: Lag coefficient (A4). Typical Value = 0.5. Default: 0.0 - :t3: Lead time constant (T3). Typical Value = 0.1. Default: 0 - :t4: Lag time constant (T4). Typical Value = 0.1. Default: 0 - :vmax3: Lead-lag max. limit (Vmax3). Typical Value = 5. Default: 0.0 - :vmin3: Lead-lag min. limit (Vmin3). Typical Value = -5. Default: 0.0 - :k5: Gain (K5). Typical Value = 1. Default: 0.0 - :a5: Lead coefficient (A5). Typical Value = 0.5. Default: 0.0 - :a6: Lag coefficient (A6). Typical Value = 0.5. Default: 0.0 - :t5: Lead time constant (T5). Typical Value = 0.1. Default: 0 - :t6: Lag time constant (T6). Typical Value = 0.1. Default: 0 - :vmax5: Lead-lag max. limit (Vmax5). Typical Value = 5. Default: 0.0 - :vmin5: Lead-lag min. limit (Vmin5). Typical Value = -2. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 'a1': [cgmesProfile.DY.value, ], - 'a2': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 'vmax1': [cgmesProfile.DY.value, ], - 'vmin1': [cgmesProfile.DY.value, ], - 'k3': [cgmesProfile.DY.value, ], - 'a3': [cgmesProfile.DY.value, ], - 'a4': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'vmax3': [cgmesProfile.DY.value, ], - 'vmin3': [cgmesProfile.DY.value, ], - 'k5': [cgmesProfile.DY.value, ], - 'a5': [cgmesProfile.DY.value, ], - 'a6': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 'vmax5': [cgmesProfile.DY.value, ], - 'vmin5': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, k1 = 0.0, a1 = 0.0, a2 = 0.0, t1 = 0, t2 = 0, vmax1 = 0.0, vmin1 = 0.0, k3 = 0.0, a3 = 0.0, a4 = 0.0, t3 = 0, t4 = 0, vmax3 = 0.0, vmin3 = 0.0, k5 = 0.0, a5 = 0.0, a6 = 0.0, t5 = 0, t6 = 0, vmax5 = 0.0, vmin5 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.k1 = k1 - self.a1 = a1 - self.a2 = a2 - self.t1 = t1 - self.t2 = t2 - self.vmax1 = vmax1 - self.vmin1 = vmin1 - self.k3 = k3 - self.a3 = a3 - self.a4 = a4 - self.t3 = t3 - self.t4 = t4 - self.vmax3 = vmax3 - self.vmin3 = vmin3 - self.k5 = k5 - self.a5 = a5 - self.a6 = a6 - self.t5 = t5 - self.t6 = t6 - self.vmax5 = vmax5 - self.vmin5 = vmin5 - - def __str__(self): - str = 'class=ExcAVR7\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcAVR7(ExcitationSystemDynamics): + """ + IVO excitation system. + + :a1: Lead coefficient (A1). Typical Value = 0.5. Default: 0.0 + :a2: Lag coefficient (A2). Typical Value = 0.5. Default: 0.0 + :a3: Lead coefficient (A3). Typical Value = 0.5. Default: 0.0 + :a4: Lag coefficient (A4). Typical Value = 0.5. Default: 0.0 + :a5: Lead coefficient (A5). Typical Value = 0.5. Default: 0.0 + :a6: Lag coefficient (A6). Typical Value = 0.5. Default: 0.0 + :k1: Gain (K1). Typical Value = 1. Default: 0.0 + :k3: Gain (K3). Typical Value = 3. Default: 0.0 + :k5: Gain (K5). Typical Value = 1. Default: 0.0 + :t1: Lead time constant (T1). Typical Value = 0.05. Default: 0.0 + :t2: Lag time constant (T2). Typical Value = 0.1. Default: 0.0 + :t3: Lead time constant (T3). Typical Value = 0.1. Default: 0.0 + :t4: Lag time constant (T4). Typical Value = 0.1. Default: 0.0 + :t5: Lead time constant (T5). Typical Value = 0.1. Default: 0.0 + :t6: Lag time constant (T6). Typical Value = 0.1. Default: 0.0 + :vmax1: Lead-lag max. limit (Vmax1). Typical Value = 5. Default: 0.0 + :vmax3: Lead-lag max. limit (Vmax3). Typical Value = 5. Default: 0.0 + :vmax5: Lead-lag max. limit (Vmax5). Typical Value = 5. Default: 0.0 + :vmin1: Lead-lag min. limit (Vmin1). Typical Value = -5. Default: 0.0 + :vmin3: Lead-lag min. limit (Vmin3). Typical Value = -5. Default: 0.0 + :vmin5: Lead-lag min. limit (Vmin5). Typical Value = -2. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "a1": [Profile.DY.value, ], + "a2": [Profile.DY.value, ], + "a3": [Profile.DY.value, ], + "a4": [Profile.DY.value, ], + "a5": [Profile.DY.value, ], + "a6": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k3": [Profile.DY.value, ], + "k5": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "vmax1": [Profile.DY.value, ], + "vmax3": [Profile.DY.value, ], + "vmax5": [Profile.DY.value, ], + "vmin1": [Profile.DY.value, ], + "vmin3": [Profile.DY.value, ], + "vmin5": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, a1 = 0.0, a2 = 0.0, a3 = 0.0, a4 = 0.0, a5 = 0.0, a6 = 0.0, k1 = 0.0, k3 = 0.0, k5 = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, t6 = 0.0, vmax1 = 0.0, vmax3 = 0.0, vmax5 = 0.0, vmin1 = 0.0, vmin3 = 0.0, vmin5 = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.a1 = a1 + self.a2 = a2 + self.a3 = a3 + self.a4 = a4 + self.a5 = a5 + self.a6 = a6 + self.k1 = k1 + self.k3 = k3 + self.k5 = k5 + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.t6 = t6 + self.vmax1 = vmax1 + self.vmax3 = vmax3 + self.vmax5 = vmax5 + self.vmin1 = vmin1 + self.vmin3 = vmin3 + self.vmin5 = vmin5 + + def __str__(self): + str = "class=ExcAVR7\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcBBC.py b/cimpy/cgmes_v2_4_15/ExcBBC.py index c1b4bca4..aba47f7d 100644 --- a/cimpy/cgmes_v2_4_15/ExcBBC.py +++ b/cimpy/cgmes_v2_4_15/ExcBBC.py @@ -1,61 +1,63 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcBBC(ExcitationSystemDynamics): - ''' - Transformer fed static excitation system (static with ABB regulator). This model represents a static excitation system in which a gated thyristor bridge fed by a transformer at the main generator terminals feeds the main generator directly. - - :t1: Controller time constant (T1). Typical Value = 6. Default: 0 - :t2: Controller time constant (T2). Typical Value = 1. Default: 0 - :t3: Lead/lag time constant (T3). Typical Value = 0.05. Default: 0 - :t4: Lead/lag time constant (T4). Typical Value = 0.01. Default: 0 - :k: Steady state gain (K). Typical Value = 300. Default: 0.0 - :vrmin: Minimum control element output (Vrmin). Typical Value = -5. Default: 0.0 - :vrmax: Maximum control element output (Vrmax). Typical Value = 5. Default: 0.0 - :efdmin: Minimum open circuit exciter voltage (Efdmin). Typical Value = -5. Default: 0.0 - :efdmax: Maximum open circuit exciter voltage (Efdmax). Typical Value = 5. Default: 0.0 - :xe: Effective excitation transformer reactance (Xe). Typical Value = 0.05. Default: 0.0 - :switch: Supplementary signal routing selector (switch). true = Vs connected to 3rd summing point false = Vs connected to 1st summing point (see diagram). Typical Value = true. Default: False - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'efdmin': [cgmesProfile.DY.value, ], - 'efdmax': [cgmesProfile.DY.value, ], - 'xe': [cgmesProfile.DY.value, ], - 'switch': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, t1 = 0, t2 = 0, t3 = 0, t4 = 0, k = 0.0, vrmin = 0.0, vrmax = 0.0, efdmin = 0.0, efdmax = 0.0, xe = 0.0, switch = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.k = k - self.vrmin = vrmin - self.vrmax = vrmax - self.efdmin = efdmin - self.efdmax = efdmax - self.xe = xe - self.switch = switch - - def __str__(self): - str = 'class=ExcBBC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcBBC(ExcitationSystemDynamics): + """ + Transformer fed static excitation system (static with ABB regulator). This model represents a static excitation system in which a gated thyristor bridge fed by a transformer at the main generator terminals feeds the main generator directly. + + :efdmax: Maximum open circuit exciter voltage (Efdmax). Typical Value = 5. Default: 0.0 + :efdmin: Minimum open circuit exciter voltage (Efdmin). Typical Value = -5. Default: 0.0 + :k: Steady state gain (K). Typical Value = 300. Default: 0.0 + :switch: Supplementary signal routing selector (switch). true = Vs connected to 3rd summing point false = Vs connected to 1st summing point (see diagram). Typical Value = true. Default: False + :t1: Controller time constant (T1). Typical Value = 6. Default: 0.0 + :t2: Controller time constant (T2). Typical Value = 1. Default: 0.0 + :t3: Lead/lag time constant (T3). Typical Value = 0.05. Default: 0.0 + :t4: Lead/lag time constant (T4). Typical Value = 0.01. Default: 0.0 + :vrmax: Maximum control element output (Vrmax). Typical Value = 5. Default: 0.0 + :vrmin: Minimum control element output (Vrmin). Typical Value = -5. Default: 0.0 + :xe: Effective excitation transformer reactance (Xe). Typical Value = 0.05. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efdmax": [Profile.DY.value, ], + "efdmin": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "switch": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + "xe": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efdmax = 0.0, efdmin = 0.0, k = 0.0, switch = False, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, vrmax = 0.0, vrmin = 0.0, xe = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efdmax = efdmax + self.efdmin = efdmin + self.k = k + self.switch = switch + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.vrmax = vrmax + self.vrmin = vrmin + self.xe = xe + + def __str__(self): + str = "class=ExcBBC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcCZ.py b/cimpy/cgmes_v2_4_15/ExcCZ.py index a7187072..9a7ec164 100644 --- a/cimpy/cgmes_v2_4_15/ExcCZ.py +++ b/cimpy/cgmes_v2_4_15/ExcCZ.py @@ -1,58 +1,60 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcCZ(ExcitationSystemDynamics): - ''' - Czech Proportion/Integral Exciter. - - :kp: Regulator proportional gain (Kp). Default: 0.0 - :tc: Regulator integral time constant (Tc). Default: 0 - :vrmax: Voltage regulator maximum limit (Vrmax). Default: 0.0 - :vrmin: Voltage regulator minimum limit (Vrmin). Default: 0.0 - :ka: Regulator gain (Ka). Default: 0.0 - :ta: Regulator time constant (Ta). Default: 0 - :ke: Exciter constant related to self-excited field (Ke). Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (Te). Default: 0 - :efdmax: Exciter output maximum limit (Efdmax). Default: 0.0 - :efdmin: Exciter output minimum limit (Efdmin). Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'efdmax': [cgmesProfile.DY.value, ], - 'efdmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, kp = 0.0, tc = 0, vrmax = 0.0, vrmin = 0.0, ka = 0.0, ta = 0, ke = 0.0, te = 0, efdmax = 0.0, efdmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kp = kp - self.tc = tc - self.vrmax = vrmax - self.vrmin = vrmin - self.ka = ka - self.ta = ta - self.ke = ke - self.te = te - self.efdmax = efdmax - self.efdmin = efdmin - - def __str__(self): - str = 'class=ExcCZ\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcCZ(ExcitationSystemDynamics): + """ + Czech Proportion/Integral Exciter. + + :efdmax: Exciter output maximum limit (Efdmax). Default: 0.0 + :efdmin: Exciter output minimum limit (Efdmin). Default: 0.0 + :ka: Regulator gain (Ka). Default: 0.0 + :ke: Exciter constant related to self-excited field (Ke). Default: 0.0 + :kp: Regulator proportional gain (Kp). Default: 0.0 + :ta: Regulator time constant (Ta). Default: 0.0 + :tc: Regulator integral time constant (Tc). Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (Te). Default: 0.0 + :vrmax: Voltage regulator maximum limit (Vrmax). Default: 0.0 + :vrmin: Voltage regulator minimum limit (Vrmin). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efdmax": [Profile.DY.value, ], + "efdmin": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efdmax = 0.0, efdmin = 0.0, ka = 0.0, ke = 0.0, kp = 0.0, ta = 0.0, tc = 0.0, te = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efdmax = efdmax + self.efdmin = efdmin + self.ka = ka + self.ke = ke + self.kp = kp + self.ta = ta + self.tc = tc + self.te = te + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcCZ\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcDC1A.py b/cimpy/cgmes_v2_4_15/ExcDC1A.py index 27759c52..86f1ca00 100644 --- a/cimpy/cgmes_v2_4_15/ExcDC1A.py +++ b/cimpy/cgmes_v2_4_15/ExcDC1A.py @@ -1,82 +1,84 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcDC1A(ExcitationSystemDynamics): - ''' - Modified IEEE DC1A direct current commutator exciter with speed input and without underexcitation limiters (UEL) inputs. - - :ka: Voltage regulator gain (Ka). Typical Value = 46. Default: 0.0 - :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 - :ta: Voltage regulator time constant (Ta). Typical Value = 0.06. Default: 0 - :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0 - :tc: Voltage regulator time constant (Tc). Typical Value = 0. Default: 0 - :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 1. Default: 0.0 - :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -0.9. Default: 0.0 - :ke: Exciter constant related to self-excited field (Ke). Typical Value = 0. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 0.46. Default: 0 - :kf: Excitation control system stabilizer gain (Kf). Typical Value = 0.1. Default: 0.0 - :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 1. Default: 0 - :efd1: Exciter voltage at which exciter saturation is defined (Efd1). Typical Value = 3.1. Default: 0.0 - :seefd1: Exciter saturation function value at the corresponding exciter voltage, Efd1 (Se[Eefd1]). Typical Value = 0.33. Default: 0.0 - :efd2: Exciter voltage at which exciter saturation is defined (Efd2). Typical Value = 2.3. Default: 0.0 - :seefd2: Exciter saturation function value at the corresponding exciter voltage, Efd1 (Se[Eefd1]). Typical Value = 0.33. Default: 0.0 - :exclim: (exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero is not applied to integrator output. Typical Value = true. Default: False - :efdmin: Minimum voltage exciter output limiter (Efdmin). Typical Value = -99. Default: 0.0 - :edfmax: Maximum voltage exciter output limiter (Efdmax). Typical Value = 99. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'efd1': [cgmesProfile.DY.value, ], - 'seefd1': [cgmesProfile.DY.value, ], - 'efd2': [cgmesProfile.DY.value, ], - 'seefd2': [cgmesProfile.DY.value, ], - 'exclim': [cgmesProfile.DY.value, ], - 'efdmin': [cgmesProfile.DY.value, ], - 'edfmax': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, ks = 0.0, ta = 0, tb = 0, tc = 0, vrmax = 0.0, vrmin = 0.0, ke = 0.0, te = 0, kf = 0.0, tf = 0, efd1 = 0.0, seefd1 = 0.0, efd2 = 0.0, seefd2 = 0.0, exclim = False, efdmin = 0.0, edfmax = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.ks = ks - self.ta = ta - self.tb = tb - self.tc = tc - self.vrmax = vrmax - self.vrmin = vrmin - self.ke = ke - self.te = te - self.kf = kf - self.tf = tf - self.efd1 = efd1 - self.seefd1 = seefd1 - self.efd2 = efd2 - self.seefd2 = seefd2 - self.exclim = exclim - self.efdmin = efdmin - self.edfmax = edfmax - - def __str__(self): - str = 'class=ExcDC1A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcDC1A(ExcitationSystemDynamics): + """ + Modified IEEE DC1A direct current commutator exciter with speed input and without underexcitation limiters (UEL) inputs. + + :edfmax: Maximum voltage exciter output limiter (Efdmax). Typical Value = 99. Default: 0.0 + :efd1: Exciter voltage at which exciter saturation is defined (Efd1). Typical Value = 3.1. Default: 0.0 + :efd2: Exciter voltage at which exciter saturation is defined (Efd2). Typical Value = 2.3. Default: 0.0 + :efdmin: Minimum voltage exciter output limiter (Efdmin). Typical Value = -99. Default: 0.0 + :exclim: (exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero is not applied to integrator output. Typical Value = true. Default: False + :ka: Voltage regulator gain (Ka). Typical Value = 46. Default: 0.0 + :ke: Exciter constant related to self-excited field (Ke). Typical Value = 0. Default: 0.0 + :kf: Excitation control system stabilizer gain (Kf). Typical Value = 0.1. Default: 0.0 + :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 + :seefd1: Exciter saturation function value at the corresponding exciter voltage, Efd1 (Se[Eefd1]). Typical Value = 0.33. Default: 0.0 + :seefd2: Exciter saturation function value at the corresponding exciter voltage, Efd1 (Se[Eefd1]). Typical Value = 0.33. Default: 0.0 + :ta: Voltage regulator time constant (Ta). Typical Value = 0.06. Default: 0.0 + :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (Tc). Typical Value = 0. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 0.46. Default: 0.0 + :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 1. Default: 0.0 + :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 1. Default: 0.0 + :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -0.9. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "edfmax": [Profile.DY.value, ], + "efd1": [Profile.DY.value, ], + "efd2": [Profile.DY.value, ], + "efdmin": [Profile.DY.value, ], + "exclim": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "seefd1": [Profile.DY.value, ], + "seefd2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, edfmax = 0.0, efd1 = 0.0, efd2 = 0.0, efdmin = 0.0, exclim = False, ka = 0.0, ke = 0.0, kf = 0.0, ks = 0.0, seefd1 = 0.0, seefd2 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, tf = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.edfmax = edfmax + self.efd1 = efd1 + self.efd2 = efd2 + self.efdmin = efdmin + self.exclim = exclim + self.ka = ka + self.ke = ke + self.kf = kf + self.ks = ks + self.seefd1 = seefd1 + self.seefd2 = seefd2 + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.tf = tf + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcDC1A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcDC2A.py b/cimpy/cgmes_v2_4_15/ExcDC2A.py index 6e5a3085..82bcf756 100644 --- a/cimpy/cgmes_v2_4_15/ExcDC2A.py +++ b/cimpy/cgmes_v2_4_15/ExcDC2A.py @@ -1,82 +1,84 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcDC2A(ExcitationSystemDynamics): - ''' - Modified IEEE DC2A direct current commutator exciters with speed input, one more leg block in feedback loop and without underexcitation limiters (UEL) inputs. DC type 2 excitation system model with added speed multiplier, added lead-lag, and voltage-dependent limits. - - :ka: Voltage regulator gain (Ka). Typical Value = 300. Default: 0.0 - :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 - :ta: Voltage regulator time constant (Ta). Typical Value = 0.01. Default: 0 - :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0 - :tc: Voltage regulator time constant (Tc). Typical Value = 0. Default: 0 - :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 4.95. Default: 0.0 - :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -4.9. Default: 0.0 - :ke: Exciter constant related to self-excited field (Ke). If Ke is entered as zero, the model calculates an effective value of Ke such that the initial condition value of Vr is zero. The zero value of Ke is not changed. If Ke is entered as non-zero, its value is used directly, without change. Typical Value = 1. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 1.33. Default: 0 - :kf: Excitation control system stabilizer gain (Kf). Typical Value = 0.1. Default: 0.0 - :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 0.675. Default: 0 - :tf1: Excitation control system stabilizer time constant (Tf1). Typical Value = 0. Default: 0 - :efd1: Exciter voltage at which exciter saturation is defined (Efd1). Typical Value = 3.05. Default: 0.0 - :seefd1: Exciter saturation function value at the corresponding exciter voltage, Efd1 (Se[Eefd1]). Typical Value = 0.279. Default: 0.0 - :efd2: Exciter voltage at which exciter saturation is defined (Efd2). Typical Value = 2.29. Default: 0.0 - :seefd2: Exciter saturation function value at the corresponding exciter voltage, Efd2 (Se[Efd2]). Typical Value = 0.117. Default: 0.0 - :exclim: (exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero is not applied to integrator output. Typical Value = true. Default: False - :vtlim: (Vtlim). true = limiter at the block [Ka/(1+sTa)] is dependent on Vt false = limiter at the block is not dependent on Vt. Typical Value = true. Default: False - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'tf1': [cgmesProfile.DY.value, ], - 'efd1': [cgmesProfile.DY.value, ], - 'seefd1': [cgmesProfile.DY.value, ], - 'efd2': [cgmesProfile.DY.value, ], - 'seefd2': [cgmesProfile.DY.value, ], - 'exclim': [cgmesProfile.DY.value, ], - 'vtlim': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, ks = 0.0, ta = 0, tb = 0, tc = 0, vrmax = 0.0, vrmin = 0.0, ke = 0.0, te = 0, kf = 0.0, tf = 0, tf1 = 0, efd1 = 0.0, seefd1 = 0.0, efd2 = 0.0, seefd2 = 0.0, exclim = False, vtlim = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.ks = ks - self.ta = ta - self.tb = tb - self.tc = tc - self.vrmax = vrmax - self.vrmin = vrmin - self.ke = ke - self.te = te - self.kf = kf - self.tf = tf - self.tf1 = tf1 - self.efd1 = efd1 - self.seefd1 = seefd1 - self.efd2 = efd2 - self.seefd2 = seefd2 - self.exclim = exclim - self.vtlim = vtlim - - def __str__(self): - str = 'class=ExcDC2A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcDC2A(ExcitationSystemDynamics): + """ + Modified IEEE DC2A direct current commutator exciters with speed input, one more leg block in feedback loop and without underexcitation limiters (UEL) inputs. DC type 2 excitation system model with added speed multiplier, added lead-lag, and voltage-dependent limits. + + :efd1: Exciter voltage at which exciter saturation is defined (Efd1). Typical Value = 3.05. Default: 0.0 + :efd2: Exciter voltage at which exciter saturation is defined (Efd2). Typical Value = 2.29. Default: 0.0 + :exclim: (exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero is not applied to integrator output. Typical Value = true. Default: False + :ka: Voltage regulator gain (Ka). Typical Value = 300. Default: 0.0 + :ke: Exciter constant related to self-excited field (Ke). If Ke is entered as zero, the model calculates an effective value of Ke such that the initial condition value of Vr is zero. The zero value of Ke is not changed. If Ke is entered as non-zero, its value is used directly, without change. Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gain (Kf). Typical Value = 0.1. Default: 0.0 + :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 + :seefd1: Exciter saturation function value at the corresponding exciter voltage, Efd1 (Se[Eefd1]). Typical Value = 0.279. Default: 0.0 + :seefd2: Exciter saturation function value at the corresponding exciter voltage, Efd2 (Se[Efd2]). Typical Value = 0.117. Default: 0.0 + :ta: Voltage regulator time constant (Ta). Typical Value = 0.01. Default: 0.0 + :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (Tc). Typical Value = 0. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 1.33. Default: 0.0 + :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 0.675. Default: 0.0 + :tf1: Excitation control system stabilizer time constant (Tf1). Typical Value = 0. Default: 0.0 + :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 4.95. Default: 0.0 + :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -4.9. Default: 0.0 + :vtlim: (Vtlim). true = limiter at the block [Ka/(1+sTa)] is dependent on Vt false = limiter at the block is not dependent on Vt. Typical Value = true. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efd1": [Profile.DY.value, ], + "efd2": [Profile.DY.value, ], + "exclim": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "seefd1": [Profile.DY.value, ], + "seefd2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "tf1": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + "vtlim": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efd1 = 0.0, efd2 = 0.0, exclim = False, ka = 0.0, ke = 0.0, kf = 0.0, ks = 0.0, seefd1 = 0.0, seefd2 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, tf = 0.0, tf1 = 0.0, vrmax = 0.0, vrmin = 0.0, vtlim = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efd1 = efd1 + self.efd2 = efd2 + self.exclim = exclim + self.ka = ka + self.ke = ke + self.kf = kf + self.ks = ks + self.seefd1 = seefd1 + self.seefd2 = seefd2 + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.tf = tf + self.tf1 = tf1 + self.vrmax = vrmax + self.vrmin = vrmin + self.vtlim = vtlim + + def __str__(self): + str = "class=ExcDC2A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcDC3A.py b/cimpy/cgmes_v2_4_15/ExcDC3A.py index 4bb5e52d..b9ca3967 100644 --- a/cimpy/cgmes_v2_4_15/ExcDC3A.py +++ b/cimpy/cgmes_v2_4_15/ExcDC3A.py @@ -1,76 +1,78 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcDC3A(ExcitationSystemDynamics): - ''' - This is modified IEEE DC3A direct current commutator exciters with speed input, and death band. DC old type 4. - - :trh: Rheostat travel time (Trh). Typical Value = 20. Default: 0 - :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 - :kr: Death band (Kr). If Kr is not zero, the voltage regulator input changes at a constant rate if Verr > Kr or Verr < -Kr as per the IEEE (1968) Type 4 model. If Kr is zero, the error signal drives the voltage regulator continuously as per the IEEE (1980) DC3 and IEEE (1992, 2005) DC3A models. Typical Value = 0. Default: 0.0 - :kv: Fast raise/lower contact setting (Kv). Typical Value = 0.05. Default: 0.0 - :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 5. Default: 0.0 - :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = 0. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 1.83. Default: 0 - :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 - :efd1: Exciter voltage at which exciter saturation is defined (Efd1). Typical Value = 2.6. Default: 0.0 - :seefd1: Exciter saturation function value at the corresponding exciter voltage, Efd1 (Se[Eefd1]). Typical Value = 0.1. Default: 0.0 - :efd2: Exciter voltage at which exciter saturation is defined (Efd2). Typical Value = 3.45. Default: 0.0 - :seefd2: Exciter saturation function value at the corresponding exciter voltage, Efd2 (Se[Efd2]). Typical Value = 0.35. Default: 0.0 - :exclim: (exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero not applied to integrator output. Typical Value = true. Default: False - :edfmax: Maximum voltage exciter output limiter (Efdmax). Typical Value = 99. Default: 0.0 - :efdmin: Minimum voltage exciter output limiter (Efdmin). Typical Value = -99. Default: 0.0 - :efdlim: (Efdlim). true = exciter output limiter is active false = exciter output limiter not active. Typical Value = true. Default: False - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'trh': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'kr': [cgmesProfile.DY.value, ], - 'kv': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'efd1': [cgmesProfile.DY.value, ], - 'seefd1': [cgmesProfile.DY.value, ], - 'efd2': [cgmesProfile.DY.value, ], - 'seefd2': [cgmesProfile.DY.value, ], - 'exclim': [cgmesProfile.DY.value, ], - 'edfmax': [cgmesProfile.DY.value, ], - 'efdmin': [cgmesProfile.DY.value, ], - 'efdlim': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, trh = 0, ks = 0.0, kr = 0.0, kv = 0.0, vrmax = 0.0, vrmin = 0.0, te = 0, ke = 0.0, efd1 = 0.0, seefd1 = 0.0, efd2 = 0.0, seefd2 = 0.0, exclim = False, edfmax = 0.0, efdmin = 0.0, efdlim = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.trh = trh - self.ks = ks - self.kr = kr - self.kv = kv - self.vrmax = vrmax - self.vrmin = vrmin - self.te = te - self.ke = ke - self.efd1 = efd1 - self.seefd1 = seefd1 - self.efd2 = efd2 - self.seefd2 = seefd2 - self.exclim = exclim - self.edfmax = edfmax - self.efdmin = efdmin - self.efdlim = efdlim - - def __str__(self): - str = 'class=ExcDC3A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcDC3A(ExcitationSystemDynamics): + """ + This is modified IEEE DC3A direct current commutator exciters with speed input, and death band. DC old type 4. + + :edfmax: Maximum voltage exciter output limiter (Efdmax). Typical Value = 99. Default: 0.0 + :efd1: Exciter voltage at which exciter saturation is defined (Efd1). Typical Value = 2.6. Default: 0.0 + :efd2: Exciter voltage at which exciter saturation is defined (Efd2). Typical Value = 3.45. Default: 0.0 + :efdlim: (Efdlim). true = exciter output limiter is active false = exciter output limiter not active. Typical Value = true. Default: False + :efdmin: Minimum voltage exciter output limiter (Efdmin). Typical Value = -99. Default: 0.0 + :exclim: (exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero not applied to integrator output. Typical Value = true. Default: False + :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 + :kr: Death band (Kr). If Kr is not zero, the voltage regulator input changes at a constant rate if Verr > Kr or Verr < -Kr as per the IEEE (1968) Type 4 model. If Kr is zero, the error signal drives the voltage regulator continuously as per the IEEE (1980) DC3 and IEEE (1992, 2005) DC3A models. Typical Value = 0. Default: 0.0 + :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 + :kv: Fast raise/lower contact setting (Kv). Typical Value = 0.05. Default: 0.0 + :seefd1: Exciter saturation function value at the corresponding exciter voltage, Efd1 (Se[Eefd1]). Typical Value = 0.1. Default: 0.0 + :seefd2: Exciter saturation function value at the corresponding exciter voltage, Efd2 (Se[Efd2]). Typical Value = 0.35. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 1.83. Default: 0.0 + :trh: Rheostat travel time (Trh). Typical Value = 20. Default: 0.0 + :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 5. Default: 0.0 + :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "edfmax": [Profile.DY.value, ], + "efd1": [Profile.DY.value, ], + "efd2": [Profile.DY.value, ], + "efdlim": [Profile.DY.value, ], + "efdmin": [Profile.DY.value, ], + "exclim": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kr": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "kv": [Profile.DY.value, ], + "seefd1": [Profile.DY.value, ], + "seefd2": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "trh": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, edfmax = 0.0, efd1 = 0.0, efd2 = 0.0, efdlim = False, efdmin = 0.0, exclim = False, ke = 0.0, kr = 0.0, ks = 0.0, kv = 0.0, seefd1 = 0.0, seefd2 = 0.0, te = 0.0, trh = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.edfmax = edfmax + self.efd1 = efd1 + self.efd2 = efd2 + self.efdlim = efdlim + self.efdmin = efdmin + self.exclim = exclim + self.ke = ke + self.kr = kr + self.ks = ks + self.kv = kv + self.seefd1 = seefd1 + self.seefd2 = seefd2 + self.te = te + self.trh = trh + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcDC3A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcDC3A1.py b/cimpy/cgmes_v2_4_15/ExcDC3A1.py index 342b5ae7..4d68dec1 100644 --- a/cimpy/cgmes_v2_4_15/ExcDC3A1.py +++ b/cimpy/cgmes_v2_4_15/ExcDC3A1.py @@ -1,70 +1,72 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcDC3A1(ExcitationSystemDynamics): - ''' - This is modified old IEEE type 3 excitation system. - - :ka: Voltage regulator gain (Ka). Typical Value = 300. Default: 0.0 - :ta: Voltage regulator time constant (Ta). Typical Value = 0.01. Default: 0 - :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 5. Default: 0.0 - :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = 0. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 1.83. Default: 0 - :kf: Excitation control system stabilizer gain (Kf). Typical Value = 0.1. Default: 0.0 - :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 0.675. Default: 0 - :kp: Potential circuit gain coefficient (Kp). Typical Value = 4.37. Default: 0.0 - :ki: Potential circuit gain coefficient (Ki). Typical Value = 4.83. Default: 0.0 - :vbmax: Available exciter voltage limiter (Vbmax). Typical Value = 11.63. Default: 0.0 - :exclim: (exclim). true = lower limit of zero is applied to integrator output false = lower limit of zero not applied to integrator output. Typical Value = true. Default: False - :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 - :vb1max: Available exciter voltage limiter (Vb1max). Typical Value = 11.63. Default: 0.0 - :vblim: Vb limiter indicator. true = exciter Vbmax limiter is active false = Vb1max is active. Typical Value = true. Default: False - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'vbmax': [cgmesProfile.DY.value, ], - 'exclim': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'vb1max': [cgmesProfile.DY.value, ], - 'vblim': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, ta = 0, vrmax = 0.0, vrmin = 0.0, te = 0, kf = 0.0, tf = 0, kp = 0.0, ki = 0.0, vbmax = 0.0, exclim = False, ke = 0.0, vb1max = 0.0, vblim = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.ta = ta - self.vrmax = vrmax - self.vrmin = vrmin - self.te = te - self.kf = kf - self.tf = tf - self.kp = kp - self.ki = ki - self.vbmax = vbmax - self.exclim = exclim - self.ke = ke - self.vb1max = vb1max - self.vblim = vblim - - def __str__(self): - str = 'class=ExcDC3A1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcDC3A1(ExcitationSystemDynamics): + """ + This is modified old IEEE type 3 excitation system. + + :exclim: (exclim). true = lower limit of zero is applied to integrator output false = lower limit of zero not applied to integrator output. Typical Value = true. Default: False + :ka: Voltage regulator gain (Ka). Typical Value = 300. Default: 0.0 + :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gain (Kf). Typical Value = 0.1. Default: 0.0 + :ki: Potential circuit gain coefficient (Ki). Typical Value = 4.83. Default: 0.0 + :kp: Potential circuit gain coefficient (Kp). Typical Value = 4.37. Default: 0.0 + :ta: Voltage regulator time constant (Ta). Typical Value = 0.01. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 1.83. Default: 0.0 + :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 0.675. Default: 0.0 + :vb1max: Available exciter voltage limiter (Vb1max). Typical Value = 11.63. Default: 0.0 + :vblim: Vb limiter indicator. true = exciter Vbmax limiter is active false = Vb1max is active. Typical Value = true. Default: False + :vbmax: Available exciter voltage limiter (Vbmax). Typical Value = 11.63. Default: 0.0 + :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 5. Default: 0.0 + :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "exclim": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "vb1max": [Profile.DY.value, ], + "vblim": [Profile.DY.value, ], + "vbmax": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, exclim = False, ka = 0.0, ke = 0.0, kf = 0.0, ki = 0.0, kp = 0.0, ta = 0.0, te = 0.0, tf = 0.0, vb1max = 0.0, vblim = False, vbmax = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.exclim = exclim + self.ka = ka + self.ke = ke + self.kf = kf + self.ki = ki + self.kp = kp + self.ta = ta + self.te = te + self.tf = tf + self.vb1max = vb1max + self.vblim = vblim + self.vbmax = vbmax + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcDC3A1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcELIN1.py b/cimpy/cgmes_v2_4_15/ExcELIN1.py index 163e48cf..c1122cec 100644 --- a/cimpy/cgmes_v2_4_15/ExcELIN1.py +++ b/cimpy/cgmes_v2_4_15/ExcELIN1.py @@ -1,73 +1,75 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcELIN1(ExcitationSystemDynamics): - ''' - Static PI transformer fed excitation system: ELIN (VATECH) - simplified model. This model represents an all-static excitation system. A PI voltage controller establishes a desired field current set point for a proportional current controller. The integrator of the PI controller has a follow-up input to match its signal to the present field current. A power system stabilizer with power input is included in the model. - - :tfi: Current transducer time constant (Tfi). Typical Value = 0. Default: 0 - :tnu: Controller reset time constant (Tnu). Typical Value = 2. Default: 0 - :vpu: Voltage controller proportional gain (Vpu). Typical Value = 34.5. Default: 0.0 - :vpi: Current controller gain (Vpi). Typical Value = 12.45. Default: 0.0 - :vpnf: Controller follow up gain (Vpnf). Typical Value = 2. Default: 0.0 - :dpnf: Controller follow up dead band (Dpnf). Typical Value = 0. Default: 0.0 - :tsw: Stabilizer parameters (Tsw). Typical Value = 3. Default: 0 - :efmin: Minimum open circuit excitation voltage (Efmin). Typical Value = -5. Default: 0.0 - :efmax: Maximum open circuit excitation voltage (Efmax). Typical Value = 5. Default: 0.0 - :xe: Excitation transformer effective reactance (Xe) (>=0). Xe represents the regulation of the transformer/rectifier unit. Typical Value = 0.06. Default: 0.0 - :ks1: Stabilizer Gain 1 (Ks1). Typical Value = 0. Default: 0.0 - :ks2: Stabilizer Gain 2 (Ks2). Typical Value = 0. Default: 0.0 - :ts1: Stabilizer Phase Lag Time Constant (Ts1). Typical Value = 1. Default: 0 - :ts2: Stabilizer Filter Time Constant (Ts2). Typical Value = 1. Default: 0 - :smax: Stabilizer Limit Output (smax). Typical Value = 0.1. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tfi': [cgmesProfile.DY.value, ], - 'tnu': [cgmesProfile.DY.value, ], - 'vpu': [cgmesProfile.DY.value, ], - 'vpi': [cgmesProfile.DY.value, ], - 'vpnf': [cgmesProfile.DY.value, ], - 'dpnf': [cgmesProfile.DY.value, ], - 'tsw': [cgmesProfile.DY.value, ], - 'efmin': [cgmesProfile.DY.value, ], - 'efmax': [cgmesProfile.DY.value, ], - 'xe': [cgmesProfile.DY.value, ], - 'ks1': [cgmesProfile.DY.value, ], - 'ks2': [cgmesProfile.DY.value, ], - 'ts1': [cgmesProfile.DY.value, ], - 'ts2': [cgmesProfile.DY.value, ], - 'smax': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, tfi = 0, tnu = 0, vpu = 0.0, vpi = 0.0, vpnf = 0.0, dpnf = 0.0, tsw = 0, efmin = 0.0, efmax = 0.0, xe = 0.0, ks1 = 0.0, ks2 = 0.0, ts1 = 0, ts2 = 0, smax = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tfi = tfi - self.tnu = tnu - self.vpu = vpu - self.vpi = vpi - self.vpnf = vpnf - self.dpnf = dpnf - self.tsw = tsw - self.efmin = efmin - self.efmax = efmax - self.xe = xe - self.ks1 = ks1 - self.ks2 = ks2 - self.ts1 = ts1 - self.ts2 = ts2 - self.smax = smax - - def __str__(self): - str = 'class=ExcELIN1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcELIN1(ExcitationSystemDynamics): + """ + Static PI transformer fed excitation system: ELIN (VATECH) - simplified model. This model represents an all-static excitation system. A PI voltage controller establishes a desired field current set point for a proportional current controller. The integrator of the PI controller has a follow-up input to match its signal to the present field current. A power system stabilizer with power input is included in the model. + + :dpnf: Controller follow up dead band (Dpnf). Typical Value = 0. Default: 0.0 + :efmax: Maximum open circuit excitation voltage (Efmax). Typical Value = 5. Default: 0.0 + :efmin: Minimum open circuit excitation voltage (Efmin). Typical Value = -5. Default: 0.0 + :ks1: Stabilizer Gain 1 (Ks1). Typical Value = 0. Default: 0.0 + :ks2: Stabilizer Gain 2 (Ks2). Typical Value = 0. Default: 0.0 + :smax: Stabilizer Limit Output (smax). Typical Value = 0.1. Default: 0.0 + :tfi: Current transducer time constant (Tfi). Typical Value = 0. Default: 0.0 + :tnu: Controller reset time constant (Tnu). Typical Value = 2. Default: 0.0 + :ts1: Stabilizer Phase Lag Time Constant (Ts1). Typical Value = 1. Default: 0.0 + :ts2: Stabilizer Filter Time Constant (Ts2). Typical Value = 1. Default: 0.0 + :tsw: Stabilizer parameters (Tsw). Typical Value = 3. Default: 0.0 + :vpi: Current controller gain (Vpi). Typical Value = 12.45. Default: 0.0 + :vpnf: Controller follow up gain (Vpnf). Typical Value = 2. Default: 0.0 + :vpu: Voltage controller proportional gain (Vpu). Typical Value = 34.5. Default: 0.0 + :xe: Excitation transformer effective reactance (Xe) (>=0). Xe represents the regulation of the transformer/rectifier unit. Typical Value = 0.06. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "dpnf": [Profile.DY.value, ], + "efmax": [Profile.DY.value, ], + "efmin": [Profile.DY.value, ], + "ks1": [Profile.DY.value, ], + "ks2": [Profile.DY.value, ], + "smax": [Profile.DY.value, ], + "tfi": [Profile.DY.value, ], + "tnu": [Profile.DY.value, ], + "ts1": [Profile.DY.value, ], + "ts2": [Profile.DY.value, ], + "tsw": [Profile.DY.value, ], + "vpi": [Profile.DY.value, ], + "vpnf": [Profile.DY.value, ], + "vpu": [Profile.DY.value, ], + "xe": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, dpnf = 0.0, efmax = 0.0, efmin = 0.0, ks1 = 0.0, ks2 = 0.0, smax = 0.0, tfi = 0.0, tnu = 0.0, ts1 = 0.0, ts2 = 0.0, tsw = 0.0, vpi = 0.0, vpnf = 0.0, vpu = 0.0, xe = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.dpnf = dpnf + self.efmax = efmax + self.efmin = efmin + self.ks1 = ks1 + self.ks2 = ks2 + self.smax = smax + self.tfi = tfi + self.tnu = tnu + self.ts1 = ts1 + self.ts2 = ts2 + self.tsw = tsw + self.vpi = vpi + self.vpnf = vpnf + self.vpu = vpu + self.xe = xe + + def __str__(self): + str = "class=ExcELIN1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcELIN2.py b/cimpy/cgmes_v2_4_15/ExcELIN2.py index 3fe927df..7a619c91 100644 --- a/cimpy/cgmes_v2_4_15/ExcELIN2.py +++ b/cimpy/cgmes_v2_4_15/ExcELIN2.py @@ -1,109 +1,111 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcELIN2(ExcitationSystemDynamics): - ''' - Detailed Excitation System Model - ELIN (VATECH). This model represents an all-static excitation system. A PI voltage controller establishes a desired field current set point for a proportional current controller. The integrator of the PI controller has a follow-up input to match its signal to the present field current. Power system stabilizer models used in conjunction with this excitation system model: PssELIN2, PssIEEE2B, Pss2B. - - :k1: Voltage regulator input gain (K1). Typical Value = 0. Default: 0.0 - :k1ec: Voltage regulator input limit (K1ec). Typical Value = 2. Default: 0.0 - :kd1: Voltage controller derivative gain (Kd1). Typical Value = 34.5. Default: 0.0 - :tb1: Voltage controller derivative washout time constant (Tb1). Typical Value = 12.45. Default: 0 - :pid1max: Controller follow up gain (PID1max). Typical Value = 2. Default: 0.0 - :ti1: Controller follow up dead band (Ti1). Typical Value = 0. Default: 0.0 - :iefmax2: Minimum open circuit excitation voltage (Iefmax2). Typical Value = -5. Default: 0.0 - :k2: Gain (K2). Typical Value = 5. Default: 0.0 - :ketb: Gain (Ketb). Typical Value = 0.06. Default: 0.0 - :upmax: Limiter (Upmax). Typical Value = 3. Default: 0.0 - :upmin: Limiter (Upmin). Typical Value = 0. Default: 0.0 - :te: Time constant (Te). Typical Value = 0. Default: 0 - :xp: Excitation transformer effective reactance (Xp). Typical Value = 1. Default: 0.0 - :te2: Time Constant (Te2). Typical Value = 1. Default: 0 - :ke2: Gain (Ke2). Typical Value = 0.1. Default: 0.0 - :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve1). Typical Value = 3. Default: 0.0 - :seve1: Exciter saturation function value at the corresponding exciter voltage, Ve1, back of commutating reactance (Se[Ve1]). Typical Value = 0. Default: 0.0 - :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve2). Typical Value = 0. Default: 0.0 - :seve2: Exciter saturation function value at the corresponding exciter voltage, Ve2, back of commutating reactance (Se[Ve2]). Typical Value = 1. Default: 0.0 - :tr4: Time constant (Tr4). Typical Value = 1. Default: 0 - :k3: Gain (K3). Typical Value = 0.1. Default: 0.0 - :ti3: Time constant (Ti3). Typical Value = 3. Default: 0 - :k4: Gain (K4). Typical Value = 0. Default: 0.0 - :ti4: Time constant (Ti4). Typical Value = 0. Default: 0 - :iefmax: Limiter (Iefmax). Typical Value = 1. Default: 0.0 - :iefmin: Limiter (Iefmin). Typical Value = 1. Default: 0.0 - :efdbas: Gain (Efdbas). Typical Value = 0.1. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 'k1ec': [cgmesProfile.DY.value, ], - 'kd1': [cgmesProfile.DY.value, ], - 'tb1': [cgmesProfile.DY.value, ], - 'pid1max': [cgmesProfile.DY.value, ], - 'ti1': [cgmesProfile.DY.value, ], - 'iefmax2': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - 'ketb': [cgmesProfile.DY.value, ], - 'upmax': [cgmesProfile.DY.value, ], - 'upmin': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'xp': [cgmesProfile.DY.value, ], - 'te2': [cgmesProfile.DY.value, ], - 'ke2': [cgmesProfile.DY.value, ], - 've1': [cgmesProfile.DY.value, ], - 'seve1': [cgmesProfile.DY.value, ], - 've2': [cgmesProfile.DY.value, ], - 'seve2': [cgmesProfile.DY.value, ], - 'tr4': [cgmesProfile.DY.value, ], - 'k3': [cgmesProfile.DY.value, ], - 'ti3': [cgmesProfile.DY.value, ], - 'k4': [cgmesProfile.DY.value, ], - 'ti4': [cgmesProfile.DY.value, ], - 'iefmax': [cgmesProfile.DY.value, ], - 'iefmin': [cgmesProfile.DY.value, ], - 'efdbas': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, k1 = 0.0, k1ec = 0.0, kd1 = 0.0, tb1 = 0, pid1max = 0.0, ti1 = 0.0, iefmax2 = 0.0, k2 = 0.0, ketb = 0.0, upmax = 0.0, upmin = 0.0, te = 0, xp = 0.0, te2 = 0, ke2 = 0.0, ve1 = 0.0, seve1 = 0.0, ve2 = 0.0, seve2 = 0.0, tr4 = 0, k3 = 0.0, ti3 = 0, k4 = 0.0, ti4 = 0, iefmax = 0.0, iefmin = 0.0, efdbas = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.k1 = k1 - self.k1ec = k1ec - self.kd1 = kd1 - self.tb1 = tb1 - self.pid1max = pid1max - self.ti1 = ti1 - self.iefmax2 = iefmax2 - self.k2 = k2 - self.ketb = ketb - self.upmax = upmax - self.upmin = upmin - self.te = te - self.xp = xp - self.te2 = te2 - self.ke2 = ke2 - self.ve1 = ve1 - self.seve1 = seve1 - self.ve2 = ve2 - self.seve2 = seve2 - self.tr4 = tr4 - self.k3 = k3 - self.ti3 = ti3 - self.k4 = k4 - self.ti4 = ti4 - self.iefmax = iefmax - self.iefmin = iefmin - self.efdbas = efdbas - - def __str__(self): - str = 'class=ExcELIN2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcELIN2(ExcitationSystemDynamics): + """ + Detailed Excitation System Model - ELIN (VATECH). This model represents an all-static excitation system. A PI voltage controller establishes a desired field current set point for a proportional current controller. The integrator of the PI controller has a follow-up input to match its signal to the present field current. Power system stabilizer models used in conjunction with this excitation system model: PssELIN2, PssIEEE2B, Pss2B. + + :efdbas: Gain (Efdbas). Typical Value = 0.1. Default: 0.0 + :iefmax: Limiter (Iefmax). Typical Value = 1. Default: 0.0 + :iefmax2: Minimum open circuit excitation voltage (Iefmax2). Typical Value = -5. Default: 0.0 + :iefmin: Limiter (Iefmin). Typical Value = 1. Default: 0.0 + :k1: Voltage regulator input gain (K1). Typical Value = 0. Default: 0.0 + :k1ec: Voltage regulator input limit (K1ec). Typical Value = 2. Default: 0.0 + :k2: Gain (K2). Typical Value = 5. Default: 0.0 + :k3: Gain (K3). Typical Value = 0.1. Default: 0.0 + :k4: Gain (K4). Typical Value = 0. Default: 0.0 + :kd1: Voltage controller derivative gain (Kd1). Typical Value = 34.5. Default: 0.0 + :ke2: Gain (Ke2). Typical Value = 0.1. Default: 0.0 + :ketb: Gain (Ketb). Typical Value = 0.06. Default: 0.0 + :pid1max: Controller follow up gain (PID1max). Typical Value = 2. Default: 0.0 + :seve1: Exciter saturation function value at the corresponding exciter voltage, Ve1, back of commutating reactance (Se[Ve1]). Typical Value = 0. Default: 0.0 + :seve2: Exciter saturation function value at the corresponding exciter voltage, Ve2, back of commutating reactance (Se[Ve2]). Typical Value = 1. Default: 0.0 + :tb1: Voltage controller derivative washout time constant (Tb1). Typical Value = 12.45. Default: 0.0 + :te: Time constant (Te). Typical Value = 0. Default: 0.0 + :te2: Time Constant (Te2). Typical Value = 1. Default: 0.0 + :ti1: Controller follow up dead band (Ti1). Typical Value = 0. Default: 0.0 + :ti3: Time constant (Ti3). Typical Value = 3. Default: 0.0 + :ti4: Time constant (Ti4). Typical Value = 0. Default: 0.0 + :tr4: Time constant (Tr4). Typical Value = 1. Default: 0.0 + :upmax: Limiter (Upmax). Typical Value = 3. Default: 0.0 + :upmin: Limiter (Upmin). Typical Value = 0. Default: 0.0 + :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve1). Typical Value = 3. Default: 0.0 + :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve2). Typical Value = 0. Default: 0.0 + :xp: Excitation transformer effective reactance (Xp). Typical Value = 1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efdbas": [Profile.DY.value, ], + "iefmax": [Profile.DY.value, ], + "iefmax2": [Profile.DY.value, ], + "iefmin": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k1ec": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "k3": [Profile.DY.value, ], + "k4": [Profile.DY.value, ], + "kd1": [Profile.DY.value, ], + "ke2": [Profile.DY.value, ], + "ketb": [Profile.DY.value, ], + "pid1max": [Profile.DY.value, ], + "seve1": [Profile.DY.value, ], + "seve2": [Profile.DY.value, ], + "tb1": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "te2": [Profile.DY.value, ], + "ti1": [Profile.DY.value, ], + "ti3": [Profile.DY.value, ], + "ti4": [Profile.DY.value, ], + "tr4": [Profile.DY.value, ], + "upmax": [Profile.DY.value, ], + "upmin": [Profile.DY.value, ], + "ve1": [Profile.DY.value, ], + "ve2": [Profile.DY.value, ], + "xp": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efdbas = 0.0, iefmax = 0.0, iefmax2 = 0.0, iefmin = 0.0, k1 = 0.0, k1ec = 0.0, k2 = 0.0, k3 = 0.0, k4 = 0.0, kd1 = 0.0, ke2 = 0.0, ketb = 0.0, pid1max = 0.0, seve1 = 0.0, seve2 = 0.0, tb1 = 0.0, te = 0.0, te2 = 0.0, ti1 = 0.0, ti3 = 0.0, ti4 = 0.0, tr4 = 0.0, upmax = 0.0, upmin = 0.0, ve1 = 0.0, ve2 = 0.0, xp = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efdbas = efdbas + self.iefmax = iefmax + self.iefmax2 = iefmax2 + self.iefmin = iefmin + self.k1 = k1 + self.k1ec = k1ec + self.k2 = k2 + self.k3 = k3 + self.k4 = k4 + self.kd1 = kd1 + self.ke2 = ke2 + self.ketb = ketb + self.pid1max = pid1max + self.seve1 = seve1 + self.seve2 = seve2 + self.tb1 = tb1 + self.te = te + self.te2 = te2 + self.ti1 = ti1 + self.ti3 = ti3 + self.ti4 = ti4 + self.tr4 = tr4 + self.upmax = upmax + self.upmin = upmin + self.ve1 = ve1 + self.ve2 = ve2 + self.xp = xp + + def __str__(self): + str = "class=ExcELIN2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcHU.py b/cimpy/cgmes_v2_4_15/ExcHU.py index 0f29e038..4872f70a 100644 --- a/cimpy/cgmes_v2_4_15/ExcHU.py +++ b/cimpy/cgmes_v2_4_15/ExcHU.py @@ -1,64 +1,66 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcHU(ExcitationSystemDynamics): - ''' - Hungarian Excitation System Model, with built-in voltage transducer. - - :tr: Filter time constant (Tr). If a voltage compensator is used in conjunction with this excitation system model, Tr should be set to 0. Typical Value = 0.01. Default: 0 - :te: Major loop PI tag integration time constant (Te). Typical Value = 0.154. Default: 0 - :imin: Major loop PI tag output signal lower limit (Imin). Typical Value = 0.1. Default: 0.0 - :imax: Major loop PI tag output signal upper limit (Imax). Typical Value = 2.19. Default: 0.0 - :ae: Major loop PI tag gain factor (Ae). Typical Value = 3. Default: 0.0 - :emin: Field voltage control signal lower limit on AVR base (Emin). Typical Value = -0.866. Default: 0.0 - :emax: Field voltage control signal upper limit on AVR base (Emax). Typical Value = 0.996. Default: 0.0 - :ki: Current base conversion constant (Ki). Typical Value = 0.21428. Default: 0.0 - :ai: Minor loop PI tag gain factor (Ai). Typical Value = 22. Default: 0.0 - :ti: Minor loop PI control tag integration time constant (Ti). Typical Value = 0.01333. Default: 0 - :atr: AVR constant (Atr). Typical Value = 2.19. Default: 0.0 - :ke: Voltage base conversion constant (Ke). Typical Value = 4.666. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tr': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'imin': [cgmesProfile.DY.value, ], - 'imax': [cgmesProfile.DY.value, ], - 'ae': [cgmesProfile.DY.value, ], - 'emin': [cgmesProfile.DY.value, ], - 'emax': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'ai': [cgmesProfile.DY.value, ], - 'ti': [cgmesProfile.DY.value, ], - 'atr': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, tr = 0, te = 0, imin = 0.0, imax = 0.0, ae = 0.0, emin = 0.0, emax = 0.0, ki = 0.0, ai = 0.0, ti = 0, atr = 0.0, ke = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tr = tr - self.te = te - self.imin = imin - self.imax = imax - self.ae = ae - self.emin = emin - self.emax = emax - self.ki = ki - self.ai = ai - self.ti = ti - self.atr = atr - self.ke = ke - - def __str__(self): - str = 'class=ExcHU\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcHU(ExcitationSystemDynamics): + """ + Hungarian Excitation System Model, with built-in voltage transducer. + + :ae: Major loop PI tag gain factor (Ae). Typical Value = 3. Default: 0.0 + :ai: Minor loop PI tag gain factor (Ai). Typical Value = 22. Default: 0.0 + :atr: AVR constant (Atr). Typical Value = 2.19. Default: 0.0 + :emax: Field voltage control signal upper limit on AVR base (Emax). Typical Value = 0.996. Default: 0.0 + :emin: Field voltage control signal lower limit on AVR base (Emin). Typical Value = -0.866. Default: 0.0 + :imax: Major loop PI tag output signal upper limit (Imax). Typical Value = 2.19. Default: 0.0 + :imin: Major loop PI tag output signal lower limit (Imin). Typical Value = 0.1. Default: 0.0 + :ke: Voltage base conversion constant (Ke). Typical Value = 4.666. Default: 0.0 + :ki: Current base conversion constant (Ki). Typical Value = 0.21428. Default: 0.0 + :te: Major loop PI tag integration time constant (Te). Typical Value = 0.154. Default: 0.0 + :ti: Minor loop PI control tag integration time constant (Ti). Typical Value = 0.01333. Default: 0.0 + :tr: Filter time constant (Tr). If a voltage compensator is used in conjunction with this excitation system model, Tr should be set to 0. Typical Value = 0.01. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ae": [Profile.DY.value, ], + "ai": [Profile.DY.value, ], + "atr": [Profile.DY.value, ], + "emax": [Profile.DY.value, ], + "emin": [Profile.DY.value, ], + "imax": [Profile.DY.value, ], + "imin": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "ti": [Profile.DY.value, ], + "tr": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ae = 0.0, ai = 0.0, atr = 0.0, emax = 0.0, emin = 0.0, imax = 0.0, imin = 0.0, ke = 0.0, ki = 0.0, te = 0.0, ti = 0.0, tr = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ae = ae + self.ai = ai + self.atr = atr + self.emax = emax + self.emin = emin + self.imax = imax + self.imin = imin + self.ke = ke + self.ki = ki + self.te = te + self.ti = ti + self.tr = tr + + def __str__(self): + str = "class=ExcHU\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEAC1A.py b/cimpy/cgmes_v2_4_15/ExcIEEEAC1A.py index 9ecf8fb9..b671e9ee 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEAC1A.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEAC1A.py @@ -1,82 +1,84 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEAC1A(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type AC1A model. The model represents the field-controlled alternator-rectifier excitation systems designated Type AC1A. These excitation systems consist of an alternator main exciter with non-controlled rectifiers. Reference: IEEE Standard 421.5-2005 Section 6.1. - - :tb: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :ka: Voltage regulator gain (K). Typical Value = 400. Default: 0.0 - :ta: Voltage regulator time constant (T). Typical Value = 0.02. Default: 0 - :vamax: Maximum voltage regulator output (V). Typical Value = 14.5. Default: 0.0 - :vamin: Minimum voltage regulator output (V). Typical Value = -14.5. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.8. Default: 0 - :kf: Excitation control system stabilizer gains (K). Typical Value = 0.03. Default: 0.0 - :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0 - :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.2. Default: 0.0 - :kd: Demagnetizing factor, a function of exciter alternator reactances (K). Typical Value = 0.38. Default: 0.0 - :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 - :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 4.18. Default: 0.0 - :seve1: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.1. Default: 0.0 - :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 3.14. Default: 0.0 - :seve2: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.03. Default: 0.0 - :vrmax: Maximum voltage regulator outputs (V). Typical Value = 6.03. Default: 0.0 - :vrmin: Minimum voltage regulator outputs (V). Typical Value = -5.43. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vamax': [cgmesProfile.DY.value, ], - 'vamin': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 've1': [cgmesProfile.DY.value, ], - 'seve1': [cgmesProfile.DY.value, ], - 've2': [cgmesProfile.DY.value, ], - 'seve2': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, tb = 0, tc = 0, ka = 0.0, ta = 0, vamax = 0.0, vamin = 0.0, te = 0, kf = 0.0, tf = 0, kc = 0.0, kd = 0.0, ke = 0.0, ve1 = 0.0, seve1 = 0.0, ve2 = 0.0, seve2 = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tb = tb - self.tc = tc - self.ka = ka - self.ta = ta - self.vamax = vamax - self.vamin = vamin - self.te = te - self.kf = kf - self.tf = tf - self.kc = kc - self.kd = kd - self.ke = ke - self.ve1 = ve1 - self.seve1 = seve1 - self.ve2 = ve2 - self.seve2 = seve2 - self.vrmax = vrmax - self.vrmin = vrmin - - def __str__(self): - str = 'class=ExcIEEEAC1A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEAC1A(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type AC1A model. The model represents the field-controlled alternator-rectifier excitation systems designated Type AC1A. These excitation systems consist of an alternator main exciter with non-controlled rectifiers. Reference: IEEE Standard 421.5-2005 Section 6.1. + + :ka: Voltage regulator gain (K). Typical Value = 400. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.2. Default: 0.0 + :kd: Demagnetizing factor, a function of exciter alternator reactances (K). Typical Value = 0.38. Default: 0.0 + :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gains (K). Typical Value = 0.03. Default: 0.0 + :seve1: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.1. Default: 0.0 + :seve2: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.03. Default: 0.0 + :ta: Voltage regulator time constant (T). Typical Value = 0.02. Default: 0.0 + :tb: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.8. Default: 0.0 + :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0.0 + :vamax: Maximum voltage regulator output (V). Typical Value = 14.5. Default: 0.0 + :vamin: Minimum voltage regulator output (V). Typical Value = -14.5. Default: 0.0 + :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 4.18. Default: 0.0 + :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 3.14. Default: 0.0 + :vrmax: Maximum voltage regulator outputs (V). Typical Value = 6.03. Default: 0.0 + :vrmin: Minimum voltage regulator outputs (V). Typical Value = -5.43. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "seve1": [Profile.DY.value, ], + "seve2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "vamax": [Profile.DY.value, ], + "vamin": [Profile.DY.value, ], + "ve1": [Profile.DY.value, ], + "ve2": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ka = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, kf = 0.0, seve1 = 0.0, seve2 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, tf = 0.0, vamax = 0.0, vamin = 0.0, ve1 = 0.0, ve2 = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ka = ka + self.kc = kc + self.kd = kd + self.ke = ke + self.kf = kf + self.seve1 = seve1 + self.seve2 = seve2 + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.tf = tf + self.vamax = vamax + self.vamin = vamin + self.ve1 = ve1 + self.ve2 = ve2 + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEAC1A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEAC2A.py b/cimpy/cgmes_v2_4_15/ExcIEEEAC2A.py index 10152f5f..d1dc810d 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEAC2A.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEAC2A.py @@ -1,91 +1,93 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEAC2A(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type AC2A model. The model represents a high initial response field-controlled alternator-rectifier excitation system. The alternator main exciter is used with non-controlled rectifiers. The Type AC2A model is similar to that of Type AC1A except for the inclusion of exciter time constant compensation and exciter field current limiting elements. Reference: IEEE Standard 421.5-2005 Section 6.2. - - :tb: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :ka: Voltage regulator gain (K). Typical Value = 400. Default: 0.0 - :ta: Voltage regulator time constant (T). Typical Value = 0.02. Default: 0 - :vamax: Maximum voltage regulator output (V). Typical Value = 8. Default: 0.0 - :vamin: Minimum voltage regulator output (V). Typical Value = -8. Default: 0.0 - :kb: Second stage regulator gain (K). Typical Value = 25. Default: 0.0 - :vrmax: Maximum voltage regulator outputs (V). Typical Value = 105. Default: 0.0 - :vrmin: Minimum voltage regulator outputs (V). Typical Value = -95. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.6. Default: 0 - :vfemax: Exciter field current limit reference (V). Typical Value = 4.4. Default: 0.0 - :kh: Exciter field current feedback gain (K). Typical Value = 1. Default: 0.0 - :kf: Excitation control system stabilizer gains (K). Typical Value = 0.03. Default: 0.0 - :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0 - :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.28. Default: 0.0 - :kd: Demagnetizing factor, a function of exciter alternator reactances (K). Typical Value = 0.35. Default: 0.0 - :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 - :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 4.4. Default: 0.0 - :seve1: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.037. Default: 0.0 - :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 3.3. Default: 0.0 - :seve2: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.012. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vamax': [cgmesProfile.DY.value, ], - 'vamin': [cgmesProfile.DY.value, ], - 'kb': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'vfemax': [cgmesProfile.DY.value, ], - 'kh': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 've1': [cgmesProfile.DY.value, ], - 'seve1': [cgmesProfile.DY.value, ], - 've2': [cgmesProfile.DY.value, ], - 'seve2': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, tb = 0, tc = 0, ka = 0.0, ta = 0, vamax = 0.0, vamin = 0.0, kb = 0.0, vrmax = 0.0, vrmin = 0.0, te = 0, vfemax = 0.0, kh = 0.0, kf = 0.0, tf = 0, kc = 0.0, kd = 0.0, ke = 0.0, ve1 = 0.0, seve1 = 0.0, ve2 = 0.0, seve2 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tb = tb - self.tc = tc - self.ka = ka - self.ta = ta - self.vamax = vamax - self.vamin = vamin - self.kb = kb - self.vrmax = vrmax - self.vrmin = vrmin - self.te = te - self.vfemax = vfemax - self.kh = kh - self.kf = kf - self.tf = tf - self.kc = kc - self.kd = kd - self.ke = ke - self.ve1 = ve1 - self.seve1 = seve1 - self.ve2 = ve2 - self.seve2 = seve2 - - def __str__(self): - str = 'class=ExcIEEEAC2A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEAC2A(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type AC2A model. The model represents a high initial response field-controlled alternator-rectifier excitation system. The alternator main exciter is used with non-controlled rectifiers. The Type AC2A model is similar to that of Type AC1A except for the inclusion of exciter time constant compensation and exciter field current limiting elements. Reference: IEEE Standard 421.5-2005 Section 6.2. + + :ka: Voltage regulator gain (K). Typical Value = 400. Default: 0.0 + :kb: Second stage regulator gain (K). Typical Value = 25. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.28. Default: 0.0 + :kd: Demagnetizing factor, a function of exciter alternator reactances (K). Typical Value = 0.35. Default: 0.0 + :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gains (K). Typical Value = 0.03. Default: 0.0 + :kh: Exciter field current feedback gain (K). Typical Value = 1. Default: 0.0 + :seve1: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.037. Default: 0.0 + :seve2: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.012. Default: 0.0 + :ta: Voltage regulator time constant (T). Typical Value = 0.02. Default: 0.0 + :tb: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.6. Default: 0.0 + :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0.0 + :vamax: Maximum voltage regulator output (V). Typical Value = 8. Default: 0.0 + :vamin: Minimum voltage regulator output (V). Typical Value = -8. Default: 0.0 + :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 4.4. Default: 0.0 + :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 3.3. Default: 0.0 + :vfemax: Exciter field current limit reference (V). Typical Value = 4.4. Default: 0.0 + :vrmax: Maximum voltage regulator outputs (V). Typical Value = 105. Default: 0.0 + :vrmin: Minimum voltage regulator outputs (V). Typical Value = -95. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kb": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "kh": [Profile.DY.value, ], + "seve1": [Profile.DY.value, ], + "seve2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "vamax": [Profile.DY.value, ], + "vamin": [Profile.DY.value, ], + "ve1": [Profile.DY.value, ], + "ve2": [Profile.DY.value, ], + "vfemax": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ka = 0.0, kb = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, kf = 0.0, kh = 0.0, seve1 = 0.0, seve2 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, tf = 0.0, vamax = 0.0, vamin = 0.0, ve1 = 0.0, ve2 = 0.0, vfemax = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ka = ka + self.kb = kb + self.kc = kc + self.kd = kd + self.ke = ke + self.kf = kf + self.kh = kh + self.seve1 = seve1 + self.seve2 = seve2 + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.tf = tf + self.vamax = vamax + self.vamin = vamin + self.ve1 = ve1 + self.ve2 = ve2 + self.vfemax = vfemax + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEAC2A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEAC3A.py b/cimpy/cgmes_v2_4_15/ExcIEEEAC3A.py index 1fec42bf..9dba0362 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEAC3A.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEAC3A.py @@ -1,91 +1,93 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEAC3A(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type AC3A model. The model represents the field-controlled alternator-rectifier excitation systems designated Type AC3A. These excitation systems include an alternator main exciter with non-controlled rectifiers. The exciter employs self-excitation, and the voltage regulator power is derived from the exciter output voltage. Therefore, this system has an additional nonlinearity, simulated by the use of a multiplier whose inputs are the voltage regulator command signal, , and the exciter output voltage, , times . This model is applicable to excitation systems employing static voltage regulators. Reference: IEEE Standard 421.5-2005 Section 6.3. - - :tb: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :ka: Voltage regulator gain (K). Typical Value = 45.62. Default: 0.0 - :ta: Voltage regulator time constant (T). Typical Value = 0.013. Default: 0 - :vamax: Maximum voltage regulator output (V). Typical Value = 1. Default: 0.0 - :vamin: Minimum voltage regulator output (V). Typical Value = -0.95. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 1.17. Default: 0 - :vemin: Minimum exciter voltage output (V). Typical Value = 0.1. Default: 0.0 - :kr: Constant associated with regulator and alternator field power supply (K). Typical Value = 3.77. Default: 0.0 - :kf: Excitation control system stabilizer gains (K). Typical Value = 0.143. Default: 0.0 - :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0 - :kn: Excitation control system stabilizer gain (K). Typical Value = 0.05. Default: 0.0 - :efdn: Value of at which feedback gain changes (E). Typical Value = 2.36. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.104. Default: 0.0 - :kd: Demagnetizing factor, a function of exciter alternator reactances (K). Typical Value = 0.499. Default: 0.0 - :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 - :vfemax: Exciter field current limit reference (V). Typical Value = 16. Default: 0.0 - :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V) equals V(V). Typical Value = 6.24. Default: 0.0 - :seve1: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 1.143. Default: 0.0 - :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 4.68. Default: 0.0 - :seve2: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.1. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vamax': [cgmesProfile.DY.value, ], - 'vamin': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'vemin': [cgmesProfile.DY.value, ], - 'kr': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'kn': [cgmesProfile.DY.value, ], - 'efdn': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'vfemax': [cgmesProfile.DY.value, ], - 've1': [cgmesProfile.DY.value, ], - 'seve1': [cgmesProfile.DY.value, ], - 've2': [cgmesProfile.DY.value, ], - 'seve2': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, tb = 0, tc = 0, ka = 0.0, ta = 0, vamax = 0.0, vamin = 0.0, te = 0, vemin = 0.0, kr = 0.0, kf = 0.0, tf = 0, kn = 0.0, efdn = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, vfemax = 0.0, ve1 = 0.0, seve1 = 0.0, ve2 = 0.0, seve2 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tb = tb - self.tc = tc - self.ka = ka - self.ta = ta - self.vamax = vamax - self.vamin = vamin - self.te = te - self.vemin = vemin - self.kr = kr - self.kf = kf - self.tf = tf - self.kn = kn - self.efdn = efdn - self.kc = kc - self.kd = kd - self.ke = ke - self.vfemax = vfemax - self.ve1 = ve1 - self.seve1 = seve1 - self.ve2 = ve2 - self.seve2 = seve2 - - def __str__(self): - str = 'class=ExcIEEEAC3A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEAC3A(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type AC3A model. The model represents the field-controlled alternator-rectifier excitation systems designated Type AC3A. These excitation systems include an alternator main exciter with non-controlled rectifiers. The exciter employs self-excitation, and the voltage regulator power is derived from the exciter output voltage. Therefore, this system has an additional nonlinearity, simulated by the use of a multiplier whose inputs are the voltage regulator command signal, , and the exciter output voltage, , times . This model is applicable to excitation systems employing static voltage regulators. Reference: IEEE Standard 421.5-2005 Section 6.3. + + :efdn: Value of at which feedback gain changes (E). Typical Value = 2.36. Default: 0.0 + :ka: Voltage regulator gain (K). Typical Value = 45.62. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.104. Default: 0.0 + :kd: Demagnetizing factor, a function of exciter alternator reactances (K). Typical Value = 0.499. Default: 0.0 + :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gains (K). Typical Value = 0.143. Default: 0.0 + :kn: Excitation control system stabilizer gain (K). Typical Value = 0.05. Default: 0.0 + :kr: Constant associated with regulator and alternator field power supply (K). Typical Value = 3.77. Default: 0.0 + :seve1: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 1.143. Default: 0.0 + :seve2: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.1. Default: 0.0 + :ta: Voltage regulator time constant (T). Typical Value = 0.013. Default: 0.0 + :tb: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 1.17. Default: 0.0 + :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0.0 + :vamax: Maximum voltage regulator output (V). Typical Value = 1. Default: 0.0 + :vamin: Minimum voltage regulator output (V). Typical Value = -0.95. Default: 0.0 + :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V) equals V(V). Typical Value = 6.24. Default: 0.0 + :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 4.68. Default: 0.0 + :vemin: Minimum exciter voltage output (V). Typical Value = 0.1. Default: 0.0 + :vfemax: Exciter field current limit reference (V). Typical Value = 16. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efdn": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "kn": [Profile.DY.value, ], + "kr": [Profile.DY.value, ], + "seve1": [Profile.DY.value, ], + "seve2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "vamax": [Profile.DY.value, ], + "vamin": [Profile.DY.value, ], + "ve1": [Profile.DY.value, ], + "ve2": [Profile.DY.value, ], + "vemin": [Profile.DY.value, ], + "vfemax": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efdn = 0.0, ka = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, kf = 0.0, kn = 0.0, kr = 0.0, seve1 = 0.0, seve2 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, tf = 0.0, vamax = 0.0, vamin = 0.0, ve1 = 0.0, ve2 = 0.0, vemin = 0.0, vfemax = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efdn = efdn + self.ka = ka + self.kc = kc + self.kd = kd + self.ke = ke + self.kf = kf + self.kn = kn + self.kr = kr + self.seve1 = seve1 + self.seve2 = seve2 + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.tf = tf + self.vamax = vamax + self.vamin = vamin + self.ve1 = ve1 + self.ve2 = ve2 + self.vemin = vemin + self.vfemax = vfemax + + def __str__(self): + str = "class=ExcIEEEAC3A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEAC4A.py b/cimpy/cgmes_v2_4_15/ExcIEEEAC4A.py index 5de51c89..64e0467f 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEAC4A.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEAC4A.py @@ -1,55 +1,57 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEAC4A(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type AC4A model. The model represents type AC4A alternator-supplied controlled-rectifier excitation system which is quite different from the other type ac systems. This high initial response excitation system utilizes a full thyristor bridge in the exciter output circuit. The voltage regulator controls the firing of the thyristor bridges. The exciter alternator uses an independent voltage regulator to control its output voltage to a constant value. These effects are not modeled; however, transient loading effects on the exciter alternator are included. Reference: IEEE Standard 421.5-2005 Section 6.4. - - :vimax: Maximum voltage regulator input limit (V). Typical Value = 10. Default: 0.0 - :vimin: Minimum voltage regulator input limit (V). Typical Value = -10. Default: 0.0 - :tc: Voltage regulator time constant (T). Typical Value = 1. Default: 0 - :tb: Voltage regulator time constant (T). Typical Value = 10. Default: 0 - :ka: Voltage regulator gain (K). Typical Value = 200. Default: 0.0 - :ta: Voltage regulator time constant (T). Typical Value = 0.015. Default: 0 - :vrmax: Maximum voltage regulator output (V). Typical Value = 5.64. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = -4.53. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'vimax': [cgmesProfile.DY.value, ], - 'vimin': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, vimax = 0.0, vimin = 0.0, tc = 0, tb = 0, ka = 0.0, ta = 0, vrmax = 0.0, vrmin = 0.0, kc = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.vimax = vimax - self.vimin = vimin - self.tc = tc - self.tb = tb - self.ka = ka - self.ta = ta - self.vrmax = vrmax - self.vrmin = vrmin - self.kc = kc - - def __str__(self): - str = 'class=ExcIEEEAC4A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEAC4A(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type AC4A model. The model represents type AC4A alternator-supplied controlled-rectifier excitation system which is quite different from the other type ac systems. This high initial response excitation system utilizes a full thyristor bridge in the exciter output circuit. The voltage regulator controls the firing of the thyristor bridges. The exciter alternator uses an independent voltage regulator to control its output voltage to a constant value. These effects are not modeled; however, transient loading effects on the exciter alternator are included. Reference: IEEE Standard 421.5-2005 Section 6.4. + + :ka: Voltage regulator gain (K). Typical Value = 200. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0. Default: 0.0 + :ta: Voltage regulator time constant (T). Typical Value = 0.015. Default: 0.0 + :tb: Voltage regulator time constant (T). Typical Value = 10. Default: 0.0 + :tc: Voltage regulator time constant (T). Typical Value = 1. Default: 0.0 + :vimax: Maximum voltage regulator input limit (V). Typical Value = 10. Default: 0.0 + :vimin: Minimum voltage regulator input limit (V). Typical Value = -10. Default: 0.0 + :vrmax: Maximum voltage regulator output (V). Typical Value = 5.64. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = -4.53. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "vimax": [Profile.DY.value, ], + "vimin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ka = 0.0, kc = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, vimax = 0.0, vimin = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ka = ka + self.kc = kc + self.ta = ta + self.tb = tb + self.tc = tc + self.vimax = vimax + self.vimin = vimin + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEAC4A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEAC5A.py b/cimpy/cgmes_v2_4_15/ExcIEEEAC5A.py index d5e49c31..b1c485be 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEAC5A.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEAC5A.py @@ -1,70 +1,72 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEAC5A(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type AC5A model. The model represents a simplified model for brushless excitation systems. The regulator is supplied from a source, such as a permanent magnet generator, which is not affected by system disturbances. Unlike other ac models, this model uses loaded rather than open circuit exciter saturation data in the same way as it is used for the dc models. Because the model has been widely implemented by the industry, it is sometimes used to represent other types of systems when either detailed data for them are not available or simplified models are required. Reference: IEEE Standard 421.5-2005 Section 6.5. - - :ka: Voltage regulator gain (K). Typical Value = 400. Default: 0.0 - :ta: Voltage regulator time constant (T). Typical Value = 0.02. Default: 0 - :vrmax: Maximum voltage regulator output (V). Typical Value = 7.3. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = -7.3. Default: 0.0 - :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.8. Default: 0 - :kf: Excitation control system stabilizer gains (K). Typical Value = 0.03. Default: 0.0 - :tf1: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0 - :tf2: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0 - :tf3: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0 - :efd1: Exciter voltage at which exciter saturation is defined (E). Typical Value = 5.6. Default: 0.0 - :seefd1: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.86. Default: 0.0 - :efd2: Exciter voltage at which exciter saturation is defined (E). Typical Value = 4.2. Default: 0.0 - :seefd2: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.5. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf1': [cgmesProfile.DY.value, ], - 'tf2': [cgmesProfile.DY.value, ], - 'tf3': [cgmesProfile.DY.value, ], - 'efd1': [cgmesProfile.DY.value, ], - 'seefd1': [cgmesProfile.DY.value, ], - 'efd2': [cgmesProfile.DY.value, ], - 'seefd2': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, ta = 0, vrmax = 0.0, vrmin = 0.0, ke = 0.0, te = 0, kf = 0.0, tf1 = 0, tf2 = 0, tf3 = 0, efd1 = 0.0, seefd1 = 0.0, efd2 = 0.0, seefd2 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.ta = ta - self.vrmax = vrmax - self.vrmin = vrmin - self.ke = ke - self.te = te - self.kf = kf - self.tf1 = tf1 - self.tf2 = tf2 - self.tf3 = tf3 - self.efd1 = efd1 - self.seefd1 = seefd1 - self.efd2 = efd2 - self.seefd2 = seefd2 - - def __str__(self): - str = 'class=ExcIEEEAC5A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEAC5A(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type AC5A model. The model represents a simplified model for brushless excitation systems. The regulator is supplied from a source, such as a permanent magnet generator, which is not affected by system disturbances. Unlike other ac models, this model uses loaded rather than open circuit exciter saturation data in the same way as it is used for the dc models. Because the model has been widely implemented by the industry, it is sometimes used to represent other types of systems when either detailed data for them are not available or simplified models are required. Reference: IEEE Standard 421.5-2005 Section 6.5. + + :efd1: Exciter voltage at which exciter saturation is defined (E). Typical Value = 5.6. Default: 0.0 + :efd2: Exciter voltage at which exciter saturation is defined (E). Typical Value = 4.2. Default: 0.0 + :ka: Voltage regulator gain (K). Typical Value = 400. Default: 0.0 + :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gains (K). Typical Value = 0.03. Default: 0.0 + :seefd1: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.86. Default: 0.0 + :seefd2: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.5. Default: 0.0 + :ta: Voltage regulator time constant (T). Typical Value = 0.02. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.8. Default: 0.0 + :tf1: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0.0 + :tf2: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0.0 + :tf3: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0.0 + :vrmax: Maximum voltage regulator output (V). Typical Value = 7.3. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = -7.3. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efd1": [Profile.DY.value, ], + "efd2": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "seefd1": [Profile.DY.value, ], + "seefd2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf1": [Profile.DY.value, ], + "tf2": [Profile.DY.value, ], + "tf3": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efd1 = 0.0, efd2 = 0.0, ka = 0.0, ke = 0.0, kf = 0.0, seefd1 = 0.0, seefd2 = 0.0, ta = 0.0, te = 0.0, tf1 = 0.0, tf2 = 0.0, tf3 = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efd1 = efd1 + self.efd2 = efd2 + self.ka = ka + self.ke = ke + self.kf = kf + self.seefd1 = seefd1 + self.seefd2 = seefd2 + self.ta = ta + self.te = te + self.tf1 = tf1 + self.tf2 = tf2 + self.tf3 = tf3 + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEAC5A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEAC6A.py b/cimpy/cgmes_v2_4_15/ExcIEEEAC6A.py index 2c188819..f2da23a9 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEAC6A.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEAC6A.py @@ -1,94 +1,96 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEAC6A(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type AC6A model. The model represents field-controlled alternator-rectifier excitation systems with system-supplied electronic voltage regulators. The maximum output of the regulator, , is a function of terminal voltage, . The field current limiter included in the original model AC6A remains in the 2005 update. Reference: IEEE Standard 421.5-2005 Section 6.6. - - :ka: Voltage regulator gain (K). Typical Value = 536. Default: 0.0 - :ta: Voltage regulator time constant (T). Typical Value = 0.086. Default: 0 - :tk: Voltage regulator time constant (T). Typical Value = 0.18. Default: 0 - :tb: Voltage regulator time constant (T). Typical Value = 9. Default: 0 - :tc: Voltage regulator time constant (T). Typical Value = 3. Default: 0 - :vamax: Maximum voltage regulator output (V). Typical Value = 75. Default: 0.0 - :vamin: Minimum voltage regulator output (V). Typical Value = -75. Default: 0.0 - :vrmax: Maximum voltage regulator output (V). Typical Value = 44. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = -36. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 1. Default: 0 - :kh: Exciter field current limiter gain (K). Typical Value = 92. Default: 0.0 - :tj: Exciter field current limiter time constant (T). Typical Value = 0.02. Default: 0 - :th: Exciter field current limiter time constant (T). Typical Value = 0.08. Default: 0 - :vfelim: Exciter field current limit reference (V). Typical Value = 19. Default: 0.0 - :vhmax: Maximum field current limiter signal reference (V). Typical Value = 75. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.173. Default: 0.0 - :kd: Demagnetizing factor, a function of exciter alternator reactances (K). Typical Value = 1.91. Default: 0.0 - :ke: Exciter constant related to self-excited field (K). Typical Value = 1.6. Default: 0.0 - :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V) equals V(V). Typical Value = 7.4. Default: 0.0 - :seve1: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.214. Default: 0.0 - :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 5.55. Default: 0.0 - :seve2: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.044. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tk': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'vamax': [cgmesProfile.DY.value, ], - 'vamin': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kh': [cgmesProfile.DY.value, ], - 'tj': [cgmesProfile.DY.value, ], - 'th': [cgmesProfile.DY.value, ], - 'vfelim': [cgmesProfile.DY.value, ], - 'vhmax': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 've1': [cgmesProfile.DY.value, ], - 'seve1': [cgmesProfile.DY.value, ], - 've2': [cgmesProfile.DY.value, ], - 'seve2': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, ta = 0, tk = 0, tb = 0, tc = 0, vamax = 0.0, vamin = 0.0, vrmax = 0.0, vrmin = 0.0, te = 0, kh = 0.0, tj = 0, th = 0, vfelim = 0.0, vhmax = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, ve1 = 0.0, seve1 = 0.0, ve2 = 0.0, seve2 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.ta = ta - self.tk = tk - self.tb = tb - self.tc = tc - self.vamax = vamax - self.vamin = vamin - self.vrmax = vrmax - self.vrmin = vrmin - self.te = te - self.kh = kh - self.tj = tj - self.th = th - self.vfelim = vfelim - self.vhmax = vhmax - self.kc = kc - self.kd = kd - self.ke = ke - self.ve1 = ve1 - self.seve1 = seve1 - self.ve2 = ve2 - self.seve2 = seve2 - - def __str__(self): - str = 'class=ExcIEEEAC6A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEAC6A(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type AC6A model. The model represents field-controlled alternator-rectifier excitation systems with system-supplied electronic voltage regulators. The maximum output of the regulator, , is a function of terminal voltage, . The field current limiter included in the original model AC6A remains in the 2005 update. Reference: IEEE Standard 421.5-2005 Section 6.6. + + :ka: Voltage regulator gain (K). Typical Value = 536. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.173. Default: 0.0 + :kd: Demagnetizing factor, a function of exciter alternator reactances (K). Typical Value = 1.91. Default: 0.0 + :ke: Exciter constant related to self-excited field (K). Typical Value = 1.6. Default: 0.0 + :kh: Exciter field current limiter gain (K). Typical Value = 92. Default: 0.0 + :seve1: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.214. Default: 0.0 + :seve2: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.044. Default: 0.0 + :ta: Voltage regulator time constant (T). Typical Value = 0.086. Default: 0.0 + :tb: Voltage regulator time constant (T). Typical Value = 9. Default: 0.0 + :tc: Voltage regulator time constant (T). Typical Value = 3. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 1. Default: 0.0 + :th: Exciter field current limiter time constant (T). Typical Value = 0.08. Default: 0.0 + :tj: Exciter field current limiter time constant (T). Typical Value = 0.02. Default: 0.0 + :tk: Voltage regulator time constant (T). Typical Value = 0.18. Default: 0.0 + :vamax: Maximum voltage regulator output (V). Typical Value = 75. Default: 0.0 + :vamin: Minimum voltage regulator output (V). Typical Value = -75. Default: 0.0 + :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V) equals V(V). Typical Value = 7.4. Default: 0.0 + :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 5.55. Default: 0.0 + :vfelim: Exciter field current limit reference (V). Typical Value = 19. Default: 0.0 + :vhmax: Maximum field current limiter signal reference (V). Typical Value = 75. Default: 0.0 + :vrmax: Maximum voltage regulator output (V). Typical Value = 44. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = -36. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kh": [Profile.DY.value, ], + "seve1": [Profile.DY.value, ], + "seve2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "th": [Profile.DY.value, ], + "tj": [Profile.DY.value, ], + "tk": [Profile.DY.value, ], + "vamax": [Profile.DY.value, ], + "vamin": [Profile.DY.value, ], + "ve1": [Profile.DY.value, ], + "ve2": [Profile.DY.value, ], + "vfelim": [Profile.DY.value, ], + "vhmax": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ka = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, kh = 0.0, seve1 = 0.0, seve2 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, th = 0.0, tj = 0.0, tk = 0.0, vamax = 0.0, vamin = 0.0, ve1 = 0.0, ve2 = 0.0, vfelim = 0.0, vhmax = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ka = ka + self.kc = kc + self.kd = kd + self.ke = ke + self.kh = kh + self.seve1 = seve1 + self.seve2 = seve2 + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.th = th + self.tj = tj + self.tk = tk + self.vamax = vamax + self.vamin = vamin + self.ve1 = ve1 + self.ve2 = ve2 + self.vfelim = vfelim + self.vhmax = vhmax + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEAC6A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEAC7B.py b/cimpy/cgmes_v2_4_15/ExcIEEEAC7B.py index f63e72ce..08995d86 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEAC7B.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEAC7B.py @@ -1,106 +1,108 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEAC7B(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type AC7B model. The model represents excitation systems which consist of an ac alternator with either stationary or rotating rectifiers to produce the dc field requirements. It is an upgrade to earlier ac excitation systems, which replace only the controls but retain the ac alternator and diode rectifier bridge. Reference: IEEE Standard 421.5-2005 Section 6.7. In the IEEE Standard 421.5 - 2005, the [1 / sT] block is shown as [1 / (1 + sT)], which is incorrect. - - :kpr: Voltage regulator proportional gain (K). Typical Value = 4.24. Default: 0.0 - :kir: Voltage regulator integral gain (K). Typical Value = 4.24. Default: 0.0 - :kdr: Voltage regulator derivative gain (K). Typical Value = 0. Default: 0.0 - :tdr: Lag time constant (T). Typical Value = 0. Default: 0 - :vrmax: Maximum voltage regulator output (V). Typical Value = 5.79. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = -5.79. Default: 0.0 - :kpa: Voltage regulator proportional gain (K). Typical Value = 65.36. Default: 0.0 - :kia: Voltage regulator integral gain (K). Typical Value = 59.69. Default: 0.0 - :vamax: Maximum voltage regulator output (V). Typical Value = 1. Default: 0.0 - :vamin: Minimum voltage regulator output (V). Typical Value = -0.95. Default: 0.0 - :kp: Potential circuit gain coefficient (K). Typical Value = 4.96. Default: 0.0 - :kl: Exciter field voltage lower limit parameter (K). Typical Value = 10. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 1.1. Default: 0 - :vfemax: Exciter field current limit reference (V). Typical Value = 6.9. Default: 0.0 - :vemin: Minimum exciter voltage output (V). Typical Value = 0. Default: 0.0 - :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.18. Default: 0.0 - :kd: Demagnetizing factor, a function of exciter alternator reactances (K). Typical Value = 0.02. Default: 0.0 - :kf1: Excitation control system stabilizer gain (K). Typical Value = 0.212. Default: 0.0 - :kf2: Excitation control system stabilizer gain (K). Typical Value = 0. Default: 0.0 - :kf3: Excitation control system stabilizer gain (K). Typical Value = 0. Default: 0.0 - :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0 - :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V) equals V (V). Typical Value = 6.3. Default: 0.0 - :seve1: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.44. Default: 0.0 - :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 3.02. Default: 0.0 - :seve2: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.075. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kpr': [cgmesProfile.DY.value, ], - 'kir': [cgmesProfile.DY.value, ], - 'kdr': [cgmesProfile.DY.value, ], - 'tdr': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'kpa': [cgmesProfile.DY.value, ], - 'kia': [cgmesProfile.DY.value, ], - 'vamax': [cgmesProfile.DY.value, ], - 'vamin': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'kl': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'vfemax': [cgmesProfile.DY.value, ], - 'vemin': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'kf1': [cgmesProfile.DY.value, ], - 'kf2': [cgmesProfile.DY.value, ], - 'kf3': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 've1': [cgmesProfile.DY.value, ], - 'seve1': [cgmesProfile.DY.value, ], - 've2': [cgmesProfile.DY.value, ], - 'seve2': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, kpr = 0.0, kir = 0.0, kdr = 0.0, tdr = 0, vrmax = 0.0, vrmin = 0.0, kpa = 0.0, kia = 0.0, vamax = 0.0, vamin = 0.0, kp = 0.0, kl = 0.0, te = 0, vfemax = 0.0, vemin = 0.0, ke = 0.0, kc = 0.0, kd = 0.0, kf1 = 0.0, kf2 = 0.0, kf3 = 0.0, tf = 0, ve1 = 0.0, seve1 = 0.0, ve2 = 0.0, seve2 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kpr = kpr - self.kir = kir - self.kdr = kdr - self.tdr = tdr - self.vrmax = vrmax - self.vrmin = vrmin - self.kpa = kpa - self.kia = kia - self.vamax = vamax - self.vamin = vamin - self.kp = kp - self.kl = kl - self.te = te - self.vfemax = vfemax - self.vemin = vemin - self.ke = ke - self.kc = kc - self.kd = kd - self.kf1 = kf1 - self.kf2 = kf2 - self.kf3 = kf3 - self.tf = tf - self.ve1 = ve1 - self.seve1 = seve1 - self.ve2 = ve2 - self.seve2 = seve2 - - def __str__(self): - str = 'class=ExcIEEEAC7B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEAC7B(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type AC7B model. The model represents excitation systems which consist of an ac alternator with either stationary or rotating rectifiers to produce the dc field requirements. It is an upgrade to earlier ac excitation systems, which replace only the controls but retain the ac alternator and diode rectifier bridge. Reference: IEEE Standard 421.5-2005 Section 6.7. In the IEEE Standard 421.5 - 2005, the [1 / sT] block is shown as [1 / (1 + sT)], which is incorrect. + + :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.18. Default: 0.0 + :kd: Demagnetizing factor, a function of exciter alternator reactances (K). Typical Value = 0.02. Default: 0.0 + :kdr: Voltage regulator derivative gain (K). Typical Value = 0. Default: 0.0 + :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 + :kf1: Excitation control system stabilizer gain (K). Typical Value = 0.212. Default: 0.0 + :kf2: Excitation control system stabilizer gain (K). Typical Value = 0. Default: 0.0 + :kf3: Excitation control system stabilizer gain (K). Typical Value = 0. Default: 0.0 + :kia: Voltage regulator integral gain (K). Typical Value = 59.69. Default: 0.0 + :kir: Voltage regulator integral gain (K). Typical Value = 4.24. Default: 0.0 + :kl: Exciter field voltage lower limit parameter (K). Typical Value = 10. Default: 0.0 + :kp: Potential circuit gain coefficient (K). Typical Value = 4.96. Default: 0.0 + :kpa: Voltage regulator proportional gain (K). Typical Value = 65.36. Default: 0.0 + :kpr: Voltage regulator proportional gain (K). Typical Value = 4.24. Default: 0.0 + :seve1: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.44. Default: 0.0 + :seve2: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.075. Default: 0.0 + :tdr: Lag time constant (T). Typical Value = 0. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 1.1. Default: 0.0 + :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0.0 + :vamax: Maximum voltage regulator output (V). Typical Value = 1. Default: 0.0 + :vamin: Minimum voltage regulator output (V). Typical Value = -0.95. Default: 0.0 + :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V) equals V (V). Typical Value = 6.3. Default: 0.0 + :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 3.02. Default: 0.0 + :vemin: Minimum exciter voltage output (V). Typical Value = 0. Default: 0.0 + :vfemax: Exciter field current limit reference (V). Typical Value = 6.9. Default: 0.0 + :vrmax: Maximum voltage regulator output (V). Typical Value = 5.79. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = -5.79. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "kdr": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf1": [Profile.DY.value, ], + "kf2": [Profile.DY.value, ], + "kf3": [Profile.DY.value, ], + "kia": [Profile.DY.value, ], + "kir": [Profile.DY.value, ], + "kl": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "kpa": [Profile.DY.value, ], + "kpr": [Profile.DY.value, ], + "seve1": [Profile.DY.value, ], + "seve2": [Profile.DY.value, ], + "tdr": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "vamax": [Profile.DY.value, ], + "vamin": [Profile.DY.value, ], + "ve1": [Profile.DY.value, ], + "ve2": [Profile.DY.value, ], + "vemin": [Profile.DY.value, ], + "vfemax": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, kc = 0.0, kd = 0.0, kdr = 0.0, ke = 0.0, kf1 = 0.0, kf2 = 0.0, kf3 = 0.0, kia = 0.0, kir = 0.0, kl = 0.0, kp = 0.0, kpa = 0.0, kpr = 0.0, seve1 = 0.0, seve2 = 0.0, tdr = 0.0, te = 0.0, tf = 0.0, vamax = 0.0, vamin = 0.0, ve1 = 0.0, ve2 = 0.0, vemin = 0.0, vfemax = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.kc = kc + self.kd = kd + self.kdr = kdr + self.ke = ke + self.kf1 = kf1 + self.kf2 = kf2 + self.kf3 = kf3 + self.kia = kia + self.kir = kir + self.kl = kl + self.kp = kp + self.kpa = kpa + self.kpr = kpr + self.seve1 = seve1 + self.seve2 = seve2 + self.tdr = tdr + self.te = te + self.tf = tf + self.vamax = vamax + self.vamin = vamin + self.ve1 = ve1 + self.ve2 = ve2 + self.vemin = vemin + self.vfemax = vfemax + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEAC7B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEAC8B.py b/cimpy/cgmes_v2_4_15/ExcIEEEAC8B.py index 02c5f630..a06bad68 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEAC8B.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEAC8B.py @@ -1,82 +1,84 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEAC8B(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type AC8B model. This model represents a PID voltage regulator with either a brushless exciter or dc exciter. The AVR in this model consists of PID control, with separate constants for the proportional (), integral (), and derivative () gains. The representation of the brushless exciter (, , , , ) is similar to the model Type AC2A. The Type AC8B model can be used to represent static voltage regulators applied to brushless excitation systems. Digitally based voltage regulators feeding dc rotating main exciters can be represented with the AC Type AC8B model with the parameters and set to 0. For thyristor power stages fed from the generator terminals, the limits and should be a function of terminal voltage: * and * . Reference: IEEE Standard 421.5-2005 Section 6.8. - - :kpr: Voltage regulator proportional gain (K). Typical Value = 80. Default: 0.0 - :kir: Voltage regulator integral gain (K). Typical Value = 5. Default: 0.0 - :kdr: Voltage regulator derivative gain (K). Typical Value = 10. Default: 0.0 - :tdr: Lag time constant (T). Typical Value = 0.1. Default: 0 - :vrmax: Maximum voltage regulator output (V). Typical Value = 35. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = 0. Default: 0.0 - :ka: Voltage regulator gain (K). Typical Value = 1. Default: 0.0 - :ta: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 1.2. Default: 0 - :vfemax: Exciter field current limit reference (V). Typical Value = 6. Default: 0.0 - :vemin: Minimum exciter voltage output (V). Typical Value = 0. Default: 0.0 - :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.55. Default: 0.0 - :kd: Demagnetizing factor, a function of exciter alternator reactances (K). Typical Value = 1.1. Default: 0.0 - :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V) equals V (V). Typical Value = 6.5. Default: 0.0 - :seve1: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.3. Default: 0.0 - :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 9. Default: 0.0 - :seve2: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 3. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kpr': [cgmesProfile.DY.value, ], - 'kir': [cgmesProfile.DY.value, ], - 'kdr': [cgmesProfile.DY.value, ], - 'tdr': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'vfemax': [cgmesProfile.DY.value, ], - 'vemin': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 've1': [cgmesProfile.DY.value, ], - 'seve1': [cgmesProfile.DY.value, ], - 've2': [cgmesProfile.DY.value, ], - 'seve2': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, kpr = 0.0, kir = 0.0, kdr = 0.0, tdr = 0, vrmax = 0.0, vrmin = 0.0, ka = 0.0, ta = 0, te = 0, vfemax = 0.0, vemin = 0.0, ke = 0.0, kc = 0.0, kd = 0.0, ve1 = 0.0, seve1 = 0.0, ve2 = 0.0, seve2 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kpr = kpr - self.kir = kir - self.kdr = kdr - self.tdr = tdr - self.vrmax = vrmax - self.vrmin = vrmin - self.ka = ka - self.ta = ta - self.te = te - self.vfemax = vfemax - self.vemin = vemin - self.ke = ke - self.kc = kc - self.kd = kd - self.ve1 = ve1 - self.seve1 = seve1 - self.ve2 = ve2 - self.seve2 = seve2 - - def __str__(self): - str = 'class=ExcIEEEAC8B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEAC8B(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type AC8B model. This model represents a PID voltage regulator with either a brushless exciter or dc exciter. The AVR in this model consists of PID control, with separate constants for the proportional (), integral (), and derivative () gains. The representation of the brushless exciter (, , , , ) is similar to the model Type AC2A. The Type AC8B model can be used to represent static voltage regulators applied to brushless excitation systems. Digitally based voltage regulators feeding dc rotating main exciters can be represented with the AC Type AC8B model with the parameters and set to 0. For thyristor power stages fed from the generator terminals, the limits and should be a function of terminal voltage: * and * . Reference: IEEE Standard 421.5-2005 Section 6.8. + + :ka: Voltage regulator gain (K). Typical Value = 1. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.55. Default: 0.0 + :kd: Demagnetizing factor, a function of exciter alternator reactances (K). Typical Value = 1.1. Default: 0.0 + :kdr: Voltage regulator derivative gain (K). Typical Value = 10. Default: 0.0 + :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 + :kir: Voltage regulator integral gain (K). Typical Value = 5. Default: 0.0 + :kpr: Voltage regulator proportional gain (K). Typical Value = 80. Default: 0.0 + :seve1: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 0.3. Default: 0.0 + :seve2: Exciter saturation function value at the corresponding exciter voltage, V, back of commutating reactance (S[V]). Typical Value = 3. Default: 0.0 + :ta: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :tdr: Lag time constant (T). Typical Value = 0.1. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 1.2. Default: 0.0 + :ve1: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V) equals V (V). Typical Value = 6.5. Default: 0.0 + :ve2: Exciter alternator output voltages back of commutating reactance at which saturation is defined (V). Typical Value = 9. Default: 0.0 + :vemin: Minimum exciter voltage output (V). Typical Value = 0. Default: 0.0 + :vfemax: Exciter field current limit reference (V). Typical Value = 6. Default: 0.0 + :vrmax: Maximum voltage regulator output (V). Typical Value = 35. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "kdr": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kir": [Profile.DY.value, ], + "kpr": [Profile.DY.value, ], + "seve1": [Profile.DY.value, ], + "seve2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tdr": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "ve1": [Profile.DY.value, ], + "ve2": [Profile.DY.value, ], + "vemin": [Profile.DY.value, ], + "vfemax": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ka = 0.0, kc = 0.0, kd = 0.0, kdr = 0.0, ke = 0.0, kir = 0.0, kpr = 0.0, seve1 = 0.0, seve2 = 0.0, ta = 0.0, tdr = 0.0, te = 0.0, ve1 = 0.0, ve2 = 0.0, vemin = 0.0, vfemax = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ka = ka + self.kc = kc + self.kd = kd + self.kdr = kdr + self.ke = ke + self.kir = kir + self.kpr = kpr + self.seve1 = seve1 + self.seve2 = seve2 + self.ta = ta + self.tdr = tdr + self.te = te + self.ve1 = ve1 + self.ve2 = ve2 + self.vemin = vemin + self.vfemax = vfemax + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEAC8B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEDC1A.py b/cimpy/cgmes_v2_4_15/ExcIEEEDC1A.py index 2a915328..ac92fafa 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEDC1A.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEDC1A.py @@ -1,76 +1,78 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEDC1A(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type DC1A model. This model represents field-controlled dc commutator exciters with continuously acting voltage regulators (especially the direct-acting rheostatic, rotating amplifier, and magnetic amplifier types). Because this model has been widely implemented by the industry, it is sometimes used to represent other types of systems when detailed data for them are not available or when a simplified model is required. Reference: IEEE Standard 421.5-2005 Section 5.1. - - :ka: Voltage regulator gain (K). Typical Value = 46. Default: 0.0 - :ta: Voltage regulator time constant (T). Typical Value = 0.06. Default: 0 - :tb: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :vrmax: Maximum voltage regulator output (V). Typical Value = 1. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = -0.9. Default: 0.0 - :ke: Exciter constant related to self-excited field (K). Typical Value = 0. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.46. Default: 0 - :kf: Excitation control system stabilizer gain (K). Typical Value = 0.1. Default: 0.0 - :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0 - :efd1: Exciter voltage at which exciter saturation is defined (E). Typical Value = 3.1. Default: 0.0 - :seefd1: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.33. Default: 0.0 - :efd2: Exciter voltage at which exciter saturation is defined (E). Typical Value = 2.3. Default: 0.0 - :seefd2: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.1. Default: 0.0 - :uelin: UEL input (uelin). true = input is connected to the HV gate false = input connects to the error signal. Typical Value = true. Default: False - :exclim: (exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero is not applied to integrator output. Typical Value = true. Default: False - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'efd1': [cgmesProfile.DY.value, ], - 'seefd1': [cgmesProfile.DY.value, ], - 'efd2': [cgmesProfile.DY.value, ], - 'seefd2': [cgmesProfile.DY.value, ], - 'uelin': [cgmesProfile.DY.value, ], - 'exclim': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, ta = 0, tb = 0, tc = 0, vrmax = 0.0, vrmin = 0.0, ke = 0.0, te = 0, kf = 0.0, tf = 0, efd1 = 0.0, seefd1 = 0.0, efd2 = 0.0, seefd2 = 0.0, uelin = False, exclim = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.ta = ta - self.tb = tb - self.tc = tc - self.vrmax = vrmax - self.vrmin = vrmin - self.ke = ke - self.te = te - self.kf = kf - self.tf = tf - self.efd1 = efd1 - self.seefd1 = seefd1 - self.efd2 = efd2 - self.seefd2 = seefd2 - self.uelin = uelin - self.exclim = exclim - - def __str__(self): - str = 'class=ExcIEEEDC1A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEDC1A(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type DC1A model. This model represents field-controlled dc commutator exciters with continuously acting voltage regulators (especially the direct-acting rheostatic, rotating amplifier, and magnetic amplifier types). Because this model has been widely implemented by the industry, it is sometimes used to represent other types of systems when detailed data for them are not available or when a simplified model is required. Reference: IEEE Standard 421.5-2005 Section 5.1. + + :efd1: Exciter voltage at which exciter saturation is defined (E). Typical Value = 3.1. Default: 0.0 + :efd2: Exciter voltage at which exciter saturation is defined (E). Typical Value = 2.3. Default: 0.0 + :exclim: (exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero is not applied to integrator output. Typical Value = true. Default: False + :ka: Voltage regulator gain (K). Typical Value = 46. Default: 0.0 + :ke: Exciter constant related to self-excited field (K). Typical Value = 0. Default: 0.0 + :kf: Excitation control system stabilizer gain (K). Typical Value = 0.1. Default: 0.0 + :seefd1: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.33. Default: 0.0 + :seefd2: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.1. Default: 0.0 + :ta: Voltage regulator time constant (T). Typical Value = 0.06. Default: 0.0 + :tb: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.46. Default: 0.0 + :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0.0 + :uelin: UEL input (uelin). true = input is connected to the HV gate false = input connects to the error signal. Typical Value = true. Default: False + :vrmax: Maximum voltage regulator output (V). Typical Value = 1. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = -0.9. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efd1": [Profile.DY.value, ], + "efd2": [Profile.DY.value, ], + "exclim": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "seefd1": [Profile.DY.value, ], + "seefd2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "uelin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efd1 = 0.0, efd2 = 0.0, exclim = False, ka = 0.0, ke = 0.0, kf = 0.0, seefd1 = 0.0, seefd2 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, tf = 0.0, uelin = False, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efd1 = efd1 + self.efd2 = efd2 + self.exclim = exclim + self.ka = ka + self.ke = ke + self.kf = kf + self.seefd1 = seefd1 + self.seefd2 = seefd2 + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.tf = tf + self.uelin = uelin + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEDC1A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEDC2A.py b/cimpy/cgmes_v2_4_15/ExcIEEEDC2A.py index b38cee59..7874adbf 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEDC2A.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEDC2A.py @@ -1,76 +1,78 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEDC2A(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type DC2A model. This model represents represent field-controlled dc commutator exciters with continuously acting voltage regulators having supplies obtained from the generator or auxiliary bus. It differs from the Type DC1A model only in the voltage regulator output limits, which are now proportional to terminal voltage . It is representative of solid-state replacements for various forms of older mechanical and rotating amplifier regulating equipment connected to dc commutator exciters. Reference: IEEE Standard 421.5-2005 Section 5.2. - - :efd1: Exciter voltage at which exciter saturation is defined (E). Typical Value = 3.05. Default: 0.0 - :efd2: Exciter voltage at which exciter saturation is defined (E). Typical Value = 2.29. Default: 0.0 - :exclim: (exclim). IEEE standard is ambiguous about lower limit on exciter output. Typical Value = - 999 which means that there is no limit applied. Default: 0.0 - :ka: Voltage regulator gain (K). Typical Value = 300. Default: 0.0 - :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 - :kf: Excitation control system stabilizer gain (K). Typical Value = 0.1. Default: 0.0 - :seefd1: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.279. Default: 0.0 - :seefd2: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.117. Default: 0.0 - :ta: Voltage regulator time constant (T). Typical Value = 0.01. Default: 0 - :tb: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 1.33. Default: 0 - :tf: Excitation control system stabilizer time constant (T). Typical Value = 0.675. Default: 0 - :uelin: UEL input (uelin). true = input is connected to the HV gate false = input connects to the error signal. Typical Value = true. Default: False - :vrmax: Maximum voltage regulator output (V). Typical Value = 4.95. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = -4.9. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'efd1': [cgmesProfile.DY.value, ], - 'efd2': [cgmesProfile.DY.value, ], - 'exclim': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'seefd1': [cgmesProfile.DY.value, ], - 'seefd2': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'uelin': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, efd1 = 0.0, efd2 = 0.0, exclim = 0.0, ka = 0.0, ke = 0.0, kf = 0.0, seefd1 = 0.0, seefd2 = 0.0, ta = 0, tb = 0, tc = 0, te = 0, tf = 0, uelin = False, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.efd1 = efd1 - self.efd2 = efd2 - self.exclim = exclim - self.ka = ka - self.ke = ke - self.kf = kf - self.seefd1 = seefd1 - self.seefd2 = seefd2 - self.ta = ta - self.tb = tb - self.tc = tc - self.te = te - self.tf = tf - self.uelin = uelin - self.vrmax = vrmax - self.vrmin = vrmin - - def __str__(self): - str = 'class=ExcIEEEDC2A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEDC2A(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type DC2A model. This model represents represent field-controlled dc commutator exciters with continuously acting voltage regulators having supplies obtained from the generator or auxiliary bus. It differs from the Type DC1A model only in the voltage regulator output limits, which are now proportional to terminal voltage . It is representative of solid-state replacements for various forms of older mechanical and rotating amplifier regulating equipment connected to dc commutator exciters. Reference: IEEE Standard 421.5-2005 Section 5.2. + + :efd1: Exciter voltage at which exciter saturation is defined (E). Typical Value = 3.05. Default: 0.0 + :efd2: Exciter voltage at which exciter saturation is defined (E). Typical Value = 2.29. Default: 0.0 + :exclim: (exclim). IEEE standard is ambiguous about lower limit on exciter output. Typical Value = - 999 which means that there is no limit applied. Default: 0.0 + :ka: Voltage regulator gain (K). Typical Value = 300. Default: 0.0 + :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gain (K). Typical Value = 0.1. Default: 0.0 + :seefd1: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.279. Default: 0.0 + :seefd2: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.117. Default: 0.0 + :ta: Voltage regulator time constant (T). Typical Value = 0.01. Default: 0.0 + :tb: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 1.33. Default: 0.0 + :tf: Excitation control system stabilizer time constant (T). Typical Value = 0.675. Default: 0.0 + :uelin: UEL input (uelin). true = input is connected to the HV gate false = input connects to the error signal. Typical Value = true. Default: False + :vrmax: Maximum voltage regulator output (V). Typical Value = 4.95. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = -4.9. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efd1": [Profile.DY.value, ], + "efd2": [Profile.DY.value, ], + "exclim": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "seefd1": [Profile.DY.value, ], + "seefd2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "uelin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efd1 = 0.0, efd2 = 0.0, exclim = 0.0, ka = 0.0, ke = 0.0, kf = 0.0, seefd1 = 0.0, seefd2 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, tf = 0.0, uelin = False, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efd1 = efd1 + self.efd2 = efd2 + self.exclim = exclim + self.ka = ka + self.ke = ke + self.kf = kf + self.seefd1 = seefd1 + self.seefd2 = seefd2 + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.tf = tf + self.uelin = uelin + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEDC2A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEDC3A.py b/cimpy/cgmes_v2_4_15/ExcIEEEDC3A.py index 1302a51d..9c1063de 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEDC3A.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEDC3A.py @@ -1,61 +1,63 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEDC3A(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type DC3A model. This model represents represent older systems, in particular those dc commutator exciters with non-continuously acting regulators that were commonly used before the development of the continuously acting varieties. These systems respond at basically two different rates, depending upon the magnitude of voltage error. For small errors, adjustment is made periodically with a signal to a motor-operated rheostat. Larger errors cause resistors to be quickly shorted or inserted and a strong forcing signal applied to the exciter. Continuous motion of the motor-operated rheostat occurs for these larger error signals, even though it is bypassed by contactor action. Reference: IEEE Standard 421.5-2005 Section 5.3. - - :trh: Rheostat travel time (T). Typical Value = 20. Default: 0 - :kv: Fast raise/lower contact setting (K). Typical Value = 0.05. Default: 0.0 - :vrmax: Maximum voltage regulator output (V). Typical Value = 1. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = 0. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.5. Default: 0 - :ke: Exciter constant related to self-excited field (K). Typical Value = 0.05. Default: 0.0 - :efd1: Exciter voltage at which exciter saturation is defined (E). Typical Value = 3.375. Default: 0.0 - :seefd1: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.267. Default: 0.0 - :efd2: Exciter voltage at which exciter saturation is defined (E). Typical Value = 3.15. Default: 0.0 - :seefd2: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.068. Default: 0.0 - :exclim: (exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero is not applied to integrator output. Typical Value = true. Default: False - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'trh': [cgmesProfile.DY.value, ], - 'kv': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'efd1': [cgmesProfile.DY.value, ], - 'seefd1': [cgmesProfile.DY.value, ], - 'efd2': [cgmesProfile.DY.value, ], - 'seefd2': [cgmesProfile.DY.value, ], - 'exclim': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, trh = 0, kv = 0.0, vrmax = 0.0, vrmin = 0.0, te = 0, ke = 0.0, efd1 = 0.0, seefd1 = 0.0, efd2 = 0.0, seefd2 = 0.0, exclim = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.trh = trh - self.kv = kv - self.vrmax = vrmax - self.vrmin = vrmin - self.te = te - self.ke = ke - self.efd1 = efd1 - self.seefd1 = seefd1 - self.efd2 = efd2 - self.seefd2 = seefd2 - self.exclim = exclim - - def __str__(self): - str = 'class=ExcIEEEDC3A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEDC3A(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type DC3A model. This model represents represent older systems, in particular those dc commutator exciters with non-continuously acting regulators that were commonly used before the development of the continuously acting varieties. These systems respond at basically two different rates, depending upon the magnitude of voltage error. For small errors, adjustment is made periodically with a signal to a motor-operated rheostat. Larger errors cause resistors to be quickly shorted or inserted and a strong forcing signal applied to the exciter. Continuous motion of the motor-operated rheostat occurs for these larger error signals, even though it is bypassed by contactor action. Reference: IEEE Standard 421.5-2005 Section 5.3. + + :efd1: Exciter voltage at which exciter saturation is defined (E). Typical Value = 3.375. Default: 0.0 + :efd2: Exciter voltage at which exciter saturation is defined (E). Typical Value = 3.15. Default: 0.0 + :exclim: (exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero is not applied to integrator output. Typical Value = true. Default: False + :ke: Exciter constant related to self-excited field (K). Typical Value = 0.05. Default: 0.0 + :kv: Fast raise/lower contact setting (K). Typical Value = 0.05. Default: 0.0 + :seefd1: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.267. Default: 0.0 + :seefd2: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.068. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.5. Default: 0.0 + :trh: Rheostat travel time (T). Typical Value = 20. Default: 0.0 + :vrmax: Maximum voltage regulator output (V). Typical Value = 1. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efd1": [Profile.DY.value, ], + "efd2": [Profile.DY.value, ], + "exclim": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kv": [Profile.DY.value, ], + "seefd1": [Profile.DY.value, ], + "seefd2": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "trh": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efd1 = 0.0, efd2 = 0.0, exclim = False, ke = 0.0, kv = 0.0, seefd1 = 0.0, seefd2 = 0.0, te = 0.0, trh = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efd1 = efd1 + self.efd2 = efd2 + self.exclim = exclim + self.ke = ke + self.kv = kv + self.seefd1 = seefd1 + self.seefd2 = seefd2 + self.te = te + self.trh = trh + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEDC3A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEDC4B.py b/cimpy/cgmes_v2_4_15/ExcIEEEDC4B.py index 7584e07c..3d630ce0 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEDC4B.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEDC4B.py @@ -1,85 +1,87 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEDC4B(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type DC4B model. These excitation systems utilize a field-controlled dc commutator exciter with a continuously acting voltage regulator having supplies obtained from the generator or auxiliary bus. Reference: IEEE Standard 421.5-2005 Section 5.4. - - :ka: Voltage regulator gain (K). Typical Value = 1. Default: 0.0 - :ta: Voltage regulator time constant (T). Typical Value = 0.2. Default: 0 - :kp: Regulator proportional gain (K). Typical Value = 20. Default: 0.0 - :ki: Regulator integral gain (K). Typical Value = 20. Default: 0.0 - :kd: Regulator derivative gain (K). Typical Value = 20. Default: 0.0 - :td: Regulator derivative filter time constant(T). Typical Value = 0.01. Default: 0 - :vrmax: Maximum voltage regulator output (V). Typical Value = 2.7. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = -0.9. Default: 0.0 - :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.8. Default: 0 - :kf: Excitation control system stabilizer gain (K). Typical Value = 0. Default: 0.0 - :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0 - :efd1: Exciter voltage at which exciter saturation is defined (E). Typical Value = 1.75. Default: 0.0 - :seefd1: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.08. Default: 0.0 - :efd2: Exciter voltage at which exciter saturation is defined (E). Typical Value = 2.33. Default: 0.0 - :seefd2: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.27. Default: 0.0 - :vemin: Minimum exciter voltage output(V). Typical Value = 0. Default: 0.0 - :oelin: OEL input (OELin). true = LV gate false = subtract from error signal. Typical Value = true. Default: False - :uelin: UEL input (UELin). true = HV gate false = add to error signal. Typical Value = true. Default: False - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'td': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'efd1': [cgmesProfile.DY.value, ], - 'seefd1': [cgmesProfile.DY.value, ], - 'efd2': [cgmesProfile.DY.value, ], - 'seefd2': [cgmesProfile.DY.value, ], - 'vemin': [cgmesProfile.DY.value, ], - 'oelin': [cgmesProfile.DY.value, ], - 'uelin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, ta = 0, kp = 0.0, ki = 0.0, kd = 0.0, td = 0, vrmax = 0.0, vrmin = 0.0, ke = 0.0, te = 0, kf = 0.0, tf = 0, efd1 = 0.0, seefd1 = 0.0, efd2 = 0.0, seefd2 = 0.0, vemin = 0.0, oelin = False, uelin = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.ta = ta - self.kp = kp - self.ki = ki - self.kd = kd - self.td = td - self.vrmax = vrmax - self.vrmin = vrmin - self.ke = ke - self.te = te - self.kf = kf - self.tf = tf - self.efd1 = efd1 - self.seefd1 = seefd1 - self.efd2 = efd2 - self.seefd2 = seefd2 - self.vemin = vemin - self.oelin = oelin - self.uelin = uelin - - def __str__(self): - str = 'class=ExcIEEEDC4B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEDC4B(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type DC4B model. These excitation systems utilize a field-controlled dc commutator exciter with a continuously acting voltage regulator having supplies obtained from the generator or auxiliary bus. Reference: IEEE Standard 421.5-2005 Section 5.4. + + :efd1: Exciter voltage at which exciter saturation is defined (E). Typical Value = 1.75. Default: 0.0 + :efd2: Exciter voltage at which exciter saturation is defined (E). Typical Value = 2.33. Default: 0.0 + :ka: Voltage regulator gain (K). Typical Value = 1. Default: 0.0 + :kd: Regulator derivative gain (K). Typical Value = 20. Default: 0.0 + :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gain (K). Typical Value = 0. Default: 0.0 + :ki: Regulator integral gain (K). Typical Value = 20. Default: 0.0 + :kp: Regulator proportional gain (K). Typical Value = 20. Default: 0.0 + :oelin: OEL input (OELin). true = LV gate false = subtract from error signal. Typical Value = true. Default: False + :seefd1: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.08. Default: 0.0 + :seefd2: Exciter saturation function value at the corresponding exciter voltage, E (S[E]). Typical Value = 0.27. Default: 0.0 + :ta: Voltage regulator time constant (T). Typical Value = 0.2. Default: 0.0 + :td: Regulator derivative filter time constant(T). Typical Value = 0.01. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.8. Default: 0.0 + :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0.0 + :uelin: UEL input (UELin). true = HV gate false = add to error signal. Typical Value = true. Default: False + :vemin: Minimum exciter voltage output(V). Typical Value = 0. Default: 0.0 + :vrmax: Maximum voltage regulator output (V). Typical Value = 2.7. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = -0.9. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efd1": [Profile.DY.value, ], + "efd2": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "oelin": [Profile.DY.value, ], + "seefd1": [Profile.DY.value, ], + "seefd2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "td": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "uelin": [Profile.DY.value, ], + "vemin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efd1 = 0.0, efd2 = 0.0, ka = 0.0, kd = 0.0, ke = 0.0, kf = 0.0, ki = 0.0, kp = 0.0, oelin = False, seefd1 = 0.0, seefd2 = 0.0, ta = 0.0, td = 0.0, te = 0.0, tf = 0.0, uelin = False, vemin = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efd1 = efd1 + self.efd2 = efd2 + self.ka = ka + self.kd = kd + self.ke = ke + self.kf = kf + self.ki = ki + self.kp = kp + self.oelin = oelin + self.seefd1 = seefd1 + self.seefd2 = seefd2 + self.ta = ta + self.td = td + self.te = te + self.tf = tf + self.uelin = uelin + self.vemin = vemin + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEDC4B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEST1A.py b/cimpy/cgmes_v2_4_15/ExcIEEEST1A.py index 29851ab1..a692d0cf 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEST1A.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEST1A.py @@ -1,85 +1,87 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEST1A(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type ST1A model. This model represents systems in which excitation power is supplied through a transformer from the generator terminals (or the unit's auxiliary bus) and is regulated by a controlled rectifier. The maximum exciter voltage available from such systems is directly related to the generator terminal voltage. Reference: IEEE Standard 421.5-2005 Section 7.1. - - :ilr: Exciter output current limit reference (I). Typical Value = 0. Default: 0.0 - :ka: Voltage regulator gain (K). Typical Value = 190. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.08. Default: 0.0 - :kf: Excitation control system stabilizer gains (K). Typical Value = 0. Default: 0.0 - :klr: Exciter output current limiter gain (K). Typical Value = 0. Default: 0.0 - :pssin: Selector of the Power System Stabilizer (PSS) input (PSSin). true = PSS input (Vs) added to error signal false = PSS input (Vs) added to voltage regulator output. Typical Value = true. Default: False - :ta: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :tb: Voltage regulator time constant (T). Typical Value = 10. Default: 0 - :tb1: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :tc: Voltage regulator time constant (T). Typical Value = 1. Default: 0 - :tc1: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0 - :uelin: Selector of the connection of the UEL input (UELin). Typical Value = ignoreUELsignal. Default: None - :vamax: Maximum voltage regulator output (V). Typical Value = 14.5. Default: 0.0 - :vamin: Minimum voltage regulator output (V). Typical Value = -14.5. Default: 0.0 - :vimax: Maximum voltage regulator input limit (V). Typical Value = 999. Default: 0.0 - :vimin: Minimum voltage regulator input limit (V). Typical Value = -999. Default: 0.0 - :vrmax: Maximum voltage regulator outputs (V). Typical Value = 7.8. Default: 0.0 - :vrmin: Minimum voltage regulator outputs (V). Typical Value = -6.7. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ilr': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'klr': [cgmesProfile.DY.value, ], - 'pssin': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tb1': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'tc1': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'uelin': [cgmesProfile.DY.value, ], - 'vamax': [cgmesProfile.DY.value, ], - 'vamin': [cgmesProfile.DY.value, ], - 'vimax': [cgmesProfile.DY.value, ], - 'vimin': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ilr = 0.0, ka = 0.0, kc = 0.0, kf = 0.0, klr = 0.0, pssin = False, ta = 0, tb = 0, tb1 = 0, tc = 0, tc1 = 0, tf = 0, uelin = None, vamax = 0.0, vamin = 0.0, vimax = 0.0, vimin = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ilr = ilr - self.ka = ka - self.kc = kc - self.kf = kf - self.klr = klr - self.pssin = pssin - self.ta = ta - self.tb = tb - self.tb1 = tb1 - self.tc = tc - self.tc1 = tc1 - self.tf = tf - self.uelin = uelin - self.vamax = vamax - self.vamin = vamin - self.vimax = vimax - self.vimin = vimin - self.vrmax = vrmax - self.vrmin = vrmin - - def __str__(self): - str = 'class=ExcIEEEST1A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEST1A(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type ST1A model. This model represents systems in which excitation power is supplied through a transformer from the generator terminals (or the unit's auxiliary bus) and is regulated by a controlled rectifier. The maximum exciter voltage available from such systems is directly related to the generator terminal voltage. Reference: IEEE Standard 421.5-2005 Section 7.1. + + :ilr: Exciter output current limit reference (I). Typical Value = 0. Default: 0.0 + :ka: Voltage regulator gain (K). Typical Value = 190. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.08. Default: 0.0 + :kf: Excitation control system stabilizer gains (K). Typical Value = 0. Default: 0.0 + :klr: Exciter output current limiter gain (K). Typical Value = 0. Default: 0.0 + :pssin: Selector of the Power System Stabilizer (PSS) input (PSSin). true = PSS input (Vs) added to error signal false = PSS input (Vs) added to voltage regulator output. Typical Value = true. Default: False + :ta: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :tb: Voltage regulator time constant (T). Typical Value = 10. Default: 0.0 + :tb1: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (T). Typical Value = 1. Default: 0.0 + :tc1: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0.0 + :uelin: Selector of the connection of the UEL input (UELin). Typical Value = ignoreUELsignal. Default: None + :vamax: Maximum voltage regulator output (V). Typical Value = 14.5. Default: 0.0 + :vamin: Minimum voltage regulator output (V). Typical Value = -14.5. Default: 0.0 + :vimax: Maximum voltage regulator input limit (V). Typical Value = 999. Default: 0.0 + :vimin: Minimum voltage regulator input limit (V). Typical Value = -999. Default: 0.0 + :vrmax: Maximum voltage regulator outputs (V). Typical Value = 7.8. Default: 0.0 + :vrmin: Minimum voltage regulator outputs (V). Typical Value = -6.7. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ilr": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "klr": [Profile.DY.value, ], + "pssin": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tb1": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "tc1": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "uelin": [Profile.DY.value, ], + "vamax": [Profile.DY.value, ], + "vamin": [Profile.DY.value, ], + "vimax": [Profile.DY.value, ], + "vimin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ilr = 0.0, ka = 0.0, kc = 0.0, kf = 0.0, klr = 0.0, pssin = False, ta = 0.0, tb = 0.0, tb1 = 0.0, tc = 0.0, tc1 = 0.0, tf = 0.0, uelin = None, vamax = 0.0, vamin = 0.0, vimax = 0.0, vimin = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ilr = ilr + self.ka = ka + self.kc = kc + self.kf = kf + self.klr = klr + self.pssin = pssin + self.ta = ta + self.tb = tb + self.tb1 = tb1 + self.tc = tc + self.tc1 = tc1 + self.tf = tf + self.uelin = uelin + self.vamax = vamax + self.vamin = vamin + self.vimax = vimax + self.vimin = vimin + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEST1A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEST1AUELselectorKind.py b/cimpy/cgmes_v2_4_15/ExcIEEEST1AUELselectorKind.py index f6d2d347..a945bc4c 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEST1AUELselectorKind.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEST1AUELselectorKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class ExcIEEEST1AUELselectorKind(Base): - ''' - Type of connection for the UEL input used in ExcIEEEST1A. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=ExcIEEEST1AUELselectorKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ExcIEEEST1AUELselectorKind(Base): + """ + Type of connection for the UEL input used in ExcIEEEST1A. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=ExcIEEEST1AUELselectorKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEST2A.py b/cimpy/cgmes_v2_4_15/ExcIEEEST2A.py index a64ff3ac..e35d44be 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEST2A.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEST2A.py @@ -1,67 +1,69 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEST2A(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type ST2A model. Some static systems utilize both current and voltage sources (generator terminal quantities) to comprise the power source. The regulator controls the exciter output through controlled saturation of the power transformer components. These compound-source rectifier excitation systems are designated Type ST2A and are represented by ExcIEEEST2A. Reference: IEEE Standard 421.5-2005 Section 7.2. - - :ka: Voltage regulator gain (K). Typical Value = 120. Default: 0.0 - :ta: Voltage regulator time constant (T). Typical Value = 0.15. Default: 0 - :vrmax: Maximum voltage regulator outputs (V). Typical Value = 1. Default: 0.0 - :vrmin: Minimum voltage regulator outputs (V). Typical Value = 0. Default: 0.0 - :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.5. Default: 0 - :kf: Excitation control system stabilizer gains (K). Typical Value = 0.05. Default: 0.0 - :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0 - :kp: Potential circuit gain coefficient (K). Typical Value = 4.88. Default: 0.0 - :ki: Potential circuit gain coefficient (K). Typical Value = 8. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 1.82. Default: 0.0 - :efdmax: Maximum field voltage (E). Typical Value = 99. Default: 0.0 - :uelin: UEL input (UELin). true = HV gate false = add to error signal. Typical Value = true. Default: False - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'efdmax': [cgmesProfile.DY.value, ], - 'uelin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, ta = 0, vrmax = 0.0, vrmin = 0.0, ke = 0.0, te = 0, kf = 0.0, tf = 0, kp = 0.0, ki = 0.0, kc = 0.0, efdmax = 0.0, uelin = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.ta = ta - self.vrmax = vrmax - self.vrmin = vrmin - self.ke = ke - self.te = te - self.kf = kf - self.tf = tf - self.kp = kp - self.ki = ki - self.kc = kc - self.efdmax = efdmax - self.uelin = uelin - - def __str__(self): - str = 'class=ExcIEEEST2A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEST2A(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type ST2A model. Some static systems utilize both current and voltage sources (generator terminal quantities) to comprise the power source. The regulator controls the exciter output through controlled saturation of the power transformer components. These compound-source rectifier excitation systems are designated Type ST2A and are represented by ExcIEEEST2A. Reference: IEEE Standard 421.5-2005 Section 7.2. + + :efdmax: Maximum field voltage (E). Typical Value = 99. Default: 0.0 + :ka: Voltage regulator gain (K). Typical Value = 120. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 1.82. Default: 0.0 + :ke: Exciter constant related to self-excited field (K). Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gains (K). Typical Value = 0.05. Default: 0.0 + :ki: Potential circuit gain coefficient (K). Typical Value = 8. Default: 0.0 + :kp: Potential circuit gain coefficient (K). Typical Value = 4.88. Default: 0.0 + :ta: Voltage regulator time constant (T). Typical Value = 0.15. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (T). Typical Value = 0.5. Default: 0.0 + :tf: Excitation control system stabilizer time constant (T). Typical Value = 1. Default: 0.0 + :uelin: UEL input (UELin). true = HV gate false = add to error signal. Typical Value = true. Default: False + :vrmax: Maximum voltage regulator outputs (V). Typical Value = 1. Default: 0.0 + :vrmin: Minimum voltage regulator outputs (V). Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efdmax": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "uelin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efdmax = 0.0, ka = 0.0, kc = 0.0, ke = 0.0, kf = 0.0, ki = 0.0, kp = 0.0, ta = 0.0, te = 0.0, tf = 0.0, uelin = False, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efdmax = efdmax + self.ka = ka + self.kc = kc + self.ke = ke + self.kf = kf + self.ki = ki + self.kp = kp + self.ta = ta + self.te = te + self.tf = tf + self.uelin = uelin + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEST2A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEST3A.py b/cimpy/cgmes_v2_4_15/ExcIEEEST3A.py index 89e353d9..90e7e56e 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEST3A.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEST3A.py @@ -1,88 +1,90 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEST3A(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type ST3A model. Some static systems utilize a field voltage control loop to linearize the exciter control characteristic. This also makes the output independent of supply source variations until supply limitations are reached. These systems utilize a variety of controlled-rectifier designs: full thyristor complements or hybrid bridges in either series or shunt configurations. The power source may consist of only a potential source, either fed from the machine terminals or from internal windings. Some designs may have compound power sources utilizing both machine potential and current. These power sources are represented as phasor combinations of machine terminal current and voltage and are accommodated by suitable parameters in model Type ST3A which is represented by ExcIEEEST3A. Reference: IEEE Standard 421.5-2005 Section 7.3. - - :vimax: Maximum voltage regulator input limit (V). Typical Value = 0.2. Default: 0.0 - :vimin: Minimum voltage regulator input limit (V). Typical Value = -0.2. Default: 0.0 - :ka: Voltage regulator gain (K). This is parameter K in the IEEE Std. Typical Value = 200. Default: 0.0 - :ta: Voltage regulator time constant (T). Typical Value = 0. Default: 0 - :tb: Voltage regulator time constant (T). Typical Value = 10. Default: 0 - :tc: Voltage regulator time constant (T). Typical Value = 1. Default: 0 - :vrmax: Maximum voltage regulator output (V). Typical Value = 10. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = -10. Default: 0.0 - :km: Forward gain constant of the inner loop field regulator (K). Typical Value = 7.93. Default: 0.0 - :tm: Forward time constant of inner loop field regulator (T). Typical Value = 0.4. Default: 0 - :vmmax: Maximum inner loop output (V). Typical Value = 1. Default: 0.0 - :vmmin: Minimum inner loop output (V). Typical Value = 0. Default: 0.0 - :kg: Feedback gain constant of the inner loop field regulator (K). Typical Value = 1. Default: 0.0 - :kp: Potential circuit gain coefficient (K). Typical Value = 6.15. Default: 0.0 - :thetap: Potential circuit phase angle (thetap). Typical Value = 0. Default: 0.0 - :ki: Potential circuit gain coefficient (K). Typical Value = 0. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.2. Default: 0.0 - :xl: Reactance associated with potential source (X). Typical Value = 0.081. Default: 0.0 - :vbmax: Maximum excitation voltage (V). Typical Value = 6.9. Default: 0.0 - :vgmax: Maximum inner loop feedback voltage (V). Typical Value = 5.8. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'vimax': [cgmesProfile.DY.value, ], - 'vimin': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'km': [cgmesProfile.DY.value, ], - 'tm': [cgmesProfile.DY.value, ], - 'vmmax': [cgmesProfile.DY.value, ], - 'vmmin': [cgmesProfile.DY.value, ], - 'kg': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'thetap': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'xl': [cgmesProfile.DY.value, ], - 'vbmax': [cgmesProfile.DY.value, ], - 'vgmax': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, vimax = 0.0, vimin = 0.0, ka = 0.0, ta = 0, tb = 0, tc = 0, vrmax = 0.0, vrmin = 0.0, km = 0.0, tm = 0, vmmax = 0.0, vmmin = 0.0, kg = 0.0, kp = 0.0, thetap = 0.0, ki = 0.0, kc = 0.0, xl = 0.0, vbmax = 0.0, vgmax = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.vimax = vimax - self.vimin = vimin - self.ka = ka - self.ta = ta - self.tb = tb - self.tc = tc - self.vrmax = vrmax - self.vrmin = vrmin - self.km = km - self.tm = tm - self.vmmax = vmmax - self.vmmin = vmmin - self.kg = kg - self.kp = kp - self.thetap = thetap - self.ki = ki - self.kc = kc - self.xl = xl - self.vbmax = vbmax - self.vgmax = vgmax - - def __str__(self): - str = 'class=ExcIEEEST3A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEST3A(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type ST3A model. Some static systems utilize a field voltage control loop to linearize the exciter control characteristic. This also makes the output independent of supply source variations until supply limitations are reached. These systems utilize a variety of controlled-rectifier designs: full thyristor complements or hybrid bridges in either series or shunt configurations. The power source may consist of only a potential source, either fed from the machine terminals or from internal windings. Some designs may have compound power sources utilizing both machine potential and current. These power sources are represented as phasor combinations of machine terminal current and voltage and are accommodated by suitable parameters in model Type ST3A which is represented by ExcIEEEST3A. Reference: IEEE Standard 421.5-2005 Section 7.3. + + :ka: Voltage regulator gain (K). This is parameter K in the IEEE Std. Typical Value = 200. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.2. Default: 0.0 + :kg: Feedback gain constant of the inner loop field regulator (K). Typical Value = 1. Default: 0.0 + :ki: Potential circuit gain coefficient (K). Typical Value = 0. Default: 0.0 + :km: Forward gain constant of the inner loop field regulator (K). Typical Value = 7.93. Default: 0.0 + :kp: Potential circuit gain coefficient (K). Typical Value = 6.15. Default: 0.0 + :ta: Voltage regulator time constant (T). Typical Value = 0. Default: 0.0 + :tb: Voltage regulator time constant (T). Typical Value = 10. Default: 0.0 + :tc: Voltage regulator time constant (T). Typical Value = 1. Default: 0.0 + :thetap: Potential circuit phase angle (thetap). Typical Value = 0. Default: 0.0 + :tm: Forward time constant of inner loop field regulator (T). Typical Value = 0.4. Default: 0.0 + :vbmax: Maximum excitation voltage (V). Typical Value = 6.9. Default: 0.0 + :vgmax: Maximum inner loop feedback voltage (V). Typical Value = 5.8. Default: 0.0 + :vimax: Maximum voltage regulator input limit (V). Typical Value = 0.2. Default: 0.0 + :vimin: Minimum voltage regulator input limit (V). Typical Value = -0.2. Default: 0.0 + :vmmax: Maximum inner loop output (V). Typical Value = 1. Default: 0.0 + :vmmin: Minimum inner loop output (V). Typical Value = 0. Default: 0.0 + :vrmax: Maximum voltage regulator output (V). Typical Value = 10. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = -10. Default: 0.0 + :xl: Reactance associated with potential source (X). Typical Value = 0.081. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kg": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "km": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "thetap": [Profile.DY.value, ], + "tm": [Profile.DY.value, ], + "vbmax": [Profile.DY.value, ], + "vgmax": [Profile.DY.value, ], + "vimax": [Profile.DY.value, ], + "vimin": [Profile.DY.value, ], + "vmmax": [Profile.DY.value, ], + "vmmin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + "xl": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ka = 0.0, kc = 0.0, kg = 0.0, ki = 0.0, km = 0.0, kp = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, thetap = 0.0, tm = 0.0, vbmax = 0.0, vgmax = 0.0, vimax = 0.0, vimin = 0.0, vmmax = 0.0, vmmin = 0.0, vrmax = 0.0, vrmin = 0.0, xl = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ka = ka + self.kc = kc + self.kg = kg + self.ki = ki + self.km = km + self.kp = kp + self.ta = ta + self.tb = tb + self.tc = tc + self.thetap = thetap + self.tm = tm + self.vbmax = vbmax + self.vgmax = vgmax + self.vimax = vimax + self.vimin = vimin + self.vmmax = vmmax + self.vmmin = vmmin + self.vrmax = vrmax + self.vrmin = vrmin + self.xl = xl + + def __str__(self): + str = "class=ExcIEEEST3A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEST4B.py b/cimpy/cgmes_v2_4_15/ExcIEEEST4B.py index e18801fc..dce9e15b 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEST4B.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEST4B.py @@ -1,76 +1,78 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEST4B(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type ST4B model. This model is a variation of the Type ST3A model, with a proportional plus integral (PI) regulator block replacing the lag-lead regulator characteristic that is in the ST3A model. Both potential and compound source rectifier excitation systems are modeled. The PI regulator blocks have non-windup limits that are represented. The voltage regulator of this model is typically implemented digitally. Reference: IEEE Standard 421.5-2005 Section 7.4. - - :kpr: Voltage regulator proportional gain (K). Typical Value = 10.75. Default: 0.0 - :kir: Voltage regulator integral gain (K). Typical Value = 10.75. Default: 0.0 - :ta: Voltage regulator time constant (T). Typical Value = 0.02. Default: 0 - :vrmax: Maximum voltage regulator output (V). Typical Value = 1. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = -0.87. Default: 0.0 - :kpm: Voltage regulator proportional gain output (K). Typical Value = 1. Default: 0.0 - :kim: Voltage regulator integral gain output (K). Typical Value = 0. Default: 0.0 - :vmmax: Maximum inner loop output (V). Typical Value = 99. Default: 0.0 - :vmmin: Minimum inner loop output (V). Typical Value = -99. Default: 0.0 - :kg: Feedback gain constant of the inner loop field regulator (K). Typical Value = 0. Default: 0.0 - :kp: Potential circuit gain coefficient (K). Typical Value = 9.3. Default: 0.0 - :thetap: Potential circuit phase angle (thetap). Typical Value = 0. Default: 0.0 - :ki: Potential circuit gain coefficient (K). Typical Value = 0. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.113. Default: 0.0 - :xl: Reactance associated with potential source (X). Typical Value = 0.124. Default: 0.0 - :vbmax: Maximum excitation voltage (V). Typical Value = 11.63. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kpr': [cgmesProfile.DY.value, ], - 'kir': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'kpm': [cgmesProfile.DY.value, ], - 'kim': [cgmesProfile.DY.value, ], - 'vmmax': [cgmesProfile.DY.value, ], - 'vmmin': [cgmesProfile.DY.value, ], - 'kg': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'thetap': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'xl': [cgmesProfile.DY.value, ], - 'vbmax': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, kpr = 0.0, kir = 0.0, ta = 0, vrmax = 0.0, vrmin = 0.0, kpm = 0.0, kim = 0.0, vmmax = 0.0, vmmin = 0.0, kg = 0.0, kp = 0.0, thetap = 0.0, ki = 0.0, kc = 0.0, xl = 0.0, vbmax = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kpr = kpr - self.kir = kir - self.ta = ta - self.vrmax = vrmax - self.vrmin = vrmin - self.kpm = kpm - self.kim = kim - self.vmmax = vmmax - self.vmmin = vmmin - self.kg = kg - self.kp = kp - self.thetap = thetap - self.ki = ki - self.kc = kc - self.xl = xl - self.vbmax = vbmax - - def __str__(self): - str = 'class=ExcIEEEST4B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEST4B(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type ST4B model. This model is a variation of the Type ST3A model, with a proportional plus integral (PI) regulator block replacing the lag-lead regulator characteristic that is in the ST3A model. Both potential and compound source rectifier excitation systems are modeled. The PI regulator blocks have non-windup limits that are represented. The voltage regulator of this model is typically implemented digitally. Reference: IEEE Standard 421.5-2005 Section 7.4. + + :kc: Rectifier loading factor proportional to commutating reactance (K). Typical Value = 0.113. Default: 0.0 + :kg: Feedback gain constant of the inner loop field regulator (K). Typical Value = 0. Default: 0.0 + :ki: Potential circuit gain coefficient (K). Typical Value = 0. Default: 0.0 + :kim: Voltage regulator integral gain output (K). Typical Value = 0. Default: 0.0 + :kir: Voltage regulator integral gain (K). Typical Value = 10.75. Default: 0.0 + :kp: Potential circuit gain coefficient (K). Typical Value = 9.3. Default: 0.0 + :kpm: Voltage regulator proportional gain output (K). Typical Value = 1. Default: 0.0 + :kpr: Voltage regulator proportional gain (K). Typical Value = 10.75. Default: 0.0 + :ta: Voltage regulator time constant (T). Typical Value = 0.02. Default: 0.0 + :thetap: Potential circuit phase angle (thetap). Typical Value = 0. Default: 0.0 + :vbmax: Maximum excitation voltage (V). Typical Value = 11.63. Default: 0.0 + :vmmax: Maximum inner loop output (V). Typical Value = 99. Default: 0.0 + :vmmin: Minimum inner loop output (V). Typical Value = -99. Default: 0.0 + :vrmax: Maximum voltage regulator output (V). Typical Value = 1. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = -0.87. Default: 0.0 + :xl: Reactance associated with potential source (X). Typical Value = 0.124. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kg": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kim": [Profile.DY.value, ], + "kir": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "kpm": [Profile.DY.value, ], + "kpr": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "thetap": [Profile.DY.value, ], + "vbmax": [Profile.DY.value, ], + "vmmax": [Profile.DY.value, ], + "vmmin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + "xl": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, kc = 0.0, kg = 0.0, ki = 0.0, kim = 0.0, kir = 0.0, kp = 0.0, kpm = 0.0, kpr = 0.0, ta = 0.0, thetap = 0.0, vbmax = 0.0, vmmax = 0.0, vmmin = 0.0, vrmax = 0.0, vrmin = 0.0, xl = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.kc = kc + self.kg = kg + self.ki = ki + self.kim = kim + self.kir = kir + self.kp = kp + self.kpm = kpm + self.kpr = kpr + self.ta = ta + self.thetap = thetap + self.vbmax = vbmax + self.vmmax = vmmax + self.vmmin = vmmin + self.vrmax = vrmax + self.vrmin = vrmin + self.xl = xl + + def __str__(self): + str = "class=ExcIEEEST4B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEST5B.py b/cimpy/cgmes_v2_4_15/ExcIEEEST5B.py index e886d565..e84252ad 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEST5B.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEST5B.py @@ -1,79 +1,81 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEST5B(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type ST5B model. The Type ST5B excitation system is a variation of the Type ST1A model, with alternative overexcitation and underexcitation inputs and additional limits. Reference: IEEE Standard 421.5-2005 Section 7.5. Note: the block diagram in the IEEE 421.5 standard has input signal Vc and does not indicate the summation point with Vref. The implementation of the ExcIEEEST5B shall consider summation point with Vref. - - :kr: Regulator gain (K). Typical Value = 200. Default: 0.0 - :t1: Firing circuit time constant (T1). Typical Value = 0.004. Default: 0 - :kc: Rectifier regulation factor (K). Typical Value = 0.004. Default: 0.0 - :vrmax: Maximum voltage regulator output (V). Typical Value = 5. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = -4. Default: 0.0 - :tc1: Regulator lead time constant (T). Typical Value = 0.8. Default: 0 - :tb1: Regulator lag time constant (T). Typical Value = 6. Default: 0 - :tc2: Regulator lead time constant (T). Typical Value = 0.08. Default: 0 - :tb2: Regulator lag time constant (T). Typical Value = 0.01. Default: 0 - :toc1: OEL lead time constant (T). Typical Value = 0.1. Default: 0 - :tob1: OEL lag time constant (T). Typical Value = 2. Default: 0 - :toc2: OEL lead time constant (T). Typical Value = 0.08. Default: 0 - :tob2: OEL lag time constant (T). Typical Value = 0.08. Default: 0 - :tuc1: UEL lead time constant (T). Typical Value = 2. Default: 0 - :tub1: UEL lag time constant (T). Typical Value = 10. Default: 0 - :tuc2: UEL lead time constant (T). Typical Value = 0.1. Default: 0 - :tub2: UEL lag time constant (T). Typical Value = 0.05. Default: 0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kr': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'tc1': [cgmesProfile.DY.value, ], - 'tb1': [cgmesProfile.DY.value, ], - 'tc2': [cgmesProfile.DY.value, ], - 'tb2': [cgmesProfile.DY.value, ], - 'toc1': [cgmesProfile.DY.value, ], - 'tob1': [cgmesProfile.DY.value, ], - 'toc2': [cgmesProfile.DY.value, ], - 'tob2': [cgmesProfile.DY.value, ], - 'tuc1': [cgmesProfile.DY.value, ], - 'tub1': [cgmesProfile.DY.value, ], - 'tuc2': [cgmesProfile.DY.value, ], - 'tub2': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, kr = 0.0, t1 = 0, kc = 0.0, vrmax = 0.0, vrmin = 0.0, tc1 = 0, tb1 = 0, tc2 = 0, tb2 = 0, toc1 = 0, tob1 = 0, toc2 = 0, tob2 = 0, tuc1 = 0, tub1 = 0, tuc2 = 0, tub2 = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kr = kr - self.t1 = t1 - self.kc = kc - self.vrmax = vrmax - self.vrmin = vrmin - self.tc1 = tc1 - self.tb1 = tb1 - self.tc2 = tc2 - self.tb2 = tb2 - self.toc1 = toc1 - self.tob1 = tob1 - self.toc2 = toc2 - self.tob2 = tob2 - self.tuc1 = tuc1 - self.tub1 = tub1 - self.tuc2 = tuc2 - self.tub2 = tub2 - - def __str__(self): - str = 'class=ExcIEEEST5B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEST5B(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type ST5B model. The Type ST5B excitation system is a variation of the Type ST1A model, with alternative overexcitation and underexcitation inputs and additional limits. Reference: IEEE Standard 421.5-2005 Section 7.5. Note: the block diagram in the IEEE 421.5 standard has input signal Vc and does not indicate the summation point with Vref. The implementation of the ExcIEEEST5B shall consider summation point with Vref. + + :kc: Rectifier regulation factor (K). Typical Value = 0.004. Default: 0.0 + :kr: Regulator gain (K). Typical Value = 200. Default: 0.0 + :t1: Firing circuit time constant (T1). Typical Value = 0.004. Default: 0.0 + :tb1: Regulator lag time constant (T). Typical Value = 6. Default: 0.0 + :tb2: Regulator lag time constant (T). Typical Value = 0.01. Default: 0.0 + :tc1: Regulator lead time constant (T). Typical Value = 0.8. Default: 0.0 + :tc2: Regulator lead time constant (T). Typical Value = 0.08. Default: 0.0 + :tob1: OEL lag time constant (T). Typical Value = 2. Default: 0.0 + :tob2: OEL lag time constant (T). Typical Value = 0.08. Default: 0.0 + :toc1: OEL lead time constant (T). Typical Value = 0.1. Default: 0.0 + :toc2: OEL lead time constant (T). Typical Value = 0.08. Default: 0.0 + :tub1: UEL lag time constant (T). Typical Value = 10. Default: 0.0 + :tub2: UEL lag time constant (T). Typical Value = 0.05. Default: 0.0 + :tuc1: UEL lead time constant (T). Typical Value = 2. Default: 0.0 + :tuc2: UEL lead time constant (T). Typical Value = 0.1. Default: 0.0 + :vrmax: Maximum voltage regulator output (V). Typical Value = 5. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = -4. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kr": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "tb1": [Profile.DY.value, ], + "tb2": [Profile.DY.value, ], + "tc1": [Profile.DY.value, ], + "tc2": [Profile.DY.value, ], + "tob1": [Profile.DY.value, ], + "tob2": [Profile.DY.value, ], + "toc1": [Profile.DY.value, ], + "toc2": [Profile.DY.value, ], + "tub1": [Profile.DY.value, ], + "tub2": [Profile.DY.value, ], + "tuc1": [Profile.DY.value, ], + "tuc2": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, kc = 0.0, kr = 0.0, t1 = 0.0, tb1 = 0.0, tb2 = 0.0, tc1 = 0.0, tc2 = 0.0, tob1 = 0.0, tob2 = 0.0, toc1 = 0.0, toc2 = 0.0, tub1 = 0.0, tub2 = 0.0, tuc1 = 0.0, tuc2 = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.kc = kc + self.kr = kr + self.t1 = t1 + self.tb1 = tb1 + self.tb2 = tb2 + self.tc1 = tc1 + self.tc2 = tc2 + self.tob1 = tob1 + self.tob2 = tob2 + self.toc1 = toc1 + self.toc2 = toc2 + self.tub1 = tub1 + self.tub2 = tub2 + self.tuc1 = tuc1 + self.tuc2 = tuc2 + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEST5B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEST6B.py b/cimpy/cgmes_v2_4_15/ExcIEEEST6B.py index 9355ef03..81ef60d5 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEST6B.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEST6B.py @@ -1,70 +1,72 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEST6B(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type ST6B model. This model consists of a PI voltage regulator with an inner loop field voltage regulator and pre-control. The field voltage regulator implements a proportional control. The pre-control and the delay in the feedback circuit increase the dynamic response. Reference: IEEE Standard 421.5-2005 Section 7.6. - - :ilr: Exciter output current limit reference (I). Typical Value = 4.164. Default: 0.0 - :kci: Exciter output current limit adjustment (K). Typical Value = 1.0577. Default: 0.0 - :kff: Pre-control gain constant of the inner loop field regulator (K). Typical Value = 1. Default: 0.0 - :kg: Feedback gain constant of the inner loop field regulator (K). Typical Value = 1. Default: 0.0 - :kia: Voltage regulator integral gain (K). Typical Value = 45.094. Default: 0.0 - :klr: Exciter output current limiter gain (K). Typical Value = 17.33. Default: 0.0 - :km: Forward gain constant of the inner loop field regulator (K). Typical Value = 1. Default: 0.0 - :kpa: Voltage regulator proportional gain (K). Typical Value = 18.038. Default: 0.0 - :oelin: OEL input selector (OELin). Typical Value = noOELinput. Default: None - :tg: Feedback time constant of inner loop field voltage regulator (T). Typical Value = 0.02. Default: 0 - :vamax: Maximum voltage regulator output (V). Typical Value = 4.81. Default: 0.0 - :vamin: Minimum voltage regulator output (V). Typical Value = -3.85. Default: 0.0 - :vrmax: Maximum voltage regulator output (V). Typical Value = 4.81. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = -3.85. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ilr': [cgmesProfile.DY.value, ], - 'kci': [cgmesProfile.DY.value, ], - 'kff': [cgmesProfile.DY.value, ], - 'kg': [cgmesProfile.DY.value, ], - 'kia': [cgmesProfile.DY.value, ], - 'klr': [cgmesProfile.DY.value, ], - 'km': [cgmesProfile.DY.value, ], - 'kpa': [cgmesProfile.DY.value, ], - 'oelin': [cgmesProfile.DY.value, ], - 'tg': [cgmesProfile.DY.value, ], - 'vamax': [cgmesProfile.DY.value, ], - 'vamin': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ilr = 0.0, kci = 0.0, kff = 0.0, kg = 0.0, kia = 0.0, klr = 0.0, km = 0.0, kpa = 0.0, oelin = None, tg = 0, vamax = 0.0, vamin = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ilr = ilr - self.kci = kci - self.kff = kff - self.kg = kg - self.kia = kia - self.klr = klr - self.km = km - self.kpa = kpa - self.oelin = oelin - self.tg = tg - self.vamax = vamax - self.vamin = vamin - self.vrmax = vrmax - self.vrmin = vrmin - - def __str__(self): - str = 'class=ExcIEEEST6B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEST6B(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type ST6B model. This model consists of a PI voltage regulator with an inner loop field voltage regulator and pre-control. The field voltage regulator implements a proportional control. The pre-control and the delay in the feedback circuit increase the dynamic response. Reference: IEEE Standard 421.5-2005 Section 7.6. + + :ilr: Exciter output current limit reference (I). Typical Value = 4.164. Default: 0.0 + :kci: Exciter output current limit adjustment (K). Typical Value = 1.0577. Default: 0.0 + :kff: Pre-control gain constant of the inner loop field regulator (K). Typical Value = 1. Default: 0.0 + :kg: Feedback gain constant of the inner loop field regulator (K). Typical Value = 1. Default: 0.0 + :kia: Voltage regulator integral gain (K). Typical Value = 45.094. Default: 0.0 + :klr: Exciter output current limiter gain (K). Typical Value = 17.33. Default: 0.0 + :km: Forward gain constant of the inner loop field regulator (K). Typical Value = 1. Default: 0.0 + :kpa: Voltage regulator proportional gain (K). Typical Value = 18.038. Default: 0.0 + :oelin: OEL input selector (OELin). Typical Value = noOELinput. Default: None + :tg: Feedback time constant of inner loop field voltage regulator (T). Typical Value = 0.02. Default: 0.0 + :vamax: Maximum voltage regulator output (V). Typical Value = 4.81. Default: 0.0 + :vamin: Minimum voltage regulator output (V). Typical Value = -3.85. Default: 0.0 + :vrmax: Maximum voltage regulator output (V). Typical Value = 4.81. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = -3.85. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ilr": [Profile.DY.value, ], + "kci": [Profile.DY.value, ], + "kff": [Profile.DY.value, ], + "kg": [Profile.DY.value, ], + "kia": [Profile.DY.value, ], + "klr": [Profile.DY.value, ], + "km": [Profile.DY.value, ], + "kpa": [Profile.DY.value, ], + "oelin": [Profile.DY.value, ], + "tg": [Profile.DY.value, ], + "vamax": [Profile.DY.value, ], + "vamin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ilr = 0.0, kci = 0.0, kff = 0.0, kg = 0.0, kia = 0.0, klr = 0.0, km = 0.0, kpa = 0.0, oelin = None, tg = 0.0, vamax = 0.0, vamin = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ilr = ilr + self.kci = kci + self.kff = kff + self.kg = kg + self.kia = kia + self.klr = klr + self.km = km + self.kpa = kpa + self.oelin = oelin + self.tg = tg + self.vamax = vamax + self.vamin = vamin + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEST6B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcIEEEST7B.py b/cimpy/cgmes_v2_4_15/ExcIEEEST7B.py index 4b0eb537..a4d9f1ce 100644 --- a/cimpy/cgmes_v2_4_15/ExcIEEEST7B.py +++ b/cimpy/cgmes_v2_4_15/ExcIEEEST7B.py @@ -1,73 +1,75 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcIEEEST7B(ExcitationSystemDynamics): - ''' - The class represents IEEE Std 421.5-2005 type ST7B model. This model is representative of static potential-source excitation systems. In this system, the AVR consists of a PI voltage regulator. A phase lead-lag filter in series allows introduction of a derivative function, typically used with brushless excitation systems. In that case, the regulator is of the PID type. In addition, the terminal voltage channel includes a phase lead-lag filter. The AVR includes the appropriate inputs on its reference for overexcitation limiter (OEL1), underexcitation limiter (UEL), stator current limiter (SCL), and current compensator (DROOP). All these limitations, when they work at voltage reference level, keep the PSS (VS signal from Type PSS1A, PSS2A, or PSS2B) in operation. However, the UEL limitation can also be transferred to the high value (HV) gate acting on the output signal. In addition, the output signal passes through a low value (LV) gate for a ceiling overexcitation limiter (OEL2). Reference: IEEE Standard 421.5-2005 Section 7.7. - - :kh: High-value gate feedback gain (K). Typical Value 1. Default: 0.0 - :kia: Voltage regulator integral gain (K). Typical Value = 1. Default: 0.0 - :kl: Low-value gate feedback gain (K). Typical Value 1. Default: 0.0 - :kpa: Voltage regulator proportional gain (K). Typical Value = 40. Default: 0.0 - :oelin: OEL input selector (OELin). Typical Value = noOELinput. Default: None - :tb: Regulator lag time constant (T). Typical Value 1. Default: 0 - :tc: Regulator lead time constant (T). Typical Value 1. Default: 0 - :tf: Excitation control system stabilizer time constant (T). Typical Value 1. Default: 0 - :tg: Feedback time constant of inner loop field voltage regulator (T). Typical Value 1. Default: 0 - :tia: Feedback time constant (T). Typical Value = 3. Default: 0 - :uelin: UEL input selector (UELin). Typical Value = noUELinput. Default: None - :vmax: Maximum voltage reference signal (V). Typical Value = 1.1. Default: 0.0 - :vmin: Minimum voltage reference signal (V). Typical Value = 0.9. Default: 0.0 - :vrmax: Maximum voltage regulator output (V). Typical Value = 5. Default: 0.0 - :vrmin: Minimum voltage regulator output (V). Typical Value = -4.5. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kh': [cgmesProfile.DY.value, ], - 'kia': [cgmesProfile.DY.value, ], - 'kl': [cgmesProfile.DY.value, ], - 'kpa': [cgmesProfile.DY.value, ], - 'oelin': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'tg': [cgmesProfile.DY.value, ], - 'tia': [cgmesProfile.DY.value, ], - 'uelin': [cgmesProfile.DY.value, ], - 'vmax': [cgmesProfile.DY.value, ], - 'vmin': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, kh = 0.0, kia = 0.0, kl = 0.0, kpa = 0.0, oelin = None, tb = 0, tc = 0, tf = 0, tg = 0, tia = 0, uelin = None, vmax = 0.0, vmin = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kh = kh - self.kia = kia - self.kl = kl - self.kpa = kpa - self.oelin = oelin - self.tb = tb - self.tc = tc - self.tf = tf - self.tg = tg - self.tia = tia - self.uelin = uelin - self.vmax = vmax - self.vmin = vmin - self.vrmax = vrmax - self.vrmin = vrmin - - def __str__(self): - str = 'class=ExcIEEEST7B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcIEEEST7B(ExcitationSystemDynamics): + """ + The class represents IEEE Std 421.5-2005 type ST7B model. This model is representative of static potential-source excitation systems. In this system, the AVR consists of a PI voltage regulator. A phase lead-lag filter in series allows introduction of a derivative function, typically used with brushless excitation systems. In that case, the regulator is of the PID type. In addition, the terminal voltage channel includes a phase lead-lag filter. The AVR includes the appropriate inputs on its reference for overexcitation limiter (OEL1), underexcitation limiter (UEL), stator current limiter (SCL), and current compensator (DROOP). All these limitations, when they work at voltage reference level, keep the PSS (VS signal from Type PSS1A, PSS2A, or PSS2B) in operation. However, the UEL limitation can also be transferred to the high value (HV) gate acting on the output signal. In addition, the output signal passes through a low value (LV) gate for a ceiling overexcitation limiter (OEL2). Reference: IEEE Standard 421.5-2005 Section 7.7. + + :kh: High-value gate feedback gain (K). Typical Value 1. Default: 0.0 + :kia: Voltage regulator integral gain (K). Typical Value = 1. Default: 0.0 + :kl: Low-value gate feedback gain (K). Typical Value 1. Default: 0.0 + :kpa: Voltage regulator proportional gain (K). Typical Value = 40. Default: 0.0 + :oelin: OEL input selector (OELin). Typical Value = noOELinput. Default: None + :tb: Regulator lag time constant (T). Typical Value 1. Default: 0.0 + :tc: Regulator lead time constant (T). Typical Value 1. Default: 0.0 + :tf: Excitation control system stabilizer time constant (T). Typical Value 1. Default: 0.0 + :tg: Feedback time constant of inner loop field voltage regulator (T). Typical Value 1. Default: 0.0 + :tia: Feedback time constant (T). Typical Value = 3. Default: 0.0 + :uelin: UEL input selector (UELin). Typical Value = noUELinput. Default: None + :vmax: Maximum voltage reference signal (V). Typical Value = 1.1. Default: 0.0 + :vmin: Minimum voltage reference signal (V). Typical Value = 0.9. Default: 0.0 + :vrmax: Maximum voltage regulator output (V). Typical Value = 5. Default: 0.0 + :vrmin: Minimum voltage regulator output (V). Typical Value = -4.5. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "kh": [Profile.DY.value, ], + "kia": [Profile.DY.value, ], + "kl": [Profile.DY.value, ], + "kpa": [Profile.DY.value, ], + "oelin": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "tg": [Profile.DY.value, ], + "tia": [Profile.DY.value, ], + "uelin": [Profile.DY.value, ], + "vmax": [Profile.DY.value, ], + "vmin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, kh = 0.0, kia = 0.0, kl = 0.0, kpa = 0.0, oelin = None, tb = 0.0, tc = 0.0, tf = 0.0, tg = 0.0, tia = 0.0, uelin = None, vmax = 0.0, vmin = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.kh = kh + self.kia = kia + self.kl = kl + self.kpa = kpa + self.oelin = oelin + self.tb = tb + self.tc = tc + self.tf = tf + self.tg = tg + self.tia = tia + self.uelin = uelin + self.vmax = vmax + self.vmin = vmin + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcIEEEST7B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcOEX3T.py b/cimpy/cgmes_v2_4_15/ExcOEX3T.py index 91f71088..e5d066f4 100644 --- a/cimpy/cgmes_v2_4_15/ExcOEX3T.py +++ b/cimpy/cgmes_v2_4_15/ExcOEX3T.py @@ -1,85 +1,87 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcOEX3T(ExcitationSystemDynamics): - ''' - Modified IEEE Type ST1 Excitation System with semi-continuous and acting terminal voltage limiter. - - :t1: Time constant (T). Default: 0 - :t2: Time constant (T). Default: 0 - :t3: Time constant (T). Default: 0 - :t4: Time constant (T). Default: 0 - :ka: Gain (K). Default: 0.0 - :t5: Time constant (T). Default: 0 - :t6: Time constant (T). Default: 0 - :vrmax: Limiter (V). Default: 0.0 - :vrmin: Limiter (V). Default: 0.0 - :te: Time constant (T). Default: 0 - :kf: Gain (K). Default: 0.0 - :tf: Time constant (T). Default: 0 - :kc: Gain (K). Default: 0.0 - :kd: Gain (K). Default: 0.0 - :ke: Gain (K). Default: 0.0 - :e1: Saturation parameter (E). Default: 0.0 - :see1: Saturation parameter (S(E)). Default: 0.0 - :e2: Saturation parameter (E). Default: 0.0 - :see2: Saturation parameter (S(E)). Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'e1': [cgmesProfile.DY.value, ], - 'see1': [cgmesProfile.DY.value, ], - 'e2': [cgmesProfile.DY.value, ], - 'see2': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, t1 = 0, t2 = 0, t3 = 0, t4 = 0, ka = 0.0, t5 = 0, t6 = 0, vrmax = 0.0, vrmin = 0.0, te = 0, kf = 0.0, tf = 0, kc = 0.0, kd = 0.0, ke = 0.0, e1 = 0.0, see1 = 0.0, e2 = 0.0, see2 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.ka = ka - self.t5 = t5 - self.t6 = t6 - self.vrmax = vrmax - self.vrmin = vrmin - self.te = te - self.kf = kf - self.tf = tf - self.kc = kc - self.kd = kd - self.ke = ke - self.e1 = e1 - self.see1 = see1 - self.e2 = e2 - self.see2 = see2 - - def __str__(self): - str = 'class=ExcOEX3T\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcOEX3T(ExcitationSystemDynamics): + """ + Modified IEEE Type ST1 Excitation System with semi-continuous and acting terminal voltage limiter. + + :e1: Saturation parameter (E). Default: 0.0 + :e2: Saturation parameter (E). Default: 0.0 + :ka: Gain (K). Default: 0.0 + :kc: Gain (K). Default: 0.0 + :kd: Gain (K). Default: 0.0 + :ke: Gain (K). Default: 0.0 + :kf: Gain (K). Default: 0.0 + :see1: Saturation parameter (S(E)). Default: 0.0 + :see2: Saturation parameter (S(E)). Default: 0.0 + :t1: Time constant (T). Default: 0.0 + :t2: Time constant (T). Default: 0.0 + :t3: Time constant (T). Default: 0.0 + :t4: Time constant (T). Default: 0.0 + :t5: Time constant (T). Default: 0.0 + :t6: Time constant (T). Default: 0.0 + :te: Time constant (T). Default: 0.0 + :tf: Time constant (T). Default: 0.0 + :vrmax: Limiter (V). Default: 0.0 + :vrmin: Limiter (V). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "e1": [Profile.DY.value, ], + "e2": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "see1": [Profile.DY.value, ], + "see2": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, e1 = 0.0, e2 = 0.0, ka = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, kf = 0.0, see1 = 0.0, see2 = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, t6 = 0.0, te = 0.0, tf = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.e1 = e1 + self.e2 = e2 + self.ka = ka + self.kc = kc + self.kd = kd + self.ke = ke + self.kf = kf + self.see1 = see1 + self.see2 = see2 + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.t6 = t6 + self.te = te + self.tf = tf + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcOEX3T\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcPIC.py b/cimpy/cgmes_v2_4_15/ExcPIC.py index 2d8ec05d..ae00631e 100644 --- a/cimpy/cgmes_v2_4_15/ExcPIC.py +++ b/cimpy/cgmes_v2_4_15/ExcPIC.py @@ -1,97 +1,99 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcPIC(ExcitationSystemDynamics): - ''' - Proportional/Integral Regulator Excitation System Model. This model can be used to represent excitation systems with a proportional-integral (PI) voltage regulator controller. - - :ka: PI controller gain (Ka). Typical Value = 3.15. Default: 0.0 - :ta1: PI controller time constant (Ta1). Typical Value = 1. Default: 0 - :vr1: PI maximum limit (Vr1). Typical Value = 1. Default: 0.0 - :vr2: PI minimum limit (Vr2). Typical Value = -0.87. Default: 0.0 - :ta2: Voltage regulator time constant (Ta2). Typical Value = 0.01. Default: 0 - :ta3: Lead time constant (Ta3). Typical Value = 0. Default: 0 - :ta4: Lag time constant (Ta4). Typical Value = 0. Default: 0 - :vrmax: Voltage regulator maximum limit (Vrmax). Typical Value = 1. Default: 0.0 - :vrmin: Voltage regulator minimum limit (Vrmin). Typical Value = -0.87. Default: 0.0 - :kf: Rate feedback gain (Kf). Typical Value = 0. Default: 0.0 - :tf1: Rate feedback time constant (Tf1). Typical Value = 0. Default: 0 - :tf2: Rate feedback lag time constant (Tf2). Typical Value = 0. Default: 0 - :efdmax: Exciter maximum limit (Efdmax). Typical Value = 8. Default: 0.0 - :efdmin: Exciter minimum limit (Efdmin). Typical Value = -0.87. Default: 0.0 - :ke: Exciter constant (Ke). Typical Value = 0. Default: 0.0 - :te: Exciter time constant (Te). Typical Value = 0. Default: 0 - :e1: Field voltage value 1 (E1). Typical Value = 0. Default: 0.0 - :se1: Saturation factor at E1 (Se1). Typical Value = 0. Default: 0.0 - :e2: Field voltage value 2 (E2). Typical Value = 0. Default: 0.0 - :se2: Saturation factor at E2 (Se2). Typical Value = 0. Default: 0.0 - :kp: Potential source gain (Kp). Typical Value = 6.5. Default: 0.0 - :ki: Current source gain (Ki). Typical Value = 0. Default: 0.0 - :kc: Exciter regulation factor (Kc). Typical Value = 0.08. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta1': [cgmesProfile.DY.value, ], - 'vr1': [cgmesProfile.DY.value, ], - 'vr2': [cgmesProfile.DY.value, ], - 'ta2': [cgmesProfile.DY.value, ], - 'ta3': [cgmesProfile.DY.value, ], - 'ta4': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf1': [cgmesProfile.DY.value, ], - 'tf2': [cgmesProfile.DY.value, ], - 'efdmax': [cgmesProfile.DY.value, ], - 'efdmin': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'e1': [cgmesProfile.DY.value, ], - 'se1': [cgmesProfile.DY.value, ], - 'e2': [cgmesProfile.DY.value, ], - 'se2': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, ta1 = 0, vr1 = 0.0, vr2 = 0.0, ta2 = 0, ta3 = 0, ta4 = 0, vrmax = 0.0, vrmin = 0.0, kf = 0.0, tf1 = 0, tf2 = 0, efdmax = 0.0, efdmin = 0.0, ke = 0.0, te = 0, e1 = 0.0, se1 = 0.0, e2 = 0.0, se2 = 0.0, kp = 0.0, ki = 0.0, kc = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.ta1 = ta1 - self.vr1 = vr1 - self.vr2 = vr2 - self.ta2 = ta2 - self.ta3 = ta3 - self.ta4 = ta4 - self.vrmax = vrmax - self.vrmin = vrmin - self.kf = kf - self.tf1 = tf1 - self.tf2 = tf2 - self.efdmax = efdmax - self.efdmin = efdmin - self.ke = ke - self.te = te - self.e1 = e1 - self.se1 = se1 - self.e2 = e2 - self.se2 = se2 - self.kp = kp - self.ki = ki - self.kc = kc - - def __str__(self): - str = 'class=ExcPIC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcPIC(ExcitationSystemDynamics): + """ + Proportional/Integral Regulator Excitation System Model. This model can be used to represent excitation systems with a proportional-integral (PI) voltage regulator controller. + + :e1: Field voltage value 1 (E1). Typical Value = 0. Default: 0.0 + :e2: Field voltage value 2 (E2). Typical Value = 0. Default: 0.0 + :efdmax: Exciter maximum limit (Efdmax). Typical Value = 8. Default: 0.0 + :efdmin: Exciter minimum limit (Efdmin). Typical Value = -0.87. Default: 0.0 + :ka: PI controller gain (Ka). Typical Value = 3.15. Default: 0.0 + :kc: Exciter regulation factor (Kc). Typical Value = 0.08. Default: 0.0 + :ke: Exciter constant (Ke). Typical Value = 0. Default: 0.0 + :kf: Rate feedback gain (Kf). Typical Value = 0. Default: 0.0 + :ki: Current source gain (Ki). Typical Value = 0. Default: 0.0 + :kp: Potential source gain (Kp). Typical Value = 6.5. Default: 0.0 + :se1: Saturation factor at E1 (Se1). Typical Value = 0. Default: 0.0 + :se2: Saturation factor at E2 (Se2). Typical Value = 0. Default: 0.0 + :ta1: PI controller time constant (Ta1). Typical Value = 1. Default: 0.0 + :ta2: Voltage regulator time constant (Ta2). Typical Value = 0.01. Default: 0.0 + :ta3: Lead time constant (Ta3). Typical Value = 0. Default: 0.0 + :ta4: Lag time constant (Ta4). Typical Value = 0. Default: 0.0 + :te: Exciter time constant (Te). Typical Value = 0. Default: 0.0 + :tf1: Rate feedback time constant (Tf1). Typical Value = 0. Default: 0.0 + :tf2: Rate feedback lag time constant (Tf2). Typical Value = 0. Default: 0.0 + :vr1: PI maximum limit (Vr1). Typical Value = 1. Default: 0.0 + :vr2: PI minimum limit (Vr2). Typical Value = -0.87. Default: 0.0 + :vrmax: Voltage regulator maximum limit (Vrmax). Typical Value = 1. Default: 0.0 + :vrmin: Voltage regulator minimum limit (Vrmin). Typical Value = -0.87. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "e1": [Profile.DY.value, ], + "e2": [Profile.DY.value, ], + "efdmax": [Profile.DY.value, ], + "efdmin": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "se1": [Profile.DY.value, ], + "se2": [Profile.DY.value, ], + "ta1": [Profile.DY.value, ], + "ta2": [Profile.DY.value, ], + "ta3": [Profile.DY.value, ], + "ta4": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf1": [Profile.DY.value, ], + "tf2": [Profile.DY.value, ], + "vr1": [Profile.DY.value, ], + "vr2": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, e1 = 0.0, e2 = 0.0, efdmax = 0.0, efdmin = 0.0, ka = 0.0, kc = 0.0, ke = 0.0, kf = 0.0, ki = 0.0, kp = 0.0, se1 = 0.0, se2 = 0.0, ta1 = 0.0, ta2 = 0.0, ta3 = 0.0, ta4 = 0.0, te = 0.0, tf1 = 0.0, tf2 = 0.0, vr1 = 0.0, vr2 = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.e1 = e1 + self.e2 = e2 + self.efdmax = efdmax + self.efdmin = efdmin + self.ka = ka + self.kc = kc + self.ke = ke + self.kf = kf + self.ki = ki + self.kp = kp + self.se1 = se1 + self.se2 = se2 + self.ta1 = ta1 + self.ta2 = ta2 + self.ta3 = ta3 + self.ta4 = ta4 + self.te = te + self.tf1 = tf1 + self.tf2 = tf2 + self.vr1 = vr1 + self.vr2 = vr2 + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcPIC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcREXS.py b/cimpy/cgmes_v2_4_15/ExcREXS.py index d2f8299b..d497d200 100644 --- a/cimpy/cgmes_v2_4_15/ExcREXS.py +++ b/cimpy/cgmes_v2_4_15/ExcREXS.py @@ -1,136 +1,138 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcREXS(ExcitationSystemDynamics): - ''' - General Purpose Rotating Excitation System Model. This model can be used to represent a wide range of excitation systems whose DC power source is an AC or DC generator. It encompasses IEEE type AC1, AC2, DC1, and DC2 excitation system models. - - :e1: Field voltage value 1 (E1). Typical Value = 3. Default: 0.0 - :e2: Field voltage value 2 (E2). Typical Value = 4. Default: 0.0 - :fbf: Rate feedback signal flag (Fbf). Typical Value = fieldCurrent. Default: None - :flimf: Limit type flag (Flimf). Typical Value = 0. Default: 0.0 - :kc: Rectifier regulation factor (Kc). Typical Value = 0.05. Default: 0.0 - :kd: Exciter regulation factor (Kd). Typical Value = 2. Default: 0.0 - :ke: Exciter field proportional constant (Ke). Typical Value = 1. Default: 0.0 - :kefd: Field voltage feedback gain (Kefd). Typical Value = 0. Default: 0.0 - :kf: Rate feedback gain (Kf). Typical Value = 0.05. Default: 0 - :kh: Field voltage controller feedback gain (Kh). Typical Value = 0. Default: 0.0 - :kii: Field Current Regulator Integral Gain (Kii). Typical Value = 0. Default: 0.0 - :kip: Field Current Regulator Proportional Gain (Kip). Typical Value = 1. Default: 0.0 - :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 - :kvi: Voltage Regulator Integral Gain (Kvi). Typical Value = 0. Default: 0.0 - :kvp: Voltage Regulator Proportional Gain (Kvp). Typical Value = 2800. Default: 0.0 - :kvphz: V/Hz limiter gain (Kvphz). Typical Value = 0. Default: 0.0 - :nvphz: Pickup speed of V/Hz limiter (Nvphz). Typical Value = 0. Default: 0.0 - :se1: Saturation factor at E1 (Se1). Typical Value = 0.0001. Default: 0.0 - :se2: Saturation factor at E2 (Se2). Typical Value = 0.001. Default: 0.0 - :ta: Voltage Regulator time constant (Ta). Typical Value = 0.01. Default: 0 - :tb1: Lag time constant (Tb1). Typical Value = 0. Default: 0 - :tb2: Lag time constant (Tb2). Typical Value = 0. Default: 0 - :tc1: Lead time constant (Tc1). Typical Value = 0. Default: 0 - :tc2: Lead time constant (Tc2). Typical Value = 0. Default: 0 - :te: Exciter field time constant (Te). Typical Value = 1.2. Default: 0 - :tf: Rate feedback time constant (Tf). Typical Value = 1. Default: 0 - :tf1: Feedback lead time constant (Tf1). Typical Value = 0. Default: 0 - :tf2: Feedback lag time constant (Tf2). Typical Value = 0. Default: 0 - :tp: Field current Bridge time constant (Tp). Typical Value = 0. Default: 0 - :vcmax: Maximum compounding voltage (Vcmax). Typical Value = 0. Default: 0.0 - :vfmax: Maximum Exciter Field Current (Vfmax). Typical Value = 47. Default: 0.0 - :vfmin: Minimum Exciter Field Current (Vfmin). Typical Value = -20. Default: 0.0 - :vimax: Voltage Regulator Input Limit (Vimax). Typical Value = 0.1. Default: 0.0 - :vrmax: Maximum controller output (Vrmax). Typical Value = 47. Default: 0.0 - :vrmin: Minimum controller output (Vrmin). Typical Value = -20. Default: 0.0 - :xc: Exciter compounding reactance (Xc). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'e1': [cgmesProfile.DY.value, ], - 'e2': [cgmesProfile.DY.value, ], - 'fbf': [cgmesProfile.DY.value, ], - 'flimf': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'kefd': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'kh': [cgmesProfile.DY.value, ], - 'kii': [cgmesProfile.DY.value, ], - 'kip': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'kvi': [cgmesProfile.DY.value, ], - 'kvp': [cgmesProfile.DY.value, ], - 'kvphz': [cgmesProfile.DY.value, ], - 'nvphz': [cgmesProfile.DY.value, ], - 'se1': [cgmesProfile.DY.value, ], - 'se2': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb1': [cgmesProfile.DY.value, ], - 'tb2': [cgmesProfile.DY.value, ], - 'tc1': [cgmesProfile.DY.value, ], - 'tc2': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'tf1': [cgmesProfile.DY.value, ], - 'tf2': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 'vcmax': [cgmesProfile.DY.value, ], - 'vfmax': [cgmesProfile.DY.value, ], - 'vfmin': [cgmesProfile.DY.value, ], - 'vimax': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'xc': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, e1 = 0.0, e2 = 0.0, fbf = None, flimf = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, kefd = 0.0, kf = 0, kh = 0.0, kii = 0.0, kip = 0.0, ks = 0.0, kvi = 0.0, kvp = 0.0, kvphz = 0.0, nvphz = 0.0, se1 = 0.0, se2 = 0.0, ta = 0, tb1 = 0, tb2 = 0, tc1 = 0, tc2 = 0, te = 0, tf = 0, tf1 = 0, tf2 = 0, tp = 0, vcmax = 0.0, vfmax = 0.0, vfmin = 0.0, vimax = 0.0, vrmax = 0.0, vrmin = 0.0, xc = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.e1 = e1 - self.e2 = e2 - self.fbf = fbf - self.flimf = flimf - self.kc = kc - self.kd = kd - self.ke = ke - self.kefd = kefd - self.kf = kf - self.kh = kh - self.kii = kii - self.kip = kip - self.ks = ks - self.kvi = kvi - self.kvp = kvp - self.kvphz = kvphz - self.nvphz = nvphz - self.se1 = se1 - self.se2 = se2 - self.ta = ta - self.tb1 = tb1 - self.tb2 = tb2 - self.tc1 = tc1 - self.tc2 = tc2 - self.te = te - self.tf = tf - self.tf1 = tf1 - self.tf2 = tf2 - self.tp = tp - self.vcmax = vcmax - self.vfmax = vfmax - self.vfmin = vfmin - self.vimax = vimax - self.vrmax = vrmax - self.vrmin = vrmin - self.xc = xc - - def __str__(self): - str = 'class=ExcREXS\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcREXS(ExcitationSystemDynamics): + """ + General Purpose Rotating Excitation System Model. This model can be used to represent a wide range of excitation systems whose DC power source is an AC or DC generator. It encompasses IEEE type AC1, AC2, DC1, and DC2 excitation system models. + + :e1: Field voltage value 1 (E1). Typical Value = 3. Default: 0.0 + :e2: Field voltage value 2 (E2). Typical Value = 4. Default: 0.0 + :fbf: Rate feedback signal flag (Fbf). Typical Value = fieldCurrent. Default: None + :flimf: Limit type flag (Flimf). Typical Value = 0. Default: 0.0 + :kc: Rectifier regulation factor (Kc). Typical Value = 0.05. Default: 0.0 + :kd: Exciter regulation factor (Kd). Typical Value = 2. Default: 0.0 + :ke: Exciter field proportional constant (Ke). Typical Value = 1. Default: 0.0 + :kefd: Field voltage feedback gain (Kefd). Typical Value = 0. Default: 0.0 + :kf: Rate feedback gain (Kf). Typical Value = 0.05. Default: 0.0 + :kh: Field voltage controller feedback gain (Kh). Typical Value = 0. Default: 0.0 + :kii: Field Current Regulator Integral Gain (Kii). Typical Value = 0. Default: 0.0 + :kip: Field Current Regulator Proportional Gain (Kip). Typical Value = 1. Default: 0.0 + :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 + :kvi: Voltage Regulator Integral Gain (Kvi). Typical Value = 0. Default: 0.0 + :kvp: Voltage Regulator Proportional Gain (Kvp). Typical Value = 2800. Default: 0.0 + :kvphz: V/Hz limiter gain (Kvphz). Typical Value = 0. Default: 0.0 + :nvphz: Pickup speed of V/Hz limiter (Nvphz). Typical Value = 0. Default: 0.0 + :se1: Saturation factor at E1 (Se1). Typical Value = 0.0001. Default: 0.0 + :se2: Saturation factor at E2 (Se2). Typical Value = 0.001. Default: 0.0 + :ta: Voltage Regulator time constant (Ta). Typical Value = 0.01. Default: 0.0 + :tb1: Lag time constant (Tb1). Typical Value = 0. Default: 0.0 + :tb2: Lag time constant (Tb2). Typical Value = 0. Default: 0.0 + :tc1: Lead time constant (Tc1). Typical Value = 0. Default: 0.0 + :tc2: Lead time constant (Tc2). Typical Value = 0. Default: 0.0 + :te: Exciter field time constant (Te). Typical Value = 1.2. Default: 0.0 + :tf: Rate feedback time constant (Tf). Typical Value = 1. Default: 0.0 + :tf1: Feedback lead time constant (Tf1). Typical Value = 0. Default: 0.0 + :tf2: Feedback lag time constant (Tf2). Typical Value = 0. Default: 0.0 + :tp: Field current Bridge time constant (Tp). Typical Value = 0. Default: 0.0 + :vcmax: Maximum compounding voltage (Vcmax). Typical Value = 0. Default: 0.0 + :vfmax: Maximum Exciter Field Current (Vfmax). Typical Value = 47. Default: 0.0 + :vfmin: Minimum Exciter Field Current (Vfmin). Typical Value = -20. Default: 0.0 + :vimax: Voltage Regulator Input Limit (Vimax). Typical Value = 0.1. Default: 0.0 + :vrmax: Maximum controller output (Vrmax). Typical Value = 47. Default: 0.0 + :vrmin: Minimum controller output (Vrmin). Typical Value = -20. Default: 0.0 + :xc: Exciter compounding reactance (Xc). Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "e1": [Profile.DY.value, ], + "e2": [Profile.DY.value, ], + "fbf": [Profile.DY.value, ], + "flimf": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kefd": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "kh": [Profile.DY.value, ], + "kii": [Profile.DY.value, ], + "kip": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "kvi": [Profile.DY.value, ], + "kvp": [Profile.DY.value, ], + "kvphz": [Profile.DY.value, ], + "nvphz": [Profile.DY.value, ], + "se1": [Profile.DY.value, ], + "se2": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb1": [Profile.DY.value, ], + "tb2": [Profile.DY.value, ], + "tc1": [Profile.DY.value, ], + "tc2": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "tf1": [Profile.DY.value, ], + "tf2": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + "vcmax": [Profile.DY.value, ], + "vfmax": [Profile.DY.value, ], + "vfmin": [Profile.DY.value, ], + "vimax": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + "xc": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, e1 = 0.0, e2 = 0.0, fbf = None, flimf = 0.0, kc = 0.0, kd = 0.0, ke = 0.0, kefd = 0.0, kf = 0.0, kh = 0.0, kii = 0.0, kip = 0.0, ks = 0.0, kvi = 0.0, kvp = 0.0, kvphz = 0.0, nvphz = 0.0, se1 = 0.0, se2 = 0.0, ta = 0.0, tb1 = 0.0, tb2 = 0.0, tc1 = 0.0, tc2 = 0.0, te = 0.0, tf = 0.0, tf1 = 0.0, tf2 = 0.0, tp = 0.0, vcmax = 0.0, vfmax = 0.0, vfmin = 0.0, vimax = 0.0, vrmax = 0.0, vrmin = 0.0, xc = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.e1 = e1 + self.e2 = e2 + self.fbf = fbf + self.flimf = flimf + self.kc = kc + self.kd = kd + self.ke = ke + self.kefd = kefd + self.kf = kf + self.kh = kh + self.kii = kii + self.kip = kip + self.ks = ks + self.kvi = kvi + self.kvp = kvp + self.kvphz = kvphz + self.nvphz = nvphz + self.se1 = se1 + self.se2 = se2 + self.ta = ta + self.tb1 = tb1 + self.tb2 = tb2 + self.tc1 = tc1 + self.tc2 = tc2 + self.te = te + self.tf = tf + self.tf1 = tf1 + self.tf2 = tf2 + self.tp = tp + self.vcmax = vcmax + self.vfmax = vfmax + self.vfmin = vfmin + self.vimax = vimax + self.vrmax = vrmax + self.vrmin = vrmin + self.xc = xc + + def __str__(self): + str = "class=ExcREXS\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcREXSFeedbackSignalKind.py b/cimpy/cgmes_v2_4_15/ExcREXSFeedbackSignalKind.py index 5d9658f6..0ea4fd00 100644 --- a/cimpy/cgmes_v2_4_15/ExcREXSFeedbackSignalKind.py +++ b/cimpy/cgmes_v2_4_15/ExcREXSFeedbackSignalKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class ExcREXSFeedbackSignalKind(Base): - ''' - Type of rate feedback signals. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=ExcREXSFeedbackSignalKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ExcREXSFeedbackSignalKind(Base): + """ + Type of rate feedback signals. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=ExcREXSFeedbackSignalKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcSCRX.py b/cimpy/cgmes_v2_4_15/ExcSCRX.py index 550e9678..62d5129f 100644 --- a/cimpy/cgmes_v2_4_15/ExcSCRX.py +++ b/cimpy/cgmes_v2_4_15/ExcSCRX.py @@ -1,52 +1,54 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcSCRX(ExcitationSystemDynamics): - ''' - Simple excitation system model representing generic characteristics of many excitation systems; intended for use where negative field current may be a problem. - - :tatb: Ta/Tb - gain reduction ratio of lag-lead element (TaTb). The parameter Ta is not defined explicitly. Typical Value = 0.1. Default: 0.0 - :tb: Denominator time constant of lag-lead block (Tb). Typical Value = 10. Default: 0 - :k: Gain (K) (>0). Typical Value = 200. Default: 0.0 - :te: Time constant of gain block (Te) (>0). Typical Value = 0.02. Default: 0 - :emin: Minimum field voltage output (Emin). Typical Value = 0. Default: 0.0 - :emax: Maximum field voltage output (Emax). Typical Value = 5. Default: 0.0 - :cswitch: Power source switch (Cswitch). true = fixed voltage of 1.0 PU false = generator terminal voltage. Default: False - :rcrfd: Rc/Rfd - ratio of field discharge resistance to field winding resistance (RcRfd). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tatb': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'emin': [cgmesProfile.DY.value, ], - 'emax': [cgmesProfile.DY.value, ], - 'cswitch': [cgmesProfile.DY.value, ], - 'rcrfd': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, tatb = 0.0, tb = 0, k = 0.0, te = 0, emin = 0.0, emax = 0.0, cswitch = False, rcrfd = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tatb = tatb - self.tb = tb - self.k = k - self.te = te - self.emin = emin - self.emax = emax - self.cswitch = cswitch - self.rcrfd = rcrfd - - def __str__(self): - str = 'class=ExcSCRX\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcSCRX(ExcitationSystemDynamics): + """ + Simple excitation system model representing generic characteristics of many excitation systems; intended for use where negative field current may be a problem. + + :cswitch: Power source switch (Cswitch). true = fixed voltage of 1.0 PU false = generator terminal voltage. Default: False + :emax: Maximum field voltage output (Emax). Typical Value = 5. Default: 0.0 + :emin: Minimum field voltage output (Emin). Typical Value = 0. Default: 0.0 + :k: Gain (K) (>0). Typical Value = 200. Default: 0.0 + :rcrfd: Rc/Rfd - ratio of field discharge resistance to field winding resistance (RcRfd). Typical Value = 0. Default: 0.0 + :tatb: Ta/Tb - gain reduction ratio of lag-lead element (TaTb). The parameter Ta is not defined explicitly. Typical Value = 0.1. Default: 0.0 + :tb: Denominator time constant of lag-lead block (Tb). Typical Value = 10. Default: 0.0 + :te: Time constant of gain block (Te) (>0). Typical Value = 0.02. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "cswitch": [Profile.DY.value, ], + "emax": [Profile.DY.value, ], + "emin": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "rcrfd": [Profile.DY.value, ], + "tatb": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, cswitch = False, emax = 0.0, emin = 0.0, k = 0.0, rcrfd = 0.0, tatb = 0.0, tb = 0.0, te = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.cswitch = cswitch + self.emax = emax + self.emin = emin + self.k = k + self.rcrfd = rcrfd + self.tatb = tatb + self.tb = tb + self.te = te + + def __str__(self): + str = "class=ExcSCRX\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcSEXS.py b/cimpy/cgmes_v2_4_15/ExcSEXS.py index bea15a2d..00499c0f 100644 --- a/cimpy/cgmes_v2_4_15/ExcSEXS.py +++ b/cimpy/cgmes_v2_4_15/ExcSEXS.py @@ -1,58 +1,60 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcSEXS(ExcitationSystemDynamics): - ''' - Simplified Excitation System Model. - - :tatb: Ta/Tb - gain reduction ratio of lag-lead element (TaTb). Typical Value = 0.1. Default: 0.0 - :tb: Denominator time constant of lag-lead block (Tb). Typical Value = 10. Default: 0 - :k: Gain (K) (>0). Typical Value = 100. Default: 0.0 - :te: Time constant of gain block (Te). Typical Value = 0.05. Default: 0 - :emin: Minimum field voltage output (Emin). Typical Value = -5. Default: 0.0 - :emax: Maximum field voltage output (Emax). Typical Value = 5. Default: 0.0 - :kc: PI controller gain (Kc). Typical Value = 0.08. Default: 0.0 - :tc: PI controller phase lead time constant (Tc). Typical Value = 0. Default: 0 - :efdmin: Field voltage clipping minimum limit (Efdmin). Typical Value = -5. Default: 0.0 - :efdmax: Field voltage clipping maximum limit (Efdmax). Typical Value = 5. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tatb': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'emin': [cgmesProfile.DY.value, ], - 'emax': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'efdmin': [cgmesProfile.DY.value, ], - 'efdmax': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, tatb = 0.0, tb = 0, k = 0.0, te = 0, emin = 0.0, emax = 0.0, kc = 0.0, tc = 0, efdmin = 0.0, efdmax = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tatb = tatb - self.tb = tb - self.k = k - self.te = te - self.emin = emin - self.emax = emax - self.kc = kc - self.tc = tc - self.efdmin = efdmin - self.efdmax = efdmax - - def __str__(self): - str = 'class=ExcSEXS\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcSEXS(ExcitationSystemDynamics): + """ + Simplified Excitation System Model. + + :efdmax: Field voltage clipping maximum limit (Efdmax). Typical Value = 5. Default: 0.0 + :efdmin: Field voltage clipping minimum limit (Efdmin). Typical Value = -5. Default: 0.0 + :emax: Maximum field voltage output (Emax). Typical Value = 5. Default: 0.0 + :emin: Minimum field voltage output (Emin). Typical Value = -5. Default: 0.0 + :k: Gain (K) (>0). Typical Value = 100. Default: 0.0 + :kc: PI controller gain (Kc). Typical Value = 0.08. Default: 0.0 + :tatb: Ta/Tb - gain reduction ratio of lag-lead element (TaTb). Typical Value = 0.1. Default: 0.0 + :tb: Denominator time constant of lag-lead block (Tb). Typical Value = 10. Default: 0.0 + :tc: PI controller phase lead time constant (Tc). Typical Value = 0. Default: 0.0 + :te: Time constant of gain block (Te). Typical Value = 0.05. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efdmax": [Profile.DY.value, ], + "efdmin": [Profile.DY.value, ], + "emax": [Profile.DY.value, ], + "emin": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "tatb": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efdmax = 0.0, efdmin = 0.0, emax = 0.0, emin = 0.0, k = 0.0, kc = 0.0, tatb = 0.0, tb = 0.0, tc = 0.0, te = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efdmax = efdmax + self.efdmin = efdmin + self.emax = emax + self.emin = emin + self.k = k + self.kc = kc + self.tatb = tatb + self.tb = tb + self.tc = tc + self.te = te + + def __str__(self): + str = "class=ExcSEXS\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcSK.py b/cimpy/cgmes_v2_4_15/ExcSK.py index f470602b..c2cf6d05 100644 --- a/cimpy/cgmes_v2_4_15/ExcSK.py +++ b/cimpy/cgmes_v2_4_15/ExcSK.py @@ -1,124 +1,126 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcSK(ExcitationSystemDynamics): - ''' - Slovakian Excitation System Model. UEL and secondary voltage control are included in this model. When this model is used, there cannot be a separate underexcitation limiter or VAr controller model. - - :efdmax: Field voltage clipping limit (Efdmax). Default: 0.0 - :efdmin: Field voltage clipping limit (Efdmin). Default: 0.0 - :emax: Maximum field voltage output (Emax). Typical Value = 20. Default: 0.0 - :emin: Minimum field voltage output (Emin). Typical Value = -20. Default: 0.0 - :k: Gain (K). Typical Value = 1. Default: 0.0 - :k1: Parameter of underexcitation limit (K1). Typical Value = 0.1364. Default: 0.0 - :k2: Parameter of underexcitation limit (K2). Typical Value = -0.3861. Default: 0.0 - :kc: PI controller gain (Kc). Typical Value = 70. Default: 0.0 - :kce: Rectifier regulation factor (Kce). Typical Value = 0. Default: 0.0 - :kd: Exciter internal reactance (Kd). Typical Value = 0. Default: 0.0 - :kgob: P controller gain (Kgob). Typical Value = 10. Default: 0.0 - :kp: PI controller gain (Kp). Typical Value = 1. Default: 0.0 - :kqi: PI controller gain of integral component (Kqi). Typical Value = 0. Default: 0.0 - :kqob: Rate of rise of the reactive power (Kqob). Default: 0.0 - :kqp: PI controller gain (Kqp). Typical Value = 0. Default: 0.0 - :nq: Dead band of reactive power (nq). Determines the range of sensitivity. Typical Value = 0.001. Default: 0.0 - :qconoff: Secondary voltage control state (Qc_on_off). true = secondary voltage control is ON false = secondary voltage control is OFF. Typical Value = false. Default: False - :qz: Desired value (setpoint) of reactive power, manual setting (Qz). Default: 0.0 - :remote: Selector to apply automatic calculation in secondary controller model. true = automatic calculation is activated false = manual set is active; the use of desired value of reactive power (Qz) is required. Typical Value = true. Default: False - :sbase: Apparent power of the unit (Sbase). Unit = MVA. Typical Value = 259. Default: 0.0 - :tc: PI controller phase lead time constant (Tc). Typical Value = 8. Default: 0 - :te: Time constant of gain block (Te). Typical Value = 0.1. Default: 0 - :ti: PI controller phase lead time constant (Ti). Typical Value = 2. Default: 0 - :tp: Time constant (Tp). Typical Value = 0.1. Default: 0 - :tr: Voltage transducer time constant (Tr). Typical Value = 0.01. Default: 0 - :uimax: Maximum error (Uimax). Typical Value = 10. Default: 0.0 - :uimin: Minimum error (UImin). Typical Value = -10. Default: 0.0 - :urmax: Maximum controller output (URmax). Typical Value = 10. Default: 0.0 - :urmin: Minimum controller output (URmin). Typical Value = -10. Default: 0.0 - :vtmax: Maximum terminal voltage input (Vtmax). Determines the range of voltage dead band. Typical Value = 1.05. Default: 0.0 - :vtmin: Minimum terminal voltage input (Vtmin). Determines the range of voltage dead band. Typical Value = 0.95. Default: 0.0 - :yp: Maximum output (Yp). Minimum output = 0. Typical Value = 1. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'efdmax': [cgmesProfile.DY.value, ], - 'efdmin': [cgmesProfile.DY.value, ], - 'emax': [cgmesProfile.DY.value, ], - 'emin': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kce': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'kgob': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'kqi': [cgmesProfile.DY.value, ], - 'kqob': [cgmesProfile.DY.value, ], - 'kqp': [cgmesProfile.DY.value, ], - 'nq': [cgmesProfile.DY.value, ], - 'qconoff': [cgmesProfile.DY.value, ], - 'qz': [cgmesProfile.DY.value, ], - 'remote': [cgmesProfile.DY.value, ], - 'sbase': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'ti': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 'tr': [cgmesProfile.DY.value, ], - 'uimax': [cgmesProfile.DY.value, ], - 'uimin': [cgmesProfile.DY.value, ], - 'urmax': [cgmesProfile.DY.value, ], - 'urmin': [cgmesProfile.DY.value, ], - 'vtmax': [cgmesProfile.DY.value, ], - 'vtmin': [cgmesProfile.DY.value, ], - 'yp': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, efdmax = 0.0, efdmin = 0.0, emax = 0.0, emin = 0.0, k = 0.0, k1 = 0.0, k2 = 0.0, kc = 0.0, kce = 0.0, kd = 0.0, kgob = 0.0, kp = 0.0, kqi = 0.0, kqob = 0.0, kqp = 0.0, nq = 0.0, qconoff = False, qz = 0.0, remote = False, sbase = 0.0, tc = 0, te = 0, ti = 0, tp = 0, tr = 0, uimax = 0.0, uimin = 0.0, urmax = 0.0, urmin = 0.0, vtmax = 0.0, vtmin = 0.0, yp = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.efdmax = efdmax - self.efdmin = efdmin - self.emax = emax - self.emin = emin - self.k = k - self.k1 = k1 - self.k2 = k2 - self.kc = kc - self.kce = kce - self.kd = kd - self.kgob = kgob - self.kp = kp - self.kqi = kqi - self.kqob = kqob - self.kqp = kqp - self.nq = nq - self.qconoff = qconoff - self.qz = qz - self.remote = remote - self.sbase = sbase - self.tc = tc - self.te = te - self.ti = ti - self.tp = tp - self.tr = tr - self.uimax = uimax - self.uimin = uimin - self.urmax = urmax - self.urmin = urmin - self.vtmax = vtmax - self.vtmin = vtmin - self.yp = yp - - def __str__(self): - str = 'class=ExcSK\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcSK(ExcitationSystemDynamics): + """ + Slovakian Excitation System Model. UEL and secondary voltage control are included in this model. When this model is used, there cannot be a separate underexcitation limiter or VAr controller model. + + :efdmax: Field voltage clipping limit (Efdmax). Default: 0.0 + :efdmin: Field voltage clipping limit (Efdmin). Default: 0.0 + :emax: Maximum field voltage output (Emax). Typical Value = 20. Default: 0.0 + :emin: Minimum field voltage output (Emin). Typical Value = -20. Default: 0.0 + :k: Gain (K). Typical Value = 1. Default: 0.0 + :k1: Parameter of underexcitation limit (K1). Typical Value = 0.1364. Default: 0.0 + :k2: Parameter of underexcitation limit (K2). Typical Value = -0.3861. Default: 0.0 + :kc: PI controller gain (Kc). Typical Value = 70. Default: 0.0 + :kce: Rectifier regulation factor (Kce). Typical Value = 0. Default: 0.0 + :kd: Exciter internal reactance (Kd). Typical Value = 0. Default: 0.0 + :kgob: P controller gain (Kgob). Typical Value = 10. Default: 0.0 + :kp: PI controller gain (Kp). Typical Value = 1. Default: 0.0 + :kqi: PI controller gain of integral component (Kqi). Typical Value = 0. Default: 0.0 + :kqob: Rate of rise of the reactive power (Kqob). Default: 0.0 + :kqp: PI controller gain (Kqp). Typical Value = 0. Default: 0.0 + :nq: Dead band of reactive power (nq). Determines the range of sensitivity. Typical Value = 0.001. Default: 0.0 + :qconoff: Secondary voltage control state (Qc_on_off). true = secondary voltage control is ON false = secondary voltage control is OFF. Typical Value = false. Default: False + :qz: Desired value (setpoint) of reactive power, manual setting (Qz). Default: 0.0 + :remote: Selector to apply automatic calculation in secondary controller model. true = automatic calculation is activated false = manual set is active; the use of desired value of reactive power (Qz) is required. Typical Value = true. Default: False + :sbase: Apparent power of the unit (Sbase). Unit = MVA. Typical Value = 259. Default: 0.0 + :tc: PI controller phase lead time constant (Tc). Typical Value = 8. Default: 0.0 + :te: Time constant of gain block (Te). Typical Value = 0.1. Default: 0.0 + :ti: PI controller phase lead time constant (Ti). Typical Value = 2. Default: 0.0 + :tp: Time constant (Tp). Typical Value = 0.1. Default: 0.0 + :tr: Voltage transducer time constant (Tr). Typical Value = 0.01. Default: 0.0 + :uimax: Maximum error (Uimax). Typical Value = 10. Default: 0.0 + :uimin: Minimum error (UImin). Typical Value = -10. Default: 0.0 + :urmax: Maximum controller output (URmax). Typical Value = 10. Default: 0.0 + :urmin: Minimum controller output (URmin). Typical Value = -10. Default: 0.0 + :vtmax: Maximum terminal voltage input (Vtmax). Determines the range of voltage dead band. Typical Value = 1.05. Default: 0.0 + :vtmin: Minimum terminal voltage input (Vtmin). Determines the range of voltage dead band. Typical Value = 0.95. Default: 0.0 + :yp: Maximum output (Yp). Minimum output = 0. Typical Value = 1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efdmax": [Profile.DY.value, ], + "efdmin": [Profile.DY.value, ], + "emax": [Profile.DY.value, ], + "emin": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kce": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "kgob": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "kqi": [Profile.DY.value, ], + "kqob": [Profile.DY.value, ], + "kqp": [Profile.DY.value, ], + "nq": [Profile.DY.value, ], + "qconoff": [Profile.DY.value, ], + "qz": [Profile.DY.value, ], + "remote": [Profile.DY.value, ], + "sbase": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "ti": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + "tr": [Profile.DY.value, ], + "uimax": [Profile.DY.value, ], + "uimin": [Profile.DY.value, ], + "urmax": [Profile.DY.value, ], + "urmin": [Profile.DY.value, ], + "vtmax": [Profile.DY.value, ], + "vtmin": [Profile.DY.value, ], + "yp": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efdmax = 0.0, efdmin = 0.0, emax = 0.0, emin = 0.0, k = 0.0, k1 = 0.0, k2 = 0.0, kc = 0.0, kce = 0.0, kd = 0.0, kgob = 0.0, kp = 0.0, kqi = 0.0, kqob = 0.0, kqp = 0.0, nq = 0.0, qconoff = False, qz = 0.0, remote = False, sbase = 0.0, tc = 0.0, te = 0.0, ti = 0.0, tp = 0.0, tr = 0.0, uimax = 0.0, uimin = 0.0, urmax = 0.0, urmin = 0.0, vtmax = 0.0, vtmin = 0.0, yp = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efdmax = efdmax + self.efdmin = efdmin + self.emax = emax + self.emin = emin + self.k = k + self.k1 = k1 + self.k2 = k2 + self.kc = kc + self.kce = kce + self.kd = kd + self.kgob = kgob + self.kp = kp + self.kqi = kqi + self.kqob = kqob + self.kqp = kqp + self.nq = nq + self.qconoff = qconoff + self.qz = qz + self.remote = remote + self.sbase = sbase + self.tc = tc + self.te = te + self.ti = ti + self.tp = tp + self.tr = tr + self.uimax = uimax + self.uimin = uimin + self.urmax = urmax + self.urmin = urmin + self.vtmax = vtmax + self.vtmin = vtmin + self.yp = yp + + def __str__(self): + str = "class=ExcSK\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcST1A.py b/cimpy/cgmes_v2_4_15/ExcST1A.py index fc2657a9..d3f880f3 100644 --- a/cimpy/cgmes_v2_4_15/ExcST1A.py +++ b/cimpy/cgmes_v2_4_15/ExcST1A.py @@ -1,82 +1,84 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcST1A(ExcitationSystemDynamics): - ''' - Modification of an old IEEE ST1A static excitation system without overexcitation limiter (OEL) and underexcitation limiter (UEL). - - :vimax: Maximum voltage regulator input limit (Vimax). Typical Value = 999. Default: 0.0 - :vimin: Minimum voltage regulator input limit (Vimin). Typical Value = -999. Default: 0.0 - :tc: Voltage regulator time constant (Tc). Typical Value = 1. Default: 0 - :tb: Voltage regulator time constant (Tb). Typical Value = 10. Default: 0 - :ka: Voltage regulator gain (Ka). Typical Value = 190. Default: 0.0 - :ta: Voltage regulator time constant (Ta). Typical Value = 0.02. Default: 0 - :vrmax: Maximum voltage regulator outputs (Vrmax). Typical Value = 7.8. Default: 0.0 - :vrmin: Minimum voltage regulator outputs (Vrmin). Typical Value = -6.7. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.05. Default: 0.0 - :kf: Excitation control system stabilizer gains (Kf). Typical Value = 0. Default: 0.0 - :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 1. Default: 0 - :tc1: Voltage regulator time constant (Tc). Typical Value = 0. Default: 0 - :tb1: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0 - :vamax: Maximum voltage regulator output (Vamax). Typical Value = 999. Default: 0.0 - :vamin: Minimum voltage regulator output (Vamin). Typical Value = -999. Default: 0.0 - :ilr: Exciter output current limit reference (Ilr). Typical Value = 0. Default: 0.0 - :klr: Exciter output current limiter gain (Klr). Typical Value = 0. Default: 0.0 - :xe: Excitation xfmr effective reactance (Xe). Typical Value = 0.04. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'vimax': [cgmesProfile.DY.value, ], - 'vimin': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'tc1': [cgmesProfile.DY.value, ], - 'tb1': [cgmesProfile.DY.value, ], - 'vamax': [cgmesProfile.DY.value, ], - 'vamin': [cgmesProfile.DY.value, ], - 'ilr': [cgmesProfile.DY.value, ], - 'klr': [cgmesProfile.DY.value, ], - 'xe': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, vimax = 0.0, vimin = 0.0, tc = 0, tb = 0, ka = 0.0, ta = 0, vrmax = 0.0, vrmin = 0.0, kc = 0.0, kf = 0.0, tf = 0, tc1 = 0, tb1 = 0, vamax = 0.0, vamin = 0.0, ilr = 0.0, klr = 0.0, xe = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.vimax = vimax - self.vimin = vimin - self.tc = tc - self.tb = tb - self.ka = ka - self.ta = ta - self.vrmax = vrmax - self.vrmin = vrmin - self.kc = kc - self.kf = kf - self.tf = tf - self.tc1 = tc1 - self.tb1 = tb1 - self.vamax = vamax - self.vamin = vamin - self.ilr = ilr - self.klr = klr - self.xe = xe - - def __str__(self): - str = 'class=ExcST1A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcST1A(ExcitationSystemDynamics): + """ + Modification of an old IEEE ST1A static excitation system without overexcitation limiter (OEL) and underexcitation limiter (UEL). + + :ilr: Exciter output current limit reference (Ilr). Typical Value = 0. Default: 0.0 + :ka: Voltage regulator gain (Ka). Typical Value = 190. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.05. Default: 0.0 + :kf: Excitation control system stabilizer gains (Kf). Typical Value = 0. Default: 0.0 + :klr: Exciter output current limiter gain (Klr). Typical Value = 0. Default: 0.0 + :ta: Voltage regulator time constant (Ta). Typical Value = 0.02. Default: 0.0 + :tb: Voltage regulator time constant (Tb). Typical Value = 10. Default: 0.0 + :tb1: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (Tc). Typical Value = 1. Default: 0.0 + :tc1: Voltage regulator time constant (Tc). Typical Value = 0. Default: 0.0 + :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 1. Default: 0.0 + :vamax: Maximum voltage regulator output (Vamax). Typical Value = 999. Default: 0.0 + :vamin: Minimum voltage regulator output (Vamin). Typical Value = -999. Default: 0.0 + :vimax: Maximum voltage regulator input limit (Vimax). Typical Value = 999. Default: 0.0 + :vimin: Minimum voltage regulator input limit (Vimin). Typical Value = -999. Default: 0.0 + :vrmax: Maximum voltage regulator outputs (Vrmax). Typical Value = 7.8. Default: 0.0 + :vrmin: Minimum voltage regulator outputs (Vrmin). Typical Value = -6.7. Default: 0.0 + :xe: Excitation xfmr effective reactance (Xe). Typical Value = 0.04. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ilr": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "klr": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tb1": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "tc1": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "vamax": [Profile.DY.value, ], + "vamin": [Profile.DY.value, ], + "vimax": [Profile.DY.value, ], + "vimin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + "xe": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ilr = 0.0, ka = 0.0, kc = 0.0, kf = 0.0, klr = 0.0, ta = 0.0, tb = 0.0, tb1 = 0.0, tc = 0.0, tc1 = 0.0, tf = 0.0, vamax = 0.0, vamin = 0.0, vimax = 0.0, vimin = 0.0, vrmax = 0.0, vrmin = 0.0, xe = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ilr = ilr + self.ka = ka + self.kc = kc + self.kf = kf + self.klr = klr + self.ta = ta + self.tb = tb + self.tb1 = tb1 + self.tc = tc + self.tc1 = tc1 + self.tf = tf + self.vamax = vamax + self.vamin = vamin + self.vimax = vimax + self.vimin = vimin + self.vrmax = vrmax + self.vrmin = vrmin + self.xe = xe + + def __str__(self): + str = "class=ExcST1A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcST2A.py b/cimpy/cgmes_v2_4_15/ExcST2A.py index 06345b18..148d5ba9 100644 --- a/cimpy/cgmes_v2_4_15/ExcST2A.py +++ b/cimpy/cgmes_v2_4_15/ExcST2A.py @@ -1,73 +1,75 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcST2A(ExcitationSystemDynamics): - ''' - Modified IEEE ST2A static excitation system - another lead-lag block added to match the model defined by WECC. - - :ka: Voltage regulator gain (Ka). Typical Value = 120. Default: 0.0 - :ta: Voltage regulator time constant (Ta). Typical Value = 0.15. Default: 0 - :vrmax: Maximum voltage regulator outputs (Vrmax). Typical Value = 1. Default: 0.0 - :vrmin: Minimum voltage regulator outputs (Vrmin). Typical Value = -1. Default: 0.0 - :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 - :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 0.5. Default: 0 - :kf: Excitation control system stabilizer gains (Kf). Typical Value = 0.05. Default: 0.0 - :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 0.7. Default: 0 - :kp: Potential circuit gain coefficient (Kp). Typical Value = 4.88. Default: 0.0 - :ki: Potential circuit gain coefficient (Ki). Typical Value = 8. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 1.82. Default: 0.0 - :efdmax: Maximum field voltage (Efdmax). Typical Value = 99. Default: 0.0 - :uelin: UEL input (UELin). true = HV gate false = add to error signal. Typical Value = false. Default: False - :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0 - :tc: Voltage regulator time constant (Tc). Typical Value = 0. Default: 0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'efdmax': [cgmesProfile.DY.value, ], - 'uelin': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ka = 0.0, ta = 0, vrmax = 0.0, vrmin = 0.0, ke = 0.0, te = 0, kf = 0.0, tf = 0, kp = 0.0, ki = 0.0, kc = 0.0, efdmax = 0.0, uelin = False, tb = 0, tc = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ka = ka - self.ta = ta - self.vrmax = vrmax - self.vrmin = vrmin - self.ke = ke - self.te = te - self.kf = kf - self.tf = tf - self.kp = kp - self.ki = ki - self.kc = kc - self.efdmax = efdmax - self.uelin = uelin - self.tb = tb - self.tc = tc - - def __str__(self): - str = 'class=ExcST2A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcST2A(ExcitationSystemDynamics): + """ + Modified IEEE ST2A static excitation system - another lead-lag block added to match the model defined by WECC. + + :efdmax: Maximum field voltage (Efdmax). Typical Value = 99. Default: 0.0 + :ka: Voltage regulator gain (Ka). Typical Value = 120. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 1.82. Default: 0.0 + :ke: Exciter constant related to self-excited field (Ke). Typical Value = 1. Default: 0.0 + :kf: Excitation control system stabilizer gains (Kf). Typical Value = 0.05. Default: 0.0 + :ki: Potential circuit gain coefficient (Ki). Typical Value = 8. Default: 0.0 + :kp: Potential circuit gain coefficient (Kp). Typical Value = 4.88. Default: 0.0 + :ta: Voltage regulator time constant (Ta). Typical Value = 0.15. Default: 0.0 + :tb: Voltage regulator time constant (Tb). Typical Value = 0. Default: 0.0 + :tc: Voltage regulator time constant (Tc). Typical Value = 0. Default: 0.0 + :te: Exciter time constant, integration rate associated with exciter control (Te). Typical Value = 0.5. Default: 0.0 + :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 0.7. Default: 0.0 + :uelin: UEL input (UELin). true = HV gate false = add to error signal. Typical Value = false. Default: False + :vrmax: Maximum voltage regulator outputs (Vrmax). Typical Value = 1. Default: 0.0 + :vrmin: Minimum voltage regulator outputs (Vrmin). Typical Value = -1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efdmax": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "uelin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efdmax = 0.0, ka = 0.0, kc = 0.0, ke = 0.0, kf = 0.0, ki = 0.0, kp = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, te = 0.0, tf = 0.0, uelin = False, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efdmax = efdmax + self.ka = ka + self.kc = kc + self.ke = ke + self.kf = kf + self.ki = ki + self.kp = kp + self.ta = ta + self.tb = tb + self.tc = tc + self.te = te + self.tf = tf + self.uelin = uelin + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcST2A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcST3A.py b/cimpy/cgmes_v2_4_15/ExcST3A.py index 26f289ff..8a3ba637 100644 --- a/cimpy/cgmes_v2_4_15/ExcST3A.py +++ b/cimpy/cgmes_v2_4_15/ExcST3A.py @@ -1,88 +1,90 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcST3A(ExcitationSystemDynamics): - ''' - Modified IEEE ST3A static excitation system with added speed multiplier. - - :vimax: Maximum voltage regulator input limit (Vimax). Typical Value = 0.2. Default: 0.0 - :vimin: Minimum voltage regulator input limit (Vimin). Typical Value = -0.2. Default: 0.0 - :kj: AVR gain (Kj). Typical Value = 200. Default: 0.0 - :tb: Voltage regulator time constant (Tb). Typical Value = 6.67. Default: 0 - :tc: Voltage regulator time constant (Tc). Typical Value = 1. Default: 0 - :efdmax: Maximum AVR output (Efdmax). Typical Value = 6.9. Default: 0.0 - :km: Forward gain constant of the inner loop field regulator (Km). Typical Value = 7.04. Default: 0.0 - :tm: Forward time constant of inner loop field regulator (Tm). Typical Value = 1. Default: 0 - :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 1. Default: 0.0 - :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = 0. Default: 0.0 - :kg: Feedback gain constant of the inner loop field regulator (Kg). Typical Value = 1. Default: 0.0 - :kp: Potential source gain (Kp) (>0). Typical Value = 4.37. Default: 0.0 - :thetap: Potential circuit phase angle (thetap). Typical Value = 20. Default: 0.0 - :ki: Potential circuit gain coefficient (Ki). Typical Value = 4.83. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 1.1. Default: 0.0 - :xl: Reactance associated with potential source (Xl). Typical Value = 0.09. Default: 0.0 - :vbmax: Maximum excitation voltage (Vbmax). Typical Value = 8.63. Default: 0.0 - :vgmax: Maximum inner loop feedback voltage (Vgmax). Typical Value = 6.53. Default: 0.0 - :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 - :ks1: Coefficient to allow different usage of the model-speed coefficient (Ks1). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'vimax': [cgmesProfile.DY.value, ], - 'vimin': [cgmesProfile.DY.value, ], - 'kj': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'efdmax': [cgmesProfile.DY.value, ], - 'km': [cgmesProfile.DY.value, ], - 'tm': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'kg': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'thetap': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'xl': [cgmesProfile.DY.value, ], - 'vbmax': [cgmesProfile.DY.value, ], - 'vgmax': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'ks1': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, vimax = 0.0, vimin = 0.0, kj = 0.0, tb = 0, tc = 0, efdmax = 0.0, km = 0.0, tm = 0, vrmax = 0.0, vrmin = 0.0, kg = 0.0, kp = 0.0, thetap = 0.0, ki = 0.0, kc = 0.0, xl = 0.0, vbmax = 0.0, vgmax = 0.0, ks = 0.0, ks1 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.vimax = vimax - self.vimin = vimin - self.kj = kj - self.tb = tb - self.tc = tc - self.efdmax = efdmax - self.km = km - self.tm = tm - self.vrmax = vrmax - self.vrmin = vrmin - self.kg = kg - self.kp = kp - self.thetap = thetap - self.ki = ki - self.kc = kc - self.xl = xl - self.vbmax = vbmax - self.vgmax = vgmax - self.ks = ks - self.ks1 = ks1 - - def __str__(self): - str = 'class=ExcST3A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcST3A(ExcitationSystemDynamics): + """ + Modified IEEE ST3A static excitation system with added speed multiplier. + + :efdmax: Maximum AVR output (Efdmax). Typical Value = 6.9. Default: 0.0 + :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 1.1. Default: 0.0 + :kg: Feedback gain constant of the inner loop field regulator (Kg). Typical Value = 1. Default: 0.0 + :ki: Potential circuit gain coefficient (Ki). Typical Value = 4.83. Default: 0.0 + :kj: AVR gain (Kj). Typical Value = 200. Default: 0.0 + :km: Forward gain constant of the inner loop field regulator (Km). Typical Value = 7.04. Default: 0.0 + :kp: Potential source gain (Kp) (>0). Typical Value = 4.37. Default: 0.0 + :ks: Coefficient to allow different usage of the model-speed coefficient (Ks). Typical Value = 0. Default: 0.0 + :ks1: Coefficient to allow different usage of the model-speed coefficient (Ks1). Typical Value = 0. Default: 0.0 + :tb: Voltage regulator time constant (Tb). Typical Value = 6.67. Default: 0.0 + :tc: Voltage regulator time constant (Tc). Typical Value = 1. Default: 0.0 + :thetap: Potential circuit phase angle (thetap). Typical Value = 20. Default: 0.0 + :tm: Forward time constant of inner loop field regulator (Tm). Typical Value = 1. Default: 0.0 + :vbmax: Maximum excitation voltage (Vbmax). Typical Value = 8.63. Default: 0.0 + :vgmax: Maximum inner loop feedback voltage (Vgmax). Typical Value = 6.53. Default: 0.0 + :vimax: Maximum voltage regulator input limit (Vimax). Typical Value = 0.2. Default: 0.0 + :vimin: Minimum voltage regulator input limit (Vimin). Typical Value = -0.2. Default: 0.0 + :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 1. Default: 0.0 + :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = 0. Default: 0.0 + :xl: Reactance associated with potential source (Xl). Typical Value = 0.09. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efdmax": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kg": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kj": [Profile.DY.value, ], + "km": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "ks1": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "thetap": [Profile.DY.value, ], + "tm": [Profile.DY.value, ], + "vbmax": [Profile.DY.value, ], + "vgmax": [Profile.DY.value, ], + "vimax": [Profile.DY.value, ], + "vimin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + "xl": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, efdmax = 0.0, kc = 0.0, kg = 0.0, ki = 0.0, kj = 0.0, km = 0.0, kp = 0.0, ks = 0.0, ks1 = 0.0, tb = 0.0, tc = 0.0, thetap = 0.0, tm = 0.0, vbmax = 0.0, vgmax = 0.0, vimax = 0.0, vimin = 0.0, vrmax = 0.0, vrmin = 0.0, xl = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efdmax = efdmax + self.kc = kc + self.kg = kg + self.ki = ki + self.kj = kj + self.km = km + self.kp = kp + self.ks = ks + self.ks1 = ks1 + self.tb = tb + self.tc = tc + self.thetap = thetap + self.tm = tm + self.vbmax = vbmax + self.vgmax = vgmax + self.vimax = vimax + self.vimin = vimin + self.vrmax = vrmax + self.vrmin = vrmin + self.xl = xl + + def __str__(self): + str = "class=ExcST3A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcST4B.py b/cimpy/cgmes_v2_4_15/ExcST4B.py index 60faf595..e2b9cb14 100644 --- a/cimpy/cgmes_v2_4_15/ExcST4B.py +++ b/cimpy/cgmes_v2_4_15/ExcST4B.py @@ -1,85 +1,87 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcST4B(ExcitationSystemDynamics): - ''' - Modified IEEE ST4B static excitation system with maximum inner loop feedback gain . - - :kpr: Voltage regulator proportional gain (Kpr). Typical Value = 10.75. Default: 0.0 - :kir: Voltage regulator integral gain (Kir). Typical Value = 10.75. Default: 0.0 - :ta: Voltage regulator time constant (Ta). Typical Value = 0.02. Default: 0 - :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 1. Default: 0.0 - :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -0.87. Default: 0.0 - :kpm: Voltage regulator proportional gain output (Kpm). Typical Value = 1. Default: 0.0 - :kim: Voltage regulator integral gain output (Kim). Typical Value = 0. Default: 0.0 - :vmmax: Maximum inner loop output (Vmmax). Typical Value = 99. Default: 0.0 - :vmmin: Minimum inner loop output (Vmmin). Typical Value = -99. Default: 0.0 - :kg: Feedback gain constant of the inner loop field regulator (Kg). Typical Value = 0. Default: 0.0 - :kp: Potential circuit gain coefficient (Kp). Typical Value = 9.3. Default: 0.0 - :thetap: Potential circuit phase angle (thetap). Typical Value = 0. Default: 0.0 - :ki: Potential circuit gain coefficient (Ki). Typical Value = 0. Default: 0.0 - :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.113. Default: 0.0 - :xl: Reactance associated with potential source (Xl). Typical Value = 0.124. Default: 0.0 - :vbmax: Maximum excitation voltage (Vbmax). Typical Value = 11.63. Default: 0.0 - :vgmax: Maximum inner loop feedback voltage (Vgmax). Typical Value = 5.8. Default: 0.0 - :uel: Selector (Uel). true = UEL is part of block diagram false = UEL is not part of block diagram. Typical Value = false. Default: False - :lvgate: Selector (LVgate). true = LVgate is part of the block diagram false = LVgate is not part of the block diagram. Typical Value = false. Default: False - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kpr': [cgmesProfile.DY.value, ], - 'kir': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'kpm': [cgmesProfile.DY.value, ], - 'kim': [cgmesProfile.DY.value, ], - 'vmmax': [cgmesProfile.DY.value, ], - 'vmmin': [cgmesProfile.DY.value, ], - 'kg': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'thetap': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'xl': [cgmesProfile.DY.value, ], - 'vbmax': [cgmesProfile.DY.value, ], - 'vgmax': [cgmesProfile.DY.value, ], - 'uel': [cgmesProfile.DY.value, ], - 'lvgate': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, kpr = 0.0, kir = 0.0, ta = 0, vrmax = 0.0, vrmin = 0.0, kpm = 0.0, kim = 0.0, vmmax = 0.0, vmmin = 0.0, kg = 0.0, kp = 0.0, thetap = 0.0, ki = 0.0, kc = 0.0, xl = 0.0, vbmax = 0.0, vgmax = 0.0, uel = False, lvgate = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kpr = kpr - self.kir = kir - self.ta = ta - self.vrmax = vrmax - self.vrmin = vrmin - self.kpm = kpm - self.kim = kim - self.vmmax = vmmax - self.vmmin = vmmin - self.kg = kg - self.kp = kp - self.thetap = thetap - self.ki = ki - self.kc = kc - self.xl = xl - self.vbmax = vbmax - self.vgmax = vgmax - self.uel = uel - self.lvgate = lvgate - - def __str__(self): - str = 'class=ExcST4B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcST4B(ExcitationSystemDynamics): + """ + Modified IEEE ST4B static excitation system with maximum inner loop feedback gain . + + :kc: Rectifier loading factor proportional to commutating reactance (Kc). Typical Value = 0.113. Default: 0.0 + :kg: Feedback gain constant of the inner loop field regulator (Kg). Typical Value = 0. Default: 0.0 + :ki: Potential circuit gain coefficient (Ki). Typical Value = 0. Default: 0.0 + :kim: Voltage regulator integral gain output (Kim). Typical Value = 0. Default: 0.0 + :kir: Voltage regulator integral gain (Kir). Typical Value = 10.75. Default: 0.0 + :kp: Potential circuit gain coefficient (Kp). Typical Value = 9.3. Default: 0.0 + :kpm: Voltage regulator proportional gain output (Kpm). Typical Value = 1. Default: 0.0 + :kpr: Voltage regulator proportional gain (Kpr). Typical Value = 10.75. Default: 0.0 + :lvgate: Selector (LVgate). true = LVgate is part of the block diagram false = LVgate is not part of the block diagram. Typical Value = false. Default: False + :ta: Voltage regulator time constant (Ta). Typical Value = 0.02. Default: 0.0 + :thetap: Potential circuit phase angle (thetap). Typical Value = 0. Default: 0.0 + :uel: Selector (Uel). true = UEL is part of block diagram false = UEL is not part of block diagram. Typical Value = false. Default: False + :vbmax: Maximum excitation voltage (Vbmax). Typical Value = 11.63. Default: 0.0 + :vgmax: Maximum inner loop feedback voltage (Vgmax). Typical Value = 5.8. Default: 0.0 + :vmmax: Maximum inner loop output (Vmmax). Typical Value = 99. Default: 0.0 + :vmmin: Minimum inner loop output (Vmmin). Typical Value = -99. Default: 0.0 + :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 1. Default: 0.0 + :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -0.87. Default: 0.0 + :xl: Reactance associated with potential source (Xl). Typical Value = 0.124. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kg": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kim": [Profile.DY.value, ], + "kir": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "kpm": [Profile.DY.value, ], + "kpr": [Profile.DY.value, ], + "lvgate": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "thetap": [Profile.DY.value, ], + "uel": [Profile.DY.value, ], + "vbmax": [Profile.DY.value, ], + "vgmax": [Profile.DY.value, ], + "vmmax": [Profile.DY.value, ], + "vmmin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + "xl": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, kc = 0.0, kg = 0.0, ki = 0.0, kim = 0.0, kir = 0.0, kp = 0.0, kpm = 0.0, kpr = 0.0, lvgate = False, ta = 0.0, thetap = 0.0, uel = False, vbmax = 0.0, vgmax = 0.0, vmmax = 0.0, vmmin = 0.0, vrmax = 0.0, vrmin = 0.0, xl = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.kc = kc + self.kg = kg + self.ki = ki + self.kim = kim + self.kir = kir + self.kp = kp + self.kpm = kpm + self.kpr = kpr + self.lvgate = lvgate + self.ta = ta + self.thetap = thetap + self.uel = uel + self.vbmax = vbmax + self.vgmax = vgmax + self.vmmax = vmmax + self.vmmin = vmmin + self.vrmax = vrmax + self.vrmin = vrmin + self.xl = xl + + def __str__(self): + str = "class=ExcST4B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcST6B.py b/cimpy/cgmes_v2_4_15/ExcST6B.py index cb1a90aa..8944b9b0 100644 --- a/cimpy/cgmes_v2_4_15/ExcST6B.py +++ b/cimpy/cgmes_v2_4_15/ExcST6B.py @@ -1,97 +1,99 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcST6B(ExcitationSystemDynamics): - ''' - Modified IEEE ST6B static excitation system with PID controller and optional inner feedbacks loop. - - :ilr: Exciter output current limit reference (Ilr). Typical Value = 4.164. Default: 0.0 - :k1: Selector (K1). true = feedback is from Ifd false = feedback is not from Ifd. Typical Value = true. Default: False - :kcl: Exciter output current limit adjustment (Kcl). Typical Value = 1.0577. Default: 0.0 - :kff: Pre-control gain constant of the inner loop field regulator (Kff). Typical Value = 1. Default: 0.0 - :kg: Feedback gain constant of the inner loop field regulator (Kg). Typical Value = 1. Default: 0.0 - :kia: Voltage regulator integral gain (Kia). Typical Value = 45.094. Default: 0.0 - :klr: Exciter output current limit adjustment (Kcl). Typical Value = 17.33. Default: 0.0 - :km: Forward gain constant of the inner loop field regulator (Km). Typical Value = 1. Default: 0.0 - :kpa: Voltage regulator proportional gain (Kpa). Typical Value = 18.038. Default: 0.0 - :kvd: Voltage regulator derivative gain (Kvd). Typical Value = 0. Default: 0.0 - :oelin: OEL input selector (OELin). Typical Value = noOELinput. Default: None - :tg: Feedback time constant of inner loop field voltage regulator (Tg). Typical Value = 0.02. Default: 0 - :ts: Rectifier firing time constant (Ts). Typical Value = 0. Default: 0 - :tvd: Voltage regulator derivative gain (Tvd). Typical Value = 0. Default: 0 - :vamax: Maximum voltage regulator output (Vamax). Typical Value = 4.81. Default: 0.0 - :vamin: Minimum voltage regulator output (Vamin). Typical Value = -3.85. Default: 0.0 - :vilim: Selector (Vilim). true = Vimin-Vimax limiter is active false = Vimin-Vimax limiter is not active. Typical Value = true. Default: False - :vimax: Maximum voltage regulator input limit (Vimax). Typical Value = 10. Default: 0.0 - :vimin: Minimum voltage regulator input limit (Vimin). Typical Value = -10. Default: 0.0 - :vmult: Selector (Vmult). true = multiply regulator output by terminal voltage false = do not multiply regulator output by terminal voltage. Typical Value = true. Default: False - :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 4.81. Default: 0.0 - :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -3.85. Default: 0.0 - :xc: Excitation source reactance (Xc). Typical Value = 0.05. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ilr': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 'kcl': [cgmesProfile.DY.value, ], - 'kff': [cgmesProfile.DY.value, ], - 'kg': [cgmesProfile.DY.value, ], - 'kia': [cgmesProfile.DY.value, ], - 'klr': [cgmesProfile.DY.value, ], - 'km': [cgmesProfile.DY.value, ], - 'kpa': [cgmesProfile.DY.value, ], - 'kvd': [cgmesProfile.DY.value, ], - 'oelin': [cgmesProfile.DY.value, ], - 'tg': [cgmesProfile.DY.value, ], - 'ts': [cgmesProfile.DY.value, ], - 'tvd': [cgmesProfile.DY.value, ], - 'vamax': [cgmesProfile.DY.value, ], - 'vamin': [cgmesProfile.DY.value, ], - 'vilim': [cgmesProfile.DY.value, ], - 'vimax': [cgmesProfile.DY.value, ], - 'vimin': [cgmesProfile.DY.value, ], - 'vmult': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'xc': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, ilr = 0.0, k1 = False, kcl = 0.0, kff = 0.0, kg = 0.0, kia = 0.0, klr = 0.0, km = 0.0, kpa = 0.0, kvd = 0.0, oelin = None, tg = 0, ts = 0, tvd = 0, vamax = 0.0, vamin = 0.0, vilim = False, vimax = 0.0, vimin = 0.0, vmult = False, vrmax = 0.0, vrmin = 0.0, xc = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ilr = ilr - self.k1 = k1 - self.kcl = kcl - self.kff = kff - self.kg = kg - self.kia = kia - self.klr = klr - self.km = km - self.kpa = kpa - self.kvd = kvd - self.oelin = oelin - self.tg = tg - self.ts = ts - self.tvd = tvd - self.vamax = vamax - self.vamin = vamin - self.vilim = vilim - self.vimax = vimax - self.vimin = vimin - self.vmult = vmult - self.vrmax = vrmax - self.vrmin = vrmin - self.xc = xc - - def __str__(self): - str = 'class=ExcST6B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcST6B(ExcitationSystemDynamics): + """ + Modified IEEE ST6B static excitation system with PID controller and optional inner feedbacks loop. + + :ilr: Exciter output current limit reference (Ilr). Typical Value = 4.164. Default: 0.0 + :k1: Selector (K1). true = feedback is from Ifd false = feedback is not from Ifd. Typical Value = true. Default: False + :kcl: Exciter output current limit adjustment (Kcl). Typical Value = 1.0577. Default: 0.0 + :kff: Pre-control gain constant of the inner loop field regulator (Kff). Typical Value = 1. Default: 0.0 + :kg: Feedback gain constant of the inner loop field regulator (Kg). Typical Value = 1. Default: 0.0 + :kia: Voltage regulator integral gain (Kia). Typical Value = 45.094. Default: 0.0 + :klr: Exciter output current limit adjustment (Kcl). Typical Value = 17.33. Default: 0.0 + :km: Forward gain constant of the inner loop field regulator (Km). Typical Value = 1. Default: 0.0 + :kpa: Voltage regulator proportional gain (Kpa). Typical Value = 18.038. Default: 0.0 + :kvd: Voltage regulator derivative gain (Kvd). Typical Value = 0. Default: 0.0 + :oelin: OEL input selector (OELin). Typical Value = noOELinput. Default: None + :tg: Feedback time constant of inner loop field voltage regulator (Tg). Typical Value = 0.02. Default: 0.0 + :ts: Rectifier firing time constant (Ts). Typical Value = 0. Default: 0.0 + :tvd: Voltage regulator derivative gain (Tvd). Typical Value = 0. Default: 0.0 + :vamax: Maximum voltage regulator output (Vamax). Typical Value = 4.81. Default: 0.0 + :vamin: Minimum voltage regulator output (Vamin). Typical Value = -3.85. Default: 0.0 + :vilim: Selector (Vilim). true = Vimin-Vimax limiter is active false = Vimin-Vimax limiter is not active. Typical Value = true. Default: False + :vimax: Maximum voltage regulator input limit (Vimax). Typical Value = 10. Default: 0.0 + :vimin: Minimum voltage regulator input limit (Vimin). Typical Value = -10. Default: 0.0 + :vmult: Selector (Vmult). true = multiply regulator output by terminal voltage false = do not multiply regulator output by terminal voltage. Typical Value = true. Default: False + :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 4.81. Default: 0.0 + :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -3.85. Default: 0.0 + :xc: Excitation source reactance (Xc). Typical Value = 0.05. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ilr": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "kcl": [Profile.DY.value, ], + "kff": [Profile.DY.value, ], + "kg": [Profile.DY.value, ], + "kia": [Profile.DY.value, ], + "klr": [Profile.DY.value, ], + "km": [Profile.DY.value, ], + "kpa": [Profile.DY.value, ], + "kvd": [Profile.DY.value, ], + "oelin": [Profile.DY.value, ], + "tg": [Profile.DY.value, ], + "ts": [Profile.DY.value, ], + "tvd": [Profile.DY.value, ], + "vamax": [Profile.DY.value, ], + "vamin": [Profile.DY.value, ], + "vilim": [Profile.DY.value, ], + "vimax": [Profile.DY.value, ], + "vimin": [Profile.DY.value, ], + "vmult": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + "xc": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ilr = 0.0, k1 = False, kcl = 0.0, kff = 0.0, kg = 0.0, kia = 0.0, klr = 0.0, km = 0.0, kpa = 0.0, kvd = 0.0, oelin = None, tg = 0.0, ts = 0.0, tvd = 0.0, vamax = 0.0, vamin = 0.0, vilim = False, vimax = 0.0, vimin = 0.0, vmult = False, vrmax = 0.0, vrmin = 0.0, xc = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ilr = ilr + self.k1 = k1 + self.kcl = kcl + self.kff = kff + self.kg = kg + self.kia = kia + self.klr = klr + self.km = km + self.kpa = kpa + self.kvd = kvd + self.oelin = oelin + self.tg = tg + self.ts = ts + self.tvd = tvd + self.vamax = vamax + self.vamin = vamin + self.vilim = vilim + self.vimax = vimax + self.vimin = vimin + self.vmult = vmult + self.vrmax = vrmax + self.vrmin = vrmin + self.xc = xc + + def __str__(self): + str = "class=ExcST6B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcST6BOELselectorKind.py b/cimpy/cgmes_v2_4_15/ExcST6BOELselectorKind.py index 580f9f05..f78c7f12 100644 --- a/cimpy/cgmes_v2_4_15/ExcST6BOELselectorKind.py +++ b/cimpy/cgmes_v2_4_15/ExcST6BOELselectorKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class ExcST6BOELselectorKind(Base): - ''' - Type of connection for the OEL input used for static excitation systems type 6B. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=ExcST6BOELselectorKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ExcST6BOELselectorKind(Base): + """ + Type of connection for the OEL input used for static excitation systems type 6B. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=ExcST6BOELselectorKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcST7B.py b/cimpy/cgmes_v2_4_15/ExcST7B.py index 105fd6e4..9b4a88c3 100644 --- a/cimpy/cgmes_v2_4_15/ExcST7B.py +++ b/cimpy/cgmes_v2_4_15/ExcST7B.py @@ -1,76 +1,78 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcST7B(ExcitationSystemDynamics): - ''' - Modified IEEE ST7B static excitation system without stator current limiter (SCL) and current compensator (DROOP) inputs. - - :kh: High-value gate feedback gain (Kh). Typical Value = 1. Default: 0.0 - :kia: Voltage regulator integral gain (Kia). Typical Value = 1. Default: 0.0 - :kl: Low-value gate feedback gain (Kl). Typical Value = 1. Default: 0.0 - :kpa: Voltage regulator proportional gain (Kpa). Typical Value = 40. Default: 0.0 - :oelin: OEL input selector (OELin). Typical Value = noOELinput. Default: None - :tb: Regulator lag time constant (Tb). Typical Value = 1. Default: 0 - :tc: Regulator lead time constant (Tc). Typical Value = 1. Default: 0 - :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 1. Default: 0 - :tg: Feedback time constant of inner loop field voltage regulator (Tg). Typical Value = 1. Default: 0 - :tia: Feedback time constant (Tia). Typical Value = 3. Default: 0 - :ts: Rectifier firing time constant (Ts). Typical Value = 0. Default: 0 - :uelin: UEL input selector (UELin). Typical Value = noUELinput. Default: None - :vmax: Maximum voltage reference signal (Vmax). Typical Value = 1.1. Default: 0.0 - :vmin: Minimum voltage reference signal (Vmin). Typical Value = 0.9. Default: 0.0 - :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 5. Default: 0.0 - :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -4.5. Default: 0.0 - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kh': [cgmesProfile.DY.value, ], - 'kia': [cgmesProfile.DY.value, ], - 'kl': [cgmesProfile.DY.value, ], - 'kpa': [cgmesProfile.DY.value, ], - 'oelin': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'tg': [cgmesProfile.DY.value, ], - 'tia': [cgmesProfile.DY.value, ], - 'ts': [cgmesProfile.DY.value, ], - 'uelin': [cgmesProfile.DY.value, ], - 'vmax': [cgmesProfile.DY.value, ], - 'vmin': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, kh = 0.0, kia = 0.0, kl = 0.0, kpa = 0.0, oelin = None, tb = 0, tc = 0, tf = 0, tg = 0, tia = 0, ts = 0, uelin = None, vmax = 0.0, vmin = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kh = kh - self.kia = kia - self.kl = kl - self.kpa = kpa - self.oelin = oelin - self.tb = tb - self.tc = tc - self.tf = tf - self.tg = tg - self.tia = tia - self.ts = ts - self.uelin = uelin - self.vmax = vmax - self.vmin = vmin - self.vrmax = vrmax - self.vrmin = vrmin - - def __str__(self): - str = 'class=ExcST7B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcST7B(ExcitationSystemDynamics): + """ + Modified IEEE ST7B static excitation system without stator current limiter (SCL) and current compensator (DROOP) inputs. + + :kh: High-value gate feedback gain (Kh). Typical Value = 1. Default: 0.0 + :kia: Voltage regulator integral gain (Kia). Typical Value = 1. Default: 0.0 + :kl: Low-value gate feedback gain (Kl). Typical Value = 1. Default: 0.0 + :kpa: Voltage regulator proportional gain (Kpa). Typical Value = 40. Default: 0.0 + :oelin: OEL input selector (OELin). Typical Value = noOELinput. Default: None + :tb: Regulator lag time constant (Tb). Typical Value = 1. Default: 0.0 + :tc: Regulator lead time constant (Tc). Typical Value = 1. Default: 0.0 + :tf: Excitation control system stabilizer time constant (Tf). Typical Value = 1. Default: 0.0 + :tg: Feedback time constant of inner loop field voltage regulator (Tg). Typical Value = 1. Default: 0.0 + :tia: Feedback time constant (Tia). Typical Value = 3. Default: 0.0 + :ts: Rectifier firing time constant (Ts). Typical Value = 0. Default: 0.0 + :uelin: UEL input selector (UELin). Typical Value = noUELinput. Default: None + :vmax: Maximum voltage reference signal (Vmax). Typical Value = 1.1. Default: 0.0 + :vmin: Minimum voltage reference signal (Vmin). Typical Value = 0.9. Default: 0.0 + :vrmax: Maximum voltage regulator output (Vrmax). Typical Value = 5. Default: 0.0 + :vrmin: Minimum voltage regulator output (Vrmin). Typical Value = -4.5. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "kh": [Profile.DY.value, ], + "kia": [Profile.DY.value, ], + "kl": [Profile.DY.value, ], + "kpa": [Profile.DY.value, ], + "oelin": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "tg": [Profile.DY.value, ], + "tia": [Profile.DY.value, ], + "ts": [Profile.DY.value, ], + "uelin": [Profile.DY.value, ], + "vmax": [Profile.DY.value, ], + "vmin": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, kh = 0.0, kia = 0.0, kl = 0.0, kpa = 0.0, oelin = None, tb = 0.0, tc = 0.0, tf = 0.0, tg = 0.0, tia = 0.0, ts = 0.0, uelin = None, vmax = 0.0, vmin = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.kh = kh + self.kia = kia + self.kl = kl + self.kpa = kpa + self.oelin = oelin + self.tb = tb + self.tc = tc + self.tf = tf + self.tg = tg + self.tia = tia + self.ts = ts + self.uelin = uelin + self.vmax = vmax + self.vmin = vmin + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=ExcST7B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcST7BOELselectorKind.py b/cimpy/cgmes_v2_4_15/ExcST7BOELselectorKind.py index 22549e31..ef060bda 100644 --- a/cimpy/cgmes_v2_4_15/ExcST7BOELselectorKind.py +++ b/cimpy/cgmes_v2_4_15/ExcST7BOELselectorKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class ExcST7BOELselectorKind(Base): - ''' - Type of connection for the OEL input used for static excitation systems type 7B. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=ExcST7BOELselectorKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ExcST7BOELselectorKind(Base): + """ + Type of connection for the OEL input used for static excitation systems type 7B. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=ExcST7BOELselectorKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcST7BUELselectorKind.py b/cimpy/cgmes_v2_4_15/ExcST7BUELselectorKind.py index cae633cd..385b9678 100644 --- a/cimpy/cgmes_v2_4_15/ExcST7BUELselectorKind.py +++ b/cimpy/cgmes_v2_4_15/ExcST7BUELselectorKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class ExcST7BUELselectorKind(Base): - ''' - Type of connection for the UEL input used for static excitation systems type 7B. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=ExcST7BUELselectorKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ExcST7BUELselectorKind(Base): + """ + Type of connection for the UEL input used for static excitation systems type 7B. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=ExcST7BUELselectorKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcitationSystemDynamics.py b/cimpy/cgmes_v2_4_15/ExcitationSystemDynamics.py index ad4536dd..2d7921d4 100644 --- a/cimpy/cgmes_v2_4_15/ExcitationSystemDynamics.py +++ b/cimpy/cgmes_v2_4_15/ExcitationSystemDynamics.py @@ -1,52 +1,54 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class ExcitationSystemDynamics(DynamicsFunctionBlock): - ''' - Excitation system function block whose behavior is described by reference to a standard model - - :SynchronousMachineDynamics: Synchronous machine model with which this excitation system model is associated. Default: None - :PowerSystemStabilizerDynamics: Power system stabilizer model associated with this excitation system model. Default: None - :PFVArControllerType1Dynamics: Power Factor or VAr controller Type I model associated with this excitation system model. Default: None - :VoltageCompensatorDynamics: Voltage compensator model associated with this excitation system model. Default: None - :DiscontinuousExcitationControlDynamics: Discontinuous excitation control model associated with this excitation system model. Default: None - :UnderexcitationLimiterDynamics: Undrexcitation limiter model associated with this excitation system model. Default: None - :PFVArControllerType2Dynamics: Power Factor or VAr controller Type II model associated with this excitation system model. Default: None - :OverexcitationLimiterDynamics: Overexcitation limiter model associated with this excitation system model. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'SynchronousMachineDynamics': [cgmesProfile.DY.value, ], - 'PowerSystemStabilizerDynamics': [cgmesProfile.DY.value, ], - 'PFVArControllerType1Dynamics': [cgmesProfile.DY.value, ], - 'VoltageCompensatorDynamics': [cgmesProfile.DY.value, ], - 'DiscontinuousExcitationControlDynamics': [cgmesProfile.DY.value, ], - 'UnderexcitationLimiterDynamics': [cgmesProfile.DY.value, ], - 'PFVArControllerType2Dynamics': [cgmesProfile.DY.value, ], - 'OverexcitationLimiterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, SynchronousMachineDynamics = None, PowerSystemStabilizerDynamics = None, PFVArControllerType1Dynamics = None, VoltageCompensatorDynamics = None, DiscontinuousExcitationControlDynamics = None, UnderexcitationLimiterDynamics = None, PFVArControllerType2Dynamics = None, OverexcitationLimiterDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.SynchronousMachineDynamics = SynchronousMachineDynamics - self.PowerSystemStabilizerDynamics = PowerSystemStabilizerDynamics - self.PFVArControllerType1Dynamics = PFVArControllerType1Dynamics - self.VoltageCompensatorDynamics = VoltageCompensatorDynamics - self.DiscontinuousExcitationControlDynamics = DiscontinuousExcitationControlDynamics - self.UnderexcitationLimiterDynamics = UnderexcitationLimiterDynamics - self.PFVArControllerType2Dynamics = PFVArControllerType2Dynamics - self.OverexcitationLimiterDynamics = OverexcitationLimiterDynamics - - def __str__(self): - str = 'class=ExcitationSystemDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class ExcitationSystemDynamics(DynamicsFunctionBlock): + """ + Excitation system function block whose behavior is described by reference to a standard model + + :DiscontinuousExcitationControlDynamics: Discontinuous excitation control model associated with this excitation system model. Default: None + :OverexcitationLimiterDynamics: Overexcitation limiter model associated with this excitation system model. Default: None + :PFVArControllerType1Dynamics: Power Factor or VAr controller Type I model associated with this excitation system model. Default: None + :PFVArControllerType2Dynamics: Power Factor or VAr controller Type II model associated with this excitation system model. Default: None + :PowerSystemStabilizerDynamics: Power system stabilizer model associated with this excitation system model. Default: None + :SynchronousMachineDynamics: Synchronous machine model with which this excitation system model is associated. Default: None + :UnderexcitationLimiterDynamics: Undrexcitation limiter model associated with this excitation system model. Default: None + :VoltageCompensatorDynamics: Voltage compensator model associated with this excitation system model. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "DiscontinuousExcitationControlDynamics": [Profile.DY.value, ], + "OverexcitationLimiterDynamics": [Profile.DY.value, ], + "PFVArControllerType1Dynamics": [Profile.DY.value, ], + "PFVArControllerType2Dynamics": [Profile.DY.value, ], + "PowerSystemStabilizerDynamics": [Profile.DY.value, ], + "SynchronousMachineDynamics": [Profile.DY.value, ], + "UnderexcitationLimiterDynamics": [Profile.DY.value, ], + "VoltageCompensatorDynamics": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, DiscontinuousExcitationControlDynamics = None, OverexcitationLimiterDynamics = None, PFVArControllerType1Dynamics = None, PFVArControllerType2Dynamics = None, PowerSystemStabilizerDynamics = None, SynchronousMachineDynamics = None, UnderexcitationLimiterDynamics = None, VoltageCompensatorDynamics = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DiscontinuousExcitationControlDynamics = DiscontinuousExcitationControlDynamics + self.OverexcitationLimiterDynamics = OverexcitationLimiterDynamics + self.PFVArControllerType1Dynamics = PFVArControllerType1Dynamics + self.PFVArControllerType2Dynamics = PFVArControllerType2Dynamics + self.PowerSystemStabilizerDynamics = PowerSystemStabilizerDynamics + self.SynchronousMachineDynamics = SynchronousMachineDynamics + self.UnderexcitationLimiterDynamics = UnderexcitationLimiterDynamics + self.VoltageCompensatorDynamics = VoltageCompensatorDynamics + + def __str__(self): + str = "class=ExcitationSystemDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExcitationSystemUserDefined.py b/cimpy/cgmes_v2_4_15/ExcitationSystemUserDefined.py index 4839e2a3..c8598b85 100644 --- a/cimpy/cgmes_v2_4_15/ExcitationSystemUserDefined.py +++ b/cimpy/cgmes_v2_4_15/ExcitationSystemUserDefined.py @@ -1,34 +1,36 @@ -from .ExcitationSystemDynamics import ExcitationSystemDynamics - - -class ExcitationSystemUserDefined(ExcitationSystemDynamics): - ''' - Excitation system function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = ExcitationSystemDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ExcitationSystemDynamics: \n' + ExcitationSystemDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=ExcitationSystemUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ExcitationSystemDynamics import ExcitationSystemDynamics +from .CGMESProfile import Profile + + +class ExcitationSystemUserDefined(ExcitationSystemDynamics): + """ + Excitation system function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class ExcitationSystemDynamics:\n" + ExcitationSystemDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=ExcitationSystemUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ExternalNetworkInjection.py b/cimpy/cgmes_v2_4_15/ExternalNetworkInjection.py index b449a16a..6a688c11 100644 --- a/cimpy/cgmes_v2_4_15/ExternalNetworkInjection.py +++ b/cimpy/cgmes_v2_4_15/ExternalNetworkInjection.py @@ -1,82 +1,84 @@ -from .RegulatingCondEq import RegulatingCondEq - - -class ExternalNetworkInjection(RegulatingCondEq): - ''' - This class represents external network and it is used for IEC 60909 calculations. - - :governorSCD: Power Frequency Bias. This is the change in power injection divided by the change in frequency and negated. A positive value of the power frequency bias provides additional power injection upon a drop in frequency. Default: 0.0 - :maxP: Maximum active power of the injection. Default: 0.0 - :maxQ: Not for short circuit modelling; It is used for modelling of infeed for load flow exchange. If maxQ and minQ are not used ReactiveCapabilityCurve can be used Default: 0.0 - :minP: Minimum active power of the injection. Default: 0.0 - :minQ: Not for short circuit modelling; It is used for modelling of infeed for load flow exchange. If maxQ and minQ are not used ReactiveCapabilityCurve can be used Default: 0.0 - :ikSecond: Indicates whether initial symmetrical short-circuit current and power have been calculated according to IEC (Ik`). Default: False - :maxInitialSymShCCurrent: Maximum initial symmetrical short-circuit currents (Ik` max) in A (Ik` = Sk`/(SQRT(3) Un)). Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :maxR0ToX0Ratio: Maximum ratio of zero sequence resistance of Network Feeder to its zero sequence reactance (R(0)/X(0) max). Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :maxR1ToX1Ratio: Maximum ratio of positive sequence resistance of Network Feeder to its positive sequence reactance (R(1)/X(1) max). Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :maxZ0ToZ1Ratio: Maximum ratio of zero sequence impedance to its positive sequence impedance (Z(0)/Z(1) max). Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :minInitialSymShCCurrent: Minimum initial symmetrical short-circuit currents (Ik` min) in A (Ik` = Sk`/(SQRT(3) Un)). Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :minR0ToX0Ratio: Indicates whether initial symmetrical short-circuit current and power have been calculated according to IEC (Ik`). Used for short circuit data exchange according to IEC 6090 Default: 0.0 - :minR1ToX1Ratio: Minimum ratio of positive sequence resistance of Network Feeder to its positive sequence reactance (R(1)/X(1) min). Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :minZ0ToZ1Ratio: Minimum ratio of zero sequence impedance to its positive sequence impedance (Z(0)/Z(1) min). Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :voltageFactor: Voltage factor in pu, which was used to calculate short-circuit current Ik` and power Sk`. Default: 0.0 - :referencePriority: Priority of unit for use as powerflow voltage phase angle reference bus selection. 0 = don t care (default) 1 = highest priority. 2 is less than 1 and so on. Default: 0 - :p: Active power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions. Default: 0.0 - :q: Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions. Default: 0.0 - ''' - - cgmesProfile = RegulatingCondEq.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'governorSCD': [cgmesProfile.EQ.value, ], - 'maxP': [cgmesProfile.EQ.value, ], - 'maxQ': [cgmesProfile.EQ.value, ], - 'minP': [cgmesProfile.EQ.value, ], - 'minQ': [cgmesProfile.EQ.value, ], - 'ikSecond': [cgmesProfile.EQ.value, ], - 'maxInitialSymShCCurrent': [cgmesProfile.EQ.value, ], - 'maxR0ToX0Ratio': [cgmesProfile.EQ.value, ], - 'maxR1ToX1Ratio': [cgmesProfile.EQ.value, ], - 'maxZ0ToZ1Ratio': [cgmesProfile.EQ.value, ], - 'minInitialSymShCCurrent': [cgmesProfile.EQ.value, ], - 'minR0ToX0Ratio': [cgmesProfile.EQ.value, ], - 'minR1ToX1Ratio': [cgmesProfile.EQ.value, ], - 'minZ0ToZ1Ratio': [cgmesProfile.EQ.value, ], - 'voltageFactor': [cgmesProfile.EQ.value, ], - 'referencePriority': [cgmesProfile.SSH.value, ], - 'p': [cgmesProfile.SSH.value, ], - 'q': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class RegulatingCondEq: \n' + RegulatingCondEq.__doc__ - - def __init__(self, governorSCD = 0.0, maxP = 0.0, maxQ = 0.0, minP = 0.0, minQ = 0.0, ikSecond = False, maxInitialSymShCCurrent = 0.0, maxR0ToX0Ratio = 0.0, maxR1ToX1Ratio = 0.0, maxZ0ToZ1Ratio = 0.0, minInitialSymShCCurrent = 0.0, minR0ToX0Ratio = 0.0, minR1ToX1Ratio = 0.0, minZ0ToZ1Ratio = 0.0, voltageFactor = 0.0, referencePriority = 0, p = 0.0, q = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.governorSCD = governorSCD - self.maxP = maxP - self.maxQ = maxQ - self.minP = minP - self.minQ = minQ - self.ikSecond = ikSecond - self.maxInitialSymShCCurrent = maxInitialSymShCCurrent - self.maxR0ToX0Ratio = maxR0ToX0Ratio - self.maxR1ToX1Ratio = maxR1ToX1Ratio - self.maxZ0ToZ1Ratio = maxZ0ToZ1Ratio - self.minInitialSymShCCurrent = minInitialSymShCCurrent - self.minR0ToX0Ratio = minR0ToX0Ratio - self.minR1ToX1Ratio = minR1ToX1Ratio - self.minZ0ToZ1Ratio = minZ0ToZ1Ratio - self.voltageFactor = voltageFactor - self.referencePriority = referencePriority - self.p = p - self.q = q - - def __str__(self): - str = 'class=ExternalNetworkInjection\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .RegulatingCondEq import RegulatingCondEq +from .CGMESProfile import Profile + + +class ExternalNetworkInjection(RegulatingCondEq): + """ + This class represents external network and it is used for IEC 60909 calculations. + + :governorSCD: Power Frequency Bias. This is the change in power injection divided by the change in frequency and negated. A positive value of the power frequency bias provides additional power injection upon a drop in frequency. Default: 0.0 + :ikSecond: Indicates whether initial symmetrical short-circuit current and power have been calculated according to IEC (Ik`). Default: False + :maxInitialSymShCCurrent: Maximum initial symmetrical short-circuit currents (Ik` max) in A (Ik` = Sk`/(SQRT(3) Un)). Used for short circuit data exchange according to IEC 60909 Default: 0.0 + :maxP: Maximum active power of the injection. Default: 0.0 + :maxQ: Not for short circuit modelling; It is used for modelling of infeed for load flow exchange. If maxQ and minQ are not used ReactiveCapabilityCurve can be used Default: 0.0 + :maxR0ToX0Ratio: Maximum ratio of zero sequence resistance of Network Feeder to its zero sequence reactance (R(0)/X(0) max). Used for short circuit data exchange according to IEC 60909 Default: 0.0 + :maxR1ToX1Ratio: Maximum ratio of positive sequence resistance of Network Feeder to its positive sequence reactance (R(1)/X(1) max). Used for short circuit data exchange according to IEC 60909 Default: 0.0 + :maxZ0ToZ1Ratio: Maximum ratio of zero sequence impedance to its positive sequence impedance (Z(0)/Z(1) max). Used for short circuit data exchange according to IEC 60909 Default: 0.0 + :minInitialSymShCCurrent: Minimum initial symmetrical short-circuit currents (Ik` min) in A (Ik` = Sk`/(SQRT(3) Un)). Used for short circuit data exchange according to IEC 60909 Default: 0.0 + :minP: Minimum active power of the injection. Default: 0.0 + :minQ: Not for short circuit modelling; It is used for modelling of infeed for load flow exchange. If maxQ and minQ are not used ReactiveCapabilityCurve can be used Default: 0.0 + :minR0ToX0Ratio: Indicates whether initial symmetrical short-circuit current and power have been calculated according to IEC (Ik`). Used for short circuit data exchange according to IEC 6090 Default: 0.0 + :minR1ToX1Ratio: Minimum ratio of positive sequence resistance of Network Feeder to its positive sequence reactance (R(1)/X(1) min). Used for short circuit data exchange according to IEC 60909 Default: 0.0 + :minZ0ToZ1Ratio: Minimum ratio of zero sequence impedance to its positive sequence impedance (Z(0)/Z(1) min). Used for short circuit data exchange according to IEC 60909 Default: 0.0 + :p: Active power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions. Default: 0.0 + :q: Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions. Default: 0.0 + :referencePriority: Priority of unit for use as powerflow voltage phase angle reference bus selection. 0 = don t care (default) 1 = highest priority. 2 is less than 1 and so on. Default: 0 + :voltageFactor: Voltage factor in pu, which was used to calculate short-circuit current Ik` and power Sk`. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "governorSCD": [Profile.EQ.value, ], + "ikSecond": [Profile.EQ.value, ], + "maxInitialSymShCCurrent": [Profile.EQ.value, ], + "maxP": [Profile.EQ.value, ], + "maxQ": [Profile.EQ.value, ], + "maxR0ToX0Ratio": [Profile.EQ.value, ], + "maxR1ToX1Ratio": [Profile.EQ.value, ], + "maxZ0ToZ1Ratio": [Profile.EQ.value, ], + "minInitialSymShCCurrent": [Profile.EQ.value, ], + "minP": [Profile.EQ.value, ], + "minQ": [Profile.EQ.value, ], + "minR0ToX0Ratio": [Profile.EQ.value, ], + "minR1ToX1Ratio": [Profile.EQ.value, ], + "minZ0ToZ1Ratio": [Profile.EQ.value, ], + "p": [Profile.SSH.value, ], + "q": [Profile.SSH.value, ], + "referencePriority": [Profile.SSH.value, ], + "voltageFactor": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class RegulatingCondEq:\n" + RegulatingCondEq.__doc__ + + def __init__(self, governorSCD = 0.0, ikSecond = False, maxInitialSymShCCurrent = 0.0, maxP = 0.0, maxQ = 0.0, maxR0ToX0Ratio = 0.0, maxR1ToX1Ratio = 0.0, maxZ0ToZ1Ratio = 0.0, minInitialSymShCCurrent = 0.0, minP = 0.0, minQ = 0.0, minR0ToX0Ratio = 0.0, minR1ToX1Ratio = 0.0, minZ0ToZ1Ratio = 0.0, p = 0.0, q = 0.0, referencePriority = 0, voltageFactor = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.governorSCD = governorSCD + self.ikSecond = ikSecond + self.maxInitialSymShCCurrent = maxInitialSymShCCurrent + self.maxP = maxP + self.maxQ = maxQ + self.maxR0ToX0Ratio = maxR0ToX0Ratio + self.maxR1ToX1Ratio = maxR1ToX1Ratio + self.maxZ0ToZ1Ratio = maxZ0ToZ1Ratio + self.minInitialSymShCCurrent = minInitialSymShCCurrent + self.minP = minP + self.minQ = minQ + self.minR0ToX0Ratio = minR0ToX0Ratio + self.minR1ToX1Ratio = minR1ToX1Ratio + self.minZ0ToZ1Ratio = minZ0ToZ1Ratio + self.p = p + self.q = q + self.referencePriority = referencePriority + self.voltageFactor = voltageFactor + + def __str__(self): + str = "class=ExternalNetworkInjection\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Float.py b/cimpy/cgmes_v2_4_15/Float.py index 8cc936ee..ccbc31be 100644 --- a/cimpy/cgmes_v2_4_15/Float.py +++ b/cimpy/cgmes_v2_4_15/Float.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class Float(Base): - ''' - A floating point number. The range is unspecified and not limited. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=Float\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Float(Base): + """ + A floating point number. The range is unspecified and not limited. + + """ + + possibleProfileList = { + "class": [Profile.DL.value, Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=Float\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/FossilFuel.py b/cimpy/cgmes_v2_4_15/FossilFuel.py index 0da7f207..1219236f 100644 --- a/cimpy/cgmes_v2_4_15/FossilFuel.py +++ b/cimpy/cgmes_v2_4_15/FossilFuel.py @@ -1,34 +1,36 @@ -from .IdentifiedObject import IdentifiedObject - - -class FossilFuel(IdentifiedObject): - ''' - The fossil fuel consumed by the non-nuclear thermal generating unit. For example, coal, oil, gas, etc. This a the specific fuels that the generating unit can consume. - - :fossilFuelType: The type of fossil fuel, such as coal, oil, or gas. Default: None - :ThermalGeneratingUnit: A thermal generating unit may have one or more fossil fuels. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'fossilFuelType': [cgmesProfile.EQ.value, ], - 'ThermalGeneratingUnit': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, fossilFuelType = None, ThermalGeneratingUnit = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.fossilFuelType = fossilFuelType - self.ThermalGeneratingUnit = ThermalGeneratingUnit - - def __str__(self): - str = 'class=FossilFuel\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class FossilFuel(IdentifiedObject): + """ + The fossil fuel consumed by the non-nuclear thermal generating unit. For example, coal, oil, gas, etc. This a the specific fuels that the generating unit can consume. + + :ThermalGeneratingUnit: A thermal generating unit may have one or more fossil fuels. Default: None + :fossilFuelType: The type of fossil fuel, such as coal, oil, or gas. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "ThermalGeneratingUnit": [Profile.EQ.value, ], + "fossilFuelType": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, ThermalGeneratingUnit = None, fossilFuelType = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ThermalGeneratingUnit = ThermalGeneratingUnit + self.fossilFuelType = fossilFuelType + + def __str__(self): + str = "class=FossilFuel\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/FrancisGovernorControlKind.py b/cimpy/cgmes_v2_4_15/FrancisGovernorControlKind.py index df41d15e..54e27e24 100644 --- a/cimpy/cgmes_v2_4_15/FrancisGovernorControlKind.py +++ b/cimpy/cgmes_v2_4_15/FrancisGovernorControlKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class FrancisGovernorControlKind(Base): - ''' - Governor control flag for Francis hydro model. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=FrancisGovernorControlKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class FrancisGovernorControlKind(Base): + """ + Governor control flag for Francis hydro model. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=FrancisGovernorControlKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Frequency.py b/cimpy/cgmes_v2_4_15/Frequency.py index f95a240c..fb9b27f4 100644 --- a/cimpy/cgmes_v2_4_15/Frequency.py +++ b/cimpy/cgmes_v2_4_15/Frequency.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class Frequency(Base): - ''' - Cycles per second. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'value': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'unit': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'multiplier': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=Frequency\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Frequency(Base): + """ + Cycles per second. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, ], + "multiplier": [Profile.DY.value, Profile.EQ.value, ], + "unit": [Profile.DY.value, Profile.EQ.value, ], + "value": [Profile.DY.value, Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=Frequency\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/FuelType.py b/cimpy/cgmes_v2_4_15/FuelType.py index 2090dc64..5cda18fa 100644 --- a/cimpy/cgmes_v2_4_15/FuelType.py +++ b/cimpy/cgmes_v2_4_15/FuelType.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class FuelType(Base): - ''' - Type of fuel. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=FuelType\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class FuelType(Base): + """ + Type of fuel. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=FuelType\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GenICompensationForGenJ.py b/cimpy/cgmes_v2_4_15/GenICompensationForGenJ.py index 15247b3d..12c8dd3a 100644 --- a/cimpy/cgmes_v2_4_15/GenICompensationForGenJ.py +++ b/cimpy/cgmes_v2_4_15/GenICompensationForGenJ.py @@ -1,40 +1,42 @@ -from .IdentifiedObject import IdentifiedObject - - -class GenICompensationForGenJ(IdentifiedObject): - ''' - This class provides the resistive and reactive components of compensation for the generator associated with the IEEE Type 2 voltage compensator for current flow out of one of the other generators in the interconnection. - - :SynchronousMachineDynamics: Standard synchronous machine out of which current flow is being compensated for. Default: None - :VcompIEEEType2: The standard IEEE Type 2 voltage compensator of this compensation. Default: None - :rcij: Default: 0.0 - :xcij: Default: 0.0 - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'SynchronousMachineDynamics': [cgmesProfile.DY.value, ], - 'VcompIEEEType2': [cgmesProfile.DY.value, ], - 'rcij': [cgmesProfile.DY.value, ], - 'xcij': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, SynchronousMachineDynamics = None, VcompIEEEType2 = None, rcij = 0.0, xcij = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.SynchronousMachineDynamics = SynchronousMachineDynamics - self.VcompIEEEType2 = VcompIEEEType2 - self.rcij = rcij - self.xcij = xcij - - def __str__(self): - str = 'class=GenICompensationForGenJ\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class GenICompensationForGenJ(IdentifiedObject): + """ + This class provides the resistive and reactive components of compensation for the generator associated with the IEEE Type 2 voltage compensator for current flow out of one of the other generators in the interconnection. + + :SynchronousMachineDynamics: Standard synchronous machine out of which current flow is being compensated for. Default: None + :VcompIEEEType2: The standard IEEE Type 2 voltage compensator of this compensation. Default: None + :rcij: Default: 0.0 + :xcij: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "SynchronousMachineDynamics": [Profile.DY.value, ], + "VcompIEEEType2": [Profile.DY.value, ], + "rcij": [Profile.DY.value, ], + "xcij": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, SynchronousMachineDynamics = None, VcompIEEEType2 = None, rcij = 0.0, xcij = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.SynchronousMachineDynamics = SynchronousMachineDynamics + self.VcompIEEEType2 = VcompIEEEType2 + self.rcij = rcij + self.xcij = xcij + + def __str__(self): + str = "class=GenICompensationForGenJ\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GeneratingUnit.py b/cimpy/cgmes_v2_4_15/GeneratingUnit.py index fd5650cd..a7b82e6b 100644 --- a/cimpy/cgmes_v2_4_15/GeneratingUnit.py +++ b/cimpy/cgmes_v2_4_15/GeneratingUnit.py @@ -1,85 +1,87 @@ -from .Equipment import Equipment - - -class GeneratingUnit(Equipment): - ''' - A single or set of synchronous machines for converting mechanical power into alternating-current power. For example, individual machines within a set may be defined for scheduling purposes while a single control signal is derived for the set. In this case there would be a GeneratingUnit for each member of the set and an additional GeneratingUnit corresponding to the set. - - :genControlSource: The source of controls for a generating unit. Default: None - :governorSCD: Governor Speed Changer Droop. This is the change in generator power output divided by the change in frequency normalized by the nominal power of the generator and the nominal frequency and expressed in percent and negated. A positive value of speed change droop provides additional generator output upon a drop in frequency. Default: 0.0 - :initialP: Default initial active power which is used to store a powerflow result for the initial active power for this unit in this network configuration. Default: 0.0 - :longPF: Generating unit long term economic participation factor. Default: 0.0 - :maximumAllowableSpinningReserve: Maximum allowable spinning reserve. Spinning reserve will never be considered greater than this value regardless of the current operating point. Default: 0.0 - :maxOperatingP: This is the maximum operating active power limit the dispatcher can enter for this unit. Default: 0.0 - :minOperatingP: This is the minimum operating active power limit the dispatcher can enter for this unit. Default: 0.0 - :nominalP: The nominal power of the generating unit. Used to give precise meaning to percentage based attributes such as the governor speed change droop (governorSCD attribute). The attribute shall be a positive value equal or less than RotatingMachine.ratedS. Default: 0.0 - :ratedGrossMaxP: The unit`s gross rated maximum capacity (book value). Default: 0.0 - :ratedGrossMinP: The gross rated minimum generation level which the unit can safely operate at while delivering power to the transmission grid. Default: 0.0 - :ratedNetMaxP: The net rated maximum capacity determined by subtracting the auxiliary power used to operate the internal plant machinery from the rated gross maximum capacity. Default: 0.0 - :shortPF: Generating unit short term economic participation factor. Default: 0.0 - :startupCost: The initial startup cost incurred for each start of the GeneratingUnit. Default: 0.0 - :variableCost: The variable cost component of production per unit of ActivePower. Default: 0.0 - :totalEfficiency: The efficiency of the unit in converting the fuel into electrical energy. Default: 0.0 - :ControlAreaGeneratingUnit: ControlArea specifications for this generating unit. Default: "list" - :RotatingMachine: A synchronous machine may operate as a generator and as such becomes a member of a generating unit. Default: "list" - :GrossToNetActivePowerCurves: A generating unit may have a gross active power to net active power curve, describing the losses and auxiliary power requirements of the unit. Default: "list" - :normalPF: Generating unit economic participation factor. Default: 0.0 - ''' - - cgmesProfile = Equipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'genControlSource': [cgmesProfile.EQ.value, ], - 'governorSCD': [cgmesProfile.EQ.value, ], - 'initialP': [cgmesProfile.EQ.value, ], - 'longPF': [cgmesProfile.EQ.value, ], - 'maximumAllowableSpinningReserve': [cgmesProfile.EQ.value, ], - 'maxOperatingP': [cgmesProfile.EQ.value, ], - 'minOperatingP': [cgmesProfile.EQ.value, ], - 'nominalP': [cgmesProfile.EQ.value, ], - 'ratedGrossMaxP': [cgmesProfile.EQ.value, ], - 'ratedGrossMinP': [cgmesProfile.EQ.value, ], - 'ratedNetMaxP': [cgmesProfile.EQ.value, ], - 'shortPF': [cgmesProfile.EQ.value, ], - 'startupCost': [cgmesProfile.EQ.value, ], - 'variableCost': [cgmesProfile.EQ.value, ], - 'totalEfficiency': [cgmesProfile.EQ.value, ], - 'ControlAreaGeneratingUnit': [cgmesProfile.EQ.value, ], - 'RotatingMachine': [cgmesProfile.EQ.value, ], - 'GrossToNetActivePowerCurves': [cgmesProfile.EQ.value, ], - 'normalPF': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Equipment: \n' + Equipment.__doc__ - - def __init__(self, genControlSource = None, governorSCD = 0.0, initialP = 0.0, longPF = 0.0, maximumAllowableSpinningReserve = 0.0, maxOperatingP = 0.0, minOperatingP = 0.0, nominalP = 0.0, ratedGrossMaxP = 0.0, ratedGrossMinP = 0.0, ratedNetMaxP = 0.0, shortPF = 0.0, startupCost = 0.0, variableCost = 0.0, totalEfficiency = 0.0, ControlAreaGeneratingUnit = "list", RotatingMachine = "list", GrossToNetActivePowerCurves = "list", normalPF = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.genControlSource = genControlSource - self.governorSCD = governorSCD - self.initialP = initialP - self.longPF = longPF - self.maximumAllowableSpinningReserve = maximumAllowableSpinningReserve - self.maxOperatingP = maxOperatingP - self.minOperatingP = minOperatingP - self.nominalP = nominalP - self.ratedGrossMaxP = ratedGrossMaxP - self.ratedGrossMinP = ratedGrossMinP - self.ratedNetMaxP = ratedNetMaxP - self.shortPF = shortPF - self.startupCost = startupCost - self.variableCost = variableCost - self.totalEfficiency = totalEfficiency - self.ControlAreaGeneratingUnit = ControlAreaGeneratingUnit - self.RotatingMachine = RotatingMachine - self.GrossToNetActivePowerCurves = GrossToNetActivePowerCurves - self.normalPF = normalPF - - def __str__(self): - str = 'class=GeneratingUnit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Equipment import Equipment +from .CGMESProfile import Profile + + +class GeneratingUnit(Equipment): + """ + A single or set of synchronous machines for converting mechanical power into alternating-current power. For example, individual machines within a set may be defined for scheduling purposes while a single control signal is derived for the set. In this case there would be a GeneratingUnit for each member of the set and an additional GeneratingUnit corresponding to the set. + + :ControlAreaGeneratingUnit: ControlArea specifications for this generating unit. Default: "list" + :GrossToNetActivePowerCurves: A generating unit may have a gross active power to net active power curve, describing the losses and auxiliary power requirements of the unit. Default: "list" + :RotatingMachine: A synchronous machine may operate as a generator and as such becomes a member of a generating unit. Default: "list" + :genControlSource: The source of controls for a generating unit. Default: None + :governorSCD: Governor Speed Changer Droop. This is the change in generator power output divided by the change in frequency normalized by the nominal power of the generator and the nominal frequency and expressed in percent and negated. A positive value of speed change droop provides additional generator output upon a drop in frequency. Default: 0.0 + :initialP: Default initial active power which is used to store a powerflow result for the initial active power for this unit in this network configuration. Default: 0.0 + :longPF: Generating unit long term economic participation factor. Default: 0.0 + :maxOperatingP: This is the maximum operating active power limit the dispatcher can enter for this unit. Default: 0.0 + :maximumAllowableSpinningReserve: Maximum allowable spinning reserve. Spinning reserve will never be considered greater than this value regardless of the current operating point. Default: 0.0 + :minOperatingP: This is the minimum operating active power limit the dispatcher can enter for this unit. Default: 0.0 + :nominalP: The nominal power of the generating unit. Used to give precise meaning to percentage based attributes such as the governor speed change droop (governorSCD attribute). The attribute shall be a positive value equal or less than RotatingMachine.ratedS. Default: 0.0 + :normalPF: Generating unit economic participation factor. Default: 0.0 + :ratedGrossMaxP: The unit`s gross rated maximum capacity (book value). Default: 0.0 + :ratedGrossMinP: The gross rated minimum generation level which the unit can safely operate at while delivering power to the transmission grid. Default: 0.0 + :ratedNetMaxP: The net rated maximum capacity determined by subtracting the auxiliary power used to operate the internal plant machinery from the rated gross maximum capacity. Default: 0.0 + :shortPF: Generating unit short term economic participation factor. Default: 0.0 + :startupCost: The initial startup cost incurred for each start of the GeneratingUnit. Default: 0.0 + :totalEfficiency: The efficiency of the unit in converting the fuel into electrical energy. Default: 0.0 + :variableCost: The variable cost component of production per unit of ActivePower. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "ControlAreaGeneratingUnit": [Profile.EQ.value, ], + "GrossToNetActivePowerCurves": [Profile.EQ.value, ], + "RotatingMachine": [Profile.EQ.value, ], + "genControlSource": [Profile.EQ.value, ], + "governorSCD": [Profile.EQ.value, ], + "initialP": [Profile.EQ.value, ], + "longPF": [Profile.EQ.value, ], + "maxOperatingP": [Profile.EQ.value, ], + "maximumAllowableSpinningReserve": [Profile.EQ.value, ], + "minOperatingP": [Profile.EQ.value, ], + "nominalP": [Profile.EQ.value, ], + "normalPF": [Profile.SSH.value, ], + "ratedGrossMaxP": [Profile.EQ.value, ], + "ratedGrossMinP": [Profile.EQ.value, ], + "ratedNetMaxP": [Profile.EQ.value, ], + "shortPF": [Profile.EQ.value, ], + "startupCost": [Profile.EQ.value, ], + "totalEfficiency": [Profile.EQ.value, ], + "variableCost": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Equipment:\n" + Equipment.__doc__ + + def __init__(self, ControlAreaGeneratingUnit = "list", GrossToNetActivePowerCurves = "list", RotatingMachine = "list", genControlSource = None, governorSCD = 0.0, initialP = 0.0, longPF = 0.0, maxOperatingP = 0.0, maximumAllowableSpinningReserve = 0.0, minOperatingP = 0.0, nominalP = 0.0, normalPF = 0.0, ratedGrossMaxP = 0.0, ratedGrossMinP = 0.0, ratedNetMaxP = 0.0, shortPF = 0.0, startupCost = 0.0, totalEfficiency = 0.0, variableCost = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ControlAreaGeneratingUnit = ControlAreaGeneratingUnit + self.GrossToNetActivePowerCurves = GrossToNetActivePowerCurves + self.RotatingMachine = RotatingMachine + self.genControlSource = genControlSource + self.governorSCD = governorSCD + self.initialP = initialP + self.longPF = longPF + self.maxOperatingP = maxOperatingP + self.maximumAllowableSpinningReserve = maximumAllowableSpinningReserve + self.minOperatingP = minOperatingP + self.nominalP = nominalP + self.normalPF = normalPF + self.ratedGrossMaxP = ratedGrossMaxP + self.ratedGrossMinP = ratedGrossMinP + self.ratedNetMaxP = ratedNetMaxP + self.shortPF = shortPF + self.startupCost = startupCost + self.totalEfficiency = totalEfficiency + self.variableCost = variableCost + + def __str__(self): + str = "class=GeneratingUnit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GeneratorControlSource.py b/cimpy/cgmes_v2_4_15/GeneratorControlSource.py index d88b1528..58dba1ed 100644 --- a/cimpy/cgmes_v2_4_15/GeneratorControlSource.py +++ b/cimpy/cgmes_v2_4_15/GeneratorControlSource.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class GeneratorControlSource(Base): - ''' - The source of controls for a generating unit. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=GeneratorControlSource\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class GeneratorControlSource(Base): + """ + The source of controls for a generating unit. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=GeneratorControlSource\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GenericNonLinearLoadModelKind.py b/cimpy/cgmes_v2_4_15/GenericNonLinearLoadModelKind.py index 00ca0663..37b8d83f 100644 --- a/cimpy/cgmes_v2_4_15/GenericNonLinearLoadModelKind.py +++ b/cimpy/cgmes_v2_4_15/GenericNonLinearLoadModelKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class GenericNonLinearLoadModelKind(Base): - ''' - Type of generic non-linear load model. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=GenericNonLinearLoadModelKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class GenericNonLinearLoadModelKind(Base): + """ + Type of generic non-linear load model. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=GenericNonLinearLoadModelKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GeographicalLocationVersion.py b/cimpy/cgmes_v2_4_15/GeographicalLocationVersion.py index 54512344..0a57023d 100644 --- a/cimpy/cgmes_v2_4_15/GeographicalLocationVersion.py +++ b/cimpy/cgmes_v2_4_15/GeographicalLocationVersion.py @@ -1,57 +1,58 @@ -from .Base import Base - - -class GeographicalLocationVersion(Base): - ''' - Version details. - - :baseUML: Base UML provided by CIM model manager. Default: '' - :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' - :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' - :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' - :entsoeUML: UML provided by ENTSO-E. Default: '' - :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/GeographicalLocation/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' - :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' - :namespaceRDF: RDF namespace. Default: '' - :namespaceUML: CIM UML namespace. Default: '' - :shortName: The short name of the profile used in profile documentation. Default: '' - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.GL.value, ], - 'baseUML': [cgmesProfile.GL.value, ], - 'baseURI': [cgmesProfile.GL.value, ], - 'date': [cgmesProfile.GL.value, ], - 'differenceModelURI': [cgmesProfile.GL.value, ], - 'entsoeUML': [cgmesProfile.GL.value, ], - 'entsoeURI': [cgmesProfile.GL.value, ], - 'modelDescriptionURI': [cgmesProfile.GL.value, ], - 'namespaceRDF': [cgmesProfile.GL.value, ], - 'namespaceUML': [cgmesProfile.GL.value, ], - 'shortName': [cgmesProfile.GL.value, ], - } - - serializationProfile = {} - - - - def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = '', ): - - self.baseUML = baseUML - self.baseURI = baseURI - self.date = date - self.differenceModelURI = differenceModelURI - self.entsoeUML = entsoeUML - self.entsoeURI = entsoeURI - self.modelDescriptionURI = modelDescriptionURI - self.namespaceRDF = namespaceRDF - self.namespaceUML = namespaceUML - self.shortName = shortName - - def __str__(self): - str = 'class=GeographicalLocationVersion\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class GeographicalLocationVersion(Base): + """ + Version details. + + :baseUML: Base UML provided by CIM model manager. Default: '' + :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' + :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' + :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' + :entsoeUML: UML provided by ENTSO-E. Default: '' + :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/GeographicalLocation/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' + :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' + :namespaceRDF: RDF namespace. Default: '' + :namespaceUML: CIM UML namespace. Default: '' + :shortName: The short name of the profile used in profile documentation. Default: '' + """ + + possibleProfileList = { + "class": [Profile.GL.value, ], + "baseUML": [Profile.GL.value, ], + "baseURI": [Profile.GL.value, ], + "date": [Profile.GL.value, ], + "differenceModelURI": [Profile.GL.value, ], + "entsoeUML": [Profile.GL.value, ], + "entsoeURI": [Profile.GL.value, ], + "modelDescriptionURI": [Profile.GL.value, ], + "namespaceRDF": [Profile.GL.value, ], + "namespaceUML": [Profile.GL.value, ], + "shortName": [Profile.GL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.GL.value + + + def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = ''): + + self.baseUML = baseUML + self.baseURI = baseURI + self.date = date + self.differenceModelURI = differenceModelURI + self.entsoeUML = entsoeUML + self.entsoeURI = entsoeURI + self.modelDescriptionURI = modelDescriptionURI + self.namespaceRDF = namespaceRDF + self.namespaceUML = namespaceUML + self.shortName = shortName + + def __str__(self): + str = "class=GeographicalLocationVersion\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GeographicalRegion.py b/cimpy/cgmes_v2_4_15/GeographicalRegion.py index ff8da430..cde1ae52 100644 --- a/cimpy/cgmes_v2_4_15/GeographicalRegion.py +++ b/cimpy/cgmes_v2_4_15/GeographicalRegion.py @@ -1,31 +1,33 @@ -from .IdentifiedObject import IdentifiedObject - - -class GeographicalRegion(IdentifiedObject): - ''' - A geographical region of a power system network model. - - :Regions: All sub-geograhpical regions within this geographical region. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - 'Regions': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, Regions = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Regions = Regions - - def __str__(self): - str = 'class=GeographicalRegion\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class GeographicalRegion(IdentifiedObject): + """ + A geographical region of a power system network model. + + :Regions: All sub-geograhpical regions within this geographical region. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ_BD.value, Profile.EQ.value, ], + "Regions": [Profile.EQ_BD.value, Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, Regions = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Regions = Regions + + def __str__(self): + str = "class=GeographicalRegion\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovCT1.py b/cimpy/cgmes_v2_4_15/GovCT1.py index b9553221..e1e8993d 100644 --- a/cimpy/cgmes_v2_4_15/GovCT1.py +++ b/cimpy/cgmes_v2_4_15/GovCT1.py @@ -1,133 +1,135 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovCT1(TurbineGovernorDynamics): - ''' - General model for any prime mover with a PID governor, used primarily for combustion turbine and combined cycle units. This model can be used to represent a variety of prime movers controlled by PID governors. It is suitable, for example, for representation of Additional information on this model is available in the 2012 IEEE report, , section 3.1.2.3 page 3-4 (GGOV1). - - :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 - :r: Permanent droop (R). Typical Value = 0.04. Default: 0.0 - :rselect: Feedback signal for droop (Rselect). Typical Value = electricalPower. Default: None - :tpelec: Electrical power transducer time constant (Tpelec) (>0). Typical Value = 1. Default: 0 - :maxerr: Maximum value for speed error signal (maxerr). Typical Value = 0.05. Default: 0.0 - :minerr: Minimum value for speed error signal (minerr). Typical Value = -0.05. Default: 0.0 - :kpgov: Governor proportional gain (Kpgov). Typical Value = 10. Default: 0.0 - :kigov: Governor integral gain (Kigov). Typical Value = 2. Default: 0.0 - :kdgov: Governor derivative gain (Kdgov). Typical Value = 0. Default: 0.0 - :tdgov: Governor derivative controller time constant (Tdgov). Typical Value = 1. Default: 0 - :vmax: Maximum valve position limit (Vmax). Typical Value = 1. Default: 0.0 - :vmin: Minimum valve position limit (Vmin). Typical Value = 0.15. Default: 0.0 - :tact: Actuator time constant (Tact). Typical Value = 0.5. Default: 0 - :kturb: Turbine gain (Kturb) (>0). Typical Value = 1.5. Default: 0.0 - :wfnl: No load fuel flow (Wfnl). Typical Value = 0.2. Default: 0.0 - :tb: Turbine lag time constant (Tb) (>0). Typical Value = 0.5. Default: 0 - :tc: Turbine lead time constant (Tc). Typical Value = 0. Default: 0 - :wfspd: Switch for fuel source characteristic to recognize that fuel flow, for a given fuel valve stroke, can be proportional to engine speed (Wfspd). true = fuel flow proportional to speed (for some gas turbines and diesel engines with positive displacement fuel injectors) false = fuel control system keeps fuel flow independent of engine speed. Typical Value = true. Default: False - :teng: Transport time delay for diesel engine used in representing diesel engines where there is a small but measurable transport delay between a change in fuel flow setting and the development of torque (Teng). Teng should be zero in all but special cases where this transport delay is of particular concern. Typical Value = 0. Default: 0 - :tfload: Load Limiter time constant (Tfload) (>0). Typical Value = 3. Default: 0 - :kpload: Load limiter proportional gain for PI controller (Kpload). Typical Value = 2. Default: 0.0 - :kiload: Load limiter integral gain for PI controller (Kiload). Typical Value = 0.67. Default: 0.0 - :ldref: Load limiter reference value (Ldref). Typical Value = 1. Default: 0.0 - :dm: Speed sensitivity coefficient (Dm). Dm can represent either the variation of the engine power with the shaft speed or the variation of maximum power capability with shaft speed. If it is positive it describes the falling slope of the engine speed verses power characteristic as speed increases. A slightly falling characteristic is typical for reciprocating engines and some aero-derivative turbines. If it is negative the engine power is assumed to be unaffected by the shaft speed, but the maximum permissible fuel flow is taken to fall with falling shaft speed. This is characteristic of single-shaft industrial turbines due to exhaust temperature limits. Typical Value = 0. Default: 0.0 - :ropen: Maximum valve opening rate (Ropen). Unit = PU/sec. Typical Value = 0.10. Default: 0.0 - :rclose: Minimum valve closing rate (Rclose). Unit = PU/sec. Typical Value = -0.1. Default: 0.0 - :kimw: Power controller (reset) gain (Kimw). The default value of 0.01 corresponds to a reset time of 100 seconds. A value of 0.001 corresponds to a relatively slow acting load controller. Typical Value = 0.01. Default: 0.0 - :aset: Acceleration limiter setpoint (Aset). Unit = PU/sec. Typical Value = 0.01. Default: 0.0 - :ka: Acceleration limiter gain (Ka). Typical Value = 10. Default: 0.0 - :ta: Acceleration limiter time constant (Ta) (>0). Typical Value = 0.1. Default: 0 - :db: Speed governor dead band in per unit speed (db). In the majority of applications, it is recommended that this value be set to zero. Typical Value = 0. Default: 0.0 - :tsa: Temperature detection lead time constant (Tsa). Typical Value = 4. Default: 0 - :tsb: Temperature detection lag time constant (Tsb). Typical Value = 5. Default: 0 - :rup: Maximum rate of load limit increase (Rup). Typical Value = 99. Default: 0.0 - :rdown: Maximum rate of load limit decrease (Rdown). Typical Value = -99. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'r': [cgmesProfile.DY.value, ], - 'rselect': [cgmesProfile.DY.value, ], - 'tpelec': [cgmesProfile.DY.value, ], - 'maxerr': [cgmesProfile.DY.value, ], - 'minerr': [cgmesProfile.DY.value, ], - 'kpgov': [cgmesProfile.DY.value, ], - 'kigov': [cgmesProfile.DY.value, ], - 'kdgov': [cgmesProfile.DY.value, ], - 'tdgov': [cgmesProfile.DY.value, ], - 'vmax': [cgmesProfile.DY.value, ], - 'vmin': [cgmesProfile.DY.value, ], - 'tact': [cgmesProfile.DY.value, ], - 'kturb': [cgmesProfile.DY.value, ], - 'wfnl': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'wfspd': [cgmesProfile.DY.value, ], - 'teng': [cgmesProfile.DY.value, ], - 'tfload': [cgmesProfile.DY.value, ], - 'kpload': [cgmesProfile.DY.value, ], - 'kiload': [cgmesProfile.DY.value, ], - 'ldref': [cgmesProfile.DY.value, ], - 'dm': [cgmesProfile.DY.value, ], - 'ropen': [cgmesProfile.DY.value, ], - 'rclose': [cgmesProfile.DY.value, ], - 'kimw': [cgmesProfile.DY.value, ], - 'aset': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'db': [cgmesProfile.DY.value, ], - 'tsa': [cgmesProfile.DY.value, ], - 'tsb': [cgmesProfile.DY.value, ], - 'rup': [cgmesProfile.DY.value, ], - 'rdown': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, r = 0.0, rselect = None, tpelec = 0, maxerr = 0.0, minerr = 0.0, kpgov = 0.0, kigov = 0.0, kdgov = 0.0, tdgov = 0, vmax = 0.0, vmin = 0.0, tact = 0, kturb = 0.0, wfnl = 0.0, tb = 0, tc = 0, wfspd = False, teng = 0, tfload = 0, kpload = 0.0, kiload = 0.0, ldref = 0.0, dm = 0.0, ropen = 0.0, rclose = 0.0, kimw = 0.0, aset = 0.0, ka = 0.0, ta = 0, db = 0.0, tsa = 0, tsb = 0, rup = 0.0, rdown = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.r = r - self.rselect = rselect - self.tpelec = tpelec - self.maxerr = maxerr - self.minerr = minerr - self.kpgov = kpgov - self.kigov = kigov - self.kdgov = kdgov - self.tdgov = tdgov - self.vmax = vmax - self.vmin = vmin - self.tact = tact - self.kturb = kturb - self.wfnl = wfnl - self.tb = tb - self.tc = tc - self.wfspd = wfspd - self.teng = teng - self.tfload = tfload - self.kpload = kpload - self.kiload = kiload - self.ldref = ldref - self.dm = dm - self.ropen = ropen - self.rclose = rclose - self.kimw = kimw - self.aset = aset - self.ka = ka - self.ta = ta - self.db = db - self.tsa = tsa - self.tsb = tsb - self.rup = rup - self.rdown = rdown - - def __str__(self): - str = 'class=GovCT1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovCT1(TurbineGovernorDynamics): + """ + General model for any prime mover with a PID governor, used primarily for combustion turbine and combined cycle units. This model can be used to represent a variety of prime movers controlled by PID governors. It is suitable, for example, for representation of Additional information on this model is available in the 2012 IEEE report, , section 3.1.2.3 page 3-4 (GGOV1). + + :aset: Acceleration limiter setpoint (Aset). Unit = PU/sec. Typical Value = 0.01. Default: 0.0 + :db: Speed governor dead band in per unit speed (db). In the majority of applications, it is recommended that this value be set to zero. Typical Value = 0. Default: 0.0 + :dm: Speed sensitivity coefficient (Dm). Dm can represent either the variation of the engine power with the shaft speed or the variation of maximum power capability with shaft speed. If it is positive it describes the falling slope of the engine speed verses power characteristic as speed increases. A slightly falling characteristic is typical for reciprocating engines and some aero-derivative turbines. If it is negative the engine power is assumed to be unaffected by the shaft speed, but the maximum permissible fuel flow is taken to fall with falling shaft speed. This is characteristic of single-shaft industrial turbines due to exhaust temperature limits. Typical Value = 0. Default: 0.0 + :ka: Acceleration limiter gain (Ka). Typical Value = 10. Default: 0.0 + :kdgov: Governor derivative gain (Kdgov). Typical Value = 0. Default: 0.0 + :kigov: Governor integral gain (Kigov). Typical Value = 2. Default: 0.0 + :kiload: Load limiter integral gain for PI controller (Kiload). Typical Value = 0.67. Default: 0.0 + :kimw: Power controller (reset) gain (Kimw). The default value of 0.01 corresponds to a reset time of 100 seconds. A value of 0.001 corresponds to a relatively slow acting load controller. Typical Value = 0.01. Default: 0.0 + :kpgov: Governor proportional gain (Kpgov). Typical Value = 10. Default: 0.0 + :kpload: Load limiter proportional gain for PI controller (Kpload). Typical Value = 2. Default: 0.0 + :kturb: Turbine gain (Kturb) (>0). Typical Value = 1.5. Default: 0.0 + :ldref: Load limiter reference value (Ldref). Typical Value = 1. Default: 0.0 + :maxerr: Maximum value for speed error signal (maxerr). Typical Value = 0.05. Default: 0.0 + :minerr: Minimum value for speed error signal (minerr). Typical Value = -0.05. Default: 0.0 + :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 + :r: Permanent droop (R). Typical Value = 0.04. Default: 0.0 + :rclose: Minimum valve closing rate (Rclose). Unit = PU/sec. Typical Value = -0.1. Default: 0.0 + :rdown: Maximum rate of load limit decrease (Rdown). Typical Value = -99. Default: 0.0 + :ropen: Maximum valve opening rate (Ropen). Unit = PU/sec. Typical Value = 0.10. Default: 0.0 + :rselect: Feedback signal for droop (Rselect). Typical Value = electricalPower. Default: None + :rup: Maximum rate of load limit increase (Rup). Typical Value = 99. Default: 0.0 + :ta: Acceleration limiter time constant (Ta) (>0). Typical Value = 0.1. Default: 0.0 + :tact: Actuator time constant (Tact). Typical Value = 0.5. Default: 0.0 + :tb: Turbine lag time constant (Tb) (>0). Typical Value = 0.5. Default: 0.0 + :tc: Turbine lead time constant (Tc). Typical Value = 0. Default: 0.0 + :tdgov: Governor derivative controller time constant (Tdgov). Typical Value = 1. Default: 0.0 + :teng: Transport time delay for diesel engine used in representing diesel engines where there is a small but measurable transport delay between a change in fuel flow setting and the development of torque (Teng). Teng should be zero in all but special cases where this transport delay is of particular concern. Typical Value = 0. Default: 0.0 + :tfload: Load Limiter time constant (Tfload) (>0). Typical Value = 3. Default: 0.0 + :tpelec: Electrical power transducer time constant (Tpelec) (>0). Typical Value = 1. Default: 0.0 + :tsa: Temperature detection lead time constant (Tsa). Typical Value = 4. Default: 0.0 + :tsb: Temperature detection lag time constant (Tsb). Typical Value = 5. Default: 0.0 + :vmax: Maximum valve position limit (Vmax). Typical Value = 1. Default: 0.0 + :vmin: Minimum valve position limit (Vmin). Typical Value = 0.15. Default: 0.0 + :wfnl: No load fuel flow (Wfnl). Typical Value = 0.2. Default: 0.0 + :wfspd: Switch for fuel source characteristic to recognize that fuel flow, for a given fuel valve stroke, can be proportional to engine speed (Wfspd). true = fuel flow proportional to speed (for some gas turbines and diesel engines with positive displacement fuel injectors) false = fuel control system keeps fuel flow independent of engine speed. Typical Value = true. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "aset": [Profile.DY.value, ], + "db": [Profile.DY.value, ], + "dm": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kdgov": [Profile.DY.value, ], + "kigov": [Profile.DY.value, ], + "kiload": [Profile.DY.value, ], + "kimw": [Profile.DY.value, ], + "kpgov": [Profile.DY.value, ], + "kpload": [Profile.DY.value, ], + "kturb": [Profile.DY.value, ], + "ldref": [Profile.DY.value, ], + "maxerr": [Profile.DY.value, ], + "minerr": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "r": [Profile.DY.value, ], + "rclose": [Profile.DY.value, ], + "rdown": [Profile.DY.value, ], + "ropen": [Profile.DY.value, ], + "rselect": [Profile.DY.value, ], + "rup": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tact": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "tdgov": [Profile.DY.value, ], + "teng": [Profile.DY.value, ], + "tfload": [Profile.DY.value, ], + "tpelec": [Profile.DY.value, ], + "tsa": [Profile.DY.value, ], + "tsb": [Profile.DY.value, ], + "vmax": [Profile.DY.value, ], + "vmin": [Profile.DY.value, ], + "wfnl": [Profile.DY.value, ], + "wfspd": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, aset = 0.0, db = 0.0, dm = 0.0, ka = 0.0, kdgov = 0.0, kigov = 0.0, kiload = 0.0, kimw = 0.0, kpgov = 0.0, kpload = 0.0, kturb = 0.0, ldref = 0.0, maxerr = 0.0, minerr = 0.0, mwbase = 0.0, r = 0.0, rclose = 0.0, rdown = 0.0, ropen = 0.0, rselect = None, rup = 0.0, ta = 0.0, tact = 0.0, tb = 0.0, tc = 0.0, tdgov = 0.0, teng = 0.0, tfload = 0.0, tpelec = 0.0, tsa = 0.0, tsb = 0.0, vmax = 0.0, vmin = 0.0, wfnl = 0.0, wfspd = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.aset = aset + self.db = db + self.dm = dm + self.ka = ka + self.kdgov = kdgov + self.kigov = kigov + self.kiload = kiload + self.kimw = kimw + self.kpgov = kpgov + self.kpload = kpload + self.kturb = kturb + self.ldref = ldref + self.maxerr = maxerr + self.minerr = minerr + self.mwbase = mwbase + self.r = r + self.rclose = rclose + self.rdown = rdown + self.ropen = ropen + self.rselect = rselect + self.rup = rup + self.ta = ta + self.tact = tact + self.tb = tb + self.tc = tc + self.tdgov = tdgov + self.teng = teng + self.tfload = tfload + self.tpelec = tpelec + self.tsa = tsa + self.tsb = tsb + self.vmax = vmax + self.vmin = vmin + self.wfnl = wfnl + self.wfspd = wfspd + + def __str__(self): + str = "class=GovCT1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovCT2.py b/cimpy/cgmes_v2_4_15/GovCT2.py index 46c3663d..8976ec43 100644 --- a/cimpy/cgmes_v2_4_15/GovCT2.py +++ b/cimpy/cgmes_v2_4_15/GovCT2.py @@ -1,196 +1,198 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovCT2(TurbineGovernorDynamics): - ''' - General governor model with frequency-dependent fuel flow limit. This model is a modification of the GovCT1model in order to represent the frequency-dependent fuel flow limit of a specific gas turbine manufacturer. - - :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 - :r: Permanent droop (R). Typical Value = 0.05. Default: 0.0 - :rselect: Feedback signal for droop (Rselect). Typical Value = electricalPower. Default: None - :tpelec: Electrical power transducer time constant (Tpelec). Typical Value = 2.5. Default: 0 - :maxerr: Maximum value for speed error signal (Maxerr). Typical Value = 1. Default: 0.0 - :minerr: Minimum value for speed error signal (Minerr). Typical Value = -1. Default: 0.0 - :kpgov: Governor proportional gain (Kpgov). Typical Value = 4. Default: 0.0 - :kigov: Governor integral gain (Kigov). Typical Value = 0.45. Default: 0.0 - :kdgov: Governor derivative gain (Kdgov). Typical Value = 0. Default: 0.0 - :tdgov: Governor derivative controller time constant (Tdgov). Typical Value = 1. Default: 0 - :vmax: Maximum valve position limit (Vmax). Typical Value = 1. Default: 0.0 - :vmin: Minimum valve position limit (Vmin). Typical Value = 0.175. Default: 0.0 - :tact: Actuator time constant (Tact). Typical Value = 0.4. Default: 0 - :kturb: Turbine gain (Kturb). Typical Value = 1.9168. Default: 0.0 - :wfnl: No load fuel flow (Wfnl). Typical Value = 0.187. Default: 0.0 - :tb: Turbine lag time constant (Tb). Typical Value = 0.1. Default: 0 - :tc: Turbine lead time constant (Tc). Typical Value = 0. Default: 0 - :wfspd: Switch for fuel source characteristic to recognize that fuel flow, for a given fuel valve stroke, can be proportional to engine speed (Wfspd). true = fuel flow proportional to speed (for some gas turbines and diesel engines with positive displacement fuel injectors) false = fuel control system keeps fuel flow independent of engine speed. Typical Value = false. Default: False - :teng: Transport time delay for diesel engine used in representing diesel engines where there is a small but measurable transport delay between a change in fuel flow setting and the development of torque (Teng). Teng should be zero in all but special cases where this transport delay is of particular concern. Typical Value = 0. Default: 0 - :tfload: Load Limiter time constant (Tfload). Typical Value = 3. Default: 0 - :kpload: Load limiter proportional gain for PI controller (Kpload). Typical Value = 1. Default: 0.0 - :kiload: Load limiter integral gain for PI controller (Kiload). Typical Value = 1. Default: 0.0 - :ldref: Load limiter reference value (Ldref). Typical Value = 1. Default: 0.0 - :dm: Speed sensitivity coefficient (Dm). Dm can represent either the variation of the engine power with the shaft speed or the variation of maximum power capability with shaft speed. If it is positive it describes the falling slope of the engine speed verses power characteristic as speed increases. A slightly falling characteristic is typical for reciprocating engines and some aero-derivative turbines. If it is negative the engine power is assumed to be unaffected by the shaft speed, but the maximum permissible fuel flow is taken to fall with falling shaft speed. This is characteristic of single-shaft industrial turbines due to exhaust temperature limits. Typical Value = 0. Default: 0.0 - :ropen: Maximum valve opening rate (Ropen). Unit = PU/sec. Typical Value = 99. Default: 0.0 - :rclose: Minimum valve closing rate (Rclose). Unit = PU/sec. Typical Value = -99. Default: 0.0 - :kimw: Power controller (reset) gain (Kimw). The default value of 0.01 corresponds to a reset time of 100 seconds. A value of 0.001 corresponds to a relatively slow acting load controller. Typical Value = 0. Default: 0.0 - :aset: Acceleration limiter setpoint (Aset). Unit = PU/sec. Typical Value = 10. Default: 0.0 - :ka: Acceleration limiter Gain (Ka). Typical Value = 10. Default: 0.0 - :ta: Acceleration limiter time constant (Ta). Typical Value = 1. Default: 0 - :db: Speed governor dead band in per unit speed (db). In the majority of applications, it is recommended that this value be set to zero. Typical Value = 0. Default: 0.0 - :tsa: Temperature detection lead time constant (Tsa). Typical Value = 0. Default: 0 - :tsb: Temperature detection lag time constant (Tsb). Typical Value = 50. Default: 0 - :rup: Maximum rate of load limit increase (Rup). Typical Value = 99. Default: 0.0 - :rdown: Maximum rate of load limit decrease (Rdown). Typical Value = -99. Default: 0.0 - :prate: Ramp rate for frequency-dependent power limit (Prate). Typical Value = 0.017. Default: 0.0 - :flim1: Frequency threshold 1 (Flim1). Unit = Hz. Typical Value = 59. Default: 0.0 - :plim1: Power limit 1 (Plim1). Typical Value = 0.8325. Default: 0.0 - :flim2: Frequency threshold 2 (Flim2). Unit = Hz. Typical Value = 0. Default: 0.0 - :plim2: Power limit 2 (Plim2). Typical Value = 0. Default: 0.0 - :flim3: Frequency threshold 3 (Flim3). Unit = Hz. Typical Value = 0. Default: 0.0 - :plim3: Power limit 3 (Plim3). Typical Value = 0. Default: 0.0 - :flim4: Frequency threshold 4 (Flim4). Unit = Hz. Typical Value = 0. Default: 0.0 - :plim4: Power limit 4 (Plim4). Typical Value = 0. Default: 0.0 - :flim5: Frequency threshold 5 (Flim5). Unit = Hz. Typical Value = 0. Default: 0.0 - :plim5: Power limit 5 (Plim5). Typical Value = 0. Default: 0.0 - :flim6: Frequency threshold 6 (Flim6). Unit = Hz. Typical Value = 0. Default: 0.0 - :plim6: Power limit 6 (Plim6). Typical Value = 0. Default: 0.0 - :flim7: Frequency threshold 7 (Flim7). Unit = Hz. Typical Value = 0. Default: 0.0 - :plim7: Power limit 7 (Plim7). Typical Value = 0. Default: 0.0 - :flim8: Frequency threshold 8 (Flim8). Unit = Hz. Typical Value = 0. Default: 0.0 - :plim8: Power limit 8 (Plim8). Typical Value = 0. Default: 0.0 - :flim9: Frequency threshold 9 (Flim9). Unit = Hz. Typical Value = 0. Default: 0.0 - :plim9: Power Limit 9 (Plim9). Typical Value = 0. Default: 0.0 - :flim10: Frequency threshold 10 (Flim10). Unit = Hz. Typical Value = 0. Default: 0.0 - :plim10: Power limit 10 (Plim10). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'r': [cgmesProfile.DY.value, ], - 'rselect': [cgmesProfile.DY.value, ], - 'tpelec': [cgmesProfile.DY.value, ], - 'maxerr': [cgmesProfile.DY.value, ], - 'minerr': [cgmesProfile.DY.value, ], - 'kpgov': [cgmesProfile.DY.value, ], - 'kigov': [cgmesProfile.DY.value, ], - 'kdgov': [cgmesProfile.DY.value, ], - 'tdgov': [cgmesProfile.DY.value, ], - 'vmax': [cgmesProfile.DY.value, ], - 'vmin': [cgmesProfile.DY.value, ], - 'tact': [cgmesProfile.DY.value, ], - 'kturb': [cgmesProfile.DY.value, ], - 'wfnl': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'wfspd': [cgmesProfile.DY.value, ], - 'teng': [cgmesProfile.DY.value, ], - 'tfload': [cgmesProfile.DY.value, ], - 'kpload': [cgmesProfile.DY.value, ], - 'kiload': [cgmesProfile.DY.value, ], - 'ldref': [cgmesProfile.DY.value, ], - 'dm': [cgmesProfile.DY.value, ], - 'ropen': [cgmesProfile.DY.value, ], - 'rclose': [cgmesProfile.DY.value, ], - 'kimw': [cgmesProfile.DY.value, ], - 'aset': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'db': [cgmesProfile.DY.value, ], - 'tsa': [cgmesProfile.DY.value, ], - 'tsb': [cgmesProfile.DY.value, ], - 'rup': [cgmesProfile.DY.value, ], - 'rdown': [cgmesProfile.DY.value, ], - 'prate': [cgmesProfile.DY.value, ], - 'flim1': [cgmesProfile.DY.value, ], - 'plim1': [cgmesProfile.DY.value, ], - 'flim2': [cgmesProfile.DY.value, ], - 'plim2': [cgmesProfile.DY.value, ], - 'flim3': [cgmesProfile.DY.value, ], - 'plim3': [cgmesProfile.DY.value, ], - 'flim4': [cgmesProfile.DY.value, ], - 'plim4': [cgmesProfile.DY.value, ], - 'flim5': [cgmesProfile.DY.value, ], - 'plim5': [cgmesProfile.DY.value, ], - 'flim6': [cgmesProfile.DY.value, ], - 'plim6': [cgmesProfile.DY.value, ], - 'flim7': [cgmesProfile.DY.value, ], - 'plim7': [cgmesProfile.DY.value, ], - 'flim8': [cgmesProfile.DY.value, ], - 'plim8': [cgmesProfile.DY.value, ], - 'flim9': [cgmesProfile.DY.value, ], - 'plim9': [cgmesProfile.DY.value, ], - 'flim10': [cgmesProfile.DY.value, ], - 'plim10': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, r = 0.0, rselect = None, tpelec = 0, maxerr = 0.0, minerr = 0.0, kpgov = 0.0, kigov = 0.0, kdgov = 0.0, tdgov = 0, vmax = 0.0, vmin = 0.0, tact = 0, kturb = 0.0, wfnl = 0.0, tb = 0, tc = 0, wfspd = False, teng = 0, tfload = 0, kpload = 0.0, kiload = 0.0, ldref = 0.0, dm = 0.0, ropen = 0.0, rclose = 0.0, kimw = 0.0, aset = 0.0, ka = 0.0, ta = 0, db = 0.0, tsa = 0, tsb = 0, rup = 0.0, rdown = 0.0, prate = 0.0, flim1 = 0.0, plim1 = 0.0, flim2 = 0.0, plim2 = 0.0, flim3 = 0.0, plim3 = 0.0, flim4 = 0.0, plim4 = 0.0, flim5 = 0.0, plim5 = 0.0, flim6 = 0.0, plim6 = 0.0, flim7 = 0.0, plim7 = 0.0, flim8 = 0.0, plim8 = 0.0, flim9 = 0.0, plim9 = 0.0, flim10 = 0.0, plim10 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.r = r - self.rselect = rselect - self.tpelec = tpelec - self.maxerr = maxerr - self.minerr = minerr - self.kpgov = kpgov - self.kigov = kigov - self.kdgov = kdgov - self.tdgov = tdgov - self.vmax = vmax - self.vmin = vmin - self.tact = tact - self.kturb = kturb - self.wfnl = wfnl - self.tb = tb - self.tc = tc - self.wfspd = wfspd - self.teng = teng - self.tfload = tfload - self.kpload = kpload - self.kiload = kiload - self.ldref = ldref - self.dm = dm - self.ropen = ropen - self.rclose = rclose - self.kimw = kimw - self.aset = aset - self.ka = ka - self.ta = ta - self.db = db - self.tsa = tsa - self.tsb = tsb - self.rup = rup - self.rdown = rdown - self.prate = prate - self.flim1 = flim1 - self.plim1 = plim1 - self.flim2 = flim2 - self.plim2 = plim2 - self.flim3 = flim3 - self.plim3 = plim3 - self.flim4 = flim4 - self.plim4 = plim4 - self.flim5 = flim5 - self.plim5 = plim5 - self.flim6 = flim6 - self.plim6 = plim6 - self.flim7 = flim7 - self.plim7 = plim7 - self.flim8 = flim8 - self.plim8 = plim8 - self.flim9 = flim9 - self.plim9 = plim9 - self.flim10 = flim10 - self.plim10 = plim10 - - def __str__(self): - str = 'class=GovCT2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovCT2(TurbineGovernorDynamics): + """ + General governor model with frequency-dependent fuel flow limit. This model is a modification of the GovCT1model in order to represent the frequency-dependent fuel flow limit of a specific gas turbine manufacturer. + + :aset: Acceleration limiter setpoint (Aset). Unit = PU/sec. Typical Value = 10. Default: 0.0 + :db: Speed governor dead band in per unit speed (db). In the majority of applications, it is recommended that this value be set to zero. Typical Value = 0. Default: 0.0 + :dm: Speed sensitivity coefficient (Dm). Dm can represent either the variation of the engine power with the shaft speed or the variation of maximum power capability with shaft speed. If it is positive it describes the falling slope of the engine speed verses power characteristic as speed increases. A slightly falling characteristic is typical for reciprocating engines and some aero-derivative turbines. If it is negative the engine power is assumed to be unaffected by the shaft speed, but the maximum permissible fuel flow is taken to fall with falling shaft speed. This is characteristic of single-shaft industrial turbines due to exhaust temperature limits. Typical Value = 0. Default: 0.0 + :flim1: Frequency threshold 1 (Flim1). Unit = Hz. Typical Value = 59. Default: 0.0 + :flim10: Frequency threshold 10 (Flim10). Unit = Hz. Typical Value = 0. Default: 0.0 + :flim2: Frequency threshold 2 (Flim2). Unit = Hz. Typical Value = 0. Default: 0.0 + :flim3: Frequency threshold 3 (Flim3). Unit = Hz. Typical Value = 0. Default: 0.0 + :flim4: Frequency threshold 4 (Flim4). Unit = Hz. Typical Value = 0. Default: 0.0 + :flim5: Frequency threshold 5 (Flim5). Unit = Hz. Typical Value = 0. Default: 0.0 + :flim6: Frequency threshold 6 (Flim6). Unit = Hz. Typical Value = 0. Default: 0.0 + :flim7: Frequency threshold 7 (Flim7). Unit = Hz. Typical Value = 0. Default: 0.0 + :flim8: Frequency threshold 8 (Flim8). Unit = Hz. Typical Value = 0. Default: 0.0 + :flim9: Frequency threshold 9 (Flim9). Unit = Hz. Typical Value = 0. Default: 0.0 + :ka: Acceleration limiter Gain (Ka). Typical Value = 10. Default: 0.0 + :kdgov: Governor derivative gain (Kdgov). Typical Value = 0. Default: 0.0 + :kigov: Governor integral gain (Kigov). Typical Value = 0.45. Default: 0.0 + :kiload: Load limiter integral gain for PI controller (Kiload). Typical Value = 1. Default: 0.0 + :kimw: Power controller (reset) gain (Kimw). The default value of 0.01 corresponds to a reset time of 100 seconds. A value of 0.001 corresponds to a relatively slow acting load controller. Typical Value = 0. Default: 0.0 + :kpgov: Governor proportional gain (Kpgov). Typical Value = 4. Default: 0.0 + :kpload: Load limiter proportional gain for PI controller (Kpload). Typical Value = 1. Default: 0.0 + :kturb: Turbine gain (Kturb). Typical Value = 1.9168. Default: 0.0 + :ldref: Load limiter reference value (Ldref). Typical Value = 1. Default: 0.0 + :maxerr: Maximum value for speed error signal (Maxerr). Typical Value = 1. Default: 0.0 + :minerr: Minimum value for speed error signal (Minerr). Typical Value = -1. Default: 0.0 + :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 + :plim1: Power limit 1 (Plim1). Typical Value = 0.8325. Default: 0.0 + :plim10: Power limit 10 (Plim10). Typical Value = 0. Default: 0.0 + :plim2: Power limit 2 (Plim2). Typical Value = 0. Default: 0.0 + :plim3: Power limit 3 (Plim3). Typical Value = 0. Default: 0.0 + :plim4: Power limit 4 (Plim4). Typical Value = 0. Default: 0.0 + :plim5: Power limit 5 (Plim5). Typical Value = 0. Default: 0.0 + :plim6: Power limit 6 (Plim6). Typical Value = 0. Default: 0.0 + :plim7: Power limit 7 (Plim7). Typical Value = 0. Default: 0.0 + :plim8: Power limit 8 (Plim8). Typical Value = 0. Default: 0.0 + :plim9: Power Limit 9 (Plim9). Typical Value = 0. Default: 0.0 + :prate: Ramp rate for frequency-dependent power limit (Prate). Typical Value = 0.017. Default: 0.0 + :r: Permanent droop (R). Typical Value = 0.05. Default: 0.0 + :rclose: Minimum valve closing rate (Rclose). Unit = PU/sec. Typical Value = -99. Default: 0.0 + :rdown: Maximum rate of load limit decrease (Rdown). Typical Value = -99. Default: 0.0 + :ropen: Maximum valve opening rate (Ropen). Unit = PU/sec. Typical Value = 99. Default: 0.0 + :rselect: Feedback signal for droop (Rselect). Typical Value = electricalPower. Default: None + :rup: Maximum rate of load limit increase (Rup). Typical Value = 99. Default: 0.0 + :ta: Acceleration limiter time constant (Ta). Typical Value = 1. Default: 0.0 + :tact: Actuator time constant (Tact). Typical Value = 0.4. Default: 0.0 + :tb: Turbine lag time constant (Tb). Typical Value = 0.1. Default: 0.0 + :tc: Turbine lead time constant (Tc). Typical Value = 0. Default: 0.0 + :tdgov: Governor derivative controller time constant (Tdgov). Typical Value = 1. Default: 0.0 + :teng: Transport time delay for diesel engine used in representing diesel engines where there is a small but measurable transport delay between a change in fuel flow setting and the development of torque (Teng). Teng should be zero in all but special cases where this transport delay is of particular concern. Typical Value = 0. Default: 0.0 + :tfload: Load Limiter time constant (Tfload). Typical Value = 3. Default: 0.0 + :tpelec: Electrical power transducer time constant (Tpelec). Typical Value = 2.5. Default: 0.0 + :tsa: Temperature detection lead time constant (Tsa). Typical Value = 0. Default: 0.0 + :tsb: Temperature detection lag time constant (Tsb). Typical Value = 50. Default: 0.0 + :vmax: Maximum valve position limit (Vmax). Typical Value = 1. Default: 0.0 + :vmin: Minimum valve position limit (Vmin). Typical Value = 0.175. Default: 0.0 + :wfnl: No load fuel flow (Wfnl). Typical Value = 0.187. Default: 0.0 + :wfspd: Switch for fuel source characteristic to recognize that fuel flow, for a given fuel valve stroke, can be proportional to engine speed (Wfspd). true = fuel flow proportional to speed (for some gas turbines and diesel engines with positive displacement fuel injectors) false = fuel control system keeps fuel flow independent of engine speed. Typical Value = false. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "aset": [Profile.DY.value, ], + "db": [Profile.DY.value, ], + "dm": [Profile.DY.value, ], + "flim1": [Profile.DY.value, ], + "flim10": [Profile.DY.value, ], + "flim2": [Profile.DY.value, ], + "flim3": [Profile.DY.value, ], + "flim4": [Profile.DY.value, ], + "flim5": [Profile.DY.value, ], + "flim6": [Profile.DY.value, ], + "flim7": [Profile.DY.value, ], + "flim8": [Profile.DY.value, ], + "flim9": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kdgov": [Profile.DY.value, ], + "kigov": [Profile.DY.value, ], + "kiload": [Profile.DY.value, ], + "kimw": [Profile.DY.value, ], + "kpgov": [Profile.DY.value, ], + "kpload": [Profile.DY.value, ], + "kturb": [Profile.DY.value, ], + "ldref": [Profile.DY.value, ], + "maxerr": [Profile.DY.value, ], + "minerr": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "plim1": [Profile.DY.value, ], + "plim10": [Profile.DY.value, ], + "plim2": [Profile.DY.value, ], + "plim3": [Profile.DY.value, ], + "plim4": [Profile.DY.value, ], + "plim5": [Profile.DY.value, ], + "plim6": [Profile.DY.value, ], + "plim7": [Profile.DY.value, ], + "plim8": [Profile.DY.value, ], + "plim9": [Profile.DY.value, ], + "prate": [Profile.DY.value, ], + "r": [Profile.DY.value, ], + "rclose": [Profile.DY.value, ], + "rdown": [Profile.DY.value, ], + "ropen": [Profile.DY.value, ], + "rselect": [Profile.DY.value, ], + "rup": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tact": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "tdgov": [Profile.DY.value, ], + "teng": [Profile.DY.value, ], + "tfload": [Profile.DY.value, ], + "tpelec": [Profile.DY.value, ], + "tsa": [Profile.DY.value, ], + "tsb": [Profile.DY.value, ], + "vmax": [Profile.DY.value, ], + "vmin": [Profile.DY.value, ], + "wfnl": [Profile.DY.value, ], + "wfspd": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, aset = 0.0, db = 0.0, dm = 0.0, flim1 = 0.0, flim10 = 0.0, flim2 = 0.0, flim3 = 0.0, flim4 = 0.0, flim5 = 0.0, flim6 = 0.0, flim7 = 0.0, flim8 = 0.0, flim9 = 0.0, ka = 0.0, kdgov = 0.0, kigov = 0.0, kiload = 0.0, kimw = 0.0, kpgov = 0.0, kpload = 0.0, kturb = 0.0, ldref = 0.0, maxerr = 0.0, minerr = 0.0, mwbase = 0.0, plim1 = 0.0, plim10 = 0.0, plim2 = 0.0, plim3 = 0.0, plim4 = 0.0, plim5 = 0.0, plim6 = 0.0, plim7 = 0.0, plim8 = 0.0, plim9 = 0.0, prate = 0.0, r = 0.0, rclose = 0.0, rdown = 0.0, ropen = 0.0, rselect = None, rup = 0.0, ta = 0.0, tact = 0.0, tb = 0.0, tc = 0.0, tdgov = 0.0, teng = 0.0, tfload = 0.0, tpelec = 0.0, tsa = 0.0, tsb = 0.0, vmax = 0.0, vmin = 0.0, wfnl = 0.0, wfspd = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.aset = aset + self.db = db + self.dm = dm + self.flim1 = flim1 + self.flim10 = flim10 + self.flim2 = flim2 + self.flim3 = flim3 + self.flim4 = flim4 + self.flim5 = flim5 + self.flim6 = flim6 + self.flim7 = flim7 + self.flim8 = flim8 + self.flim9 = flim9 + self.ka = ka + self.kdgov = kdgov + self.kigov = kigov + self.kiload = kiload + self.kimw = kimw + self.kpgov = kpgov + self.kpload = kpload + self.kturb = kturb + self.ldref = ldref + self.maxerr = maxerr + self.minerr = minerr + self.mwbase = mwbase + self.plim1 = plim1 + self.plim10 = plim10 + self.plim2 = plim2 + self.plim3 = plim3 + self.plim4 = plim4 + self.plim5 = plim5 + self.plim6 = plim6 + self.plim7 = plim7 + self.plim8 = plim8 + self.plim9 = plim9 + self.prate = prate + self.r = r + self.rclose = rclose + self.rdown = rdown + self.ropen = ropen + self.rselect = rselect + self.rup = rup + self.ta = ta + self.tact = tact + self.tb = tb + self.tc = tc + self.tdgov = tdgov + self.teng = teng + self.tfload = tfload + self.tpelec = tpelec + self.tsa = tsa + self.tsb = tsb + self.vmax = vmax + self.vmin = vmin + self.wfnl = wfnl + self.wfspd = wfspd + + def __str__(self): + str = "class=GovCT2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovGAST.py b/cimpy/cgmes_v2_4_15/GovGAST.py index 82d54d82..0fac5e3f 100644 --- a/cimpy/cgmes_v2_4_15/GovGAST.py +++ b/cimpy/cgmes_v2_4_15/GovGAST.py @@ -1,58 +1,60 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovGAST(TurbineGovernorDynamics): - ''' - Single shaft gas turbine. - - :mwbase: Base for power values (MWbase) (> 0). Default: 0.0 - :r: Permanent droop (R). Typical Value = 0.04. Default: 0.0 - :t1: Governor mechanism time constant (T1). T1 represents the natural valve positioning time constant of the governor for small disturbances, as seen when rate limiting is not in effect. Typical Value = 0.5. Default: 0 - :t2: Turbine power time constant (T2). T2 represents delay due to internal energy storage of the gas turbine engine. T2 can be used to give a rough approximation to the delay associated with acceleration of the compressor spool of a multi-shaft engine, or with the compressibility of gas in the plenum of a the free power turbine of an aero-derivative unit, for example. Typical Value = 0.5. Default: 0 - :t3: Turbine exhaust temperature time constant (T3). Typical Value = 3. Default: 0 - :at: Ambient temperature load limit (Load Limit). Typical Value = 1. Default: 0.0 - :kt: Temperature limiter gain (Kt). Typical Value = 3. Default: 0.0 - :vmax: Maximum turbine power, PU of MWbase (Vmax). Typical Value = 1. Default: 0.0 - :vmin: Minimum turbine power, PU of MWbase (Vmin). Typical Value = 0. Default: 0.0 - :dturb: Turbine damping factor (Dturb). Typical Value = 0.18. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'r': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 'at': [cgmesProfile.DY.value, ], - 'kt': [cgmesProfile.DY.value, ], - 'vmax': [cgmesProfile.DY.value, ], - 'vmin': [cgmesProfile.DY.value, ], - 'dturb': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, r = 0.0, t1 = 0, t2 = 0, t3 = 0, at = 0.0, kt = 0.0, vmax = 0.0, vmin = 0.0, dturb = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.r = r - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.at = at - self.kt = kt - self.vmax = vmax - self.vmin = vmin - self.dturb = dturb - - def __str__(self): - str = 'class=GovGAST\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovGAST(TurbineGovernorDynamics): + """ + Single shaft gas turbine. + + :at: Ambient temperature load limit (Load Limit). Typical Value = 1. Default: 0.0 + :dturb: Turbine damping factor (Dturb). Typical Value = 0.18. Default: 0.0 + :kt: Temperature limiter gain (Kt). Typical Value = 3. Default: 0.0 + :mwbase: Base for power values (MWbase) (> 0). Default: 0.0 + :r: Permanent droop (R). Typical Value = 0.04. Default: 0.0 + :t1: Governor mechanism time constant (T1). T1 represents the natural valve positioning time constant of the governor for small disturbances, as seen when rate limiting is not in effect. Typical Value = 0.5. Default: 0.0 + :t2: Turbine power time constant (T2). T2 represents delay due to internal energy storage of the gas turbine engine. T2 can be used to give a rough approximation to the delay associated with acceleration of the compressor spool of a multi-shaft engine, or with the compressibility of gas in the plenum of a the free power turbine of an aero-derivative unit, for example. Typical Value = 0.5. Default: 0.0 + :t3: Turbine exhaust temperature time constant (T3). Typical Value = 3. Default: 0.0 + :vmax: Maximum turbine power, PU of MWbase (Vmax). Typical Value = 1. Default: 0.0 + :vmin: Minimum turbine power, PU of MWbase (Vmin). Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "at": [Profile.DY.value, ], + "dturb": [Profile.DY.value, ], + "kt": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "r": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "vmax": [Profile.DY.value, ], + "vmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, at = 0.0, dturb = 0.0, kt = 0.0, mwbase = 0.0, r = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, vmax = 0.0, vmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.at = at + self.dturb = dturb + self.kt = kt + self.mwbase = mwbase + self.r = r + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.vmax = vmax + self.vmin = vmin + + def __str__(self): + str = "class=GovGAST\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovGAST1.py b/cimpy/cgmes_v2_4_15/GovGAST1.py index 1b9d9884..8e03a0e6 100644 --- a/cimpy/cgmes_v2_4_15/GovGAST1.py +++ b/cimpy/cgmes_v2_4_15/GovGAST1.py @@ -1,130 +1,132 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovGAST1(TurbineGovernorDynamics): - ''' - Modified single shaft gas turbine. - - :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 - :r: Permanent droop (R). Typical Value = 0.04. Default: 0.0 - :t1: Governor mechanism time constant (T1). T1 represents the natural valve positioning time constant of the governor for small disturbances, as seen when rate limiting is not in effect. Typical Value = 0.5. Default: 0 - :t2: Turbine power time constant (T2). T2 represents delay due to internal energy storage of the gas turbine engine. T2 can be used to give a rough approximation to the delay associated with acceleration of the compressor spool of a multi-shaft engine, or with the compressibility of gas in the plenum of the free power turbine of an aero-derivative unit, for example. Typical Value = 0.5. Default: 0 - :t3: Turbine exhaust temperature time constant (T3). T3 represents delay in the exhaust temperature and load limiting system. Typical Value = 3. Default: 0 - :lmax: Ambient temperature load limit (Lmax). Lmax is the turbine power output corresponding to the limiting exhaust gas temperature. Typical Value = 1. Default: 0.0 - :kt: Temperature limiter gain (Kt). Typical Value = 3. Default: 0.0 - :vmax: Maximum turbine power, PU of MWbase (Vmax). Typical Value = 1. Default: 0.0 - :vmin: Minimum turbine power, PU of MWbase (Vmin). Typical Value = 0. Default: 0.0 - :fidle: Fuel flow at zero power output (Fidle). Typical Value = 0.18. Default: 0.0 - :rmax: Maximum fuel valve opening rate (Rmax). Unit = PU/sec. Typical Value = 1. Default: 0.0 - :loadinc: Valve position change allowed at fast rate (Loadinc). Typical Value = 0.05. Default: 0.0 - :tltr: Valve position averaging time constant (Tltr). Typical Value = 10. Default: 0 - :ltrate: Maximum long term fuel valve opening rate (Ltrate). Typical Value = 0.02. Default: 0.0 - :a: Turbine power time constant numerator scale factor (a). Typical Value = 0.8. Default: 0.0 - :b: Turbine power time constant denominator scale factor (b). Typical Value = 1. Default: 0.0 - :db1: Intentional dead-band width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 - :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 - :db2: Unintentional dead-band (db2). Unit = MW. Typical Value = 0. Default: 0.0 - :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 - :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 - :gv2: Nonlinear gain point 2,PU gv (Gv2). Typical Value = 0. Default: 0.0 - :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 - :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 - :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 - :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 - :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 - :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 - :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 - :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 - :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 - :ka: Governor gain (Ka). Typical Value = 0. Default: 0.0 - :t4: Governor lead time constant (T4). Typical Value = 0. Default: 0 - :t5: Governor lag time constant (T5). Typical Value = 0. Default: 0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'r': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 'lmax': [cgmesProfile.DY.value, ], - 'kt': [cgmesProfile.DY.value, ], - 'vmax': [cgmesProfile.DY.value, ], - 'vmin': [cgmesProfile.DY.value, ], - 'fidle': [cgmesProfile.DY.value, ], - 'rmax': [cgmesProfile.DY.value, ], - 'loadinc': [cgmesProfile.DY.value, ], - 'tltr': [cgmesProfile.DY.value, ], - 'ltrate': [cgmesProfile.DY.value, ], - 'a': [cgmesProfile.DY.value, ], - 'b': [cgmesProfile.DY.value, ], - 'db1': [cgmesProfile.DY.value, ], - 'eps': [cgmesProfile.DY.value, ], - 'db2': [cgmesProfile.DY.value, ], - 'gv1': [cgmesProfile.DY.value, ], - 'pgv1': [cgmesProfile.DY.value, ], - 'gv2': [cgmesProfile.DY.value, ], - 'pgv2': [cgmesProfile.DY.value, ], - 'gv3': [cgmesProfile.DY.value, ], - 'pgv3': [cgmesProfile.DY.value, ], - 'gv4': [cgmesProfile.DY.value, ], - 'pgv4': [cgmesProfile.DY.value, ], - 'gv5': [cgmesProfile.DY.value, ], - 'pgv5': [cgmesProfile.DY.value, ], - 'gv6': [cgmesProfile.DY.value, ], - 'pgv6': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, r = 0.0, t1 = 0, t2 = 0, t3 = 0, lmax = 0.0, kt = 0.0, vmax = 0.0, vmin = 0.0, fidle = 0.0, rmax = 0.0, loadinc = 0.0, tltr = 0, ltrate = 0.0, a = 0.0, b = 0.0, db1 = 0.0, eps = 0.0, db2 = 0.0, gv1 = 0.0, pgv1 = 0.0, gv2 = 0.0, pgv2 = 0.0, gv3 = 0.0, pgv3 = 0.0, gv4 = 0.0, pgv4 = 0.0, gv5 = 0.0, pgv5 = 0.0, gv6 = 0.0, pgv6 = 0.0, ka = 0.0, t4 = 0, t5 = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.r = r - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.lmax = lmax - self.kt = kt - self.vmax = vmax - self.vmin = vmin - self.fidle = fidle - self.rmax = rmax - self.loadinc = loadinc - self.tltr = tltr - self.ltrate = ltrate - self.a = a - self.b = b - self.db1 = db1 - self.eps = eps - self.db2 = db2 - self.gv1 = gv1 - self.pgv1 = pgv1 - self.gv2 = gv2 - self.pgv2 = pgv2 - self.gv3 = gv3 - self.pgv3 = pgv3 - self.gv4 = gv4 - self.pgv4 = pgv4 - self.gv5 = gv5 - self.pgv5 = pgv5 - self.gv6 = gv6 - self.pgv6 = pgv6 - self.ka = ka - self.t4 = t4 - self.t5 = t5 - - def __str__(self): - str = 'class=GovGAST1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovGAST1(TurbineGovernorDynamics): + """ + Modified single shaft gas turbine. + + :a: Turbine power time constant numerator scale factor (a). Typical Value = 0.8. Default: 0.0 + :b: Turbine power time constant denominator scale factor (b). Typical Value = 1. Default: 0.0 + :db1: Intentional dead-band width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 + :db2: Unintentional dead-band (db2). Unit = MW. Typical Value = 0. Default: 0.0 + :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 + :fidle: Fuel flow at zero power output (Fidle). Typical Value = 0.18. Default: 0.0 + :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 + :gv2: Nonlinear gain point 2,PU gv (Gv2). Typical Value = 0. Default: 0.0 + :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 + :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 + :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 + :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 + :ka: Governor gain (Ka). Typical Value = 0. Default: 0.0 + :kt: Temperature limiter gain (Kt). Typical Value = 3. Default: 0.0 + :lmax: Ambient temperature load limit (Lmax). Lmax is the turbine power output corresponding to the limiting exhaust gas temperature. Typical Value = 1. Default: 0.0 + :loadinc: Valve position change allowed at fast rate (Loadinc). Typical Value = 0.05. Default: 0.0 + :ltrate: Maximum long term fuel valve opening rate (Ltrate). Typical Value = 0.02. Default: 0.0 + :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 + :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 + :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 + :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 + :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 + :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 + :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 + :r: Permanent droop (R). Typical Value = 0.04. Default: 0.0 + :rmax: Maximum fuel valve opening rate (Rmax). Unit = PU/sec. Typical Value = 1. Default: 0.0 + :t1: Governor mechanism time constant (T1). T1 represents the natural valve positioning time constant of the governor for small disturbances, as seen when rate limiting is not in effect. Typical Value = 0.5. Default: 0.0 + :t2: Turbine power time constant (T2). T2 represents delay due to internal energy storage of the gas turbine engine. T2 can be used to give a rough approximation to the delay associated with acceleration of the compressor spool of a multi-shaft engine, or with the compressibility of gas in the plenum of the free power turbine of an aero-derivative unit, for example. Typical Value = 0.5. Default: 0.0 + :t3: Turbine exhaust temperature time constant (T3). T3 represents delay in the exhaust temperature and load limiting system. Typical Value = 3. Default: 0.0 + :t4: Governor lead time constant (T4). Typical Value = 0. Default: 0.0 + :t5: Governor lag time constant (T5). Typical Value = 0. Default: 0.0 + :tltr: Valve position averaging time constant (Tltr). Typical Value = 10. Default: 0.0 + :vmax: Maximum turbine power, PU of MWbase (Vmax). Typical Value = 1. Default: 0.0 + :vmin: Minimum turbine power, PU of MWbase (Vmin). Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "a": [Profile.DY.value, ], + "b": [Profile.DY.value, ], + "db1": [Profile.DY.value, ], + "db2": [Profile.DY.value, ], + "eps": [Profile.DY.value, ], + "fidle": [Profile.DY.value, ], + "gv1": [Profile.DY.value, ], + "gv2": [Profile.DY.value, ], + "gv3": [Profile.DY.value, ], + "gv4": [Profile.DY.value, ], + "gv5": [Profile.DY.value, ], + "gv6": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kt": [Profile.DY.value, ], + "lmax": [Profile.DY.value, ], + "loadinc": [Profile.DY.value, ], + "ltrate": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pgv1": [Profile.DY.value, ], + "pgv2": [Profile.DY.value, ], + "pgv3": [Profile.DY.value, ], + "pgv4": [Profile.DY.value, ], + "pgv5": [Profile.DY.value, ], + "pgv6": [Profile.DY.value, ], + "r": [Profile.DY.value, ], + "rmax": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "tltr": [Profile.DY.value, ], + "vmax": [Profile.DY.value, ], + "vmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, a = 0.0, b = 0.0, db1 = 0.0, db2 = 0.0, eps = 0.0, fidle = 0.0, gv1 = 0.0, gv2 = 0.0, gv3 = 0.0, gv4 = 0.0, gv5 = 0.0, gv6 = 0.0, ka = 0.0, kt = 0.0, lmax = 0.0, loadinc = 0.0, ltrate = 0.0, mwbase = 0.0, pgv1 = 0.0, pgv2 = 0.0, pgv3 = 0.0, pgv4 = 0.0, pgv5 = 0.0, pgv6 = 0.0, r = 0.0, rmax = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, tltr = 0.0, vmax = 0.0, vmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.a = a + self.b = b + self.db1 = db1 + self.db2 = db2 + self.eps = eps + self.fidle = fidle + self.gv1 = gv1 + self.gv2 = gv2 + self.gv3 = gv3 + self.gv4 = gv4 + self.gv5 = gv5 + self.gv6 = gv6 + self.ka = ka + self.kt = kt + self.lmax = lmax + self.loadinc = loadinc + self.ltrate = ltrate + self.mwbase = mwbase + self.pgv1 = pgv1 + self.pgv2 = pgv2 + self.pgv3 = pgv3 + self.pgv4 = pgv4 + self.pgv5 = pgv5 + self.pgv6 = pgv6 + self.r = r + self.rmax = rmax + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.tltr = tltr + self.vmax = vmax + self.vmin = vmin + + def __str__(self): + str = "class=GovGAST1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovGAST2.py b/cimpy/cgmes_v2_4_15/GovGAST2.py index b235d68e..3ca79dba 100644 --- a/cimpy/cgmes_v2_4_15/GovGAST2.py +++ b/cimpy/cgmes_v2_4_15/GovGAST2.py @@ -1,124 +1,126 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovGAST2(TurbineGovernorDynamics): - ''' - Gas turbine model. - - :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 - :w: Governor gain (1/droop) on turbine rating (W). Default: 0.0 - :x: Governor lead time constant (X). Default: 0 - :y: Governor lag time constant (Y) (>0). Default: 0 - :z: Governor mode (Z). true = Droop false = ISO. Default: False - :etd: Turbine and exhaust delay (Etd). Default: 0 - :tcd: Compressor discharge time constant (Tcd). Default: 0 - :trate: Turbine rating (Trate). Unit = MW. Default: 0.0 - :t: Fuel Control Time Constant (T). Default: 0 - :tmax: Maximum Turbine limit (Tmax). Default: 0.0 - :tmin: Minimum Turbine limit (Tmin). Default: 0.0 - :ecr: Combustion reaction time delay (Ecr). Default: 0 - :k3: Ratio of Fuel Adjustment (K3). Default: 0.0 - :a: Valve positioner (A). Default: 0.0 - :b: Valve positioner (B). Default: 0.0 - :c: Valve positioner (C). Default: 0.0 - :tf: Fuel system time constant (Tf). Default: 0 - :kf: Fuel system feedback (Kf). Default: 0.0 - :k5: Gain of radiation shield (K5). Default: 0.0 - :k4: Gain of radiation shield (K4). Default: 0.0 - :t3: Radiation shield time constant (T3). Default: 0 - :t4: Thermocouple time constant (T4). Default: 0 - :tt: Temperature controller integration rate (Tt). Default: 0 - :t5: Temperature control time constant (T5). Default: 0 - :af1: Exhaust temperature Parameter (Af1). Unit = per unit temperature. Based on temperature in degrees C. Default: 0.0 - :bf1: (Bf1). Bf1 = E(1-w) where E (speed sensitivity coefficient) is 0.55 to 0.65 x Tr. Unit = per unit temperature. Based on temperature in degrees C. Default: 0.0 - :af2: Coefficient equal to 0.5(1-speed) (Af2). Default: 0.0 - :bf2: Turbine Torque Coefficient K (depends on heating value of fuel stream in combustion chamber) (Bf2). Default: 0.0 - :cf2: Coefficient defining fuel flow where power output is 0% (Cf2). Synchronous but no output. Typically 0.23 x K (23% fuel flow). Default: 0.0 - :tr: Rated temperature (Tr). Unit = [SYMBOL REMOVED]C depending on parameters Af1 and Bf1. Default: 0.0 - :k6: Minimum fuel flow (K6). Default: 0.0 - :tc: Temperature control (Tc). Unit = [SYMBOL REMOVED]F or [SYMBOL REMOVED]C depending on constants Af1 and Bf1. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'w': [cgmesProfile.DY.value, ], - 'x': [cgmesProfile.DY.value, ], - 'y': [cgmesProfile.DY.value, ], - 'z': [cgmesProfile.DY.value, ], - 'etd': [cgmesProfile.DY.value, ], - 'tcd': [cgmesProfile.DY.value, ], - 'trate': [cgmesProfile.DY.value, ], - 't': [cgmesProfile.DY.value, ], - 'tmax': [cgmesProfile.DY.value, ], - 'tmin': [cgmesProfile.DY.value, ], - 'ecr': [cgmesProfile.DY.value, ], - 'k3': [cgmesProfile.DY.value, ], - 'a': [cgmesProfile.DY.value, ], - 'b': [cgmesProfile.DY.value, ], - 'c': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'k5': [cgmesProfile.DY.value, ], - 'k4': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'tt': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 'af1': [cgmesProfile.DY.value, ], - 'bf1': [cgmesProfile.DY.value, ], - 'af2': [cgmesProfile.DY.value, ], - 'bf2': [cgmesProfile.DY.value, ], - 'cf2': [cgmesProfile.DY.value, ], - 'tr': [cgmesProfile.DY.value, ], - 'k6': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, w = 0.0, x = 0, y = 0, z = False, etd = 0, tcd = 0, trate = 0.0, t = 0, tmax = 0.0, tmin = 0.0, ecr = 0, k3 = 0.0, a = 0.0, b = 0.0, c = 0.0, tf = 0, kf = 0.0, k5 = 0.0, k4 = 0.0, t3 = 0, t4 = 0, tt = 0, t5 = 0, af1 = 0.0, bf1 = 0.0, af2 = 0.0, bf2 = 0.0, cf2 = 0.0, tr = 0.0, k6 = 0.0, tc = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.w = w - self.x = x - self.y = y - self.z = z - self.etd = etd - self.tcd = tcd - self.trate = trate - self.t = t - self.tmax = tmax - self.tmin = tmin - self.ecr = ecr - self.k3 = k3 - self.a = a - self.b = b - self.c = c - self.tf = tf - self.kf = kf - self.k5 = k5 - self.k4 = k4 - self.t3 = t3 - self.t4 = t4 - self.tt = tt - self.t5 = t5 - self.af1 = af1 - self.bf1 = bf1 - self.af2 = af2 - self.bf2 = bf2 - self.cf2 = cf2 - self.tr = tr - self.k6 = k6 - self.tc = tc - - def __str__(self): - str = 'class=GovGAST2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovGAST2(TurbineGovernorDynamics): + """ + Gas turbine model. + + :a: Valve positioner (A). Default: 0.0 + :af1: Exhaust temperature Parameter (Af1). Unit = per unit temperature. Based on temperature in degrees C. Default: 0.0 + :af2: Coefficient equal to 0.5(1-speed) (Af2). Default: 0.0 + :b: Valve positioner (B). Default: 0.0 + :bf1: (Bf1). Bf1 = E(1-w) where E (speed sensitivity coefficient) is 0.55 to 0.65 x Tr. Unit = per unit temperature. Based on temperature in degrees C. Default: 0.0 + :bf2: Turbine Torque Coefficient K (depends on heating value of fuel stream in combustion chamber) (Bf2). Default: 0.0 + :c: Valve positioner (C). Default: 0.0 + :cf2: Coefficient defining fuel flow where power output is 0% (Cf2). Synchronous but no output. Typically 0.23 x K (23% fuel flow). Default: 0.0 + :ecr: Combustion reaction time delay (Ecr). Default: 0.0 + :etd: Turbine and exhaust delay (Etd). Default: 0.0 + :k3: Ratio of Fuel Adjustment (K3). Default: 0.0 + :k4: Gain of radiation shield (K4). Default: 0.0 + :k5: Gain of radiation shield (K5). Default: 0.0 + :k6: Minimum fuel flow (K6). Default: 0.0 + :kf: Fuel system feedback (Kf). Default: 0.0 + :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 + :t: Fuel Control Time Constant (T). Default: 0.0 + :t3: Radiation shield time constant (T3). Default: 0.0 + :t4: Thermocouple time constant (T4). Default: 0.0 + :t5: Temperature control time constant (T5). Default: 0.0 + :tc: Temperature control (Tc). Unit = [SYMBOL REMOVED]F or [SYMBOL REMOVED]C depending on constants Af1 and Bf1. Default: 0.0 + :tcd: Compressor discharge time constant (Tcd). Default: 0.0 + :tf: Fuel system time constant (Tf). Default: 0.0 + :tmax: Maximum Turbine limit (Tmax). Default: 0.0 + :tmin: Minimum Turbine limit (Tmin). Default: 0.0 + :tr: Rated temperature (Tr). Unit = [SYMBOL REMOVED]C depending on parameters Af1 and Bf1. Default: 0.0 + :trate: Turbine rating (Trate). Unit = MW. Default: 0.0 + :tt: Temperature controller integration rate (Tt). Default: 0.0 + :w: Governor gain (1/droop) on turbine rating (W). Default: 0.0 + :x: Governor lead time constant (X). Default: 0.0 + :y: Governor lag time constant (Y) (>0). Default: 0.0 + :z: Governor mode (Z). true = Droop false = ISO. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "a": [Profile.DY.value, ], + "af1": [Profile.DY.value, ], + "af2": [Profile.DY.value, ], + "b": [Profile.DY.value, ], + "bf1": [Profile.DY.value, ], + "bf2": [Profile.DY.value, ], + "c": [Profile.DY.value, ], + "cf2": [Profile.DY.value, ], + "ecr": [Profile.DY.value, ], + "etd": [Profile.DY.value, ], + "k3": [Profile.DY.value, ], + "k4": [Profile.DY.value, ], + "k5": [Profile.DY.value, ], + "k6": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "t": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "tcd": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "tmax": [Profile.DY.value, ], + "tmin": [Profile.DY.value, ], + "tr": [Profile.DY.value, ], + "trate": [Profile.DY.value, ], + "tt": [Profile.DY.value, ], + "w": [Profile.DY.value, ], + "x": [Profile.DY.value, ], + "y": [Profile.DY.value, ], + "z": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, a = 0.0, af1 = 0.0, af2 = 0.0, b = 0.0, bf1 = 0.0, bf2 = 0.0, c = 0.0, cf2 = 0.0, ecr = 0.0, etd = 0.0, k3 = 0.0, k4 = 0.0, k5 = 0.0, k6 = 0.0, kf = 0.0, mwbase = 0.0, t = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, tc = 0.0, tcd = 0.0, tf = 0.0, tmax = 0.0, tmin = 0.0, tr = 0.0, trate = 0.0, tt = 0.0, w = 0.0, x = 0.0, y = 0.0, z = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.a = a + self.af1 = af1 + self.af2 = af2 + self.b = b + self.bf1 = bf1 + self.bf2 = bf2 + self.c = c + self.cf2 = cf2 + self.ecr = ecr + self.etd = etd + self.k3 = k3 + self.k4 = k4 + self.k5 = k5 + self.k6 = k6 + self.kf = kf + self.mwbase = mwbase + self.t = t + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.tc = tc + self.tcd = tcd + self.tf = tf + self.tmax = tmax + self.tmin = tmin + self.tr = tr + self.trate = trate + self.tt = tt + self.w = w + self.x = x + self.y = y + self.z = z + + def __str__(self): + str = "class=GovGAST2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovGAST3.py b/cimpy/cgmes_v2_4_15/GovGAST3.py index e1092d80..8d4f0ac9 100644 --- a/cimpy/cgmes_v2_4_15/GovGAST3.py +++ b/cimpy/cgmes_v2_4_15/GovGAST3.py @@ -1,91 +1,93 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovGAST3(TurbineGovernorDynamics): - ''' - Generic turbogas with acceleration and temperature controller. - - :bp: Droop (bp). Typical Value = 0.05. Default: 0.0 - :tg: Time constant of speed governor (Tg). Typical Value = 0.05. Default: 0 - :rcmx: Maximum fuel flow (RCMX). Typical Value = 1. Default: 0.0 - :rcmn: Minimum fuel flow (RCMN). Typical Value = -0.1. Default: 0.0 - :ky: Coefficient of transfer function of fuel valve positioner (Ky). Typical Value = 1. Default: 0.0 - :ty: Time constant of fuel valve positioner (Ty). Typical Value = 0.2. Default: 0 - :tac: Fuel control time constant (Tac). Typical Value = 0.1. Default: 0 - :kac: Fuel system feedback (K). Typical Value = 0. Default: 0.0 - :tc: Compressor discharge volume time constant (Tc). Typical Value = 0.2. Default: 0 - :bca: Acceleration limit set-point (Bca). Unit = 1/s. Typical Value = 0.01. Default: 0.0 - :kca: Acceleration control integral gain (Kca). Unit = 1/s. Typical Value = 100. Default: 0.0 - :dtc: Exhaust temperature variation due to fuel flow increasing from 0 to 1 PU (deltaTc). Typical Value = 390. Default: 0.0 - :ka: Minimum fuel flow (Ka). Typical Value = 0.23. Default: 0.0 - :tsi: Time constant of radiation shield (Tsi). Typical Value = 15. Default: 0 - :ksi: Gain of radiation shield (Ksi). Typical Value = 0.8. Default: 0.0 - :ttc: Time constant of thermocouple (Ttc). Typical Value = 2.5. Default: 0 - :tfen: Turbine rated exhaust temperature correspondent to Pm=1 PU (Tfen). Typical Value = 540. Default: 0.0 - :td: Temperature controller derivative gain (Td). Typical Value = 3.3. Default: 0 - :tt: Temperature controller integration rate (Tt). Typical Value = 250. Default: 0.0 - :mxef: Fuel flow maximum positive error value (MX). Typical Value = 0.05. Default: 0.0 - :mnef: Fuel flow maximum negative error value (MN). Typical Value = -0.05. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'bp': [cgmesProfile.DY.value, ], - 'tg': [cgmesProfile.DY.value, ], - 'rcmx': [cgmesProfile.DY.value, ], - 'rcmn': [cgmesProfile.DY.value, ], - 'ky': [cgmesProfile.DY.value, ], - 'ty': [cgmesProfile.DY.value, ], - 'tac': [cgmesProfile.DY.value, ], - 'kac': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'bca': [cgmesProfile.DY.value, ], - 'kca': [cgmesProfile.DY.value, ], - 'dtc': [cgmesProfile.DY.value, ], - 'ka': [cgmesProfile.DY.value, ], - 'tsi': [cgmesProfile.DY.value, ], - 'ksi': [cgmesProfile.DY.value, ], - 'ttc': [cgmesProfile.DY.value, ], - 'tfen': [cgmesProfile.DY.value, ], - 'td': [cgmesProfile.DY.value, ], - 'tt': [cgmesProfile.DY.value, ], - 'mxef': [cgmesProfile.DY.value, ], - 'mnef': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, bp = 0.0, tg = 0, rcmx = 0.0, rcmn = 0.0, ky = 0.0, ty = 0, tac = 0, kac = 0.0, tc = 0, bca = 0.0, kca = 0.0, dtc = 0.0, ka = 0.0, tsi = 0, ksi = 0.0, ttc = 0, tfen = 0.0, td = 0, tt = 0.0, mxef = 0.0, mnef = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.bp = bp - self.tg = tg - self.rcmx = rcmx - self.rcmn = rcmn - self.ky = ky - self.ty = ty - self.tac = tac - self.kac = kac - self.tc = tc - self.bca = bca - self.kca = kca - self.dtc = dtc - self.ka = ka - self.tsi = tsi - self.ksi = ksi - self.ttc = ttc - self.tfen = tfen - self.td = td - self.tt = tt - self.mxef = mxef - self.mnef = mnef - - def __str__(self): - str = 'class=GovGAST3\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovGAST3(TurbineGovernorDynamics): + """ + Generic turbogas with acceleration and temperature controller. + + :bca: Acceleration limit set-point (Bca). Unit = 1/s. Typical Value = 0.01. Default: 0.0 + :bp: Droop (bp). Typical Value = 0.05. Default: 0.0 + :dtc: Exhaust temperature variation due to fuel flow increasing from 0 to 1 PU (deltaTc). Typical Value = 390. Default: 0.0 + :ka: Minimum fuel flow (Ka). Typical Value = 0.23. Default: 0.0 + :kac: Fuel system feedback (K). Typical Value = 0. Default: 0.0 + :kca: Acceleration control integral gain (Kca). Unit = 1/s. Typical Value = 100. Default: 0.0 + :ksi: Gain of radiation shield (Ksi). Typical Value = 0.8. Default: 0.0 + :ky: Coefficient of transfer function of fuel valve positioner (Ky). Typical Value = 1. Default: 0.0 + :mnef: Fuel flow maximum negative error value (MN). Typical Value = -0.05. Default: 0.0 + :mxef: Fuel flow maximum positive error value (MX). Typical Value = 0.05. Default: 0.0 + :rcmn: Minimum fuel flow (RCMN). Typical Value = -0.1. Default: 0.0 + :rcmx: Maximum fuel flow (RCMX). Typical Value = 1. Default: 0.0 + :tac: Fuel control time constant (Tac). Typical Value = 0.1. Default: 0.0 + :tc: Compressor discharge volume time constant (Tc). Typical Value = 0.2. Default: 0.0 + :td: Temperature controller derivative gain (Td). Typical Value = 3.3. Default: 0.0 + :tfen: Turbine rated exhaust temperature correspondent to Pm=1 PU (Tfen). Typical Value = 540. Default: 0.0 + :tg: Time constant of speed governor (Tg). Typical Value = 0.05. Default: 0.0 + :tsi: Time constant of radiation shield (Tsi). Typical Value = 15. Default: 0.0 + :tt: Temperature controller integration rate (Tt). Typical Value = 250. Default: 0.0 + :ttc: Time constant of thermocouple (Ttc). Typical Value = 2.5. Default: 0.0 + :ty: Time constant of fuel valve positioner (Ty). Typical Value = 0.2. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "bca": [Profile.DY.value, ], + "bp": [Profile.DY.value, ], + "dtc": [Profile.DY.value, ], + "ka": [Profile.DY.value, ], + "kac": [Profile.DY.value, ], + "kca": [Profile.DY.value, ], + "ksi": [Profile.DY.value, ], + "ky": [Profile.DY.value, ], + "mnef": [Profile.DY.value, ], + "mxef": [Profile.DY.value, ], + "rcmn": [Profile.DY.value, ], + "rcmx": [Profile.DY.value, ], + "tac": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "td": [Profile.DY.value, ], + "tfen": [Profile.DY.value, ], + "tg": [Profile.DY.value, ], + "tsi": [Profile.DY.value, ], + "tt": [Profile.DY.value, ], + "ttc": [Profile.DY.value, ], + "ty": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, bca = 0.0, bp = 0.0, dtc = 0.0, ka = 0.0, kac = 0.0, kca = 0.0, ksi = 0.0, ky = 0.0, mnef = 0.0, mxef = 0.0, rcmn = 0.0, rcmx = 0.0, tac = 0.0, tc = 0.0, td = 0.0, tfen = 0.0, tg = 0.0, tsi = 0.0, tt = 0.0, ttc = 0.0, ty = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.bca = bca + self.bp = bp + self.dtc = dtc + self.ka = ka + self.kac = kac + self.kca = kca + self.ksi = ksi + self.ky = ky + self.mnef = mnef + self.mxef = mxef + self.rcmn = rcmn + self.rcmx = rcmx + self.tac = tac + self.tc = tc + self.td = td + self.tfen = tfen + self.tg = tg + self.tsi = tsi + self.tt = tt + self.ttc = ttc + self.ty = ty + + def __str__(self): + str = "class=GovGAST3\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovGAST4.py b/cimpy/cgmes_v2_4_15/GovGAST4.py index 0c40daaa..a6f1567f 100644 --- a/cimpy/cgmes_v2_4_15/GovGAST4.py +++ b/cimpy/cgmes_v2_4_15/GovGAST4.py @@ -1,61 +1,63 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovGAST4(TurbineGovernorDynamics): - ''' - Generic turbogas. - - :bp: Droop (bp). Typical Value = 0.05. Default: 0.0 - :tv: Time constant of fuel valve positioner (T). Typical Value = 0.1. Default: 0 - :ta: Maximum gate opening velocity (T). Typical Value = 3. Default: 0 - :tc: Maximum gate closing velocity (T). Typical Value = 0.5. Default: 0 - :tcm: Fuel control time constant (T). Typical Value = 0.1. Default: 0 - :ktm: Compressor gain (K). Typical Value = 0. Default: 0.0 - :tm: Compressor discharge volume time constant (T). Typical Value = 0.2. Default: 0 - :rymx: Maximum valve opening (RYMX). Typical Value = 1.1. Default: 0.0 - :rymn: Minimum valve opening (RYMN). Typical Value = 0. Default: 0.0 - :mxef: Fuel flow maximum positive error value (MX). Typical Value = 0.05. Default: 0.0 - :mnef: Fuel flow maximum negative error value (MN). Typical Value = -0.05. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'bp': [cgmesProfile.DY.value, ], - 'tv': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'tcm': [cgmesProfile.DY.value, ], - 'ktm': [cgmesProfile.DY.value, ], - 'tm': [cgmesProfile.DY.value, ], - 'rymx': [cgmesProfile.DY.value, ], - 'rymn': [cgmesProfile.DY.value, ], - 'mxef': [cgmesProfile.DY.value, ], - 'mnef': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, bp = 0.0, tv = 0, ta = 0, tc = 0, tcm = 0, ktm = 0.0, tm = 0, rymx = 0.0, rymn = 0.0, mxef = 0.0, mnef = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.bp = bp - self.tv = tv - self.ta = ta - self.tc = tc - self.tcm = tcm - self.ktm = ktm - self.tm = tm - self.rymx = rymx - self.rymn = rymn - self.mxef = mxef - self.mnef = mnef - - def __str__(self): - str = 'class=GovGAST4\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovGAST4(TurbineGovernorDynamics): + """ + Generic turbogas. + + :bp: Droop (bp). Typical Value = 0.05. Default: 0.0 + :ktm: Compressor gain (K). Typical Value = 0. Default: 0.0 + :mnef: Fuel flow maximum negative error value (MN). Typical Value = -0.05. Default: 0.0 + :mxef: Fuel flow maximum positive error value (MX). Typical Value = 0.05. Default: 0.0 + :rymn: Minimum valve opening (RYMN). Typical Value = 0. Default: 0.0 + :rymx: Maximum valve opening (RYMX). Typical Value = 1.1. Default: 0.0 + :ta: Maximum gate opening velocity (T). Typical Value = 3. Default: 0.0 + :tc: Maximum gate closing velocity (T). Typical Value = 0.5. Default: 0.0 + :tcm: Fuel control time constant (T). Typical Value = 0.1. Default: 0.0 + :tm: Compressor discharge volume time constant (T). Typical Value = 0.2. Default: 0.0 + :tv: Time constant of fuel valve positioner (T). Typical Value = 0.1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "bp": [Profile.DY.value, ], + "ktm": [Profile.DY.value, ], + "mnef": [Profile.DY.value, ], + "mxef": [Profile.DY.value, ], + "rymn": [Profile.DY.value, ], + "rymx": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "tcm": [Profile.DY.value, ], + "tm": [Profile.DY.value, ], + "tv": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, bp = 0.0, ktm = 0.0, mnef = 0.0, mxef = 0.0, rymn = 0.0, rymx = 0.0, ta = 0.0, tc = 0.0, tcm = 0.0, tm = 0.0, tv = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.bp = bp + self.ktm = ktm + self.mnef = mnef + self.mxef = mxef + self.rymn = rymn + self.rymx = rymx + self.ta = ta + self.tc = tc + self.tcm = tcm + self.tm = tm + self.tv = tv + + def __str__(self): + str = "class=GovGAST4\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovGASTWD.py b/cimpy/cgmes_v2_4_15/GovGASTWD.py index 6ac64b34..bc4a2b2d 100644 --- a/cimpy/cgmes_v2_4_15/GovGASTWD.py +++ b/cimpy/cgmes_v2_4_15/GovGASTWD.py @@ -1,127 +1,129 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovGASTWD(TurbineGovernorDynamics): - ''' - Woodward Gas turbine governor model. - - :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 - :kdroop: (Kdroop). Default: 0.0 - :kp: PID Proportional gain (Kp). Default: 0.0 - :ki: Isochronous Governor Gain (Ki). Default: 0.0 - :kd: Drop Governor Gain (Kd). Default: 0.0 - :etd: Turbine and exhaust delay (Etd). Default: 0 - :tcd: Compressor discharge time constant (Tcd). Default: 0 - :trate: Turbine rating (Trate). Unit = MW. Default: 0.0 - :t: Fuel Control Time Constant (T). Default: 0 - :tmax: Maximum Turbine limit (Tmax). Default: 0.0 - :tmin: Minimum Turbine limit (Tmin). Default: 0.0 - :ecr: Combustion reaction time delay (Ecr). Default: 0 - :k3: Ratio of Fuel Adjustment (K3). Default: 0.0 - :a: Valve positioner (). Default: 0.0 - :b: Valve positioner (). Default: 0.0 - :c: Valve positioner (). Default: 0.0 - :tf: Fuel system time constant (Tf). Default: 0 - :kf: Fuel system feedback (Kf). Default: 0.0 - :k5: Gain of radiation shield (K5). Default: 0.0 - :k4: Gain of radiation shield (K4). Default: 0.0 - :t3: Radiation shield time constant (T3). Default: 0 - :t4: Thermocouple time constant (T4). Default: 0 - :tt: Temperature controller integration rate (Tt). Default: 0 - :t5: Temperature control time constant (T5). Default: 0 - :af1: Exhaust temperature Parameter (Af1). Default: 0.0 - :bf1: (Bf1). Bf1 = E(1-w) where E (speed sensitivity coefficient) is 0.55 to 0.65 x Tr. Default: 0.0 - :af2: Coefficient equal to 0.5(1-speed) (Af2). Default: 0.0 - :bf2: Turbine Torque Coefficient K (depends on heating value of fuel stream in combustion chamber) (Bf2). Default: 0.0 - :cf2: Coefficient defining fuel flow where power output is 0% (Cf2). Synchronous but no output. Typically 0.23 x K(23% fuel flow). Default: 0.0 - :tr: Rated temperature (Tr). Default: 0.0 - :k6: Minimum fuel flow (K6). Default: 0.0 - :tc: Temperature control (Tc). Default: 0.0 - :td: Power transducer time constant (Td). Default: 0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'kdroop': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'etd': [cgmesProfile.DY.value, ], - 'tcd': [cgmesProfile.DY.value, ], - 'trate': [cgmesProfile.DY.value, ], - 't': [cgmesProfile.DY.value, ], - 'tmax': [cgmesProfile.DY.value, ], - 'tmin': [cgmesProfile.DY.value, ], - 'ecr': [cgmesProfile.DY.value, ], - 'k3': [cgmesProfile.DY.value, ], - 'a': [cgmesProfile.DY.value, ], - 'b': [cgmesProfile.DY.value, ], - 'c': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'k5': [cgmesProfile.DY.value, ], - 'k4': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'tt': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 'af1': [cgmesProfile.DY.value, ], - 'bf1': [cgmesProfile.DY.value, ], - 'af2': [cgmesProfile.DY.value, ], - 'bf2': [cgmesProfile.DY.value, ], - 'cf2': [cgmesProfile.DY.value, ], - 'tr': [cgmesProfile.DY.value, ], - 'k6': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'td': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, kdroop = 0.0, kp = 0.0, ki = 0.0, kd = 0.0, etd = 0, tcd = 0, trate = 0.0, t = 0, tmax = 0.0, tmin = 0.0, ecr = 0, k3 = 0.0, a = 0.0, b = 0.0, c = 0.0, tf = 0, kf = 0.0, k5 = 0.0, k4 = 0.0, t3 = 0, t4 = 0, tt = 0, t5 = 0, af1 = 0.0, bf1 = 0.0, af2 = 0.0, bf2 = 0.0, cf2 = 0.0, tr = 0.0, k6 = 0.0, tc = 0.0, td = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.kdroop = kdroop - self.kp = kp - self.ki = ki - self.kd = kd - self.etd = etd - self.tcd = tcd - self.trate = trate - self.t = t - self.tmax = tmax - self.tmin = tmin - self.ecr = ecr - self.k3 = k3 - self.a = a - self.b = b - self.c = c - self.tf = tf - self.kf = kf - self.k5 = k5 - self.k4 = k4 - self.t3 = t3 - self.t4 = t4 - self.tt = tt - self.t5 = t5 - self.af1 = af1 - self.bf1 = bf1 - self.af2 = af2 - self.bf2 = bf2 - self.cf2 = cf2 - self.tr = tr - self.k6 = k6 - self.tc = tc - self.td = td - - def __str__(self): - str = 'class=GovGASTWD\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovGASTWD(TurbineGovernorDynamics): + """ + Woodward Gas turbine governor model. + + :a: Valve positioner (). Default: 0.0 + :af1: Exhaust temperature Parameter (Af1). Default: 0.0 + :af2: Coefficient equal to 0.5(1-speed) (Af2). Default: 0.0 + :b: Valve positioner (). Default: 0.0 + :bf1: (Bf1). Bf1 = E(1-w) where E (speed sensitivity coefficient) is 0.55 to 0.65 x Tr. Default: 0.0 + :bf2: Turbine Torque Coefficient K (depends on heating value of fuel stream in combustion chamber) (Bf2). Default: 0.0 + :c: Valve positioner (). Default: 0.0 + :cf2: Coefficient defining fuel flow where power output is 0% (Cf2). Synchronous but no output. Typically 0.23 x K(23% fuel flow). Default: 0.0 + :ecr: Combustion reaction time delay (Ecr). Default: 0.0 + :etd: Turbine and exhaust delay (Etd). Default: 0.0 + :k3: Ratio of Fuel Adjustment (K3). Default: 0.0 + :k4: Gain of radiation shield (K4). Default: 0.0 + :k5: Gain of radiation shield (K5). Default: 0.0 + :k6: Minimum fuel flow (K6). Default: 0.0 + :kd: Drop Governor Gain (Kd). Default: 0.0 + :kdroop: (Kdroop). Default: 0.0 + :kf: Fuel system feedback (Kf). Default: 0.0 + :ki: Isochronous Governor Gain (Ki). Default: 0.0 + :kp: PID Proportional gain (Kp). Default: 0.0 + :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 + :t: Fuel Control Time Constant (T). Default: 0.0 + :t3: Radiation shield time constant (T3). Default: 0.0 + :t4: Thermocouple time constant (T4). Default: 0.0 + :t5: Temperature control time constant (T5). Default: 0.0 + :tc: Temperature control (Tc). Default: 0.0 + :tcd: Compressor discharge time constant (Tcd). Default: 0.0 + :td: Power transducer time constant (Td). Default: 0.0 + :tf: Fuel system time constant (Tf). Default: 0.0 + :tmax: Maximum Turbine limit (Tmax). Default: 0.0 + :tmin: Minimum Turbine limit (Tmin). Default: 0.0 + :tr: Rated temperature (Tr). Default: 0.0 + :trate: Turbine rating (Trate). Unit = MW. Default: 0.0 + :tt: Temperature controller integration rate (Tt). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "a": [Profile.DY.value, ], + "af1": [Profile.DY.value, ], + "af2": [Profile.DY.value, ], + "b": [Profile.DY.value, ], + "bf1": [Profile.DY.value, ], + "bf2": [Profile.DY.value, ], + "c": [Profile.DY.value, ], + "cf2": [Profile.DY.value, ], + "ecr": [Profile.DY.value, ], + "etd": [Profile.DY.value, ], + "k3": [Profile.DY.value, ], + "k4": [Profile.DY.value, ], + "k5": [Profile.DY.value, ], + "k6": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "kdroop": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "t": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "tcd": [Profile.DY.value, ], + "td": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "tmax": [Profile.DY.value, ], + "tmin": [Profile.DY.value, ], + "tr": [Profile.DY.value, ], + "trate": [Profile.DY.value, ], + "tt": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, a = 0.0, af1 = 0.0, af2 = 0.0, b = 0.0, bf1 = 0.0, bf2 = 0.0, c = 0.0, cf2 = 0.0, ecr = 0.0, etd = 0.0, k3 = 0.0, k4 = 0.0, k5 = 0.0, k6 = 0.0, kd = 0.0, kdroop = 0.0, kf = 0.0, ki = 0.0, kp = 0.0, mwbase = 0.0, t = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, tc = 0.0, tcd = 0.0, td = 0.0, tf = 0.0, tmax = 0.0, tmin = 0.0, tr = 0.0, trate = 0.0, tt = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.a = a + self.af1 = af1 + self.af2 = af2 + self.b = b + self.bf1 = bf1 + self.bf2 = bf2 + self.c = c + self.cf2 = cf2 + self.ecr = ecr + self.etd = etd + self.k3 = k3 + self.k4 = k4 + self.k5 = k5 + self.k6 = k6 + self.kd = kd + self.kdroop = kdroop + self.kf = kf + self.ki = ki + self.kp = kp + self.mwbase = mwbase + self.t = t + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.tc = tc + self.tcd = tcd + self.td = td + self.tf = tf + self.tmax = tmax + self.tmin = tmin + self.tr = tr + self.trate = trate + self.tt = tt + + def __str__(self): + str = "class=GovGASTWD\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydro1.py b/cimpy/cgmes_v2_4_15/GovHydro1.py index 6f30fc59..ef0fece4 100644 --- a/cimpy/cgmes_v2_4_15/GovHydro1.py +++ b/cimpy/cgmes_v2_4_15/GovHydro1.py @@ -1,70 +1,72 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydro1(TurbineGovernorDynamics): - ''' - Basic Hydro turbine governor model. - - :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 - :rperm: Permanent droop (R) (>0). Typical Value = 0.04. Default: 0.0 - :rtemp: Temporary droop (r) (>R). Typical Value = 0.3. Default: 0.0 - :tr: Washout time constant (Tr) (>0). Typical Value = 5. Default: 0 - :tf: Filter time constant () (>0). Typical Value = 0.05. Default: 0 - :tg: Gate servo time constant (Tg) (>0). Typical Value = 0.5. Default: 0 - :velm: Maximum gate velocity (Vlem) (>0). Typical Value = 0.2. Default: 0.0 - :gmax: Maximum gate opening (Gmax) (>0). Typical Value = 1. Default: 0.0 - :gmin: Minimum gate opening (Gmin) (>=0). Typical Value = 0. Default: 0.0 - :tw: Water inertia time constant (Tw) (>0). Typical Value = 1. Default: 0 - :at: Turbine gain (At) (>0). Typical Value = 1.2. Default: 0.0 - :dturb: Turbine damping factor (Dturb) (>=0). Typical Value = 0.5. Default: 0.0 - :qnl: No-load flow at nominal head (qnl) (>=0). Typical Value = 0.08. Default: 0.0 - :hdam: Turbine nominal head (hdam). Typical Value = 1. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'rperm': [cgmesProfile.DY.value, ], - 'rtemp': [cgmesProfile.DY.value, ], - 'tr': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'tg': [cgmesProfile.DY.value, ], - 'velm': [cgmesProfile.DY.value, ], - 'gmax': [cgmesProfile.DY.value, ], - 'gmin': [cgmesProfile.DY.value, ], - 'tw': [cgmesProfile.DY.value, ], - 'at': [cgmesProfile.DY.value, ], - 'dturb': [cgmesProfile.DY.value, ], - 'qnl': [cgmesProfile.DY.value, ], - 'hdam': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, rperm = 0.0, rtemp = 0.0, tr = 0, tf = 0, tg = 0, velm = 0.0, gmax = 0.0, gmin = 0.0, tw = 0, at = 0.0, dturb = 0.0, qnl = 0.0, hdam = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.rperm = rperm - self.rtemp = rtemp - self.tr = tr - self.tf = tf - self.tg = tg - self.velm = velm - self.gmax = gmax - self.gmin = gmin - self.tw = tw - self.at = at - self.dturb = dturb - self.qnl = qnl - self.hdam = hdam - - def __str__(self): - str = 'class=GovHydro1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydro1(TurbineGovernorDynamics): + """ + Basic Hydro turbine governor model. + + :at: Turbine gain (At) (>0). Typical Value = 1.2. Default: 0.0 + :dturb: Turbine damping factor (Dturb) (>=0). Typical Value = 0.5. Default: 0.0 + :gmax: Maximum gate opening (Gmax) (>0). Typical Value = 1. Default: 0.0 + :gmin: Minimum gate opening (Gmin) (>=0). Typical Value = 0. Default: 0.0 + :hdam: Turbine nominal head (hdam). Typical Value = 1. Default: 0.0 + :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 + :qnl: No-load flow at nominal head (qnl) (>=0). Typical Value = 0.08. Default: 0.0 + :rperm: Permanent droop (R) (>0). Typical Value = 0.04. Default: 0.0 + :rtemp: Temporary droop (r) (>R). Typical Value = 0.3. Default: 0.0 + :tf: Filter time constant () (>0). Typical Value = 0.05. Default: 0.0 + :tg: Gate servo time constant (Tg) (>0). Typical Value = 0.5. Default: 0.0 + :tr: Washout time constant (Tr) (>0). Typical Value = 5. Default: 0.0 + :tw: Water inertia time constant (Tw) (>0). Typical Value = 1. Default: 0.0 + :velm: Maximum gate velocity (Vlem) (>0). Typical Value = 0.2. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "at": [Profile.DY.value, ], + "dturb": [Profile.DY.value, ], + "gmax": [Profile.DY.value, ], + "gmin": [Profile.DY.value, ], + "hdam": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "qnl": [Profile.DY.value, ], + "rperm": [Profile.DY.value, ], + "rtemp": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "tg": [Profile.DY.value, ], + "tr": [Profile.DY.value, ], + "tw": [Profile.DY.value, ], + "velm": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, at = 0.0, dturb = 0.0, gmax = 0.0, gmin = 0.0, hdam = 0.0, mwbase = 0.0, qnl = 0.0, rperm = 0.0, rtemp = 0.0, tf = 0.0, tg = 0.0, tr = 0.0, tw = 0.0, velm = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.at = at + self.dturb = dturb + self.gmax = gmax + self.gmin = gmin + self.hdam = hdam + self.mwbase = mwbase + self.qnl = qnl + self.rperm = rperm + self.rtemp = rtemp + self.tf = tf + self.tg = tg + self.tr = tr + self.tw = tw + self.velm = velm + + def __str__(self): + str = "class=GovHydro1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydro2.py b/cimpy/cgmes_v2_4_15/GovHydro2.py index 00dff2b9..bca00119 100644 --- a/cimpy/cgmes_v2_4_15/GovHydro2.py +++ b/cimpy/cgmes_v2_4_15/GovHydro2.py @@ -1,115 +1,117 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydro2(TurbineGovernorDynamics): - ''' - IEEE hydro turbine governor model represents plants with straightforward penstock configurations and hydraulic-dashpot governors. - - :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 - :tg: Gate servo time constant (Tg). Typical Value = 0.5. Default: 0 - :tp: Pilot servo valve time constant (Tp). Typical Value = 0.03. Default: 0 - :uo: Maximum gate opening velocity (Uo). Unit = PU/sec. Typical Value = 0.1. Default: 0.0 - :uc: Maximum gate closing velocity (Uc) (<0). Unit = PU/sec. Typical Value = -0.1. Default: 0.0 - :pmax: Maximum gate opening (Pmax). Typical Value = 1. Default: 0.0 - :pmin: Minimum gate opening; (). Typical Value = 0. Default: 0.0 - :rperm: Permanent droop (Rperm). Typical Value = 0.05. Default: 0.0 - :rtemp: Temporary droop (Rtemp). Typical Value = 0.5. Default: 0.0 - :tr: Dashpot time constant (Tr). Typical Value = 12. Default: 0 - :tw: Water inertia time constant (Tw). Typical Value = 2. Default: 0 - :kturb: Turbine gain (Kturb). Typical Value = 1. Default: 0.0 - :aturb: Turbine numerator multiplier (Aturb). Typical Value = -1. Default: 0.0 - :bturb: Turbine denominator multiplier (Bturb). Typical Value = 0.5. Default: 0.0 - :db1: Intentional deadband width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 - :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 - :db2: Unintentional deadband (db2). Unit = MW. Typical Value = 0. Default: 0.0 - :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 - :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 - :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Default: 0.0 - :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 - :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 - :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 - :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 - :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 - :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 - :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 - :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 - :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'tg': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 'uo': [cgmesProfile.DY.value, ], - 'uc': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - 'rperm': [cgmesProfile.DY.value, ], - 'rtemp': [cgmesProfile.DY.value, ], - 'tr': [cgmesProfile.DY.value, ], - 'tw': [cgmesProfile.DY.value, ], - 'kturb': [cgmesProfile.DY.value, ], - 'aturb': [cgmesProfile.DY.value, ], - 'bturb': [cgmesProfile.DY.value, ], - 'db1': [cgmesProfile.DY.value, ], - 'eps': [cgmesProfile.DY.value, ], - 'db2': [cgmesProfile.DY.value, ], - 'gv1': [cgmesProfile.DY.value, ], - 'pgv1': [cgmesProfile.DY.value, ], - 'gv2': [cgmesProfile.DY.value, ], - 'pgv2': [cgmesProfile.DY.value, ], - 'gv3': [cgmesProfile.DY.value, ], - 'pgv3': [cgmesProfile.DY.value, ], - 'gv4': [cgmesProfile.DY.value, ], - 'pgv4': [cgmesProfile.DY.value, ], - 'gv5': [cgmesProfile.DY.value, ], - 'pgv5': [cgmesProfile.DY.value, ], - 'gv6': [cgmesProfile.DY.value, ], - 'pgv6': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, tg = 0, tp = 0, uo = 0.0, uc = 0.0, pmax = 0.0, pmin = 0.0, rperm = 0.0, rtemp = 0.0, tr = 0, tw = 0, kturb = 0.0, aturb = 0.0, bturb = 0.0, db1 = 0.0, eps = 0.0, db2 = 0.0, gv1 = 0.0, pgv1 = 0.0, gv2 = 0.0, pgv2 = 0.0, gv3 = 0.0, pgv3 = 0.0, gv4 = 0.0, pgv4 = 0.0, gv5 = 0.0, pgv5 = 0.0, gv6 = 0.0, pgv6 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.tg = tg - self.tp = tp - self.uo = uo - self.uc = uc - self.pmax = pmax - self.pmin = pmin - self.rperm = rperm - self.rtemp = rtemp - self.tr = tr - self.tw = tw - self.kturb = kturb - self.aturb = aturb - self.bturb = bturb - self.db1 = db1 - self.eps = eps - self.db2 = db2 - self.gv1 = gv1 - self.pgv1 = pgv1 - self.gv2 = gv2 - self.pgv2 = pgv2 - self.gv3 = gv3 - self.pgv3 = pgv3 - self.gv4 = gv4 - self.pgv4 = pgv4 - self.gv5 = gv5 - self.pgv5 = pgv5 - self.gv6 = gv6 - self.pgv6 = pgv6 - - def __str__(self): - str = 'class=GovHydro2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydro2(TurbineGovernorDynamics): + """ + IEEE hydro turbine governor model represents plants with straightforward penstock configurations and hydraulic-dashpot governors. + + :aturb: Turbine numerator multiplier (Aturb). Typical Value = -1. Default: 0.0 + :bturb: Turbine denominator multiplier (Bturb). Typical Value = 0.5. Default: 0.0 + :db1: Intentional deadband width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 + :db2: Unintentional deadband (db2). Unit = MW. Typical Value = 0. Default: 0.0 + :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 + :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 + :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Default: 0.0 + :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 + :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 + :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 + :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 + :kturb: Turbine gain (Kturb). Typical Value = 1. Default: 0.0 + :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 + :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 + :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 + :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 + :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 + :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 + :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 + :pmax: Maximum gate opening (Pmax). Typical Value = 1. Default: 0.0 + :pmin: Minimum gate opening; (). Typical Value = 0. Default: 0.0 + :rperm: Permanent droop (Rperm). Typical Value = 0.05. Default: 0.0 + :rtemp: Temporary droop (Rtemp). Typical Value = 0.5. Default: 0.0 + :tg: Gate servo time constant (Tg). Typical Value = 0.5. Default: 0.0 + :tp: Pilot servo valve time constant (Tp). Typical Value = 0.03. Default: 0.0 + :tr: Dashpot time constant (Tr). Typical Value = 12. Default: 0.0 + :tw: Water inertia time constant (Tw). Typical Value = 2. Default: 0.0 + :uc: Maximum gate closing velocity (Uc) (<0). Unit = PU/sec. Typical Value = -0.1. Default: 0.0 + :uo: Maximum gate opening velocity (Uo). Unit = PU/sec. Typical Value = 0.1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "aturb": [Profile.DY.value, ], + "bturb": [Profile.DY.value, ], + "db1": [Profile.DY.value, ], + "db2": [Profile.DY.value, ], + "eps": [Profile.DY.value, ], + "gv1": [Profile.DY.value, ], + "gv2": [Profile.DY.value, ], + "gv3": [Profile.DY.value, ], + "gv4": [Profile.DY.value, ], + "gv5": [Profile.DY.value, ], + "gv6": [Profile.DY.value, ], + "kturb": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pgv1": [Profile.DY.value, ], + "pgv2": [Profile.DY.value, ], + "pgv3": [Profile.DY.value, ], + "pgv4": [Profile.DY.value, ], + "pgv5": [Profile.DY.value, ], + "pgv6": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "rperm": [Profile.DY.value, ], + "rtemp": [Profile.DY.value, ], + "tg": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + "tr": [Profile.DY.value, ], + "tw": [Profile.DY.value, ], + "uc": [Profile.DY.value, ], + "uo": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, aturb = 0.0, bturb = 0.0, db1 = 0.0, db2 = 0.0, eps = 0.0, gv1 = 0.0, gv2 = 0.0, gv3 = 0.0, gv4 = 0.0, gv5 = 0.0, gv6 = 0.0, kturb = 0.0, mwbase = 0.0, pgv1 = 0.0, pgv2 = 0.0, pgv3 = 0.0, pgv4 = 0.0, pgv5 = 0.0, pgv6 = 0.0, pmax = 0.0, pmin = 0.0, rperm = 0.0, rtemp = 0.0, tg = 0.0, tp = 0.0, tr = 0.0, tw = 0.0, uc = 0.0, uo = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.aturb = aturb + self.bturb = bturb + self.db1 = db1 + self.db2 = db2 + self.eps = eps + self.gv1 = gv1 + self.gv2 = gv2 + self.gv3 = gv3 + self.gv4 = gv4 + self.gv5 = gv5 + self.gv6 = gv6 + self.kturb = kturb + self.mwbase = mwbase + self.pgv1 = pgv1 + self.pgv2 = pgv2 + self.pgv3 = pgv3 + self.pgv4 = pgv4 + self.pgv5 = pgv5 + self.pgv6 = pgv6 + self.pmax = pmax + self.pmin = pmin + self.rperm = rperm + self.rtemp = rtemp + self.tg = tg + self.tp = tp + self.tr = tr + self.tw = tw + self.uc = uc + self.uo = uo + + def __str__(self): + str = "class=GovHydro2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydro3.py b/cimpy/cgmes_v2_4_15/GovHydro3.py index 9e4f6ec1..58b2c852 100644 --- a/cimpy/cgmes_v2_4_15/GovHydro3.py +++ b/cimpy/cgmes_v2_4_15/GovHydro3.py @@ -1,136 +1,138 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydro3(TurbineGovernorDynamics): - ''' - Modified IEEE Hydro Governor-Turbine Model. This model differs from that defined in the IEEE modeling guideline paper in that the limits on gate position and velocity do not permit "wind up" of the upstream signals. - - :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 - :pmax: Maximum gate opening, PU of MWbase (Pmax). Typical Value = 1. Default: 0.0 - :pmin: Minimum gate opening, PU of MWbase (Pmin). Typical Value = 0. Default: 0.0 - :governorControl: Governor control flag (Cflag). true = PID control is active false = double derivative control is active. Typical Value = true. Default: False - :rgate: Steady-state droop, PU, for governor output feedback (Rgate). Typical Value = 0. Default: 0.0 - :relec: Steady-state droop, PU, for electrical power feedback (Relec). Typical Value = 0.05. Default: 0.0 - :td: Input filter time constant (Td). Typical Value = 0.05. Default: 0 - :tf: Washout time constant (Tf). Typical Value = 0.1. Default: 0 - :tp: Gate servo time constant (Tp). Typical Value = 0.05. Default: 0 - :velop: Maximum gate opening velocity (Velop). Unit = PU/sec. Typical Value = 0.2. Default: 0.0 - :velcl: Maximum gate closing velocity (Velcl). Unit = PU/sec. Typical Value = -0.2. Default: 0.0 - :k1: Derivative gain (K1). Typical Value = 0.01. Default: 0.0 - :k2: Double derivative gain, if Cflag = -1 (K2). Typical Value = 2.5. Default: 0.0 - :ki: Integral gain (Ki). Typical Value = 0.5. Default: 0.0 - :kg: Gate servo gain (Kg). Typical Value = 2. Default: 0.0 - :tt: Power feedback time constant (Tt). Typical Value = 0.2. Default: 0 - :db1: Intentional dead-band width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 - :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 - :db2: Unintentional dead-band (db2). Unit = MW. Typical Value = 0. Default: 0.0 - :tw: Water inertia time constant (Tw). Typical Value = 1. Default: 0 - :at: Turbine gain (At). Typical Value = 1.2. Default: 0.0 - :dturb: Turbine damping factor (Dturb). Typical Value = 0.2. Default: 0.0 - :qnl: No-load turbine flow at nominal head (Qnl). Typical Value = 0.08. Default: 0.0 - :h0: Turbine nominal head (H0). Typical Value = 1. Default: 0.0 - :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 - :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 - :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Default: 0.0 - :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 - :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 - :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 - :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 - :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 - :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 - :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 - :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 - :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - 'governorControl': [cgmesProfile.DY.value, ], - 'rgate': [cgmesProfile.DY.value, ], - 'relec': [cgmesProfile.DY.value, ], - 'td': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 'velop': [cgmesProfile.DY.value, ], - 'velcl': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kg': [cgmesProfile.DY.value, ], - 'tt': [cgmesProfile.DY.value, ], - 'db1': [cgmesProfile.DY.value, ], - 'eps': [cgmesProfile.DY.value, ], - 'db2': [cgmesProfile.DY.value, ], - 'tw': [cgmesProfile.DY.value, ], - 'at': [cgmesProfile.DY.value, ], - 'dturb': [cgmesProfile.DY.value, ], - 'qnl': [cgmesProfile.DY.value, ], - 'h0': [cgmesProfile.DY.value, ], - 'gv1': [cgmesProfile.DY.value, ], - 'pgv1': [cgmesProfile.DY.value, ], - 'gv2': [cgmesProfile.DY.value, ], - 'pgv2': [cgmesProfile.DY.value, ], - 'gv3': [cgmesProfile.DY.value, ], - 'pgv3': [cgmesProfile.DY.value, ], - 'gv4': [cgmesProfile.DY.value, ], - 'pgv4': [cgmesProfile.DY.value, ], - 'gv5': [cgmesProfile.DY.value, ], - 'pgv5': [cgmesProfile.DY.value, ], - 'gv6': [cgmesProfile.DY.value, ], - 'pgv6': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, pmax = 0.0, pmin = 0.0, governorControl = False, rgate = 0.0, relec = 0.0, td = 0, tf = 0, tp = 0, velop = 0.0, velcl = 0.0, k1 = 0.0, k2 = 0.0, ki = 0.0, kg = 0.0, tt = 0, db1 = 0.0, eps = 0.0, db2 = 0.0, tw = 0, at = 0.0, dturb = 0.0, qnl = 0.0, h0 = 0.0, gv1 = 0.0, pgv1 = 0.0, gv2 = 0.0, pgv2 = 0.0, gv3 = 0.0, pgv3 = 0.0, gv4 = 0.0, pgv4 = 0.0, gv5 = 0.0, pgv5 = 0.0, gv6 = 0.0, pgv6 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.pmax = pmax - self.pmin = pmin - self.governorControl = governorControl - self.rgate = rgate - self.relec = relec - self.td = td - self.tf = tf - self.tp = tp - self.velop = velop - self.velcl = velcl - self.k1 = k1 - self.k2 = k2 - self.ki = ki - self.kg = kg - self.tt = tt - self.db1 = db1 - self.eps = eps - self.db2 = db2 - self.tw = tw - self.at = at - self.dturb = dturb - self.qnl = qnl - self.h0 = h0 - self.gv1 = gv1 - self.pgv1 = pgv1 - self.gv2 = gv2 - self.pgv2 = pgv2 - self.gv3 = gv3 - self.pgv3 = pgv3 - self.gv4 = gv4 - self.pgv4 = pgv4 - self.gv5 = gv5 - self.pgv5 = pgv5 - self.gv6 = gv6 - self.pgv6 = pgv6 - - def __str__(self): - str = 'class=GovHydro3\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydro3(TurbineGovernorDynamics): + """ + Modified IEEE Hydro Governor-Turbine Model. This model differs from that defined in the IEEE modeling guideline paper in that the limits on gate position and velocity do not permit "wind up" of the upstream signals. + + :at: Turbine gain (At). Typical Value = 1.2. Default: 0.0 + :db1: Intentional dead-band width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 + :db2: Unintentional dead-band (db2). Unit = MW. Typical Value = 0. Default: 0.0 + :dturb: Turbine damping factor (Dturb). Typical Value = 0.2. Default: 0.0 + :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 + :governorControl: Governor control flag (Cflag). true = PID control is active false = double derivative control is active. Typical Value = true. Default: False + :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 + :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Default: 0.0 + :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 + :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 + :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 + :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 + :h0: Turbine nominal head (H0). Typical Value = 1. Default: 0.0 + :k1: Derivative gain (K1). Typical Value = 0.01. Default: 0.0 + :k2: Double derivative gain, if Cflag = -1 (K2). Typical Value = 2.5. Default: 0.0 + :kg: Gate servo gain (Kg). Typical Value = 2. Default: 0.0 + :ki: Integral gain (Ki). Typical Value = 0.5. Default: 0.0 + :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 + :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 + :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 + :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 + :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 + :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 + :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 + :pmax: Maximum gate opening, PU of MWbase (Pmax). Typical Value = 1. Default: 0.0 + :pmin: Minimum gate opening, PU of MWbase (Pmin). Typical Value = 0. Default: 0.0 + :qnl: No-load turbine flow at nominal head (Qnl). Typical Value = 0.08. Default: 0.0 + :relec: Steady-state droop, PU, for electrical power feedback (Relec). Typical Value = 0.05. Default: 0.0 + :rgate: Steady-state droop, PU, for governor output feedback (Rgate). Typical Value = 0. Default: 0.0 + :td: Input filter time constant (Td). Typical Value = 0.05. Default: 0.0 + :tf: Washout time constant (Tf). Typical Value = 0.1. Default: 0.0 + :tp: Gate servo time constant (Tp). Typical Value = 0.05. Default: 0.0 + :tt: Power feedback time constant (Tt). Typical Value = 0.2. Default: 0.0 + :tw: Water inertia time constant (Tw). Typical Value = 1. Default: 0.0 + :velcl: Maximum gate closing velocity (Velcl). Unit = PU/sec. Typical Value = -0.2. Default: 0.0 + :velop: Maximum gate opening velocity (Velop). Unit = PU/sec. Typical Value = 0.2. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "at": [Profile.DY.value, ], + "db1": [Profile.DY.value, ], + "db2": [Profile.DY.value, ], + "dturb": [Profile.DY.value, ], + "eps": [Profile.DY.value, ], + "governorControl": [Profile.DY.value, ], + "gv1": [Profile.DY.value, ], + "gv2": [Profile.DY.value, ], + "gv3": [Profile.DY.value, ], + "gv4": [Profile.DY.value, ], + "gv5": [Profile.DY.value, ], + "gv6": [Profile.DY.value, ], + "h0": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "kg": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pgv1": [Profile.DY.value, ], + "pgv2": [Profile.DY.value, ], + "pgv3": [Profile.DY.value, ], + "pgv4": [Profile.DY.value, ], + "pgv5": [Profile.DY.value, ], + "pgv6": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "qnl": [Profile.DY.value, ], + "relec": [Profile.DY.value, ], + "rgate": [Profile.DY.value, ], + "td": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + "tt": [Profile.DY.value, ], + "tw": [Profile.DY.value, ], + "velcl": [Profile.DY.value, ], + "velop": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, at = 0.0, db1 = 0.0, db2 = 0.0, dturb = 0.0, eps = 0.0, governorControl = False, gv1 = 0.0, gv2 = 0.0, gv3 = 0.0, gv4 = 0.0, gv5 = 0.0, gv6 = 0.0, h0 = 0.0, k1 = 0.0, k2 = 0.0, kg = 0.0, ki = 0.0, mwbase = 0.0, pgv1 = 0.0, pgv2 = 0.0, pgv3 = 0.0, pgv4 = 0.0, pgv5 = 0.0, pgv6 = 0.0, pmax = 0.0, pmin = 0.0, qnl = 0.0, relec = 0.0, rgate = 0.0, td = 0.0, tf = 0.0, tp = 0.0, tt = 0.0, tw = 0.0, velcl = 0.0, velop = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.at = at + self.db1 = db1 + self.db2 = db2 + self.dturb = dturb + self.eps = eps + self.governorControl = governorControl + self.gv1 = gv1 + self.gv2 = gv2 + self.gv3 = gv3 + self.gv4 = gv4 + self.gv5 = gv5 + self.gv6 = gv6 + self.h0 = h0 + self.k1 = k1 + self.k2 = k2 + self.kg = kg + self.ki = ki + self.mwbase = mwbase + self.pgv1 = pgv1 + self.pgv2 = pgv2 + self.pgv3 = pgv3 + self.pgv4 = pgv4 + self.pgv5 = pgv5 + self.pgv6 = pgv6 + self.pmax = pmax + self.pmin = pmin + self.qnl = qnl + self.relec = relec + self.rgate = rgate + self.td = td + self.tf = tf + self.tp = tp + self.tt = tt + self.tw = tw + self.velcl = velcl + self.velop = velop + + def __str__(self): + str = "class=GovHydro3\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydro4.py b/cimpy/cgmes_v2_4_15/GovHydro4.py index ebdc5205..70cd3acd 100644 --- a/cimpy/cgmes_v2_4_15/GovHydro4.py +++ b/cimpy/cgmes_v2_4_15/GovHydro4.py @@ -1,142 +1,144 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydro4(TurbineGovernorDynamics): - ''' - Hydro turbine and governor. Represents plants with straight-forward penstock configurations and hydraulic governors of traditional 'dashpot' type. This model can be used to represent simple, Francis, Pelton or Kaplan turbines. - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :tg: Gate servo time constant (Tg) (>0). Typical Value = 0.5. Default: 0 - :tp: Pilot servo time constant (Tp). Typical Value = 0.1. Default: 0 - :uo: Max gate opening velocity (Uo). Typical Vlaue = 0.2. Default: 0.0 - :uc: Max gate closing velocity (Uc). Typical Value = 0.2. Default: 0.0 - :gmax: Maximum gate opening, PU of MWbase (Gmax). Typical Value = 1. Default: 0.0 - :gmin: Minimum gate opening, PU of MWbase (Gmin). Typical Value = 0. Default: 0.0 - :rperm: Permanent droop (Rperm). Typical Value = 0.05. Default: 0 - :rtemp: Temporary droop (Rtemp). Typical Value = 0.3. Default: 0 - :tr: Dashpot time constant (Tr) (>0). Typical Value = 5. Default: 0 - :tw: Water inertia time constant (Tw) (>0). Typical Value = 1. Default: 0 - :at: Turbine gain (At). Typical Value = 1.2. Default: 0.0 - :dturb: Turbine damping factor (Dturb). Unit = delta P (PU of MWbase) / delta speed (PU). Typical Value = 0.5. Typical Value Francis = 1.1, Kaplan = 1.1. Default: 0.0 - :hdam: Head available at dam (hdam). Typical Value = 1. Default: 0.0 - :qn1: No-load flow at nominal head (Qnl). Typical Value = 0.08. Typical Value Francis = 0, Kaplan = 0. Default: 0.0 - :db1: Intentional deadband width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 - :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 - :db2: Unintentional dead-band (db2). Unit = MW. Typical Value = 0. Default: 0.0 - :gv0: Nonlinear gain point 0, PU gv (Gv0). Typical Value = 0. Typical Value Francis = 0.1, Kaplan = 0.1. Default: 0.0 - :pgv0: Nonlinear gain point 0, PU power (Pgv0). Typical Value = 0. Default: 0.0 - :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Typical Value Francis = 0.4, Kaplan = 0.4. Default: 0.0 - :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Typical Value Francis = 0.42, Kaplan = 0.35. Default: 0.0 - :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Typical Value Francis = 0.5, Kaplan = 0.5. Default: 0.0 - :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Typical Value Francis = 0.56, Kaplan = 0.468. Default: 0.0 - :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Typical Value Francis = 0.7, Kaplan = 0.7. Default: 0.0 - :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Typical Value Francis = 0.8, Kaplan = 0.796. Default: 0.0 - :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Typical Value Francis = 0.8, Kaplan = 0.8. Default: 0.0 - :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Typical Value Francis = 0.9, Kaplan = 0.917. Default: 0.0 - :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Typical Value Francis = 0.9, Kaplan = 0.9. Default: 0.0 - :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Typical Value Francis = 0.97, Kaplan = 0.99. Default: 0.0 - :bgv0: Kaplan blade servo point 0 (Bgv0). Typical Value = 0. Default: 0.0 - :bgv1: Kaplan blade servo point 1 (Bgv1). Typical Value = 0. Default: 0.0 - :bgv2: Kaplan blade servo point 2 (Bgv2). Typical Value = 0. Typical Value Francis = 0, Kaplan = 0.1. Default: 0.0 - :bgv3: Kaplan blade servo point 3 (Bgv3). Typical Value = 0. Typical Value Francis = 0, Kaplan = 0.667. Default: 0.0 - :bgv4: Kaplan blade servo point 4 (Bgv4). Typical Value = 0. Typical Value Francis = 0, Kaplan = 0.9. Default: 0.0 - :bgv5: Kaplan blade servo point 5 (Bgv5). Typical Value = 0. Typical Value Francis = 0, Kaplan = 1. Default: 0.0 - :bmax: Maximum blade adjustment factor (Bmax). Typical Value = 0. Typical Value Francis = 0, Kaplan = 1.1276. Default: 0.0 - :tblade: Blade servo time constant (Tblade). Typical Value = 100. Default: 0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'tg': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 'uo': [cgmesProfile.DY.value, ], - 'uc': [cgmesProfile.DY.value, ], - 'gmax': [cgmesProfile.DY.value, ], - 'gmin': [cgmesProfile.DY.value, ], - 'rperm': [cgmesProfile.DY.value, ], - 'rtemp': [cgmesProfile.DY.value, ], - 'tr': [cgmesProfile.DY.value, ], - 'tw': [cgmesProfile.DY.value, ], - 'at': [cgmesProfile.DY.value, ], - 'dturb': [cgmesProfile.DY.value, ], - 'hdam': [cgmesProfile.DY.value, ], - 'qn1': [cgmesProfile.DY.value, ], - 'db1': [cgmesProfile.DY.value, ], - 'eps': [cgmesProfile.DY.value, ], - 'db2': [cgmesProfile.DY.value, ], - 'gv0': [cgmesProfile.DY.value, ], - 'pgv0': [cgmesProfile.DY.value, ], - 'gv1': [cgmesProfile.DY.value, ], - 'pgv1': [cgmesProfile.DY.value, ], - 'gv2': [cgmesProfile.DY.value, ], - 'pgv2': [cgmesProfile.DY.value, ], - 'gv3': [cgmesProfile.DY.value, ], - 'pgv3': [cgmesProfile.DY.value, ], - 'gv4': [cgmesProfile.DY.value, ], - 'pgv4': [cgmesProfile.DY.value, ], - 'gv5': [cgmesProfile.DY.value, ], - 'pgv5': [cgmesProfile.DY.value, ], - 'bgv0': [cgmesProfile.DY.value, ], - 'bgv1': [cgmesProfile.DY.value, ], - 'bgv2': [cgmesProfile.DY.value, ], - 'bgv3': [cgmesProfile.DY.value, ], - 'bgv4': [cgmesProfile.DY.value, ], - 'bgv5': [cgmesProfile.DY.value, ], - 'bmax': [cgmesProfile.DY.value, ], - 'tblade': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, tg = 0, tp = 0, uo = 0.0, uc = 0.0, gmax = 0.0, gmin = 0.0, rperm = 0, rtemp = 0, tr = 0, tw = 0, at = 0.0, dturb = 0.0, hdam = 0.0, qn1 = 0.0, db1 = 0.0, eps = 0.0, db2 = 0.0, gv0 = 0.0, pgv0 = 0.0, gv1 = 0.0, pgv1 = 0.0, gv2 = 0.0, pgv2 = 0.0, gv3 = 0.0, pgv3 = 0.0, gv4 = 0.0, pgv4 = 0.0, gv5 = 0.0, pgv5 = 0.0, bgv0 = 0.0, bgv1 = 0.0, bgv2 = 0.0, bgv3 = 0.0, bgv4 = 0.0, bgv5 = 0.0, bmax = 0.0, tblade = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.tg = tg - self.tp = tp - self.uo = uo - self.uc = uc - self.gmax = gmax - self.gmin = gmin - self.rperm = rperm - self.rtemp = rtemp - self.tr = tr - self.tw = tw - self.at = at - self.dturb = dturb - self.hdam = hdam - self.qn1 = qn1 - self.db1 = db1 - self.eps = eps - self.db2 = db2 - self.gv0 = gv0 - self.pgv0 = pgv0 - self.gv1 = gv1 - self.pgv1 = pgv1 - self.gv2 = gv2 - self.pgv2 = pgv2 - self.gv3 = gv3 - self.pgv3 = pgv3 - self.gv4 = gv4 - self.pgv4 = pgv4 - self.gv5 = gv5 - self.pgv5 = pgv5 - self.bgv0 = bgv0 - self.bgv1 = bgv1 - self.bgv2 = bgv2 - self.bgv3 = bgv3 - self.bgv4 = bgv4 - self.bgv5 = bgv5 - self.bmax = bmax - self.tblade = tblade - - def __str__(self): - str = 'class=GovHydro4\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydro4(TurbineGovernorDynamics): + """ + Hydro turbine and governor. Represents plants with straight-forward penstock configurations and hydraulic governors of traditional 'dashpot' type. This model can be used to represent simple, Francis, Pelton or Kaplan turbines. + + :at: Turbine gain (At). Typical Value = 1.2. Default: 0.0 + :bgv0: Kaplan blade servo point 0 (Bgv0). Typical Value = 0. Default: 0.0 + :bgv1: Kaplan blade servo point 1 (Bgv1). Typical Value = 0. Default: 0.0 + :bgv2: Kaplan blade servo point 2 (Bgv2). Typical Value = 0. Typical Value Francis = 0, Kaplan = 0.1. Default: 0.0 + :bgv3: Kaplan blade servo point 3 (Bgv3). Typical Value = 0. Typical Value Francis = 0, Kaplan = 0.667. Default: 0.0 + :bgv4: Kaplan blade servo point 4 (Bgv4). Typical Value = 0. Typical Value Francis = 0, Kaplan = 0.9. Default: 0.0 + :bgv5: Kaplan blade servo point 5 (Bgv5). Typical Value = 0. Typical Value Francis = 0, Kaplan = 1. Default: 0.0 + :bmax: Maximum blade adjustment factor (Bmax). Typical Value = 0. Typical Value Francis = 0, Kaplan = 1.1276. Default: 0.0 + :db1: Intentional deadband width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 + :db2: Unintentional dead-band (db2). Unit = MW. Typical Value = 0. Default: 0.0 + :dturb: Turbine damping factor (Dturb). Unit = delta P (PU of MWbase) / delta speed (PU). Typical Value = 0.5. Typical Value Francis = 1.1, Kaplan = 1.1. Default: 0.0 + :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 + :gmax: Maximum gate opening, PU of MWbase (Gmax). Typical Value = 1. Default: 0.0 + :gmin: Minimum gate opening, PU of MWbase (Gmin). Typical Value = 0. Default: 0.0 + :gv0: Nonlinear gain point 0, PU gv (Gv0). Typical Value = 0. Typical Value Francis = 0.1, Kaplan = 0.1. Default: 0.0 + :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Typical Value Francis = 0.4, Kaplan = 0.4. Default: 0.0 + :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Typical Value Francis = 0.5, Kaplan = 0.5. Default: 0.0 + :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Typical Value Francis = 0.7, Kaplan = 0.7. Default: 0.0 + :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Typical Value Francis = 0.8, Kaplan = 0.8. Default: 0.0 + :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Typical Value Francis = 0.9, Kaplan = 0.9. Default: 0.0 + :hdam: Head available at dam (hdam). Typical Value = 1. Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :pgv0: Nonlinear gain point 0, PU power (Pgv0). Typical Value = 0. Default: 0.0 + :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Typical Value Francis = 0.42, Kaplan = 0.35. Default: 0.0 + :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Typical Value Francis = 0.56, Kaplan = 0.468. Default: 0.0 + :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Typical Value Francis = 0.8, Kaplan = 0.796. Default: 0.0 + :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Typical Value Francis = 0.9, Kaplan = 0.917. Default: 0.0 + :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Typical Value Francis = 0.97, Kaplan = 0.99. Default: 0.0 + :qn1: No-load flow at nominal head (Qnl). Typical Value = 0.08. Typical Value Francis = 0, Kaplan = 0. Default: 0.0 + :rperm: Permanent droop (Rperm). Typical Value = 0.05. Default: 0.0 + :rtemp: Temporary droop (Rtemp). Typical Value = 0.3. Default: 0.0 + :tblade: Blade servo time constant (Tblade). Typical Value = 100. Default: 0.0 + :tg: Gate servo time constant (Tg) (>0). Typical Value = 0.5. Default: 0.0 + :tp: Pilot servo time constant (Tp). Typical Value = 0.1. Default: 0.0 + :tr: Dashpot time constant (Tr) (>0). Typical Value = 5. Default: 0.0 + :tw: Water inertia time constant (Tw) (>0). Typical Value = 1. Default: 0.0 + :uc: Max gate closing velocity (Uc). Typical Value = 0.2. Default: 0.0 + :uo: Max gate opening velocity (Uo). Typical Vlaue = 0.2. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "at": [Profile.DY.value, ], + "bgv0": [Profile.DY.value, ], + "bgv1": [Profile.DY.value, ], + "bgv2": [Profile.DY.value, ], + "bgv3": [Profile.DY.value, ], + "bgv4": [Profile.DY.value, ], + "bgv5": [Profile.DY.value, ], + "bmax": [Profile.DY.value, ], + "db1": [Profile.DY.value, ], + "db2": [Profile.DY.value, ], + "dturb": [Profile.DY.value, ], + "eps": [Profile.DY.value, ], + "gmax": [Profile.DY.value, ], + "gmin": [Profile.DY.value, ], + "gv0": [Profile.DY.value, ], + "gv1": [Profile.DY.value, ], + "gv2": [Profile.DY.value, ], + "gv3": [Profile.DY.value, ], + "gv4": [Profile.DY.value, ], + "gv5": [Profile.DY.value, ], + "hdam": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pgv0": [Profile.DY.value, ], + "pgv1": [Profile.DY.value, ], + "pgv2": [Profile.DY.value, ], + "pgv3": [Profile.DY.value, ], + "pgv4": [Profile.DY.value, ], + "pgv5": [Profile.DY.value, ], + "qn1": [Profile.DY.value, ], + "rperm": [Profile.DY.value, ], + "rtemp": [Profile.DY.value, ], + "tblade": [Profile.DY.value, ], + "tg": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + "tr": [Profile.DY.value, ], + "tw": [Profile.DY.value, ], + "uc": [Profile.DY.value, ], + "uo": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, at = 0.0, bgv0 = 0.0, bgv1 = 0.0, bgv2 = 0.0, bgv3 = 0.0, bgv4 = 0.0, bgv5 = 0.0, bmax = 0.0, db1 = 0.0, db2 = 0.0, dturb = 0.0, eps = 0.0, gmax = 0.0, gmin = 0.0, gv0 = 0.0, gv1 = 0.0, gv2 = 0.0, gv3 = 0.0, gv4 = 0.0, gv5 = 0.0, hdam = 0.0, mwbase = 0.0, pgv0 = 0.0, pgv1 = 0.0, pgv2 = 0.0, pgv3 = 0.0, pgv4 = 0.0, pgv5 = 0.0, qn1 = 0.0, rperm = 0.0, rtemp = 0.0, tblade = 0.0, tg = 0.0, tp = 0.0, tr = 0.0, tw = 0.0, uc = 0.0, uo = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.at = at + self.bgv0 = bgv0 + self.bgv1 = bgv1 + self.bgv2 = bgv2 + self.bgv3 = bgv3 + self.bgv4 = bgv4 + self.bgv5 = bgv5 + self.bmax = bmax + self.db1 = db1 + self.db2 = db2 + self.dturb = dturb + self.eps = eps + self.gmax = gmax + self.gmin = gmin + self.gv0 = gv0 + self.gv1 = gv1 + self.gv2 = gv2 + self.gv3 = gv3 + self.gv4 = gv4 + self.gv5 = gv5 + self.hdam = hdam + self.mwbase = mwbase + self.pgv0 = pgv0 + self.pgv1 = pgv1 + self.pgv2 = pgv2 + self.pgv3 = pgv3 + self.pgv4 = pgv4 + self.pgv5 = pgv5 + self.qn1 = qn1 + self.rperm = rperm + self.rtemp = rtemp + self.tblade = tblade + self.tg = tg + self.tp = tp + self.tr = tr + self.tw = tw + self.uc = uc + self.uo = uo + + def __str__(self): + str = "class=GovHydro4\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydroDD.py b/cimpy/cgmes_v2_4_15/GovHydroDD.py index 40c6ef9e..74a437ad 100644 --- a/cimpy/cgmes_v2_4_15/GovHydroDD.py +++ b/cimpy/cgmes_v2_4_15/GovHydroDD.py @@ -1,133 +1,135 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydroDD(TurbineGovernorDynamics): - ''' - Double derivative hydro governor and turbine. - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :pmax: Maximum gate opening, PU of MWbase (Pmax). Typical Value = 1. Default: 0.0 - :pmin: Minimum gate opening, PU of MWbase (Pmin). Typical Value = 0. Default: 0.0 - :r: Steady state droop (R). Typical Value = 0.05. Default: 0.0 - :td: Input filter time constant (Td). Typical Value = 0. Default: 0 - :tf: Washout time constant (Tf). Typical Value = 0.1. Default: 0 - :tp: Gate servo time constant (Tp). Typical Value = 0.35. Default: 0 - :velop: Maximum gate opening velocity (Velop). Unit = PU/sec. Typical Value = 0.09. Default: 0.0 - :velcl: Maximum gate closing velocity (Velcl). Unit = PU/sec. Typical Value = -0.14. Default: 0.0 - :k1: Single derivative gain (K1). Typical Value = 3.6. Default: 0.0 - :k2: Double derivative gain (K2). Typical Value = 0.2. Default: 0.0 - :ki: Integral gain (Ki). Typical Value = 1. Default: 0.0 - :kg: Gate servo gain (Kg). Typical Value = 3. Default: 0.0 - :tturb: Turbine time constant (Tturb) (note 3). Typical Value = 0.8. Default: 0 - :aturb: Turbine numerator multiplier (Aturb) (note 3). Typical Value = -1. Default: 0.0 - :bturb: Turbine denominator multiplier (Bturb) (note 3). Typical Value = 0.5. Default: 0.0 - :tt: Power feedback time constant (Tt). Typical Value = 0.02. Default: 0 - :db1: Intentional dead-band width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 - :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 - :db2: Unintentional dead-band (db2). Unit = MW. Typical Value = 0. Default: 0.0 - :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 - :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 - :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Default: 0.0 - :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 - :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 - :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 - :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 - :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 - :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 - :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 - :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 - :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 - :gmax: Maximum gate opening (Gmax). Typical Value = 0. Default: 0.0 - :gmin: Minimum gate opening (Gmin). Typical Value = 0. Default: 0.0 - :inputSignal: Input signal switch (Flag). true = Pe input is used false = feedback is received from CV. Flag is normally dependent on Tt. If Tf is zero, Flag is set to false. If Tf is not zero, Flag is set to true. Typical Value = true. Default: False - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - 'r': [cgmesProfile.DY.value, ], - 'td': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 'velop': [cgmesProfile.DY.value, ], - 'velcl': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kg': [cgmesProfile.DY.value, ], - 'tturb': [cgmesProfile.DY.value, ], - 'aturb': [cgmesProfile.DY.value, ], - 'bturb': [cgmesProfile.DY.value, ], - 'tt': [cgmesProfile.DY.value, ], - 'db1': [cgmesProfile.DY.value, ], - 'eps': [cgmesProfile.DY.value, ], - 'db2': [cgmesProfile.DY.value, ], - 'gv1': [cgmesProfile.DY.value, ], - 'pgv1': [cgmesProfile.DY.value, ], - 'gv2': [cgmesProfile.DY.value, ], - 'pgv2': [cgmesProfile.DY.value, ], - 'gv3': [cgmesProfile.DY.value, ], - 'pgv3': [cgmesProfile.DY.value, ], - 'gv4': [cgmesProfile.DY.value, ], - 'pgv4': [cgmesProfile.DY.value, ], - 'gv5': [cgmesProfile.DY.value, ], - 'pgv5': [cgmesProfile.DY.value, ], - 'gv6': [cgmesProfile.DY.value, ], - 'pgv6': [cgmesProfile.DY.value, ], - 'gmax': [cgmesProfile.DY.value, ], - 'gmin': [cgmesProfile.DY.value, ], - 'inputSignal': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, pmax = 0.0, pmin = 0.0, r = 0.0, td = 0, tf = 0, tp = 0, velop = 0.0, velcl = 0.0, k1 = 0.0, k2 = 0.0, ki = 0.0, kg = 0.0, tturb = 0, aturb = 0.0, bturb = 0.0, tt = 0, db1 = 0.0, eps = 0.0, db2 = 0.0, gv1 = 0.0, pgv1 = 0.0, gv2 = 0.0, pgv2 = 0.0, gv3 = 0.0, pgv3 = 0.0, gv4 = 0.0, pgv4 = 0.0, gv5 = 0.0, pgv5 = 0.0, gv6 = 0.0, pgv6 = 0.0, gmax = 0.0, gmin = 0.0, inputSignal = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.pmax = pmax - self.pmin = pmin - self.r = r - self.td = td - self.tf = tf - self.tp = tp - self.velop = velop - self.velcl = velcl - self.k1 = k1 - self.k2 = k2 - self.ki = ki - self.kg = kg - self.tturb = tturb - self.aturb = aturb - self.bturb = bturb - self.tt = tt - self.db1 = db1 - self.eps = eps - self.db2 = db2 - self.gv1 = gv1 - self.pgv1 = pgv1 - self.gv2 = gv2 - self.pgv2 = pgv2 - self.gv3 = gv3 - self.pgv3 = pgv3 - self.gv4 = gv4 - self.pgv4 = pgv4 - self.gv5 = gv5 - self.pgv5 = pgv5 - self.gv6 = gv6 - self.pgv6 = pgv6 - self.gmax = gmax - self.gmin = gmin - self.inputSignal = inputSignal - - def __str__(self): - str = 'class=GovHydroDD\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydroDD(TurbineGovernorDynamics): + """ + Double derivative hydro governor and turbine. + + :aturb: Turbine numerator multiplier (Aturb) (note 3). Typical Value = -1. Default: 0.0 + :bturb: Turbine denominator multiplier (Bturb) (note 3). Typical Value = 0.5. Default: 0.0 + :db1: Intentional dead-band width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 + :db2: Unintentional dead-band (db2). Unit = MW. Typical Value = 0. Default: 0.0 + :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 + :gmax: Maximum gate opening (Gmax). Typical Value = 0. Default: 0.0 + :gmin: Minimum gate opening (Gmin). Typical Value = 0. Default: 0.0 + :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 + :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Default: 0.0 + :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 + :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 + :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 + :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 + :inputSignal: Input signal switch (Flag). true = Pe input is used false = feedback is received from CV. Flag is normally dependent on Tt. If Tf is zero, Flag is set to false. If Tf is not zero, Flag is set to true. Typical Value = true. Default: False + :k1: Single derivative gain (K1). Typical Value = 3.6. Default: 0.0 + :k2: Double derivative gain (K2). Typical Value = 0.2. Default: 0.0 + :kg: Gate servo gain (Kg). Typical Value = 3. Default: 0.0 + :ki: Integral gain (Ki). Typical Value = 1. Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 + :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 + :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 + :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 + :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 + :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 + :pmax: Maximum gate opening, PU of MWbase (Pmax). Typical Value = 1. Default: 0.0 + :pmin: Minimum gate opening, PU of MWbase (Pmin). Typical Value = 0. Default: 0.0 + :r: Steady state droop (R). Typical Value = 0.05. Default: 0.0 + :td: Input filter time constant (Td). Typical Value = 0. Default: 0.0 + :tf: Washout time constant (Tf). Typical Value = 0.1. Default: 0.0 + :tp: Gate servo time constant (Tp). Typical Value = 0.35. Default: 0.0 + :tt: Power feedback time constant (Tt). Typical Value = 0.02. Default: 0.0 + :tturb: Turbine time constant (Tturb) (note 3). Typical Value = 0.8. Default: 0.0 + :velcl: Maximum gate closing velocity (Velcl). Unit = PU/sec. Typical Value = -0.14. Default: 0.0 + :velop: Maximum gate opening velocity (Velop). Unit = PU/sec. Typical Value = 0.09. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "aturb": [Profile.DY.value, ], + "bturb": [Profile.DY.value, ], + "db1": [Profile.DY.value, ], + "db2": [Profile.DY.value, ], + "eps": [Profile.DY.value, ], + "gmax": [Profile.DY.value, ], + "gmin": [Profile.DY.value, ], + "gv1": [Profile.DY.value, ], + "gv2": [Profile.DY.value, ], + "gv3": [Profile.DY.value, ], + "gv4": [Profile.DY.value, ], + "gv5": [Profile.DY.value, ], + "gv6": [Profile.DY.value, ], + "inputSignal": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "kg": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pgv1": [Profile.DY.value, ], + "pgv2": [Profile.DY.value, ], + "pgv3": [Profile.DY.value, ], + "pgv4": [Profile.DY.value, ], + "pgv5": [Profile.DY.value, ], + "pgv6": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "r": [Profile.DY.value, ], + "td": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + "tt": [Profile.DY.value, ], + "tturb": [Profile.DY.value, ], + "velcl": [Profile.DY.value, ], + "velop": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, aturb = 0.0, bturb = 0.0, db1 = 0.0, db2 = 0.0, eps = 0.0, gmax = 0.0, gmin = 0.0, gv1 = 0.0, gv2 = 0.0, gv3 = 0.0, gv4 = 0.0, gv5 = 0.0, gv6 = 0.0, inputSignal = False, k1 = 0.0, k2 = 0.0, kg = 0.0, ki = 0.0, mwbase = 0.0, pgv1 = 0.0, pgv2 = 0.0, pgv3 = 0.0, pgv4 = 0.0, pgv5 = 0.0, pgv6 = 0.0, pmax = 0.0, pmin = 0.0, r = 0.0, td = 0.0, tf = 0.0, tp = 0.0, tt = 0.0, tturb = 0.0, velcl = 0.0, velop = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.aturb = aturb + self.bturb = bturb + self.db1 = db1 + self.db2 = db2 + self.eps = eps + self.gmax = gmax + self.gmin = gmin + self.gv1 = gv1 + self.gv2 = gv2 + self.gv3 = gv3 + self.gv4 = gv4 + self.gv5 = gv5 + self.gv6 = gv6 + self.inputSignal = inputSignal + self.k1 = k1 + self.k2 = k2 + self.kg = kg + self.ki = ki + self.mwbase = mwbase + self.pgv1 = pgv1 + self.pgv2 = pgv2 + self.pgv3 = pgv3 + self.pgv4 = pgv4 + self.pgv5 = pgv5 + self.pgv6 = pgv6 + self.pmax = pmax + self.pmin = pmin + self.r = r + self.td = td + self.tf = tf + self.tp = tp + self.tt = tt + self.tturb = tturb + self.velcl = velcl + self.velop = velop + + def __str__(self): + str = "class=GovHydroDD\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydroFrancis.py b/cimpy/cgmes_v2_4_15/GovHydroFrancis.py index e97f1019..a215b267 100644 --- a/cimpy/cgmes_v2_4_15/GovHydroFrancis.py +++ b/cimpy/cgmes_v2_4_15/GovHydroFrancis.py @@ -1,109 +1,111 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydroFrancis(TurbineGovernorDynamics): - ''' - Detailed hydro unit - Francis model. This model can be used to represent three types of governors. A schematic of the hydraulic system of detailed hydro unit models, like Francis and Pelton, is provided in the DetailedHydroModelHydraulicSystem diagram. - - :am: Opening section S at the maximum efficiency (Am). Typical Value = 0.7. Default: 0.0 - :av0: Area of the surge tank (A). Unit = m. Typical Value = 30. Default: 0.0 - :av1: Area of the compensation tank (A). Unit = m. Typical Value = 700. Default: 0.0 - :bp: Droop (Bp). Typical Value = 0.05. Default: 0.0 - :db1: Intentional dead-band width (DB1). Unit = Hz. Typical Value = 0. Default: 0.0 - :etamax: Maximum efficiency (EtaMax). Typical Value = 1.05. Default: 0.0 - :governorControl: Governor control flag (Cflag). Typical Value = mechanicHydrolicTachoAccelerator. Default: None - :h1: Head of compensation chamber water level with respect to the level of penstock (H). Unit = m. Typical Value = 4. Default: 0.0 - :h2: Head of surge tank water level with respect to the level of penstock (H). Unit = m. Typical Value = 40. Default: 0.0 - :hn: Rated hydraulic head (H). Unit = m. Typical Value = 250. Default: 0.0 - :kc: Penstock loss coefficient (due to friction) (Kc). Typical Value = 0.025. Default: 0.0 - :kg: Water tunnel and surge chamber loss coefficient (due to friction) (Kg). Typical Value = 0.025. Default: 0.0 - :kt: Washout gain (Kt). Typical Value = 0.25. Default: 0.0 - :qc0: No-load turbine flow at nominal head (Qc0). Typical Value = 0.21. Default: 0.0 - :qn: Rated flow (Q). Unit = m/s. Typical Value = 40. Default: 0.0 - :ta: Derivative gain (Ta). Typical Value = 3. Default: 0 - :td: Washout time constant (Td). Typical Value = 3. Default: 0 - :ts: Gate servo time constant (Ts). Typical Value = 0.5. Default: 0 - :twnc: Water inertia time constant (Twnc). Typical Value = 1. Default: 0 - :twng: Water tunnel and surge chamber inertia time constant (Twng). Typical Value = 3. Default: 0 - :tx: Derivative feedback gain (Tx). Typical Value = 1. Default: 0 - :va: Maximum gate opening velocity (Va). Unit = PU/sec. Typical Value = 0.011. Default: 0.0 - :valvmax: Maximum gate opening (ValvMax). Typical Value = 1. Default: 0.0 - :valvmin: Minimum gate opening (ValvMin). Typical Value = 0. Default: 0.0 - :vc: Maximum gate closing velocity (Vc). Unit = PU/sec. Typical Value = -0.011. Default: 0.0 - :waterTunnelSurgeChamberSimulation: Water tunnel and surge chamber simulation (Tflag). true = enable of water tunnel and surge chamber simulation false = inhibit of water tunnel and surge chamber simulation. Typical Value = false. Default: False - :zsfc: Head of upper water level with respect to the level of penstock (Zsfc). Unit = m. Typical Value = 25. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'am': [cgmesProfile.DY.value, ], - 'av0': [cgmesProfile.DY.value, ], - 'av1': [cgmesProfile.DY.value, ], - 'bp': [cgmesProfile.DY.value, ], - 'db1': [cgmesProfile.DY.value, ], - 'etamax': [cgmesProfile.DY.value, ], - 'governorControl': [cgmesProfile.DY.value, ], - 'h1': [cgmesProfile.DY.value, ], - 'h2': [cgmesProfile.DY.value, ], - 'hn': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kg': [cgmesProfile.DY.value, ], - 'kt': [cgmesProfile.DY.value, ], - 'qc0': [cgmesProfile.DY.value, ], - 'qn': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'td': [cgmesProfile.DY.value, ], - 'ts': [cgmesProfile.DY.value, ], - 'twnc': [cgmesProfile.DY.value, ], - 'twng': [cgmesProfile.DY.value, ], - 'tx': [cgmesProfile.DY.value, ], - 'va': [cgmesProfile.DY.value, ], - 'valvmax': [cgmesProfile.DY.value, ], - 'valvmin': [cgmesProfile.DY.value, ], - 'vc': [cgmesProfile.DY.value, ], - 'waterTunnelSurgeChamberSimulation': [cgmesProfile.DY.value, ], - 'zsfc': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, am = 0.0, av0 = 0.0, av1 = 0.0, bp = 0.0, db1 = 0.0, etamax = 0.0, governorControl = None, h1 = 0.0, h2 = 0.0, hn = 0.0, kc = 0.0, kg = 0.0, kt = 0.0, qc0 = 0.0, qn = 0.0, ta = 0, td = 0, ts = 0, twnc = 0, twng = 0, tx = 0, va = 0.0, valvmax = 0.0, valvmin = 0.0, vc = 0.0, waterTunnelSurgeChamberSimulation = False, zsfc = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.am = am - self.av0 = av0 - self.av1 = av1 - self.bp = bp - self.db1 = db1 - self.etamax = etamax - self.governorControl = governorControl - self.h1 = h1 - self.h2 = h2 - self.hn = hn - self.kc = kc - self.kg = kg - self.kt = kt - self.qc0 = qc0 - self.qn = qn - self.ta = ta - self.td = td - self.ts = ts - self.twnc = twnc - self.twng = twng - self.tx = tx - self.va = va - self.valvmax = valvmax - self.valvmin = valvmin - self.vc = vc - self.waterTunnelSurgeChamberSimulation = waterTunnelSurgeChamberSimulation - self.zsfc = zsfc - - def __str__(self): - str = 'class=GovHydroFrancis\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydroFrancis(TurbineGovernorDynamics): + """ + Detailed hydro unit - Francis model. This model can be used to represent three types of governors. A schematic of the hydraulic system of detailed hydro unit models, like Francis and Pelton, is provided in the DetailedHydroModelHydraulicSystem diagram. + + :am: Opening section S at the maximum efficiency (Am). Typical Value = 0.7. Default: 0.0 + :av0: Area of the surge tank (A). Unit = m. Typical Value = 30. Default: 0.0 + :av1: Area of the compensation tank (A). Unit = m. Typical Value = 700. Default: 0.0 + :bp: Droop (Bp). Typical Value = 0.05. Default: 0.0 + :db1: Intentional dead-band width (DB1). Unit = Hz. Typical Value = 0. Default: 0.0 + :etamax: Maximum efficiency (EtaMax). Typical Value = 1.05. Default: 0.0 + :governorControl: Governor control flag (Cflag). Typical Value = mechanicHydrolicTachoAccelerator. Default: None + :h1: Head of compensation chamber water level with respect to the level of penstock (H). Unit = m. Typical Value = 4. Default: 0.0 + :h2: Head of surge tank water level with respect to the level of penstock (H). Unit = m. Typical Value = 40. Default: 0.0 + :hn: Rated hydraulic head (H). Unit = m. Typical Value = 250. Default: 0.0 + :kc: Penstock loss coefficient (due to friction) (Kc). Typical Value = 0.025. Default: 0.0 + :kg: Water tunnel and surge chamber loss coefficient (due to friction) (Kg). Typical Value = 0.025. Default: 0.0 + :kt: Washout gain (Kt). Typical Value = 0.25. Default: 0.0 + :qc0: No-load turbine flow at nominal head (Qc0). Typical Value = 0.21. Default: 0.0 + :qn: Rated flow (Q). Unit = m/s. Typical Value = 40. Default: 0.0 + :ta: Derivative gain (Ta). Typical Value = 3. Default: 0.0 + :td: Washout time constant (Td). Typical Value = 3. Default: 0.0 + :ts: Gate servo time constant (Ts). Typical Value = 0.5. Default: 0.0 + :twnc: Water inertia time constant (Twnc). Typical Value = 1. Default: 0.0 + :twng: Water tunnel and surge chamber inertia time constant (Twng). Typical Value = 3. Default: 0.0 + :tx: Derivative feedback gain (Tx). Typical Value = 1. Default: 0.0 + :va: Maximum gate opening velocity (Va). Unit = PU/sec. Typical Value = 0.011. Default: 0.0 + :valvmax: Maximum gate opening (ValvMax). Typical Value = 1. Default: 0.0 + :valvmin: Minimum gate opening (ValvMin). Typical Value = 0. Default: 0.0 + :vc: Maximum gate closing velocity (Vc). Unit = PU/sec. Typical Value = -0.011. Default: 0.0 + :waterTunnelSurgeChamberSimulation: Water tunnel and surge chamber simulation (Tflag). true = enable of water tunnel and surge chamber simulation false = inhibit of water tunnel and surge chamber simulation. Typical Value = false. Default: False + :zsfc: Head of upper water level with respect to the level of penstock (Zsfc). Unit = m. Typical Value = 25. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "am": [Profile.DY.value, ], + "av0": [Profile.DY.value, ], + "av1": [Profile.DY.value, ], + "bp": [Profile.DY.value, ], + "db1": [Profile.DY.value, ], + "etamax": [Profile.DY.value, ], + "governorControl": [Profile.DY.value, ], + "h1": [Profile.DY.value, ], + "h2": [Profile.DY.value, ], + "hn": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kg": [Profile.DY.value, ], + "kt": [Profile.DY.value, ], + "qc0": [Profile.DY.value, ], + "qn": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "td": [Profile.DY.value, ], + "ts": [Profile.DY.value, ], + "twnc": [Profile.DY.value, ], + "twng": [Profile.DY.value, ], + "tx": [Profile.DY.value, ], + "va": [Profile.DY.value, ], + "valvmax": [Profile.DY.value, ], + "valvmin": [Profile.DY.value, ], + "vc": [Profile.DY.value, ], + "waterTunnelSurgeChamberSimulation": [Profile.DY.value, ], + "zsfc": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, am = 0.0, av0 = 0.0, av1 = 0.0, bp = 0.0, db1 = 0.0, etamax = 0.0, governorControl = None, h1 = 0.0, h2 = 0.0, hn = 0.0, kc = 0.0, kg = 0.0, kt = 0.0, qc0 = 0.0, qn = 0.0, ta = 0.0, td = 0.0, ts = 0.0, twnc = 0.0, twng = 0.0, tx = 0.0, va = 0.0, valvmax = 0.0, valvmin = 0.0, vc = 0.0, waterTunnelSurgeChamberSimulation = False, zsfc = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.am = am + self.av0 = av0 + self.av1 = av1 + self.bp = bp + self.db1 = db1 + self.etamax = etamax + self.governorControl = governorControl + self.h1 = h1 + self.h2 = h2 + self.hn = hn + self.kc = kc + self.kg = kg + self.kt = kt + self.qc0 = qc0 + self.qn = qn + self.ta = ta + self.td = td + self.ts = ts + self.twnc = twnc + self.twng = twng + self.tx = tx + self.va = va + self.valvmax = valvmax + self.valvmin = valvmin + self.vc = vc + self.waterTunnelSurgeChamberSimulation = waterTunnelSurgeChamberSimulation + self.zsfc = zsfc + + def __str__(self): + str = "class=GovHydroFrancis\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydroIEEE0.py b/cimpy/cgmes_v2_4_15/GovHydroIEEE0.py index faa9b188..192cca9a 100644 --- a/cimpy/cgmes_v2_4_15/GovHydroIEEE0.py +++ b/cimpy/cgmes_v2_4_15/GovHydroIEEE0.py @@ -1,52 +1,54 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydroIEEE0(TurbineGovernorDynamics): - ''' - IEEE Simplified Hydro Governor-Turbine Model. Used for Mechanical-Hydraulic and Electro-Hydraulic turbine governors, with our without steam feedback. Typical values given are for Mechanical-Hydraulic. Ref - - :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 - :k: Governor gain (K. Default: 0.0 - :t1: Governor lag time constant (T1). Typical Value = 0.25. Default: 0 - :t2: Governor lead time constant (T2. Typical Value = 0. Default: 0 - :t3: Gate actuator time constant (T3). Typical Value = 0.1. Default: 0 - :t4: Water starting time (T4). Default: 0 - :pmax: Gate maximum (Pmax). Default: 0.0 - :pmin: Gate minimum (Pmin). Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, k = 0.0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, pmax = 0.0, pmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.k = k - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.pmax = pmax - self.pmin = pmin - - def __str__(self): - str = 'class=GovHydroIEEE0\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydroIEEE0(TurbineGovernorDynamics): + """ + IEEE Simplified Hydro Governor-Turbine Model. Used for Mechanical-Hydraulic and Electro-Hydraulic turbine governors, with our without steam feedback. Typical values given are for Mechanical-Hydraulic. Ref + + :k: Governor gain (K. Default: 0.0 + :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 + :pmax: Gate maximum (Pmax). Default: 0.0 + :pmin: Gate minimum (Pmin). Default: 0.0 + :t1: Governor lag time constant (T1). Typical Value = 0.25. Default: 0.0 + :t2: Governor lead time constant (T2. Typical Value = 0. Default: 0.0 + :t3: Gate actuator time constant (T3). Typical Value = 0.1. Default: 0.0 + :t4: Water starting time (T4). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, k = 0.0, mwbase = 0.0, pmax = 0.0, pmin = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.k = k + self.mwbase = mwbase + self.pmax = pmax + self.pmin = pmin + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + + def __str__(self): + str = "class=GovHydroIEEE0\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydroIEEE2.py b/cimpy/cgmes_v2_4_15/GovHydroIEEE2.py index ad0ed8e9..dcbf0a8b 100644 --- a/cimpy/cgmes_v2_4_15/GovHydroIEEE2.py +++ b/cimpy/cgmes_v2_4_15/GovHydroIEEE2.py @@ -1,106 +1,108 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydroIEEE2(TurbineGovernorDynamics): - ''' - IEEE hydro turbine governor model represents plants with straightforward penstock configurations and hydraulic-dashpot governors. Ref - - :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 - :tg: Gate servo time constant (Tg). Typical Value = 0.5. Default: 0 - :tp: Pilot servo valve time constant (Tp). Typical Value = 0.03. Default: 0 - :uo: Maximum gate opening velocity (Uo). Unit = PU/sec. Typical Value = 0.1. Default: 0.0 - :uc: Maximum gate closing velocity (Uc) (<0). Typical Value = -0.1. Default: 0.0 - :pmax: Maximum gate opening (Pmax). Typical Value = 1. Default: 0.0 - :pmin: Minimum gate opening (Pmin). Typical Value = 0. Default: 0.0 - :rperm: Permanent droop (Rperm). Typical Value = 0.05. Default: 0.0 - :rtemp: Temporary droop (Rtemp). Typical Value = 0.5. Default: 0.0 - :tr: Dashpot time constant (Tr). Typical Value = 12. Default: 0 - :tw: Water inertia time constant (Tw). Typical Value = 2. Default: 0 - :kturb: Turbine gain (Kturb). Typical Value = 1. Default: 0.0 - :aturb: Turbine numerator multiplier (Aturb). Typical Value = -1. Default: 0.0 - :bturb: Turbine denominator multiplier (Bturb). Typical Value = 0.5. Default: 0.0 - :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 - :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 - :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Default: 0.0 - :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 - :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 - :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 - :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 - :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 - :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 - :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 - :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 - :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'tg': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 'uo': [cgmesProfile.DY.value, ], - 'uc': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - 'rperm': [cgmesProfile.DY.value, ], - 'rtemp': [cgmesProfile.DY.value, ], - 'tr': [cgmesProfile.DY.value, ], - 'tw': [cgmesProfile.DY.value, ], - 'kturb': [cgmesProfile.DY.value, ], - 'aturb': [cgmesProfile.DY.value, ], - 'bturb': [cgmesProfile.DY.value, ], - 'gv1': [cgmesProfile.DY.value, ], - 'pgv1': [cgmesProfile.DY.value, ], - 'gv2': [cgmesProfile.DY.value, ], - 'pgv2': [cgmesProfile.DY.value, ], - 'gv3': [cgmesProfile.DY.value, ], - 'pgv3': [cgmesProfile.DY.value, ], - 'gv4': [cgmesProfile.DY.value, ], - 'pgv4': [cgmesProfile.DY.value, ], - 'gv5': [cgmesProfile.DY.value, ], - 'pgv5': [cgmesProfile.DY.value, ], - 'gv6': [cgmesProfile.DY.value, ], - 'pgv6': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, tg = 0, tp = 0, uo = 0.0, uc = 0.0, pmax = 0.0, pmin = 0.0, rperm = 0.0, rtemp = 0.0, tr = 0, tw = 0, kturb = 0.0, aturb = 0.0, bturb = 0.0, gv1 = 0.0, pgv1 = 0.0, gv2 = 0.0, pgv2 = 0.0, gv3 = 0.0, pgv3 = 0.0, gv4 = 0.0, pgv4 = 0.0, gv5 = 0.0, pgv5 = 0.0, gv6 = 0.0, pgv6 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.tg = tg - self.tp = tp - self.uo = uo - self.uc = uc - self.pmax = pmax - self.pmin = pmin - self.rperm = rperm - self.rtemp = rtemp - self.tr = tr - self.tw = tw - self.kturb = kturb - self.aturb = aturb - self.bturb = bturb - self.gv1 = gv1 - self.pgv1 = pgv1 - self.gv2 = gv2 - self.pgv2 = pgv2 - self.gv3 = gv3 - self.pgv3 = pgv3 - self.gv4 = gv4 - self.pgv4 = pgv4 - self.gv5 = gv5 - self.pgv5 = pgv5 - self.gv6 = gv6 - self.pgv6 = pgv6 - - def __str__(self): - str = 'class=GovHydroIEEE2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydroIEEE2(TurbineGovernorDynamics): + """ + IEEE hydro turbine governor model represents plants with straightforward penstock configurations and hydraulic-dashpot governors. Ref + + :aturb: Turbine numerator multiplier (Aturb). Typical Value = -1. Default: 0.0 + :bturb: Turbine denominator multiplier (Bturb). Typical Value = 0.5. Default: 0.0 + :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 + :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Default: 0.0 + :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 + :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 + :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 + :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 + :kturb: Turbine gain (Kturb). Typical Value = 1. Default: 0.0 + :mwbase: Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0 + :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 + :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 + :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 + :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 + :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 + :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 + :pmax: Maximum gate opening (Pmax). Typical Value = 1. Default: 0.0 + :pmin: Minimum gate opening (Pmin). Typical Value = 0. Default: 0.0 + :rperm: Permanent droop (Rperm). Typical Value = 0.05. Default: 0.0 + :rtemp: Temporary droop (Rtemp). Typical Value = 0.5. Default: 0.0 + :tg: Gate servo time constant (Tg). Typical Value = 0.5. Default: 0.0 + :tp: Pilot servo valve time constant (Tp). Typical Value = 0.03. Default: 0.0 + :tr: Dashpot time constant (Tr). Typical Value = 12. Default: 0.0 + :tw: Water inertia time constant (Tw). Typical Value = 2. Default: 0.0 + :uc: Maximum gate closing velocity (Uc) (<0). Typical Value = -0.1. Default: 0.0 + :uo: Maximum gate opening velocity (Uo). Unit = PU/sec. Typical Value = 0.1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "aturb": [Profile.DY.value, ], + "bturb": [Profile.DY.value, ], + "gv1": [Profile.DY.value, ], + "gv2": [Profile.DY.value, ], + "gv3": [Profile.DY.value, ], + "gv4": [Profile.DY.value, ], + "gv5": [Profile.DY.value, ], + "gv6": [Profile.DY.value, ], + "kturb": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pgv1": [Profile.DY.value, ], + "pgv2": [Profile.DY.value, ], + "pgv3": [Profile.DY.value, ], + "pgv4": [Profile.DY.value, ], + "pgv5": [Profile.DY.value, ], + "pgv6": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "rperm": [Profile.DY.value, ], + "rtemp": [Profile.DY.value, ], + "tg": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + "tr": [Profile.DY.value, ], + "tw": [Profile.DY.value, ], + "uc": [Profile.DY.value, ], + "uo": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, aturb = 0.0, bturb = 0.0, gv1 = 0.0, gv2 = 0.0, gv3 = 0.0, gv4 = 0.0, gv5 = 0.0, gv6 = 0.0, kturb = 0.0, mwbase = 0.0, pgv1 = 0.0, pgv2 = 0.0, pgv3 = 0.0, pgv4 = 0.0, pgv5 = 0.0, pgv6 = 0.0, pmax = 0.0, pmin = 0.0, rperm = 0.0, rtemp = 0.0, tg = 0.0, tp = 0.0, tr = 0.0, tw = 0.0, uc = 0.0, uo = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.aturb = aturb + self.bturb = bturb + self.gv1 = gv1 + self.gv2 = gv2 + self.gv3 = gv3 + self.gv4 = gv4 + self.gv5 = gv5 + self.gv6 = gv6 + self.kturb = kturb + self.mwbase = mwbase + self.pgv1 = pgv1 + self.pgv2 = pgv2 + self.pgv3 = pgv3 + self.pgv4 = pgv4 + self.pgv5 = pgv5 + self.pgv6 = pgv6 + self.pmax = pmax + self.pmin = pmin + self.rperm = rperm + self.rtemp = rtemp + self.tg = tg + self.tp = tp + self.tr = tr + self.tw = tw + self.uc = uc + self.uo = uo + + def __str__(self): + str = "class=GovHydroIEEE2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydroPID.py b/cimpy/cgmes_v2_4_15/GovHydroPID.py index 02f74016..d97101d6 100644 --- a/cimpy/cgmes_v2_4_15/GovHydroPID.py +++ b/cimpy/cgmes_v2_4_15/GovHydroPID.py @@ -1,127 +1,129 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydroPID(TurbineGovernorDynamics): - ''' - PID governor and turbine. - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :pmax: Maximum gate opening, PU of MWbase (Pmax). Typical Value = 1. Default: 0.0 - :pmin: Minimum gate opening, PU of MWbase (Pmin). Typical Value = 0. Default: 0.0 - :r: Steady state droop (R). Typical Value = 0.05. Default: 0.0 - :td: Input filter time constant (Td). Typical Value = 0. Default: 0 - :tf: Washout time constant (Tf). Typical Value = 0.1. Default: 0 - :tp: Gate servo time constant (Tp). Typical Value = 0.35. Default: 0 - :velop: Maximum gate opening velocity (Velop). Unit = PU/sec. Typical Value = 0.09. Default: 0.0 - :velcl: Maximum gate closing velocity (Velcl). Unit = PU/sec. Typical Value = -0.14. Default: 0.0 - :kd: Derivative gain (Kd). Typical Value = 1.11. Default: 0.0 - :kp: Proportional gain (Kp). Typical Value = 0.1. Default: 0.0 - :ki: Integral gain (Ki). Typical Value = 0.36. Default: 0.0 - :kg: Gate servo gain (Kg). Typical Value = 2.5. Default: 0.0 - :tturb: Turbine time constant (Tturb) (note 3). Typical Value = 0.8. Default: 0 - :aturb: Turbine numerator multiplier (Aturb) (note 3). Typical Value -1. Default: 0.0 - :bturb: Turbine denominator multiplier (Bturb) (note 3). Typical Value = 0.5. Default: 0.0 - :tt: Power feedback time constant (Tt). Typical Value = 0.02. Default: 0 - :db1: Intentional dead-band width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 - :inputSignal: Input signal switch (Flag). true = Pe input is used false = feedback is received from CV. Flag is normally dependent on Tt. If Tf is zero, Flag is set to false. If Tf is not zero, Flag is set to true. Typical Value = true. Default: False - :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 - :db2: Unintentional dead-band (db2). Unit = MW. Typical Value = 0. Default: 0.0 - :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 - :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 - :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Default: 0.0 - :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 - :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 - :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 - :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 - :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 - :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 - :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 - :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 - :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - 'r': [cgmesProfile.DY.value, ], - 'td': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 'velop': [cgmesProfile.DY.value, ], - 'velcl': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kg': [cgmesProfile.DY.value, ], - 'tturb': [cgmesProfile.DY.value, ], - 'aturb': [cgmesProfile.DY.value, ], - 'bturb': [cgmesProfile.DY.value, ], - 'tt': [cgmesProfile.DY.value, ], - 'db1': [cgmesProfile.DY.value, ], - 'inputSignal': [cgmesProfile.DY.value, ], - 'eps': [cgmesProfile.DY.value, ], - 'db2': [cgmesProfile.DY.value, ], - 'gv1': [cgmesProfile.DY.value, ], - 'pgv1': [cgmesProfile.DY.value, ], - 'gv2': [cgmesProfile.DY.value, ], - 'pgv2': [cgmesProfile.DY.value, ], - 'gv3': [cgmesProfile.DY.value, ], - 'pgv3': [cgmesProfile.DY.value, ], - 'gv4': [cgmesProfile.DY.value, ], - 'pgv4': [cgmesProfile.DY.value, ], - 'gv5': [cgmesProfile.DY.value, ], - 'pgv5': [cgmesProfile.DY.value, ], - 'gv6': [cgmesProfile.DY.value, ], - 'pgv6': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, pmax = 0.0, pmin = 0.0, r = 0.0, td = 0, tf = 0, tp = 0, velop = 0.0, velcl = 0.0, kd = 0.0, kp = 0.0, ki = 0.0, kg = 0.0, tturb = 0, aturb = 0.0, bturb = 0.0, tt = 0, db1 = 0.0, inputSignal = False, eps = 0.0, db2 = 0.0, gv1 = 0.0, pgv1 = 0.0, gv2 = 0.0, pgv2 = 0.0, gv3 = 0.0, pgv3 = 0.0, gv4 = 0.0, pgv4 = 0.0, gv5 = 0.0, pgv5 = 0.0, gv6 = 0.0, pgv6 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.pmax = pmax - self.pmin = pmin - self.r = r - self.td = td - self.tf = tf - self.tp = tp - self.velop = velop - self.velcl = velcl - self.kd = kd - self.kp = kp - self.ki = ki - self.kg = kg - self.tturb = tturb - self.aturb = aturb - self.bturb = bturb - self.tt = tt - self.db1 = db1 - self.inputSignal = inputSignal - self.eps = eps - self.db2 = db2 - self.gv1 = gv1 - self.pgv1 = pgv1 - self.gv2 = gv2 - self.pgv2 = pgv2 - self.gv3 = gv3 - self.pgv3 = pgv3 - self.gv4 = gv4 - self.pgv4 = pgv4 - self.gv5 = gv5 - self.pgv5 = pgv5 - self.gv6 = gv6 - self.pgv6 = pgv6 - - def __str__(self): - str = 'class=GovHydroPID\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydroPID(TurbineGovernorDynamics): + """ + PID governor and turbine. + + :aturb: Turbine numerator multiplier (Aturb) (note 3). Typical Value -1. Default: 0.0 + :bturb: Turbine denominator multiplier (Bturb) (note 3). Typical Value = 0.5. Default: 0.0 + :db1: Intentional dead-band width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 + :db2: Unintentional dead-band (db2). Unit = MW. Typical Value = 0. Default: 0.0 + :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 + :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 + :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Default: 0.0 + :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 + :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 + :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 + :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 + :inputSignal: Input signal switch (Flag). true = Pe input is used false = feedback is received from CV. Flag is normally dependent on Tt. If Tf is zero, Flag is set to false. If Tf is not zero, Flag is set to true. Typical Value = true. Default: False + :kd: Derivative gain (Kd). Typical Value = 1.11. Default: 0.0 + :kg: Gate servo gain (Kg). Typical Value = 2.5. Default: 0.0 + :ki: Integral gain (Ki). Typical Value = 0.36. Default: 0.0 + :kp: Proportional gain (Kp). Typical Value = 0.1. Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 + :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 + :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 + :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 + :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 + :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 + :pmax: Maximum gate opening, PU of MWbase (Pmax). Typical Value = 1. Default: 0.0 + :pmin: Minimum gate opening, PU of MWbase (Pmin). Typical Value = 0. Default: 0.0 + :r: Steady state droop (R). Typical Value = 0.05. Default: 0.0 + :td: Input filter time constant (Td). Typical Value = 0. Default: 0.0 + :tf: Washout time constant (Tf). Typical Value = 0.1. Default: 0.0 + :tp: Gate servo time constant (Tp). Typical Value = 0.35. Default: 0.0 + :tt: Power feedback time constant (Tt). Typical Value = 0.02. Default: 0.0 + :tturb: Turbine time constant (Tturb) (note 3). Typical Value = 0.8. Default: 0.0 + :velcl: Maximum gate closing velocity (Velcl). Unit = PU/sec. Typical Value = -0.14. Default: 0.0 + :velop: Maximum gate opening velocity (Velop). Unit = PU/sec. Typical Value = 0.09. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "aturb": [Profile.DY.value, ], + "bturb": [Profile.DY.value, ], + "db1": [Profile.DY.value, ], + "db2": [Profile.DY.value, ], + "eps": [Profile.DY.value, ], + "gv1": [Profile.DY.value, ], + "gv2": [Profile.DY.value, ], + "gv3": [Profile.DY.value, ], + "gv4": [Profile.DY.value, ], + "gv5": [Profile.DY.value, ], + "gv6": [Profile.DY.value, ], + "inputSignal": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "kg": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pgv1": [Profile.DY.value, ], + "pgv2": [Profile.DY.value, ], + "pgv3": [Profile.DY.value, ], + "pgv4": [Profile.DY.value, ], + "pgv5": [Profile.DY.value, ], + "pgv6": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "r": [Profile.DY.value, ], + "td": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + "tt": [Profile.DY.value, ], + "tturb": [Profile.DY.value, ], + "velcl": [Profile.DY.value, ], + "velop": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, aturb = 0.0, bturb = 0.0, db1 = 0.0, db2 = 0.0, eps = 0.0, gv1 = 0.0, gv2 = 0.0, gv3 = 0.0, gv4 = 0.0, gv5 = 0.0, gv6 = 0.0, inputSignal = False, kd = 0.0, kg = 0.0, ki = 0.0, kp = 0.0, mwbase = 0.0, pgv1 = 0.0, pgv2 = 0.0, pgv3 = 0.0, pgv4 = 0.0, pgv5 = 0.0, pgv6 = 0.0, pmax = 0.0, pmin = 0.0, r = 0.0, td = 0.0, tf = 0.0, tp = 0.0, tt = 0.0, tturb = 0.0, velcl = 0.0, velop = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.aturb = aturb + self.bturb = bturb + self.db1 = db1 + self.db2 = db2 + self.eps = eps + self.gv1 = gv1 + self.gv2 = gv2 + self.gv3 = gv3 + self.gv4 = gv4 + self.gv5 = gv5 + self.gv6 = gv6 + self.inputSignal = inputSignal + self.kd = kd + self.kg = kg + self.ki = ki + self.kp = kp + self.mwbase = mwbase + self.pgv1 = pgv1 + self.pgv2 = pgv2 + self.pgv3 = pgv3 + self.pgv4 = pgv4 + self.pgv5 = pgv5 + self.pgv6 = pgv6 + self.pmax = pmax + self.pmin = pmin + self.r = r + self.td = td + self.tf = tf + self.tp = tp + self.tt = tt + self.tturb = tturb + self.velcl = velcl + self.velop = velop + + def __str__(self): + str = "class=GovHydroPID\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydroPID2.py b/cimpy/cgmes_v2_4_15/GovHydroPID2.py index 0a273ee6..5adfea50 100644 --- a/cimpy/cgmes_v2_4_15/GovHydroPID2.py +++ b/cimpy/cgmes_v2_4_15/GovHydroPID2.py @@ -1,94 +1,96 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydroPID2(TurbineGovernorDynamics): - ''' - Hydro turbine and governor. Represents plants with straight forward penstock configurations and "three term" electro-hydraulic governors (i.e. Woodard electronic). - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :treg: Speed detector time constant (Treg). Typical Value = 0. Default: 0 - :rperm: Permanent drop (Rperm). Typical Value = 0. Default: 0.0 - :kp: Proportional gain (Kp). Typical Value = 0. Default: 0.0 - :ki: Reset gain (Ki). Unit = PU/ sec. Typical Value = 0. Default: 0.0 - :kd: Derivative gain (Kd). Typical Value = 0. Default: 0.0 - :ta: Controller time constant (Ta) (>0). Typical Value = 0. Default: 0 - :tb: Gate servo time constant (Tb) (>0). Typical Value = 0. Default: 0 - :velmax: Maximum gate opening velocity (Velmax). Unit = PU/sec. Typical Value = 0. Default: 0.0 - :velmin: Maximum gate closing velocity (Velmin). Unit = PU/sec. Typical Value = 0. Default: 0.0 - :gmax: Maximum gate opening (Gmax). Typical Value = 0. Default: 0.0 - :gmin: Minimum gate opening (Gmin). Typical Value = 0. Default: 0.0 - :tw: Water inertia time constant (Tw) (>0). Typical Value = 0. Default: 0 - :d: Turbine damping factor (D). Unit = delta P / delta speed. Typical Value = 0. Default: 0.0 - :g0: Gate opening at speed no load (G0). Typical Value = 0. Default: 0.0 - :g1: Intermediate gate opening (G1). Typical Value = 0. Default: 0.0 - :p1: Power at gate opening G1 (P1). Typical Value = 0. Default: 0.0 - :g2: Intermediate gate opening (G2). Typical Value = 0. Default: 0.0 - :p2: Power at gate opening G2 (P2). Typical Value = 0. Default: 0.0 - :p3: Power at full opened gate (P3). Typical Value = 0. Default: 0.0 - :atw: Factor multiplying Tw (Atw). Typical Value = 0. Default: 0.0 - :feedbackSignal: Feedback signal type flag (Flag). true = use gate position feedback signal false = use Pe. Default: False - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'treg': [cgmesProfile.DY.value, ], - 'rperm': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'velmax': [cgmesProfile.DY.value, ], - 'velmin': [cgmesProfile.DY.value, ], - 'gmax': [cgmesProfile.DY.value, ], - 'gmin': [cgmesProfile.DY.value, ], - 'tw': [cgmesProfile.DY.value, ], - 'd': [cgmesProfile.DY.value, ], - 'g0': [cgmesProfile.DY.value, ], - 'g1': [cgmesProfile.DY.value, ], - 'p1': [cgmesProfile.DY.value, ], - 'g2': [cgmesProfile.DY.value, ], - 'p2': [cgmesProfile.DY.value, ], - 'p3': [cgmesProfile.DY.value, ], - 'atw': [cgmesProfile.DY.value, ], - 'feedbackSignal': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, treg = 0, rperm = 0.0, kp = 0.0, ki = 0.0, kd = 0.0, ta = 0, tb = 0, velmax = 0.0, velmin = 0.0, gmax = 0.0, gmin = 0.0, tw = 0, d = 0.0, g0 = 0.0, g1 = 0.0, p1 = 0.0, g2 = 0.0, p2 = 0.0, p3 = 0.0, atw = 0.0, feedbackSignal = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.treg = treg - self.rperm = rperm - self.kp = kp - self.ki = ki - self.kd = kd - self.ta = ta - self.tb = tb - self.velmax = velmax - self.velmin = velmin - self.gmax = gmax - self.gmin = gmin - self.tw = tw - self.d = d - self.g0 = g0 - self.g1 = g1 - self.p1 = p1 - self.g2 = g2 - self.p2 = p2 - self.p3 = p3 - self.atw = atw - self.feedbackSignal = feedbackSignal - - def __str__(self): - str = 'class=GovHydroPID2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydroPID2(TurbineGovernorDynamics): + """ + Hydro turbine and governor. Represents plants with straight forward penstock configurations and "three term" electro-hydraulic governors (i.e. Woodard electronic). + + :atw: Factor multiplying Tw (Atw). Typical Value = 0. Default: 0.0 + :d: Turbine damping factor (D). Unit = delta P / delta speed. Typical Value = 0. Default: 0.0 + :feedbackSignal: Feedback signal type flag (Flag). true = use gate position feedback signal false = use Pe. Default: False + :g0: Gate opening at speed no load (G0). Typical Value = 0. Default: 0.0 + :g1: Intermediate gate opening (G1). Typical Value = 0. Default: 0.0 + :g2: Intermediate gate opening (G2). Typical Value = 0. Default: 0.0 + :gmax: Maximum gate opening (Gmax). Typical Value = 0. Default: 0.0 + :gmin: Minimum gate opening (Gmin). Typical Value = 0. Default: 0.0 + :kd: Derivative gain (Kd). Typical Value = 0. Default: 0.0 + :ki: Reset gain (Ki). Unit = PU/ sec. Typical Value = 0. Default: 0.0 + :kp: Proportional gain (Kp). Typical Value = 0. Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :p1: Power at gate opening G1 (P1). Typical Value = 0. Default: 0.0 + :p2: Power at gate opening G2 (P2). Typical Value = 0. Default: 0.0 + :p3: Power at full opened gate (P3). Typical Value = 0. Default: 0.0 + :rperm: Permanent drop (Rperm). Typical Value = 0. Default: 0.0 + :ta: Controller time constant (Ta) (>0). Typical Value = 0. Default: 0.0 + :tb: Gate servo time constant (Tb) (>0). Typical Value = 0. Default: 0.0 + :treg: Speed detector time constant (Treg). Typical Value = 0. Default: 0.0 + :tw: Water inertia time constant (Tw) (>0). Typical Value = 0. Default: 0.0 + :velmax: Maximum gate opening velocity (Velmax). Unit = PU/sec. Typical Value = 0. Default: 0.0 + :velmin: Maximum gate closing velocity (Velmin). Unit = PU/sec. Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "atw": [Profile.DY.value, ], + "d": [Profile.DY.value, ], + "feedbackSignal": [Profile.DY.value, ], + "g0": [Profile.DY.value, ], + "g1": [Profile.DY.value, ], + "g2": [Profile.DY.value, ], + "gmax": [Profile.DY.value, ], + "gmin": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "p1": [Profile.DY.value, ], + "p2": [Profile.DY.value, ], + "p3": [Profile.DY.value, ], + "rperm": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "treg": [Profile.DY.value, ], + "tw": [Profile.DY.value, ], + "velmax": [Profile.DY.value, ], + "velmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, atw = 0.0, d = 0.0, feedbackSignal = False, g0 = 0.0, g1 = 0.0, g2 = 0.0, gmax = 0.0, gmin = 0.0, kd = 0.0, ki = 0.0, kp = 0.0, mwbase = 0.0, p1 = 0.0, p2 = 0.0, p3 = 0.0, rperm = 0.0, ta = 0.0, tb = 0.0, treg = 0.0, tw = 0.0, velmax = 0.0, velmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.atw = atw + self.d = d + self.feedbackSignal = feedbackSignal + self.g0 = g0 + self.g1 = g1 + self.g2 = g2 + self.gmax = gmax + self.gmin = gmin + self.kd = kd + self.ki = ki + self.kp = kp + self.mwbase = mwbase + self.p1 = p1 + self.p2 = p2 + self.p3 = p3 + self.rperm = rperm + self.ta = ta + self.tb = tb + self.treg = treg + self.tw = tw + self.velmax = velmax + self.velmin = velmin + + def __str__(self): + str = "class=GovHydroPID2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydroPelton.py b/cimpy/cgmes_v2_4_15/GovHydroPelton.py index c8b20367..75b40f55 100644 --- a/cimpy/cgmes_v2_4_15/GovHydroPelton.py +++ b/cimpy/cgmes_v2_4_15/GovHydroPelton.py @@ -1,112 +1,114 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydroPelton(TurbineGovernorDynamics): - ''' - Detailed hydro unit - Pelton model. This model can be used to represent the dynamic related to water tunnel and surge chamber. A schematic of the hydraulic system of detailed hydro unit models, like Francis and Pelton, is located under the GovHydroFrancis class. - - :av0: Area of the surge tank (A). Unit = m. Typical Value = 30. Default: 0.0 - :av1: Area of the compensation tank (A). Unit = m. Typical Value = 700. Default: 0.0 - :bp: Droop (bp). Typical Value = 0.05. Default: 0.0 - :db1: Intentional dead-band width (DB1). Unit = Hz. Typical Value = 0. Default: 0.0 - :db2: Intentional dead-band width of valve opening error (DB2). Unit = Hz. Typical Value = 0.01. Default: 0.0 - :h1: Head of compensation chamber water level with respect to the level of penstock (H). Unit = m. Typical Value = 4. Default: 0.0 - :h2: Head of surge tank water level with respect to the level of penstock (H). Unit = m. Typical Value = 40. Default: 0.0 - :hn: Rated hydraulic head (H). Unit = m. Typical Value = 250. Default: 0.0 - :kc: Penstock loss coefficient (due to friction) (Kc). Typical Value = 0.025. Default: 0.0 - :kg: Water tunnel and surge chamber loss coefficient (due to friction) (Kg). Typical Value = -0.025. Default: 0.0 - :qc0: No-load turbine flow at nominal head (Qc0). Typical Value = 0.05. Default: 0.0 - :qn: Rated flow (Q). Unit = m/s. Typical Value = 40. Default: 0.0 - :simplifiedPelton: Simplified Pelton model simulation (Sflag). true = enable of simplified Pelton model simulation false = enable of complete Pelton model simulation (non linear gain). Typical Value = false. Default: False - :staticCompensating: Static compensating characteristic (Cflag). true = enable of static compensating characteristic false = inhibit of static compensating characteristic. Typical Value = false. Default: False - :ta: Derivative gain (accelerometer time constant) (Ta). Typical Value = 3. Default: 0 - :ts: Gate servo time constant (Ts). Typical Value = 0.15. Default: 0 - :tv: Servomotor integrator time constant (TV). Typical Value = 0.3. Default: 0 - :twnc: Water inertia time constant (Twnc). Typical Value = 1. Default: 0 - :twng: Water tunnel and surge chamber inertia time constant (Twng). Typical Value = 3. Default: 0 - :tx: Electronic integrator time constant (Tx). Typical Value = 0.5. Default: 0 - :va: Maximum gate opening velocity (Va). Unit = PU/sec. Typical Value = 0.016. Default: 0.0 - :valvmax: Maximum gate opening (ValvMax). Typical Value = 1. Default: 0.0 - :valvmin: Minimum gate opening (ValvMin). Typical Value = 0. Default: 0.0 - :vav: Maximum servomotor valve opening velocity (Vav). Typical Value = 0.017. Default: 0.0 - :vc: Maximum gate closing velocity (Vc). Unit = PU/sec. Typical Value = -0.016. Default: 0.0 - :vcv: Maximum servomotor valve closing velocity (Vcv). Typical Value = -0.017. Default: 0.0 - :waterTunnelSurgeChamberSimulation: Water tunnel and surge chamber simulation (Tflag). true = enable of water tunnel and surge chamber simulation false = inhibit of water tunnel and surge chamber simulation. Typical Value = false. Default: False - :zsfc: Head of upper water level with respect to the level of penstock (Zsfc). Unit = m. Typical Value = 25. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'av0': [cgmesProfile.DY.value, ], - 'av1': [cgmesProfile.DY.value, ], - 'bp': [cgmesProfile.DY.value, ], - 'db1': [cgmesProfile.DY.value, ], - 'db2': [cgmesProfile.DY.value, ], - 'h1': [cgmesProfile.DY.value, ], - 'h2': [cgmesProfile.DY.value, ], - 'hn': [cgmesProfile.DY.value, ], - 'kc': [cgmesProfile.DY.value, ], - 'kg': [cgmesProfile.DY.value, ], - 'qc0': [cgmesProfile.DY.value, ], - 'qn': [cgmesProfile.DY.value, ], - 'simplifiedPelton': [cgmesProfile.DY.value, ], - 'staticCompensating': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'ts': [cgmesProfile.DY.value, ], - 'tv': [cgmesProfile.DY.value, ], - 'twnc': [cgmesProfile.DY.value, ], - 'twng': [cgmesProfile.DY.value, ], - 'tx': [cgmesProfile.DY.value, ], - 'va': [cgmesProfile.DY.value, ], - 'valvmax': [cgmesProfile.DY.value, ], - 'valvmin': [cgmesProfile.DY.value, ], - 'vav': [cgmesProfile.DY.value, ], - 'vc': [cgmesProfile.DY.value, ], - 'vcv': [cgmesProfile.DY.value, ], - 'waterTunnelSurgeChamberSimulation': [cgmesProfile.DY.value, ], - 'zsfc': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, av0 = 0.0, av1 = 0.0, bp = 0.0, db1 = 0.0, db2 = 0.0, h1 = 0.0, h2 = 0.0, hn = 0.0, kc = 0.0, kg = 0.0, qc0 = 0.0, qn = 0.0, simplifiedPelton = False, staticCompensating = False, ta = 0, ts = 0, tv = 0, twnc = 0, twng = 0, tx = 0, va = 0.0, valvmax = 0.0, valvmin = 0.0, vav = 0.0, vc = 0.0, vcv = 0.0, waterTunnelSurgeChamberSimulation = False, zsfc = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.av0 = av0 - self.av1 = av1 - self.bp = bp - self.db1 = db1 - self.db2 = db2 - self.h1 = h1 - self.h2 = h2 - self.hn = hn - self.kc = kc - self.kg = kg - self.qc0 = qc0 - self.qn = qn - self.simplifiedPelton = simplifiedPelton - self.staticCompensating = staticCompensating - self.ta = ta - self.ts = ts - self.tv = tv - self.twnc = twnc - self.twng = twng - self.tx = tx - self.va = va - self.valvmax = valvmax - self.valvmin = valvmin - self.vav = vav - self.vc = vc - self.vcv = vcv - self.waterTunnelSurgeChamberSimulation = waterTunnelSurgeChamberSimulation - self.zsfc = zsfc - - def __str__(self): - str = 'class=GovHydroPelton\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydroPelton(TurbineGovernorDynamics): + """ + Detailed hydro unit - Pelton model. This model can be used to represent the dynamic related to water tunnel and surge chamber. A schematic of the hydraulic system of detailed hydro unit models, like Francis and Pelton, is located under the GovHydroFrancis class. + + :av0: Area of the surge tank (A). Unit = m. Typical Value = 30. Default: 0.0 + :av1: Area of the compensation tank (A). Unit = m. Typical Value = 700. Default: 0.0 + :bp: Droop (bp). Typical Value = 0.05. Default: 0.0 + :db1: Intentional dead-band width (DB1). Unit = Hz. Typical Value = 0. Default: 0.0 + :db2: Intentional dead-band width of valve opening error (DB2). Unit = Hz. Typical Value = 0.01. Default: 0.0 + :h1: Head of compensation chamber water level with respect to the level of penstock (H). Unit = m. Typical Value = 4. Default: 0.0 + :h2: Head of surge tank water level with respect to the level of penstock (H). Unit = m. Typical Value = 40. Default: 0.0 + :hn: Rated hydraulic head (H). Unit = m. Typical Value = 250. Default: 0.0 + :kc: Penstock loss coefficient (due to friction) (Kc). Typical Value = 0.025. Default: 0.0 + :kg: Water tunnel and surge chamber loss coefficient (due to friction) (Kg). Typical Value = -0.025. Default: 0.0 + :qc0: No-load turbine flow at nominal head (Qc0). Typical Value = 0.05. Default: 0.0 + :qn: Rated flow (Q). Unit = m/s. Typical Value = 40. Default: 0.0 + :simplifiedPelton: Simplified Pelton model simulation (Sflag). true = enable of simplified Pelton model simulation false = enable of complete Pelton model simulation (non linear gain). Typical Value = false. Default: False + :staticCompensating: Static compensating characteristic (Cflag). true = enable of static compensating characteristic false = inhibit of static compensating characteristic. Typical Value = false. Default: False + :ta: Derivative gain (accelerometer time constant) (Ta). Typical Value = 3. Default: 0.0 + :ts: Gate servo time constant (Ts). Typical Value = 0.15. Default: 0.0 + :tv: Servomotor integrator time constant (TV). Typical Value = 0.3. Default: 0.0 + :twnc: Water inertia time constant (Twnc). Typical Value = 1. Default: 0.0 + :twng: Water tunnel and surge chamber inertia time constant (Twng). Typical Value = 3. Default: 0.0 + :tx: Electronic integrator time constant (Tx). Typical Value = 0.5. Default: 0.0 + :va: Maximum gate opening velocity (Va). Unit = PU/sec. Typical Value = 0.016. Default: 0.0 + :valvmax: Maximum gate opening (ValvMax). Typical Value = 1. Default: 0.0 + :valvmin: Minimum gate opening (ValvMin). Typical Value = 0. Default: 0.0 + :vav: Maximum servomotor valve opening velocity (Vav). Typical Value = 0.017. Default: 0.0 + :vc: Maximum gate closing velocity (Vc). Unit = PU/sec. Typical Value = -0.016. Default: 0.0 + :vcv: Maximum servomotor valve closing velocity (Vcv). Typical Value = -0.017. Default: 0.0 + :waterTunnelSurgeChamberSimulation: Water tunnel and surge chamber simulation (Tflag). true = enable of water tunnel and surge chamber simulation false = inhibit of water tunnel and surge chamber simulation. Typical Value = false. Default: False + :zsfc: Head of upper water level with respect to the level of penstock (Zsfc). Unit = m. Typical Value = 25. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "av0": [Profile.DY.value, ], + "av1": [Profile.DY.value, ], + "bp": [Profile.DY.value, ], + "db1": [Profile.DY.value, ], + "db2": [Profile.DY.value, ], + "h1": [Profile.DY.value, ], + "h2": [Profile.DY.value, ], + "hn": [Profile.DY.value, ], + "kc": [Profile.DY.value, ], + "kg": [Profile.DY.value, ], + "qc0": [Profile.DY.value, ], + "qn": [Profile.DY.value, ], + "simplifiedPelton": [Profile.DY.value, ], + "staticCompensating": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "ts": [Profile.DY.value, ], + "tv": [Profile.DY.value, ], + "twnc": [Profile.DY.value, ], + "twng": [Profile.DY.value, ], + "tx": [Profile.DY.value, ], + "va": [Profile.DY.value, ], + "valvmax": [Profile.DY.value, ], + "valvmin": [Profile.DY.value, ], + "vav": [Profile.DY.value, ], + "vc": [Profile.DY.value, ], + "vcv": [Profile.DY.value, ], + "waterTunnelSurgeChamberSimulation": [Profile.DY.value, ], + "zsfc": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, av0 = 0.0, av1 = 0.0, bp = 0.0, db1 = 0.0, db2 = 0.0, h1 = 0.0, h2 = 0.0, hn = 0.0, kc = 0.0, kg = 0.0, qc0 = 0.0, qn = 0.0, simplifiedPelton = False, staticCompensating = False, ta = 0.0, ts = 0.0, tv = 0.0, twnc = 0.0, twng = 0.0, tx = 0.0, va = 0.0, valvmax = 0.0, valvmin = 0.0, vav = 0.0, vc = 0.0, vcv = 0.0, waterTunnelSurgeChamberSimulation = False, zsfc = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.av0 = av0 + self.av1 = av1 + self.bp = bp + self.db1 = db1 + self.db2 = db2 + self.h1 = h1 + self.h2 = h2 + self.hn = hn + self.kc = kc + self.kg = kg + self.qc0 = qc0 + self.qn = qn + self.simplifiedPelton = simplifiedPelton + self.staticCompensating = staticCompensating + self.ta = ta + self.ts = ts + self.tv = tv + self.twnc = twnc + self.twng = twng + self.tx = tx + self.va = va + self.valvmax = valvmax + self.valvmin = valvmin + self.vav = vav + self.vc = vc + self.vcv = vcv + self.waterTunnelSurgeChamberSimulation = waterTunnelSurgeChamberSimulation + self.zsfc = zsfc + + def __str__(self): + str = "class=GovHydroPelton\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydroR.py b/cimpy/cgmes_v2_4_15/GovHydroR.py index b3e723aa..dd3e985f 100644 --- a/cimpy/cgmes_v2_4_15/GovHydroR.py +++ b/cimpy/cgmes_v2_4_15/GovHydroR.py @@ -1,154 +1,156 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydroR(TurbineGovernorDynamics): - ''' - Fourth order lead-lag governor and hydro turbine. - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :pmax: Maximum gate opening, PU of MWbase (Pmax). Typical Value = 1. Default: 0.0 - :pmin: Minimum gate opening, PU of MWbase (Pmin). Typical Value = 0. Default: 0.0 - :r: Steady-state droop (R). Typical Value = 0.05. Default: 0.0 - :td: Input filter time constant (Td). Typical Value = 0.05. Default: 0 - :t1: Lead time constant 1 (T1). Typical Value = 1.5. Default: 0 - :t2: Lag time constant 1 (T2). Typical Value = 0.1. Default: 0 - :t3: Lead time constant 2 (T3). Typical Value = 1.5. Default: 0 - :t4: Lag time constant 2 (T4). Typical Value = 0.1. Default: 0 - :t5: Lead time constant 3 (T5). Typical Value = 0. Default: 0 - :t6: Lag time constant 3 (T6). Typical Value = 0.05. Default: 0 - :t7: Lead time constant 4 (T7). Typical Value = 0. Default: 0 - :t8: Lag time constant 4 (T8). Typical Value = 0.05. Default: 0 - :tp: Gate servo time constant (Tp). Typical Value = 0.05. Default: 0 - :velop: Maximum gate opening velocity (Velop). Unit = PU/sec. Typical Value = 0.2. Default: 0.0 - :velcl: Maximum gate closing velocity (Velcl). Unit = PU/sec. Typical Value = -0.2. Default: 0.0 - :ki: Integral gain (Ki). Typical Value = 0.5. Default: 0.0 - :kg: Gate servo gain (Kg). Typical Value = 2. Default: 0.0 - :gmax: Maximum governor output (Gmax). Typical Value = 1.05. Default: 0.0 - :gmin: Minimum governor output (Gmin). Typical Value = -0.05. Default: 0.0 - :tt: Power feedback time constant (Tt). Typical Value = 0. Default: 0 - :inputSignal: Input signal switch (Flag). true = Pe input is used false = feedback is received from CV. Flag is normally dependent on Tt. If Tf is zero, Flag is set to false. If Tf is not zero, Flag is set to true. Typical Value = true. Default: False - :db1: Intentional dead-band width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 - :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 - :db2: Unintentional dead-band (db2). Unit = MW. Typical Value = 0. Default: 0.0 - :tw: Water inertia time constant (Tw). Typical Value = 1. Default: 0 - :at: Turbine gain (At). Typical Value = 1.2. Default: 0.0 - :dturb: Turbine damping factor (Dturb). Typical Value = 0.2. Default: 0.0 - :qnl: No-load turbine flow at nominal head (Qnl). Typical Value = 0.08. Default: 0.0 - :h0: Turbine nominal head (H0). Typical Value = 1. Default: 0.0 - :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 - :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 - :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Default: 0.0 - :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 - :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 - :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 - :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 - :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 - :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 - :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 - :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 - :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - 'r': [cgmesProfile.DY.value, ], - 'td': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 't7': [cgmesProfile.DY.value, ], - 't8': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 'velop': [cgmesProfile.DY.value, ], - 'velcl': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kg': [cgmesProfile.DY.value, ], - 'gmax': [cgmesProfile.DY.value, ], - 'gmin': [cgmesProfile.DY.value, ], - 'tt': [cgmesProfile.DY.value, ], - 'inputSignal': [cgmesProfile.DY.value, ], - 'db1': [cgmesProfile.DY.value, ], - 'eps': [cgmesProfile.DY.value, ], - 'db2': [cgmesProfile.DY.value, ], - 'tw': [cgmesProfile.DY.value, ], - 'at': [cgmesProfile.DY.value, ], - 'dturb': [cgmesProfile.DY.value, ], - 'qnl': [cgmesProfile.DY.value, ], - 'h0': [cgmesProfile.DY.value, ], - 'gv1': [cgmesProfile.DY.value, ], - 'pgv1': [cgmesProfile.DY.value, ], - 'gv2': [cgmesProfile.DY.value, ], - 'pgv2': [cgmesProfile.DY.value, ], - 'gv3': [cgmesProfile.DY.value, ], - 'pgv3': [cgmesProfile.DY.value, ], - 'gv4': [cgmesProfile.DY.value, ], - 'pgv4': [cgmesProfile.DY.value, ], - 'gv5': [cgmesProfile.DY.value, ], - 'pgv5': [cgmesProfile.DY.value, ], - 'gv6': [cgmesProfile.DY.value, ], - 'pgv6': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, pmax = 0.0, pmin = 0.0, r = 0.0, td = 0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, t5 = 0, t6 = 0, t7 = 0, t8 = 0, tp = 0, velop = 0.0, velcl = 0.0, ki = 0.0, kg = 0.0, gmax = 0.0, gmin = 0.0, tt = 0, inputSignal = False, db1 = 0.0, eps = 0.0, db2 = 0.0, tw = 0, at = 0.0, dturb = 0.0, qnl = 0.0, h0 = 0.0, gv1 = 0.0, pgv1 = 0.0, gv2 = 0.0, pgv2 = 0.0, gv3 = 0.0, pgv3 = 0.0, gv4 = 0.0, pgv4 = 0.0, gv5 = 0.0, pgv5 = 0.0, gv6 = 0.0, pgv6 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.pmax = pmax - self.pmin = pmin - self.r = r - self.td = td - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.t5 = t5 - self.t6 = t6 - self.t7 = t7 - self.t8 = t8 - self.tp = tp - self.velop = velop - self.velcl = velcl - self.ki = ki - self.kg = kg - self.gmax = gmax - self.gmin = gmin - self.tt = tt - self.inputSignal = inputSignal - self.db1 = db1 - self.eps = eps - self.db2 = db2 - self.tw = tw - self.at = at - self.dturb = dturb - self.qnl = qnl - self.h0 = h0 - self.gv1 = gv1 - self.pgv1 = pgv1 - self.gv2 = gv2 - self.pgv2 = pgv2 - self.gv3 = gv3 - self.pgv3 = pgv3 - self.gv4 = gv4 - self.pgv4 = pgv4 - self.gv5 = gv5 - self.pgv5 = pgv5 - self.gv6 = gv6 - self.pgv6 = pgv6 - - def __str__(self): - str = 'class=GovHydroR\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydroR(TurbineGovernorDynamics): + """ + Fourth order lead-lag governor and hydro turbine. + + :at: Turbine gain (At). Typical Value = 1.2. Default: 0.0 + :db1: Intentional dead-band width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 + :db2: Unintentional dead-band (db2). Unit = MW. Typical Value = 0. Default: 0.0 + :dturb: Turbine damping factor (Dturb). Typical Value = 0.2. Default: 0.0 + :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 + :gmax: Maximum governor output (Gmax). Typical Value = 1.05. Default: 0.0 + :gmin: Minimum governor output (Gmin). Typical Value = -0.05. Default: 0.0 + :gv1: Nonlinear gain point 1, PU gv (Gv1). Typical Value = 0. Default: 0.0 + :gv2: Nonlinear gain point 2, PU gv (Gv2). Typical Value = 0. Default: 0.0 + :gv3: Nonlinear gain point 3, PU gv (Gv3). Typical Value = 0. Default: 0.0 + :gv4: Nonlinear gain point 4, PU gv (Gv4). Typical Value = 0. Default: 0.0 + :gv5: Nonlinear gain point 5, PU gv (Gv5). Typical Value = 0. Default: 0.0 + :gv6: Nonlinear gain point 6, PU gv (Gv6). Typical Value = 0. Default: 0.0 + :h0: Turbine nominal head (H0). Typical Value = 1. Default: 0.0 + :inputSignal: Input signal switch (Flag). true = Pe input is used false = feedback is received from CV. Flag is normally dependent on Tt. If Tf is zero, Flag is set to false. If Tf is not zero, Flag is set to true. Typical Value = true. Default: False + :kg: Gate servo gain (Kg). Typical Value = 2. Default: 0.0 + :ki: Integral gain (Ki). Typical Value = 0.5. Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :pgv1: Nonlinear gain point 1, PU power (Pgv1). Typical Value = 0. Default: 0.0 + :pgv2: Nonlinear gain point 2, PU power (Pgv2). Typical Value = 0. Default: 0.0 + :pgv3: Nonlinear gain point 3, PU power (Pgv3). Typical Value = 0. Default: 0.0 + :pgv4: Nonlinear gain point 4, PU power (Pgv4). Typical Value = 0. Default: 0.0 + :pgv5: Nonlinear gain point 5, PU power (Pgv5). Typical Value = 0. Default: 0.0 + :pgv6: Nonlinear gain point 6, PU power (Pgv6). Typical Value = 0. Default: 0.0 + :pmax: Maximum gate opening, PU of MWbase (Pmax). Typical Value = 1. Default: 0.0 + :pmin: Minimum gate opening, PU of MWbase (Pmin). Typical Value = 0. Default: 0.0 + :qnl: No-load turbine flow at nominal head (Qnl). Typical Value = 0.08. Default: 0.0 + :r: Steady-state droop (R). Typical Value = 0.05. Default: 0.0 + :t1: Lead time constant 1 (T1). Typical Value = 1.5. Default: 0.0 + :t2: Lag time constant 1 (T2). Typical Value = 0.1. Default: 0.0 + :t3: Lead time constant 2 (T3). Typical Value = 1.5. Default: 0.0 + :t4: Lag time constant 2 (T4). Typical Value = 0.1. Default: 0.0 + :t5: Lead time constant 3 (T5). Typical Value = 0. Default: 0.0 + :t6: Lag time constant 3 (T6). Typical Value = 0.05. Default: 0.0 + :t7: Lead time constant 4 (T7). Typical Value = 0. Default: 0.0 + :t8: Lag time constant 4 (T8). Typical Value = 0.05. Default: 0.0 + :td: Input filter time constant (Td). Typical Value = 0.05. Default: 0.0 + :tp: Gate servo time constant (Tp). Typical Value = 0.05. Default: 0.0 + :tt: Power feedback time constant (Tt). Typical Value = 0. Default: 0.0 + :tw: Water inertia time constant (Tw). Typical Value = 1. Default: 0.0 + :velcl: Maximum gate closing velocity (Velcl). Unit = PU/sec. Typical Value = -0.2. Default: 0.0 + :velop: Maximum gate opening velocity (Velop). Unit = PU/sec. Typical Value = 0.2. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "at": [Profile.DY.value, ], + "db1": [Profile.DY.value, ], + "db2": [Profile.DY.value, ], + "dturb": [Profile.DY.value, ], + "eps": [Profile.DY.value, ], + "gmax": [Profile.DY.value, ], + "gmin": [Profile.DY.value, ], + "gv1": [Profile.DY.value, ], + "gv2": [Profile.DY.value, ], + "gv3": [Profile.DY.value, ], + "gv4": [Profile.DY.value, ], + "gv5": [Profile.DY.value, ], + "gv6": [Profile.DY.value, ], + "h0": [Profile.DY.value, ], + "inputSignal": [Profile.DY.value, ], + "kg": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pgv1": [Profile.DY.value, ], + "pgv2": [Profile.DY.value, ], + "pgv3": [Profile.DY.value, ], + "pgv4": [Profile.DY.value, ], + "pgv5": [Profile.DY.value, ], + "pgv6": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "qnl": [Profile.DY.value, ], + "r": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "t7": [Profile.DY.value, ], + "t8": [Profile.DY.value, ], + "td": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + "tt": [Profile.DY.value, ], + "tw": [Profile.DY.value, ], + "velcl": [Profile.DY.value, ], + "velop": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, at = 0.0, db1 = 0.0, db2 = 0.0, dturb = 0.0, eps = 0.0, gmax = 0.0, gmin = 0.0, gv1 = 0.0, gv2 = 0.0, gv3 = 0.0, gv4 = 0.0, gv5 = 0.0, gv6 = 0.0, h0 = 0.0, inputSignal = False, kg = 0.0, ki = 0.0, mwbase = 0.0, pgv1 = 0.0, pgv2 = 0.0, pgv3 = 0.0, pgv4 = 0.0, pgv5 = 0.0, pgv6 = 0.0, pmax = 0.0, pmin = 0.0, qnl = 0.0, r = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, t6 = 0.0, t7 = 0.0, t8 = 0.0, td = 0.0, tp = 0.0, tt = 0.0, tw = 0.0, velcl = 0.0, velop = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.at = at + self.db1 = db1 + self.db2 = db2 + self.dturb = dturb + self.eps = eps + self.gmax = gmax + self.gmin = gmin + self.gv1 = gv1 + self.gv2 = gv2 + self.gv3 = gv3 + self.gv4 = gv4 + self.gv5 = gv5 + self.gv6 = gv6 + self.h0 = h0 + self.inputSignal = inputSignal + self.kg = kg + self.ki = ki + self.mwbase = mwbase + self.pgv1 = pgv1 + self.pgv2 = pgv2 + self.pgv3 = pgv3 + self.pgv4 = pgv4 + self.pgv5 = pgv5 + self.pgv6 = pgv6 + self.pmax = pmax + self.pmin = pmin + self.qnl = qnl + self.r = r + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.t6 = t6 + self.t7 = t7 + self.t8 = t8 + self.td = td + self.tp = tp + self.tt = tt + self.tw = tw + self.velcl = velcl + self.velop = velop + + def __str__(self): + str = "class=GovHydroR\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydroWEH.py b/cimpy/cgmes_v2_4_15/GovHydroWEH.py index 7d80faaa..85339654 100644 --- a/cimpy/cgmes_v2_4_15/GovHydroWEH.py +++ b/cimpy/cgmes_v2_4_15/GovHydroWEH.py @@ -1,181 +1,183 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydroWEH(TurbineGovernorDynamics): - ''' - Woodward Electric Hydro Governor Model. - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :rpg: Permanent droop for governor output feedback (R-Perm-Gate). Default: 0.0 - :rpp: Permanent droop for electrical power feedback (R-Perm-Pe). Default: 0.0 - :tpe: Electrical power droop time constant (Tpe). Default: 0 - :kp: Derivative control gain (Kp). Default: 0.0 - :ki: Derivative controller Integral gain (Ki). Default: 0.0 - :kd: Derivative controller derivative gain (Kd). Default: 0.0 - :td: Derivative controller time constant to limit the derivative characteristic beyond a breakdown frequency to avoid amplification of high-frequency noise (Td). Default: 0 - :tp: Pilot Valve time lag time constant (Tp). Default: 0 - :tdv: Distributive Valve time lag time constant (Tdv). Default: 0 - :tg: Value to allow the Distribution valve controller to advance beyond the gate movement rate limit (Tg). Default: 0 - :gtmxop: Maximum gate opening rate (Gtmxop). Default: 0.0 - :gtmxcl: Maximum gate closing rate (Gtmxcl). Default: 0.0 - :gmax: Maximum Gate Position (Gmax). Default: 0.0 - :gmin: Minimum Gate Position (Gmin). Default: 0.0 - :dturb: Turbine damping factor (Dturb). Unit = delta P (PU of MWbase) / delta speed (PU). Default: 0.0 - :tw: Water inertia time constant (Tw) (>0). Default: 0 - :db: Speed Dead Band (db). Default: 0.0 - :dpv: Value to allow the Pilot valve controller to advance beyond the gate limits (Dpv). Default: 0.0 - :dicn: Value to allow the integral controller to advance beyond the gate limits (Dicn). Default: 0.0 - :feedbackSignal: Feedback signal selection (Sw). true = PID Output (if R-Perm-Gate=droop and R-Perm-Pe=0) false = Electrical Power (if R-Perm-Gate=0 and R-Perm-Pe=droop) or false = Gate Position (if R-Perm-Gate=droop and R-Perm-Pe=0). Default: False - :gv1: Gate 1 (Gv1). Gate Position value for point 1 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 - :gv2: Gate 2 (Gv2). Gate Position value for point 2 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 - :gv3: Gate 3 (Gv3). Gate Position value for point 3 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 - :gv4: Gate 4 (Gv4). Gate Position value for point 4 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 - :gv5: Gate 5 (Gv5). Gate Position value for point 5 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 - :fl1: Flow Gate 1 (Fl1). Flow value for gate position point 1 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 - :fl2: Flow Gate 2 (Fl2). Flow value for gate position point 2 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 - :fl3: Flow Gate 3 (Fl3). Flow value for gate position point 3 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 - :fl4: Flow Gate 4 (Fl4). Flow value for gate position point 4 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 - :fl5: Flow Gate 5 (Fl5). Flow value for gate position point 5 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 - :fp1: Flow P1 (Fp1). Turbine Flow value for point 1 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :fp2: Flow P2 (Fp2). Turbine Flow value for point 2 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :fp3: Flow P3 (Fp3). Turbine Flow value for point 3 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :fp4: Flow P4 (Fp4). Turbine Flow value for point 4 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :fp5: Flow P5 (Fp5). Turbine Flow value for point 5 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :fp6: Flow P6 (Fp6). Turbine Flow value for point 6 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :fp7: Flow P7 (Fp7). Turbine Flow value for point 7 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :fp8: Flow P8 (Fp8). Turbine Flow value for point 8 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :fp9: Flow P9 (Fp9). Turbine Flow value for point 9 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :fp10: Flow P10 (Fp10). Turbine Flow value for point 10 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :pmss1: Pmss Flow P1 (Pmss1). Mechanical Power output Pmss for Turbine Flow point 1 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :pmss2: Pmss Flow P2 (Pmss2). Mechanical Power output Pmss for Turbine Flow point 2 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :pmss3: Pmss Flow P3 (Pmss3). Mechanical Power output Pmss for Turbine Flow point 3 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :pmss4: Pmss Flow P4 (Pmss4). Mechanical Power output Pmss for Turbine Flow point 4 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :pmss5: Pmss Flow P5 (Pmss5). Mechanical Power output Pmss for Turbine Flow point 5 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :pmss6: Pmss Flow P6 (Pmss6). Mechanical Power output Pmss for Turbine Flow point 6 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :pmss7: Pmss Flow P7 (Pmss7). Mechanical Power output Pmss for Turbine Flow point 7 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :pmss8: Pmss Flow P8 (Pmss8). Mechanical Power output Pmss for Turbine Flow point 8 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :pmss9: Pmss Flow P9 (Pmss9). Mechanical Power output Pmss for Turbine Flow point 9 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - :pmss10: Pmss Flow P10 (Pmss10). Mechanical Power output Pmss for Turbine Flow point 10 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'rpg': [cgmesProfile.DY.value, ], - 'rpp': [cgmesProfile.DY.value, ], - 'tpe': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'td': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 'tdv': [cgmesProfile.DY.value, ], - 'tg': [cgmesProfile.DY.value, ], - 'gtmxop': [cgmesProfile.DY.value, ], - 'gtmxcl': [cgmesProfile.DY.value, ], - 'gmax': [cgmesProfile.DY.value, ], - 'gmin': [cgmesProfile.DY.value, ], - 'dturb': [cgmesProfile.DY.value, ], - 'tw': [cgmesProfile.DY.value, ], - 'db': [cgmesProfile.DY.value, ], - 'dpv': [cgmesProfile.DY.value, ], - 'dicn': [cgmesProfile.DY.value, ], - 'feedbackSignal': [cgmesProfile.DY.value, ], - 'gv1': [cgmesProfile.DY.value, ], - 'gv2': [cgmesProfile.DY.value, ], - 'gv3': [cgmesProfile.DY.value, ], - 'gv4': [cgmesProfile.DY.value, ], - 'gv5': [cgmesProfile.DY.value, ], - 'fl1': [cgmesProfile.DY.value, ], - 'fl2': [cgmesProfile.DY.value, ], - 'fl3': [cgmesProfile.DY.value, ], - 'fl4': [cgmesProfile.DY.value, ], - 'fl5': [cgmesProfile.DY.value, ], - 'fp1': [cgmesProfile.DY.value, ], - 'fp2': [cgmesProfile.DY.value, ], - 'fp3': [cgmesProfile.DY.value, ], - 'fp4': [cgmesProfile.DY.value, ], - 'fp5': [cgmesProfile.DY.value, ], - 'fp6': [cgmesProfile.DY.value, ], - 'fp7': [cgmesProfile.DY.value, ], - 'fp8': [cgmesProfile.DY.value, ], - 'fp9': [cgmesProfile.DY.value, ], - 'fp10': [cgmesProfile.DY.value, ], - 'pmss1': [cgmesProfile.DY.value, ], - 'pmss2': [cgmesProfile.DY.value, ], - 'pmss3': [cgmesProfile.DY.value, ], - 'pmss4': [cgmesProfile.DY.value, ], - 'pmss5': [cgmesProfile.DY.value, ], - 'pmss6': [cgmesProfile.DY.value, ], - 'pmss7': [cgmesProfile.DY.value, ], - 'pmss8': [cgmesProfile.DY.value, ], - 'pmss9': [cgmesProfile.DY.value, ], - 'pmss10': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, rpg = 0.0, rpp = 0.0, tpe = 0, kp = 0.0, ki = 0.0, kd = 0.0, td = 0, tp = 0, tdv = 0, tg = 0, gtmxop = 0.0, gtmxcl = 0.0, gmax = 0.0, gmin = 0.0, dturb = 0.0, tw = 0, db = 0.0, dpv = 0.0, dicn = 0.0, feedbackSignal = False, gv1 = 0.0, gv2 = 0.0, gv3 = 0.0, gv4 = 0.0, gv5 = 0.0, fl1 = 0.0, fl2 = 0.0, fl3 = 0.0, fl4 = 0.0, fl5 = 0.0, fp1 = 0.0, fp2 = 0.0, fp3 = 0.0, fp4 = 0.0, fp5 = 0.0, fp6 = 0.0, fp7 = 0.0, fp8 = 0.0, fp9 = 0.0, fp10 = 0.0, pmss1 = 0.0, pmss2 = 0.0, pmss3 = 0.0, pmss4 = 0.0, pmss5 = 0.0, pmss6 = 0.0, pmss7 = 0.0, pmss8 = 0.0, pmss9 = 0.0, pmss10 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.rpg = rpg - self.rpp = rpp - self.tpe = tpe - self.kp = kp - self.ki = ki - self.kd = kd - self.td = td - self.tp = tp - self.tdv = tdv - self.tg = tg - self.gtmxop = gtmxop - self.gtmxcl = gtmxcl - self.gmax = gmax - self.gmin = gmin - self.dturb = dturb - self.tw = tw - self.db = db - self.dpv = dpv - self.dicn = dicn - self.feedbackSignal = feedbackSignal - self.gv1 = gv1 - self.gv2 = gv2 - self.gv3 = gv3 - self.gv4 = gv4 - self.gv5 = gv5 - self.fl1 = fl1 - self.fl2 = fl2 - self.fl3 = fl3 - self.fl4 = fl4 - self.fl5 = fl5 - self.fp1 = fp1 - self.fp2 = fp2 - self.fp3 = fp3 - self.fp4 = fp4 - self.fp5 = fp5 - self.fp6 = fp6 - self.fp7 = fp7 - self.fp8 = fp8 - self.fp9 = fp9 - self.fp10 = fp10 - self.pmss1 = pmss1 - self.pmss2 = pmss2 - self.pmss3 = pmss3 - self.pmss4 = pmss4 - self.pmss5 = pmss5 - self.pmss6 = pmss6 - self.pmss7 = pmss7 - self.pmss8 = pmss8 - self.pmss9 = pmss9 - self.pmss10 = pmss10 - - def __str__(self): - str = 'class=GovHydroWEH\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydroWEH(TurbineGovernorDynamics): + """ + Woodward Electric Hydro Governor Model. + + :db: Speed Dead Band (db). Default: 0.0 + :dicn: Value to allow the integral controller to advance beyond the gate limits (Dicn). Default: 0.0 + :dpv: Value to allow the Pilot valve controller to advance beyond the gate limits (Dpv). Default: 0.0 + :dturb: Turbine damping factor (Dturb). Unit = delta P (PU of MWbase) / delta speed (PU). Default: 0.0 + :feedbackSignal: Feedback signal selection (Sw). true = PID Output (if R-Perm-Gate=droop and R-Perm-Pe=0) false = Electrical Power (if R-Perm-Gate=0 and R-Perm-Pe=droop) or false = Gate Position (if R-Perm-Gate=droop and R-Perm-Pe=0). Default: False + :fl1: Flow Gate 1 (Fl1). Flow value for gate position point 1 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 + :fl2: Flow Gate 2 (Fl2). Flow value for gate position point 2 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 + :fl3: Flow Gate 3 (Fl3). Flow value for gate position point 3 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 + :fl4: Flow Gate 4 (Fl4). Flow value for gate position point 4 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 + :fl5: Flow Gate 5 (Fl5). Flow value for gate position point 5 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 + :fp1: Flow P1 (Fp1). Turbine Flow value for point 1 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :fp10: Flow P10 (Fp10). Turbine Flow value for point 10 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :fp2: Flow P2 (Fp2). Turbine Flow value for point 2 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :fp3: Flow P3 (Fp3). Turbine Flow value for point 3 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :fp4: Flow P4 (Fp4). Turbine Flow value for point 4 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :fp5: Flow P5 (Fp5). Turbine Flow value for point 5 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :fp6: Flow P6 (Fp6). Turbine Flow value for point 6 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :fp7: Flow P7 (Fp7). Turbine Flow value for point 7 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :fp8: Flow P8 (Fp8). Turbine Flow value for point 8 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :fp9: Flow P9 (Fp9). Turbine Flow value for point 9 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :gmax: Maximum Gate Position (Gmax). Default: 0.0 + :gmin: Minimum Gate Position (Gmin). Default: 0.0 + :gtmxcl: Maximum gate closing rate (Gtmxcl). Default: 0.0 + :gtmxop: Maximum gate opening rate (Gtmxop). Default: 0.0 + :gv1: Gate 1 (Gv1). Gate Position value for point 1 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 + :gv2: Gate 2 (Gv2). Gate Position value for point 2 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 + :gv3: Gate 3 (Gv3). Gate Position value for point 3 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 + :gv4: Gate 4 (Gv4). Gate Position value for point 4 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 + :gv5: Gate 5 (Gv5). Gate Position value for point 5 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow. Default: 0.0 + :kd: Derivative controller derivative gain (Kd). Default: 0.0 + :ki: Derivative controller Integral gain (Ki). Default: 0.0 + :kp: Derivative control gain (Kp). Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :pmss1: Pmss Flow P1 (Pmss1). Mechanical Power output Pmss for Turbine Flow point 1 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :pmss10: Pmss Flow P10 (Pmss10). Mechanical Power output Pmss for Turbine Flow point 10 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :pmss2: Pmss Flow P2 (Pmss2). Mechanical Power output Pmss for Turbine Flow point 2 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :pmss3: Pmss Flow P3 (Pmss3). Mechanical Power output Pmss for Turbine Flow point 3 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :pmss4: Pmss Flow P4 (Pmss4). Mechanical Power output Pmss for Turbine Flow point 4 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :pmss5: Pmss Flow P5 (Pmss5). Mechanical Power output Pmss for Turbine Flow point 5 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :pmss6: Pmss Flow P6 (Pmss6). Mechanical Power output Pmss for Turbine Flow point 6 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :pmss7: Pmss Flow P7 (Pmss7). Mechanical Power output Pmss for Turbine Flow point 7 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :pmss8: Pmss Flow P8 (Pmss8). Mechanical Power output Pmss for Turbine Flow point 8 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :pmss9: Pmss Flow P9 (Pmss9). Mechanical Power output Pmss for Turbine Flow point 9 for lookup table representing per unit mechanical power on machine MVA rating as a function of turbine flow. Default: 0.0 + :rpg: Permanent droop for governor output feedback (R-Perm-Gate). Default: 0.0 + :rpp: Permanent droop for electrical power feedback (R-Perm-Pe). Default: 0.0 + :td: Derivative controller time constant to limit the derivative characteristic beyond a breakdown frequency to avoid amplification of high-frequency noise (Td). Default: 0.0 + :tdv: Distributive Valve time lag time constant (Tdv). Default: 0.0 + :tg: Value to allow the Distribution valve controller to advance beyond the gate movement rate limit (Tg). Default: 0.0 + :tp: Pilot Valve time lag time constant (Tp). Default: 0.0 + :tpe: Electrical power droop time constant (Tpe). Default: 0.0 + :tw: Water inertia time constant (Tw) (>0). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "db": [Profile.DY.value, ], + "dicn": [Profile.DY.value, ], + "dpv": [Profile.DY.value, ], + "dturb": [Profile.DY.value, ], + "feedbackSignal": [Profile.DY.value, ], + "fl1": [Profile.DY.value, ], + "fl2": [Profile.DY.value, ], + "fl3": [Profile.DY.value, ], + "fl4": [Profile.DY.value, ], + "fl5": [Profile.DY.value, ], + "fp1": [Profile.DY.value, ], + "fp10": [Profile.DY.value, ], + "fp2": [Profile.DY.value, ], + "fp3": [Profile.DY.value, ], + "fp4": [Profile.DY.value, ], + "fp5": [Profile.DY.value, ], + "fp6": [Profile.DY.value, ], + "fp7": [Profile.DY.value, ], + "fp8": [Profile.DY.value, ], + "fp9": [Profile.DY.value, ], + "gmax": [Profile.DY.value, ], + "gmin": [Profile.DY.value, ], + "gtmxcl": [Profile.DY.value, ], + "gtmxop": [Profile.DY.value, ], + "gv1": [Profile.DY.value, ], + "gv2": [Profile.DY.value, ], + "gv3": [Profile.DY.value, ], + "gv4": [Profile.DY.value, ], + "gv5": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pmss1": [Profile.DY.value, ], + "pmss10": [Profile.DY.value, ], + "pmss2": [Profile.DY.value, ], + "pmss3": [Profile.DY.value, ], + "pmss4": [Profile.DY.value, ], + "pmss5": [Profile.DY.value, ], + "pmss6": [Profile.DY.value, ], + "pmss7": [Profile.DY.value, ], + "pmss8": [Profile.DY.value, ], + "pmss9": [Profile.DY.value, ], + "rpg": [Profile.DY.value, ], + "rpp": [Profile.DY.value, ], + "td": [Profile.DY.value, ], + "tdv": [Profile.DY.value, ], + "tg": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + "tpe": [Profile.DY.value, ], + "tw": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, db = 0.0, dicn = 0.0, dpv = 0.0, dturb = 0.0, feedbackSignal = False, fl1 = 0.0, fl2 = 0.0, fl3 = 0.0, fl4 = 0.0, fl5 = 0.0, fp1 = 0.0, fp10 = 0.0, fp2 = 0.0, fp3 = 0.0, fp4 = 0.0, fp5 = 0.0, fp6 = 0.0, fp7 = 0.0, fp8 = 0.0, fp9 = 0.0, gmax = 0.0, gmin = 0.0, gtmxcl = 0.0, gtmxop = 0.0, gv1 = 0.0, gv2 = 0.0, gv3 = 0.0, gv4 = 0.0, gv5 = 0.0, kd = 0.0, ki = 0.0, kp = 0.0, mwbase = 0.0, pmss1 = 0.0, pmss10 = 0.0, pmss2 = 0.0, pmss3 = 0.0, pmss4 = 0.0, pmss5 = 0.0, pmss6 = 0.0, pmss7 = 0.0, pmss8 = 0.0, pmss9 = 0.0, rpg = 0.0, rpp = 0.0, td = 0.0, tdv = 0.0, tg = 0.0, tp = 0.0, tpe = 0.0, tw = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.db = db + self.dicn = dicn + self.dpv = dpv + self.dturb = dturb + self.feedbackSignal = feedbackSignal + self.fl1 = fl1 + self.fl2 = fl2 + self.fl3 = fl3 + self.fl4 = fl4 + self.fl5 = fl5 + self.fp1 = fp1 + self.fp10 = fp10 + self.fp2 = fp2 + self.fp3 = fp3 + self.fp4 = fp4 + self.fp5 = fp5 + self.fp6 = fp6 + self.fp7 = fp7 + self.fp8 = fp8 + self.fp9 = fp9 + self.gmax = gmax + self.gmin = gmin + self.gtmxcl = gtmxcl + self.gtmxop = gtmxop + self.gv1 = gv1 + self.gv2 = gv2 + self.gv3 = gv3 + self.gv4 = gv4 + self.gv5 = gv5 + self.kd = kd + self.ki = ki + self.kp = kp + self.mwbase = mwbase + self.pmss1 = pmss1 + self.pmss10 = pmss10 + self.pmss2 = pmss2 + self.pmss3 = pmss3 + self.pmss4 = pmss4 + self.pmss5 = pmss5 + self.pmss6 = pmss6 + self.pmss7 = pmss7 + self.pmss8 = pmss8 + self.pmss9 = pmss9 + self.rpg = rpg + self.rpp = rpp + self.td = td + self.tdv = tdv + self.tg = tg + self.tp = tp + self.tpe = tpe + self.tw = tw + + def __str__(self): + str = "class=GovHydroWEH\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovHydroWPID.py b/cimpy/cgmes_v2_4_15/GovHydroWPID.py index 2655cf5f..d556a7d8 100644 --- a/cimpy/cgmes_v2_4_15/GovHydroWPID.py +++ b/cimpy/cgmes_v2_4_15/GovHydroWPID.py @@ -1,94 +1,96 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovHydroWPID(TurbineGovernorDynamics): - ''' - Woodward PID Hydro Governor. - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :treg: Speed detector time constant (Treg). Default: 0 - :reg: Permanent drop (Reg). Default: 0.0 - :kp: Proportional gain (Kp). Typical Value = 0.1. Default: 0.0 - :ki: Reset gain (Ki). Typical Value = 0.36. Default: 0.0 - :kd: Derivative gain (Kd). Typical Value = 1.11. Default: 0.0 - :ta: Controller time constant (Ta) (>0). Typical Value = 0. Default: 0 - :tb: Gate servo time constant (Tb) (>0). Typical Value = 0. Default: 0 - :velmax: Maximum gate opening velocity (Velmax). Unit = PU/sec. Typical Value = 0. Default: 0.0 - :velmin: Maximum gate closing velocity (Velmin). Unit = PU/sec. Typical Value = 0. Default: 0.0 - :gatmax: Gate opening Limit Maximum (Gatmax). Default: 0.0 - :gatmin: Gate opening Limit Minimum (Gatmin). Default: 0.0 - :tw: Water inertia time constant (Tw) (>0). Typical Value = 0. Default: 0 - :pmax: Maximum Power Output (Pmax). Default: 0.0 - :pmin: Minimum Power Output (Pmin). Default: 0.0 - :d: Turbine damping factor (D). Unit = delta P / delta speed. Default: 0.0 - :gv3: Gate position 3 (Gv3). Default: 0.0 - :gv1: Gate position 1 (Gv1). Default: 0.0 - :pgv1: Output at Gv1 PU of MWbase (Pgv1). Default: 0.0 - :gv2: Gate position 2 (Gv2). Default: 0.0 - :pgv2: Output at Gv2 PU of MWbase (Pgv2). Default: 0.0 - :pgv3: Output at Gv3 PU of MWbase (Pgv3). Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'treg': [cgmesProfile.DY.value, ], - 'reg': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'velmax': [cgmesProfile.DY.value, ], - 'velmin': [cgmesProfile.DY.value, ], - 'gatmax': [cgmesProfile.DY.value, ], - 'gatmin': [cgmesProfile.DY.value, ], - 'tw': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - 'd': [cgmesProfile.DY.value, ], - 'gv3': [cgmesProfile.DY.value, ], - 'gv1': [cgmesProfile.DY.value, ], - 'pgv1': [cgmesProfile.DY.value, ], - 'gv2': [cgmesProfile.DY.value, ], - 'pgv2': [cgmesProfile.DY.value, ], - 'pgv3': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, treg = 0, reg = 0.0, kp = 0.0, ki = 0.0, kd = 0.0, ta = 0, tb = 0, velmax = 0.0, velmin = 0.0, gatmax = 0.0, gatmin = 0.0, tw = 0, pmax = 0.0, pmin = 0.0, d = 0.0, gv3 = 0.0, gv1 = 0.0, pgv1 = 0.0, gv2 = 0.0, pgv2 = 0.0, pgv3 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.treg = treg - self.reg = reg - self.kp = kp - self.ki = ki - self.kd = kd - self.ta = ta - self.tb = tb - self.velmax = velmax - self.velmin = velmin - self.gatmax = gatmax - self.gatmin = gatmin - self.tw = tw - self.pmax = pmax - self.pmin = pmin - self.d = d - self.gv3 = gv3 - self.gv1 = gv1 - self.pgv1 = pgv1 - self.gv2 = gv2 - self.pgv2 = pgv2 - self.pgv3 = pgv3 - - def __str__(self): - str = 'class=GovHydroWPID\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovHydroWPID(TurbineGovernorDynamics): + """ + Woodward PID Hydro Governor. + + :d: Turbine damping factor (D). Unit = delta P / delta speed. Default: 0.0 + :gatmax: Gate opening Limit Maximum (Gatmax). Default: 0.0 + :gatmin: Gate opening Limit Minimum (Gatmin). Default: 0.0 + :gv1: Gate position 1 (Gv1). Default: 0.0 + :gv2: Gate position 2 (Gv2). Default: 0.0 + :gv3: Gate position 3 (Gv3). Default: 0.0 + :kd: Derivative gain (Kd). Typical Value = 1.11. Default: 0.0 + :ki: Reset gain (Ki). Typical Value = 0.36. Default: 0.0 + :kp: Proportional gain (Kp). Typical Value = 0.1. Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :pgv1: Output at Gv1 PU of MWbase (Pgv1). Default: 0.0 + :pgv2: Output at Gv2 PU of MWbase (Pgv2). Default: 0.0 + :pgv3: Output at Gv3 PU of MWbase (Pgv3). Default: 0.0 + :pmax: Maximum Power Output (Pmax). Default: 0.0 + :pmin: Minimum Power Output (Pmin). Default: 0.0 + :reg: Permanent drop (Reg). Default: 0.0 + :ta: Controller time constant (Ta) (>0). Typical Value = 0. Default: 0.0 + :tb: Gate servo time constant (Tb) (>0). Typical Value = 0. Default: 0.0 + :treg: Speed detector time constant (Treg). Default: 0.0 + :tw: Water inertia time constant (Tw) (>0). Typical Value = 0. Default: 0.0 + :velmax: Maximum gate opening velocity (Velmax). Unit = PU/sec. Typical Value = 0. Default: 0.0 + :velmin: Maximum gate closing velocity (Velmin). Unit = PU/sec. Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "d": [Profile.DY.value, ], + "gatmax": [Profile.DY.value, ], + "gatmin": [Profile.DY.value, ], + "gv1": [Profile.DY.value, ], + "gv2": [Profile.DY.value, ], + "gv3": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pgv1": [Profile.DY.value, ], + "pgv2": [Profile.DY.value, ], + "pgv3": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "reg": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "treg": [Profile.DY.value, ], + "tw": [Profile.DY.value, ], + "velmax": [Profile.DY.value, ], + "velmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, d = 0.0, gatmax = 0.0, gatmin = 0.0, gv1 = 0.0, gv2 = 0.0, gv3 = 0.0, kd = 0.0, ki = 0.0, kp = 0.0, mwbase = 0.0, pgv1 = 0.0, pgv2 = 0.0, pgv3 = 0.0, pmax = 0.0, pmin = 0.0, reg = 0.0, ta = 0.0, tb = 0.0, treg = 0.0, tw = 0.0, velmax = 0.0, velmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.d = d + self.gatmax = gatmax + self.gatmin = gatmin + self.gv1 = gv1 + self.gv2 = gv2 + self.gv3 = gv3 + self.kd = kd + self.ki = ki + self.kp = kp + self.mwbase = mwbase + self.pgv1 = pgv1 + self.pgv2 = pgv2 + self.pgv3 = pgv3 + self.pmax = pmax + self.pmin = pmin + self.reg = reg + self.ta = ta + self.tb = tb + self.treg = treg + self.tw = tw + self.velmax = velmax + self.velmin = velmin + + def __str__(self): + str = "class=GovHydroWPID\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovSteam0.py b/cimpy/cgmes_v2_4_15/GovSteam0.py index bdf448b3..66030c00 100644 --- a/cimpy/cgmes_v2_4_15/GovSteam0.py +++ b/cimpy/cgmes_v2_4_15/GovSteam0.py @@ -1,52 +1,54 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovSteam0(TurbineGovernorDynamics): - ''' - A simplified steam turbine governor model. - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :r: Permanent droop (R). Typical Value = 0.05. Default: 0.0 - :t1: Steam bowl time constant (T1). Typical Value = 0.5. Default: 0 - :vmax: Maximum valve position, PU of mwcap (Vmax). Typical Value = 1. Default: 0.0 - :vmin: Minimum valve position, PU of mwcap (Vmin). Typical Value = 0. Default: 0.0 - :t2: Numerator time constant of T2/T3 block (T2). Typical Value = 3. Default: 0 - :t3: Reheater time constant (T3). Typical Value = 10. Default: 0 - :dt: Turbine damping coefficient (Dt). Unit = delta P / delta speed. Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'r': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 'vmax': [cgmesProfile.DY.value, ], - 'vmin': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 'dt': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, r = 0.0, t1 = 0, vmax = 0.0, vmin = 0.0, t2 = 0, t3 = 0, dt = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.r = r - self.t1 = t1 - self.vmax = vmax - self.vmin = vmin - self.t2 = t2 - self.t3 = t3 - self.dt = dt - - def __str__(self): - str = 'class=GovSteam0\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovSteam0(TurbineGovernorDynamics): + """ + A simplified steam turbine governor model. + + :dt: Turbine damping coefficient (Dt). Unit = delta P / delta speed. Typical Value = 0. Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :r: Permanent droop (R). Typical Value = 0.05. Default: 0.0 + :t1: Steam bowl time constant (T1). Typical Value = 0.5. Default: 0.0 + :t2: Numerator time constant of T2/T3 block (T2). Typical Value = 3. Default: 0.0 + :t3: Reheater time constant (T3). Typical Value = 10. Default: 0.0 + :vmax: Maximum valve position, PU of mwcap (Vmax). Typical Value = 1. Default: 0.0 + :vmin: Minimum valve position, PU of mwcap (Vmin). Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "dt": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "r": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "vmax": [Profile.DY.value, ], + "vmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, dt = 0.0, mwbase = 0.0, r = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, vmax = 0.0, vmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.dt = dt + self.mwbase = mwbase + self.r = r + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.vmax = vmax + self.vmin = vmin + + def __str__(self): + str = "class=GovSteam0\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovSteam1.py b/cimpy/cgmes_v2_4_15/GovSteam1.py index df0a5c7d..6bf1dc5a 100644 --- a/cimpy/cgmes_v2_4_15/GovSteam1.py +++ b/cimpy/cgmes_v2_4_15/GovSteam1.py @@ -1,145 +1,147 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovSteam1(TurbineGovernorDynamics): - ''' - Steam turbine governor model, based on the GovSteamIEEE1 model (with optional deadband and nonlinear valve gain added). - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :k: Governor gain (reciprocal of droop) (K) (>0). Typical Value = 25. Default: 0.0 - :t1: Governor lag time constant (T1). Typical Value = 0. Default: 0 - :t2: Governor lead time constant (T2). Typical Value = 0. Default: 0 - :t3: Valve positioner time constant (T3(>0). Typical Value = 0.1. Default: 0 - :uo: Maximum valve opening velocity (Uo) (>0). Unit = PU/sec. Typical Value = 1. Default: 0.0 - :uc: Maximum valve closing velocity (Uc) (<0). Unit = PU/sec. Typical Value = -10. Default: 0.0 - :pmax: Maximum valve opening (Pmax) (> Pmin). Typical Value = 1. Default: 0.0 - :pmin: Minimum valve opening (Pmin) (>=0). Typical Value = 0. Default: 0.0 - :t4: Inlet piping/steam bowl time constant (T4). Typical Value = 0.3. Default: 0 - :k1: Fraction of HP shaft power after first boiler pass (K1). Typical Value = 0.2. Default: 0.0 - :k2: Fraction of LP shaft power after first boiler pass (K2). Typical Value = 0. Default: 0.0 - :t5: Time constant of second boiler pass (T5). Typical Value = 5. Default: 0 - :k3: Fraction of HP shaft power after second boiler pass (K3). Typical Value = 0.3. Default: 0.0 - :k4: Fraction of LP shaft power after second boiler pass (K4). Typical Value = 0. Default: 0.0 - :t6: Time constant of third boiler pass (T6). Typical Value = 0.5. Default: 0 - :k5: Fraction of HP shaft power after third boiler pass (K5). Typical Value = 0.5. Default: 0.0 - :k6: Fraction of LP shaft power after third boiler pass (K6). Typical Value = 0. Default: 0.0 - :t7: Time constant of fourth boiler pass (T7). Typical Value = 0. Default: 0 - :k7: Fraction of HP shaft power after fourth boiler pass (K7). Typical Value = 0. Default: 0.0 - :k8: Fraction of LP shaft power after fourth boiler pass (K8). Typical Value = 0. Default: 0.0 - :db1: Intentional deadband width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 - :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 - :sdb1: Intentional deadband indicator. true = intentional deadband is applied false = intentional deadband is not applied. Typical Value = true. Default: False - :sdb2: Unintentional deadband location. true = intentional deadband is applied before point `A` false = intentional deadband is applied after point `A`. Typical Value = true. Default: False - :db2: Unintentional deadband (db2). Unit = MW. Typical Value = 0. Default: 0.0 - :valve: Nonlinear valve characteristic. true = nonlinear valve characteristic is used false = nonlinear valve characteristic is not used. Typical Value = true. Default: False - :gv1: Nonlinear gain valve position point 1 (GV1). Typical Value = 0. Default: 0.0 - :pgv1: Nonlinear gain power value point 1 (Pgv1). Typical Value = 0. Default: 0.0 - :gv2: Nonlinear gain valve position point 2 (GV2). Typical Value = 0.4. Default: 0.0 - :pgv2: Nonlinear gain power value point 2 (Pgv2). Typical Value = 0.75. Default: 0.0 - :gv3: Nonlinear gain valve position point 3 (GV3). Typical Value = 0.5. Default: 0.0 - :pgv3: Nonlinear gain power value point 3 (Pgv3). Typical Value = 0.91. Default: 0.0 - :gv4: Nonlinear gain valve position point 4 (GV4). Typical Value = 0.6. Default: 0.0 - :pgv4: Nonlinear gain power value point 4 (Pgv4). Typical Value = 0.98. Default: 0.0 - :gv5: Nonlinear gain valve position point 5 (GV5). Typical Value = 1. Default: 0.0 - :pgv5: Nonlinear gain power value point 5 (Pgv5). Typical Value = 1. Default: 0.0 - :gv6: Nonlinear gain valve position point 6 (GV6). Typical Value = 0. Default: 0.0 - :pgv6: Nonlinear gain power value point 6 (Pgv6). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 'uo': [cgmesProfile.DY.value, ], - 'uc': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 'k3': [cgmesProfile.DY.value, ], - 'k4': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 'k5': [cgmesProfile.DY.value, ], - 'k6': [cgmesProfile.DY.value, ], - 't7': [cgmesProfile.DY.value, ], - 'k7': [cgmesProfile.DY.value, ], - 'k8': [cgmesProfile.DY.value, ], - 'db1': [cgmesProfile.DY.value, ], - 'eps': [cgmesProfile.DY.value, ], - 'sdb1': [cgmesProfile.DY.value, ], - 'sdb2': [cgmesProfile.DY.value, ], - 'db2': [cgmesProfile.DY.value, ], - 'valve': [cgmesProfile.DY.value, ], - 'gv1': [cgmesProfile.DY.value, ], - 'pgv1': [cgmesProfile.DY.value, ], - 'gv2': [cgmesProfile.DY.value, ], - 'pgv2': [cgmesProfile.DY.value, ], - 'gv3': [cgmesProfile.DY.value, ], - 'pgv3': [cgmesProfile.DY.value, ], - 'gv4': [cgmesProfile.DY.value, ], - 'pgv4': [cgmesProfile.DY.value, ], - 'gv5': [cgmesProfile.DY.value, ], - 'pgv5': [cgmesProfile.DY.value, ], - 'gv6': [cgmesProfile.DY.value, ], - 'pgv6': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, k = 0.0, t1 = 0, t2 = 0, t3 = 0, uo = 0.0, uc = 0.0, pmax = 0.0, pmin = 0.0, t4 = 0, k1 = 0.0, k2 = 0.0, t5 = 0, k3 = 0.0, k4 = 0.0, t6 = 0, k5 = 0.0, k6 = 0.0, t7 = 0, k7 = 0.0, k8 = 0.0, db1 = 0.0, eps = 0.0, sdb1 = False, sdb2 = False, db2 = 0.0, valve = False, gv1 = 0.0, pgv1 = 0.0, gv2 = 0.0, pgv2 = 0.0, gv3 = 0.0, pgv3 = 0.0, gv4 = 0.0, pgv4 = 0.0, gv5 = 0.0, pgv5 = 0.0, gv6 = 0.0, pgv6 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.k = k - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.uo = uo - self.uc = uc - self.pmax = pmax - self.pmin = pmin - self.t4 = t4 - self.k1 = k1 - self.k2 = k2 - self.t5 = t5 - self.k3 = k3 - self.k4 = k4 - self.t6 = t6 - self.k5 = k5 - self.k6 = k6 - self.t7 = t7 - self.k7 = k7 - self.k8 = k8 - self.db1 = db1 - self.eps = eps - self.sdb1 = sdb1 - self.sdb2 = sdb2 - self.db2 = db2 - self.valve = valve - self.gv1 = gv1 - self.pgv1 = pgv1 - self.gv2 = gv2 - self.pgv2 = pgv2 - self.gv3 = gv3 - self.pgv3 = pgv3 - self.gv4 = gv4 - self.pgv4 = pgv4 - self.gv5 = gv5 - self.pgv5 = pgv5 - self.gv6 = gv6 - self.pgv6 = pgv6 - - def __str__(self): - str = 'class=GovSteam1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovSteam1(TurbineGovernorDynamics): + """ + Steam turbine governor model, based on the GovSteamIEEE1 model (with optional deadband and nonlinear valve gain added). + + :db1: Intentional deadband width (db1). Unit = Hz. Typical Value = 0. Default: 0.0 + :db2: Unintentional deadband (db2). Unit = MW. Typical Value = 0. Default: 0.0 + :eps: Intentional db hysteresis (eps). Unit = Hz. Typical Value = 0. Default: 0.0 + :gv1: Nonlinear gain valve position point 1 (GV1). Typical Value = 0. Default: 0.0 + :gv2: Nonlinear gain valve position point 2 (GV2). Typical Value = 0.4. Default: 0.0 + :gv3: Nonlinear gain valve position point 3 (GV3). Typical Value = 0.5. Default: 0.0 + :gv4: Nonlinear gain valve position point 4 (GV4). Typical Value = 0.6. Default: 0.0 + :gv5: Nonlinear gain valve position point 5 (GV5). Typical Value = 1. Default: 0.0 + :gv6: Nonlinear gain valve position point 6 (GV6). Typical Value = 0. Default: 0.0 + :k: Governor gain (reciprocal of droop) (K) (>0). Typical Value = 25. Default: 0.0 + :k1: Fraction of HP shaft power after first boiler pass (K1). Typical Value = 0.2. Default: 0.0 + :k2: Fraction of LP shaft power after first boiler pass (K2). Typical Value = 0. Default: 0.0 + :k3: Fraction of HP shaft power after second boiler pass (K3). Typical Value = 0.3. Default: 0.0 + :k4: Fraction of LP shaft power after second boiler pass (K4). Typical Value = 0. Default: 0.0 + :k5: Fraction of HP shaft power after third boiler pass (K5). Typical Value = 0.5. Default: 0.0 + :k6: Fraction of LP shaft power after third boiler pass (K6). Typical Value = 0. Default: 0.0 + :k7: Fraction of HP shaft power after fourth boiler pass (K7). Typical Value = 0. Default: 0.0 + :k8: Fraction of LP shaft power after fourth boiler pass (K8). Typical Value = 0. Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :pgv1: Nonlinear gain power value point 1 (Pgv1). Typical Value = 0. Default: 0.0 + :pgv2: Nonlinear gain power value point 2 (Pgv2). Typical Value = 0.75. Default: 0.0 + :pgv3: Nonlinear gain power value point 3 (Pgv3). Typical Value = 0.91. Default: 0.0 + :pgv4: Nonlinear gain power value point 4 (Pgv4). Typical Value = 0.98. Default: 0.0 + :pgv5: Nonlinear gain power value point 5 (Pgv5). Typical Value = 1. Default: 0.0 + :pgv6: Nonlinear gain power value point 6 (Pgv6). Typical Value = 0. Default: 0.0 + :pmax: Maximum valve opening (Pmax) (> Pmin). Typical Value = 1. Default: 0.0 + :pmin: Minimum valve opening (Pmin) (>=0). Typical Value = 0. Default: 0.0 + :sdb1: Intentional deadband indicator. true = intentional deadband is applied false = intentional deadband is not applied. Typical Value = true. Default: False + :sdb2: Unintentional deadband location. true = intentional deadband is applied before point `A` false = intentional deadband is applied after point `A`. Typical Value = true. Default: False + :t1: Governor lag time constant (T1). Typical Value = 0. Default: 0.0 + :t2: Governor lead time constant (T2). Typical Value = 0. Default: 0.0 + :t3: Valve positioner time constant (T3(>0). Typical Value = 0.1. Default: 0.0 + :t4: Inlet piping/steam bowl time constant (T4). Typical Value = 0.3. Default: 0.0 + :t5: Time constant of second boiler pass (T5). Typical Value = 5. Default: 0.0 + :t6: Time constant of third boiler pass (T6). Typical Value = 0.5. Default: 0.0 + :t7: Time constant of fourth boiler pass (T7). Typical Value = 0. Default: 0.0 + :uc: Maximum valve closing velocity (Uc) (<0). Unit = PU/sec. Typical Value = -10. Default: 0.0 + :uo: Maximum valve opening velocity (Uo) (>0). Unit = PU/sec. Typical Value = 1. Default: 0.0 + :valve: Nonlinear valve characteristic. true = nonlinear valve characteristic is used false = nonlinear valve characteristic is not used. Typical Value = true. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "db1": [Profile.DY.value, ], + "db2": [Profile.DY.value, ], + "eps": [Profile.DY.value, ], + "gv1": [Profile.DY.value, ], + "gv2": [Profile.DY.value, ], + "gv3": [Profile.DY.value, ], + "gv4": [Profile.DY.value, ], + "gv5": [Profile.DY.value, ], + "gv6": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "k3": [Profile.DY.value, ], + "k4": [Profile.DY.value, ], + "k5": [Profile.DY.value, ], + "k6": [Profile.DY.value, ], + "k7": [Profile.DY.value, ], + "k8": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pgv1": [Profile.DY.value, ], + "pgv2": [Profile.DY.value, ], + "pgv3": [Profile.DY.value, ], + "pgv4": [Profile.DY.value, ], + "pgv5": [Profile.DY.value, ], + "pgv6": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "sdb1": [Profile.DY.value, ], + "sdb2": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "t7": [Profile.DY.value, ], + "uc": [Profile.DY.value, ], + "uo": [Profile.DY.value, ], + "valve": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, db1 = 0.0, db2 = 0.0, eps = 0.0, gv1 = 0.0, gv2 = 0.0, gv3 = 0.0, gv4 = 0.0, gv5 = 0.0, gv6 = 0.0, k = 0.0, k1 = 0.0, k2 = 0.0, k3 = 0.0, k4 = 0.0, k5 = 0.0, k6 = 0.0, k7 = 0.0, k8 = 0.0, mwbase = 0.0, pgv1 = 0.0, pgv2 = 0.0, pgv3 = 0.0, pgv4 = 0.0, pgv5 = 0.0, pgv6 = 0.0, pmax = 0.0, pmin = 0.0, sdb1 = False, sdb2 = False, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, t6 = 0.0, t7 = 0.0, uc = 0.0, uo = 0.0, valve = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.db1 = db1 + self.db2 = db2 + self.eps = eps + self.gv1 = gv1 + self.gv2 = gv2 + self.gv3 = gv3 + self.gv4 = gv4 + self.gv5 = gv5 + self.gv6 = gv6 + self.k = k + self.k1 = k1 + self.k2 = k2 + self.k3 = k3 + self.k4 = k4 + self.k5 = k5 + self.k6 = k6 + self.k7 = k7 + self.k8 = k8 + self.mwbase = mwbase + self.pgv1 = pgv1 + self.pgv2 = pgv2 + self.pgv3 = pgv3 + self.pgv4 = pgv4 + self.pgv5 = pgv5 + self.pgv6 = pgv6 + self.pmax = pmax + self.pmin = pmin + self.sdb1 = sdb1 + self.sdb2 = sdb2 + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.t6 = t6 + self.t7 = t7 + self.uc = uc + self.uo = uo + self.valve = valve + + def __str__(self): + str = "class=GovSteam1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovSteam2.py b/cimpy/cgmes_v2_4_15/GovSteam2.py index 35d60f67..09c61ff4 100644 --- a/cimpy/cgmes_v2_4_15/GovSteam2.py +++ b/cimpy/cgmes_v2_4_15/GovSteam2.py @@ -1,52 +1,54 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovSteam2(TurbineGovernorDynamics): - ''' - Simplified governor model. - - :k: Governor gain (reciprocal of droop) (K). Typical Value = 20. Default: 0.0 - :dbf: Frequency dead band (DBF). Typical Value = 0. Default: 0.0 - :t1: Governor lag time constant (T) (>0). Typical Value = 0.45. Default: 0 - :t2: Governor lead time constant (T) (may be 0). Typical Value = 0. Default: 0 - :pmax: Maximum fuel flow (P). Typical Value = 1. Default: 0.0 - :pmin: Minimum fuel flow (P). Typical Value = 0. Default: 0.0 - :mxef: Fuel flow maximum positive error value (MX). Typical Value = 1. Default: 0.0 - :mnef: Fuel flow maximum negative error value (MN). Typical Value = -1. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - 'dbf': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - 'mxef': [cgmesProfile.DY.value, ], - 'mnef': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, k = 0.0, dbf = 0.0, t1 = 0, t2 = 0, pmax = 0.0, pmin = 0.0, mxef = 0.0, mnef = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.k = k - self.dbf = dbf - self.t1 = t1 - self.t2 = t2 - self.pmax = pmax - self.pmin = pmin - self.mxef = mxef - self.mnef = mnef - - def __str__(self): - str = 'class=GovSteam2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovSteam2(TurbineGovernorDynamics): + """ + Simplified governor model. + + :dbf: Frequency dead band (DBF). Typical Value = 0. Default: 0.0 + :k: Governor gain (reciprocal of droop) (K). Typical Value = 20. Default: 0.0 + :mnef: Fuel flow maximum negative error value (MN). Typical Value = -1. Default: 0.0 + :mxef: Fuel flow maximum positive error value (MX). Typical Value = 1. Default: 0.0 + :pmax: Maximum fuel flow (P). Typical Value = 1. Default: 0.0 + :pmin: Minimum fuel flow (P). Typical Value = 0. Default: 0.0 + :t1: Governor lag time constant (T) (>0). Typical Value = 0.45. Default: 0.0 + :t2: Governor lead time constant (T) (may be 0). Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "dbf": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "mnef": [Profile.DY.value, ], + "mxef": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, dbf = 0.0, k = 0.0, mnef = 0.0, mxef = 0.0, pmax = 0.0, pmin = 0.0, t1 = 0.0, t2 = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.dbf = dbf + self.k = k + self.mnef = mnef + self.mxef = mxef + self.pmax = pmax + self.pmin = pmin + self.t1 = t1 + self.t2 = t2 + + def __str__(self): + str = "class=GovSteam2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovSteamCC.py b/cimpy/cgmes_v2_4_15/GovSteamCC.py index 5e8d07de..826a8fde 100644 --- a/cimpy/cgmes_v2_4_15/GovSteamCC.py +++ b/cimpy/cgmes_v2_4_15/GovSteamCC.py @@ -1,79 +1,81 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovSteamCC(TurbineGovernorDynamics): - ''' - Cross compound turbine governor model. - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :pmaxhp: Maximum HP value position (Pmaxhp). Typical Value = 1. Default: 0.0 - :rhp: HP governor droop (Rhp). Typical Value = 0.05. Default: 0.0 - :t1hp: HP governor time constant (T1hp). Typical Value = 0.1. Default: 0 - :t3hp: HP turbine time constant (T3hp). Typical Value = 0.1. Default: 0 - :t4hp: HP turbine time constant (T4hp). Typical Value = 0.1. Default: 0 - :t5hp: HP reheater time constant (T5hp). Typical Value = 10. Default: 0 - :fhp: Fraction of HP power ahead of reheater (Fhp). Typical Value = 0.3. Default: 0.0 - :dhp: HP damping factor (Dhp). Typical Value = 0. Default: 0.0 - :pmaxlp: Maximum LP value position (Pmaxlp). Typical Value = 1. Default: 0.0 - :rlp: LP governor droop (Rlp). Typical Value = 0.05. Default: 0.0 - :t1lp: LP governor time constant (T1lp). Typical Value = 0.1. Default: 0 - :t3lp: LP turbine time constant (T3lp). Typical Value = 0.1. Default: 0 - :t4lp: LP turbine time constant (T4lp). Typical Value = 0.1. Default: 0 - :t5lp: LP reheater time constant (T5lp). Typical Value = 10. Default: 0 - :flp: Fraction of LP power ahead of reheater (Flp). Typical Value = 0.7. Default: 0.0 - :dlp: LP damping factor (Dlp). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'pmaxhp': [cgmesProfile.DY.value, ], - 'rhp': [cgmesProfile.DY.value, ], - 't1hp': [cgmesProfile.DY.value, ], - 't3hp': [cgmesProfile.DY.value, ], - 't4hp': [cgmesProfile.DY.value, ], - 't5hp': [cgmesProfile.DY.value, ], - 'fhp': [cgmesProfile.DY.value, ], - 'dhp': [cgmesProfile.DY.value, ], - 'pmaxlp': [cgmesProfile.DY.value, ], - 'rlp': [cgmesProfile.DY.value, ], - 't1lp': [cgmesProfile.DY.value, ], - 't3lp': [cgmesProfile.DY.value, ], - 't4lp': [cgmesProfile.DY.value, ], - 't5lp': [cgmesProfile.DY.value, ], - 'flp': [cgmesProfile.DY.value, ], - 'dlp': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, pmaxhp = 0.0, rhp = 0.0, t1hp = 0, t3hp = 0, t4hp = 0, t5hp = 0, fhp = 0.0, dhp = 0.0, pmaxlp = 0.0, rlp = 0.0, t1lp = 0, t3lp = 0, t4lp = 0, t5lp = 0, flp = 0.0, dlp = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.pmaxhp = pmaxhp - self.rhp = rhp - self.t1hp = t1hp - self.t3hp = t3hp - self.t4hp = t4hp - self.t5hp = t5hp - self.fhp = fhp - self.dhp = dhp - self.pmaxlp = pmaxlp - self.rlp = rlp - self.t1lp = t1lp - self.t3lp = t3lp - self.t4lp = t4lp - self.t5lp = t5lp - self.flp = flp - self.dlp = dlp - - def __str__(self): - str = 'class=GovSteamCC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovSteamCC(TurbineGovernorDynamics): + """ + Cross compound turbine governor model. + + :dhp: HP damping factor (Dhp). Typical Value = 0. Default: 0.0 + :dlp: LP damping factor (Dlp). Typical Value = 0. Default: 0.0 + :fhp: Fraction of HP power ahead of reheater (Fhp). Typical Value = 0.3. Default: 0.0 + :flp: Fraction of LP power ahead of reheater (Flp). Typical Value = 0.7. Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :pmaxhp: Maximum HP value position (Pmaxhp). Typical Value = 1. Default: 0.0 + :pmaxlp: Maximum LP value position (Pmaxlp). Typical Value = 1. Default: 0.0 + :rhp: HP governor droop (Rhp). Typical Value = 0.05. Default: 0.0 + :rlp: LP governor droop (Rlp). Typical Value = 0.05. Default: 0.0 + :t1hp: HP governor time constant (T1hp). Typical Value = 0.1. Default: 0.0 + :t1lp: LP governor time constant (T1lp). Typical Value = 0.1. Default: 0.0 + :t3hp: HP turbine time constant (T3hp). Typical Value = 0.1. Default: 0.0 + :t3lp: LP turbine time constant (T3lp). Typical Value = 0.1. Default: 0.0 + :t4hp: HP turbine time constant (T4hp). Typical Value = 0.1. Default: 0.0 + :t4lp: LP turbine time constant (T4lp). Typical Value = 0.1. Default: 0.0 + :t5hp: HP reheater time constant (T5hp). Typical Value = 10. Default: 0.0 + :t5lp: LP reheater time constant (T5lp). Typical Value = 10. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "dhp": [Profile.DY.value, ], + "dlp": [Profile.DY.value, ], + "fhp": [Profile.DY.value, ], + "flp": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pmaxhp": [Profile.DY.value, ], + "pmaxlp": [Profile.DY.value, ], + "rhp": [Profile.DY.value, ], + "rlp": [Profile.DY.value, ], + "t1hp": [Profile.DY.value, ], + "t1lp": [Profile.DY.value, ], + "t3hp": [Profile.DY.value, ], + "t3lp": [Profile.DY.value, ], + "t4hp": [Profile.DY.value, ], + "t4lp": [Profile.DY.value, ], + "t5hp": [Profile.DY.value, ], + "t5lp": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, dhp = 0.0, dlp = 0.0, fhp = 0.0, flp = 0.0, mwbase = 0.0, pmaxhp = 0.0, pmaxlp = 0.0, rhp = 0.0, rlp = 0.0, t1hp = 0.0, t1lp = 0.0, t3hp = 0.0, t3lp = 0.0, t4hp = 0.0, t4lp = 0.0, t5hp = 0.0, t5lp = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.dhp = dhp + self.dlp = dlp + self.fhp = fhp + self.flp = flp + self.mwbase = mwbase + self.pmaxhp = pmaxhp + self.pmaxlp = pmaxlp + self.rhp = rhp + self.rlp = rlp + self.t1hp = t1hp + self.t1lp = t1lp + self.t3hp = t3hp + self.t3lp = t3lp + self.t4hp = t4hp + self.t4lp = t4lp + self.t5hp = t5hp + self.t5lp = t5lp + + def __str__(self): + str = "class=GovSteamCC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovSteamEU.py b/cimpy/cgmes_v2_4_15/GovSteamEU.py index d216ac3a..9e439aa8 100644 --- a/cimpy/cgmes_v2_4_15/GovSteamEU.py +++ b/cimpy/cgmes_v2_4_15/GovSteamEU.py @@ -1,133 +1,135 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovSteamEU(TurbineGovernorDynamics): - ''' - Simplified model of boiler and steam turbine with PID governor. - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :tp: Power transducer time constant (Tp). Typical Value = 0.07. Default: 0 - :ke: Gain of the power controller (Ke). Typical Value = 0.65. Default: 0.0 - :tip: Integral time constant of the power controller (Tip). Typical Value = 2. Default: 0 - :tdp: Derivative time constant of the power controller (Tdp). Typical Value = 0. Default: 0 - :tfp: Time constant of the power controller (Tfp). Typical Value = 0. Default: 0 - :tf: Frequency transducer time constant (Tf). Typical Value = 0. Default: 0 - :kfcor: Gain of the frequency corrector (Kfcor). Typical Value = 20. Default: 0.0 - :db1: Dead band of the frequency corrector (db1). Typical Value = 0. Default: 0.0 - :wfmax: Upper limit for frequency correction (Wfmax). Typical Value = 0.05. Default: 0.0 - :wfmin: Lower limit for frequency correction (Wfmin). Typical Value = -0.05. Default: 0.0 - :pmax: Maximal active power of the turbine (Pmax). Typical Value = 1. Default: 0.0 - :ten: Electro hydraulic transducer (Ten). Typical Value = 0.1. Default: 0 - :tw: Speed transducer time constant (Tw). Typical Value = 0.02. Default: 0 - :kwcor: Gain of the speed governor (Kwcor). Typical Value = 20. Default: 0.0 - :db2: Dead band of the speed governor (db2). Typical Value = 0.0004. Default: 0.0 - :wwmax: Upper limit for the speed governor (Wwmax). Typical Value = 0.1. Default: 0.0 - :wwmin: Lower limit for the speed governor frequency correction (Wwmin). Typical Value = -1. Default: 0.0 - :wmax1: Emergency speed control lower limit (wmax1). Typical Value = 1.025. Default: 0.0 - :wmax2: Emergency speed control upper limit (wmax2). Typical Value = 1.05. Default: 0.0 - :tvhp: Control valves servo time constant (Tvhp). Typical Value = 0.1. Default: 0 - :cho: Control valves rate opening limit (Cho). Unit = PU/sec. Typical Value = 0.17. Default: 0.0 - :chc: Control valves rate closing limit (Chc). Unit = PU/sec. Typical Value = -3.3. Default: 0.0 - :hhpmax: Maximum control valve position (Hhpmax). Typical Value = 1. Default: 0.0 - :tvip: Intercept valves servo time constant (Tvip). Typical Value = 0.15. Default: 0 - :cio: Intercept valves rate opening limit (Cio). Typical Value = 0.123. Default: 0.0 - :cic: Intercept valves rate closing limit (Cic). Typical Value = -2.2. Default: 0.0 - :simx: Intercept valves transfer limit (Simx). Typical Value = 0.425. Default: 0.0 - :thp: High pressure (HP) time constant of the turbine (Thp). Typical Value = 0.31. Default: 0 - :trh: Reheater time constant of the turbine (Trh). Typical Value = 8. Default: 0 - :tlp: Low pressure(LP) time constant of the turbine (Tlp). Typical Value = 0.45. Default: 0 - :prhmax: Maximum low pressure limit (Prhmax). Typical Value = 1.4. Default: 0.0 - :khp: Fraction of total turbine output generated by HP part (Khp). Typical Value = 0.277. Default: 0.0 - :klp: Fraction of total turbine output generated by HP part (Klp). Typical Value = 0.723. Default: 0.0 - :tb: Boiler time constant (Tb). Typical Value = 100. Default: 0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 'ke': [cgmesProfile.DY.value, ], - 'tip': [cgmesProfile.DY.value, ], - 'tdp': [cgmesProfile.DY.value, ], - 'tfp': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'kfcor': [cgmesProfile.DY.value, ], - 'db1': [cgmesProfile.DY.value, ], - 'wfmax': [cgmesProfile.DY.value, ], - 'wfmin': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'ten': [cgmesProfile.DY.value, ], - 'tw': [cgmesProfile.DY.value, ], - 'kwcor': [cgmesProfile.DY.value, ], - 'db2': [cgmesProfile.DY.value, ], - 'wwmax': [cgmesProfile.DY.value, ], - 'wwmin': [cgmesProfile.DY.value, ], - 'wmax1': [cgmesProfile.DY.value, ], - 'wmax2': [cgmesProfile.DY.value, ], - 'tvhp': [cgmesProfile.DY.value, ], - 'cho': [cgmesProfile.DY.value, ], - 'chc': [cgmesProfile.DY.value, ], - 'hhpmax': [cgmesProfile.DY.value, ], - 'tvip': [cgmesProfile.DY.value, ], - 'cio': [cgmesProfile.DY.value, ], - 'cic': [cgmesProfile.DY.value, ], - 'simx': [cgmesProfile.DY.value, ], - 'thp': [cgmesProfile.DY.value, ], - 'trh': [cgmesProfile.DY.value, ], - 'tlp': [cgmesProfile.DY.value, ], - 'prhmax': [cgmesProfile.DY.value, ], - 'khp': [cgmesProfile.DY.value, ], - 'klp': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, tp = 0, ke = 0.0, tip = 0, tdp = 0, tfp = 0, tf = 0, kfcor = 0.0, db1 = 0.0, wfmax = 0.0, wfmin = 0.0, pmax = 0.0, ten = 0, tw = 0, kwcor = 0.0, db2 = 0.0, wwmax = 0.0, wwmin = 0.0, wmax1 = 0.0, wmax2 = 0.0, tvhp = 0, cho = 0.0, chc = 0.0, hhpmax = 0.0, tvip = 0, cio = 0.0, cic = 0.0, simx = 0.0, thp = 0, trh = 0, tlp = 0, prhmax = 0.0, khp = 0.0, klp = 0.0, tb = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.tp = tp - self.ke = ke - self.tip = tip - self.tdp = tdp - self.tfp = tfp - self.tf = tf - self.kfcor = kfcor - self.db1 = db1 - self.wfmax = wfmax - self.wfmin = wfmin - self.pmax = pmax - self.ten = ten - self.tw = tw - self.kwcor = kwcor - self.db2 = db2 - self.wwmax = wwmax - self.wwmin = wwmin - self.wmax1 = wmax1 - self.wmax2 = wmax2 - self.tvhp = tvhp - self.cho = cho - self.chc = chc - self.hhpmax = hhpmax - self.tvip = tvip - self.cio = cio - self.cic = cic - self.simx = simx - self.thp = thp - self.trh = trh - self.tlp = tlp - self.prhmax = prhmax - self.khp = khp - self.klp = klp - self.tb = tb - - def __str__(self): - str = 'class=GovSteamEU\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovSteamEU(TurbineGovernorDynamics): + """ + Simplified model of boiler and steam turbine with PID governor. + + :chc: Control valves rate closing limit (Chc). Unit = PU/sec. Typical Value = -3.3. Default: 0.0 + :cho: Control valves rate opening limit (Cho). Unit = PU/sec. Typical Value = 0.17. Default: 0.0 + :cic: Intercept valves rate closing limit (Cic). Typical Value = -2.2. Default: 0.0 + :cio: Intercept valves rate opening limit (Cio). Typical Value = 0.123. Default: 0.0 + :db1: Dead band of the frequency corrector (db1). Typical Value = 0. Default: 0.0 + :db2: Dead band of the speed governor (db2). Typical Value = 0.0004. Default: 0.0 + :hhpmax: Maximum control valve position (Hhpmax). Typical Value = 1. Default: 0.0 + :ke: Gain of the power controller (Ke). Typical Value = 0.65. Default: 0.0 + :kfcor: Gain of the frequency corrector (Kfcor). Typical Value = 20. Default: 0.0 + :khp: Fraction of total turbine output generated by HP part (Khp). Typical Value = 0.277. Default: 0.0 + :klp: Fraction of total turbine output generated by HP part (Klp). Typical Value = 0.723. Default: 0.0 + :kwcor: Gain of the speed governor (Kwcor). Typical Value = 20. Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :pmax: Maximal active power of the turbine (Pmax). Typical Value = 1. Default: 0.0 + :prhmax: Maximum low pressure limit (Prhmax). Typical Value = 1.4. Default: 0.0 + :simx: Intercept valves transfer limit (Simx). Typical Value = 0.425. Default: 0.0 + :tb: Boiler time constant (Tb). Typical Value = 100. Default: 0.0 + :tdp: Derivative time constant of the power controller (Tdp). Typical Value = 0. Default: 0.0 + :ten: Electro hydraulic transducer (Ten). Typical Value = 0.1. Default: 0.0 + :tf: Frequency transducer time constant (Tf). Typical Value = 0. Default: 0.0 + :tfp: Time constant of the power controller (Tfp). Typical Value = 0. Default: 0.0 + :thp: High pressure (HP) time constant of the turbine (Thp). Typical Value = 0.31. Default: 0.0 + :tip: Integral time constant of the power controller (Tip). Typical Value = 2. Default: 0.0 + :tlp: Low pressure(LP) time constant of the turbine (Tlp). Typical Value = 0.45. Default: 0.0 + :tp: Power transducer time constant (Tp). Typical Value = 0.07. Default: 0.0 + :trh: Reheater time constant of the turbine (Trh). Typical Value = 8. Default: 0.0 + :tvhp: Control valves servo time constant (Tvhp). Typical Value = 0.1. Default: 0.0 + :tvip: Intercept valves servo time constant (Tvip). Typical Value = 0.15. Default: 0.0 + :tw: Speed transducer time constant (Tw). Typical Value = 0.02. Default: 0.0 + :wfmax: Upper limit for frequency correction (Wfmax). Typical Value = 0.05. Default: 0.0 + :wfmin: Lower limit for frequency correction (Wfmin). Typical Value = -0.05. Default: 0.0 + :wmax1: Emergency speed control lower limit (wmax1). Typical Value = 1.025. Default: 0.0 + :wmax2: Emergency speed control upper limit (wmax2). Typical Value = 1.05. Default: 0.0 + :wwmax: Upper limit for the speed governor (Wwmax). Typical Value = 0.1. Default: 0.0 + :wwmin: Lower limit for the speed governor frequency correction (Wwmin). Typical Value = -1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "chc": [Profile.DY.value, ], + "cho": [Profile.DY.value, ], + "cic": [Profile.DY.value, ], + "cio": [Profile.DY.value, ], + "db1": [Profile.DY.value, ], + "db2": [Profile.DY.value, ], + "hhpmax": [Profile.DY.value, ], + "ke": [Profile.DY.value, ], + "kfcor": [Profile.DY.value, ], + "khp": [Profile.DY.value, ], + "klp": [Profile.DY.value, ], + "kwcor": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "prhmax": [Profile.DY.value, ], + "simx": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tdp": [Profile.DY.value, ], + "ten": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "tfp": [Profile.DY.value, ], + "thp": [Profile.DY.value, ], + "tip": [Profile.DY.value, ], + "tlp": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + "trh": [Profile.DY.value, ], + "tvhp": [Profile.DY.value, ], + "tvip": [Profile.DY.value, ], + "tw": [Profile.DY.value, ], + "wfmax": [Profile.DY.value, ], + "wfmin": [Profile.DY.value, ], + "wmax1": [Profile.DY.value, ], + "wmax2": [Profile.DY.value, ], + "wwmax": [Profile.DY.value, ], + "wwmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, chc = 0.0, cho = 0.0, cic = 0.0, cio = 0.0, db1 = 0.0, db2 = 0.0, hhpmax = 0.0, ke = 0.0, kfcor = 0.0, khp = 0.0, klp = 0.0, kwcor = 0.0, mwbase = 0.0, pmax = 0.0, prhmax = 0.0, simx = 0.0, tb = 0.0, tdp = 0.0, ten = 0.0, tf = 0.0, tfp = 0.0, thp = 0.0, tip = 0.0, tlp = 0.0, tp = 0.0, trh = 0.0, tvhp = 0.0, tvip = 0.0, tw = 0.0, wfmax = 0.0, wfmin = 0.0, wmax1 = 0.0, wmax2 = 0.0, wwmax = 0.0, wwmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.chc = chc + self.cho = cho + self.cic = cic + self.cio = cio + self.db1 = db1 + self.db2 = db2 + self.hhpmax = hhpmax + self.ke = ke + self.kfcor = kfcor + self.khp = khp + self.klp = klp + self.kwcor = kwcor + self.mwbase = mwbase + self.pmax = pmax + self.prhmax = prhmax + self.simx = simx + self.tb = tb + self.tdp = tdp + self.ten = ten + self.tf = tf + self.tfp = tfp + self.thp = thp + self.tip = tip + self.tlp = tlp + self.tp = tp + self.trh = trh + self.tvhp = tvhp + self.tvip = tvip + self.tw = tw + self.wfmax = wfmax + self.wfmin = wfmin + self.wmax1 = wmax1 + self.wmax2 = wmax2 + self.wwmax = wwmax + self.wwmin = wwmin + + def __str__(self): + str = "class=GovSteamEU\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovSteamFV2.py b/cimpy/cgmes_v2_4_15/GovSteamFV2.py index d1e6843e..829d63ae 100644 --- a/cimpy/cgmes_v2_4_15/GovSteamFV2.py +++ b/cimpy/cgmes_v2_4_15/GovSteamFV2.py @@ -1,67 +1,69 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovSteamFV2(TurbineGovernorDynamics): - ''' - Steam turbine governor with reheat time constants and modeling of the effects of fast valve closing to reduce mechanical power. - - :mwbase: Alternate Base used instead of Machine base in equipment model if necessary (MWbase) (>0). Unit = MW. Default: 0.0 - :r: (R). Default: 0.0 - :t1: Governor time constant (T1). Default: 0 - :vmax: (Vmax). Default: 0.0 - :vmin: (Vmin). Default: 0.0 - :k: Fraction of the turbine power developed by turbine sections not involved in fast valving (K). Default: 0.0 - :t3: Reheater time constant (T3). Default: 0 - :dt: (Dt). Default: 0.0 - :tt: Time constant with which power falls off after intercept valve closure (Tt). Default: 0 - :ta: Time after initial time for valve to close (Ta). Default: 0 - :tb: Time after initial time for valve to begin opening (Tb). Default: 0 - :tc: Time after initial time for valve to become fully open (Tc). Default: 0 - :ti: Initial time to begin fast valving (Ti). Default: 0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'r': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 'vmax': [cgmesProfile.DY.value, ], - 'vmin': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 'dt': [cgmesProfile.DY.value, ], - 'tt': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'ti': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, r = 0.0, t1 = 0, vmax = 0.0, vmin = 0.0, k = 0.0, t3 = 0, dt = 0.0, tt = 0, ta = 0, tb = 0, tc = 0, ti = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.r = r - self.t1 = t1 - self.vmax = vmax - self.vmin = vmin - self.k = k - self.t3 = t3 - self.dt = dt - self.tt = tt - self.ta = ta - self.tb = tb - self.tc = tc - self.ti = ti - - def __str__(self): - str = 'class=GovSteamFV2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovSteamFV2(TurbineGovernorDynamics): + """ + Steam turbine governor with reheat time constants and modeling of the effects of fast valve closing to reduce mechanical power. + + :dt: (Dt). Default: 0.0 + :k: Fraction of the turbine power developed by turbine sections not involved in fast valving (K). Default: 0.0 + :mwbase: Alternate Base used instead of Machine base in equipment model if necessary (MWbase) (>0). Unit = MW. Default: 0.0 + :r: (R). Default: 0.0 + :t1: Governor time constant (T1). Default: 0.0 + :t3: Reheater time constant (T3). Default: 0.0 + :ta: Time after initial time for valve to close (Ta). Default: 0.0 + :tb: Time after initial time for valve to begin opening (Tb). Default: 0.0 + :tc: Time after initial time for valve to become fully open (Tc). Default: 0.0 + :ti: Initial time to begin fast valving (Ti). Default: 0.0 + :tt: Time constant with which power falls off after intercept valve closure (Tt). Default: 0.0 + :vmax: (Vmax). Default: 0.0 + :vmin: (Vmin). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "dt": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "r": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "ti": [Profile.DY.value, ], + "tt": [Profile.DY.value, ], + "vmax": [Profile.DY.value, ], + "vmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, dt = 0.0, k = 0.0, mwbase = 0.0, r = 0.0, t1 = 0.0, t3 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, ti = 0.0, tt = 0.0, vmax = 0.0, vmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.dt = dt + self.k = k + self.mwbase = mwbase + self.r = r + self.t1 = t1 + self.t3 = t3 + self.ta = ta + self.tb = tb + self.tc = tc + self.ti = ti + self.tt = tt + self.vmax = vmax + self.vmin = vmin + + def __str__(self): + str = "class=GovSteamFV2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovSteamFV3.py b/cimpy/cgmes_v2_4_15/GovSteamFV3.py index 9446ab2d..54488245 100644 --- a/cimpy/cgmes_v2_4_15/GovSteamFV3.py +++ b/cimpy/cgmes_v2_4_15/GovSteamFV3.py @@ -1,85 +1,87 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovSteamFV3(TurbineGovernorDynamics): - ''' - Simplified GovSteamIEEE1 Steam turbine governor model with Prmax limit and fast valving. - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :k: Governor gain, (reciprocal of droop) (K). Typical Value = 20. Default: 0.0 - :t1: Governor lead time constant (T1). Typical Value = 0. Default: 0 - :t2: Governor lag time constant (T2). Typical Value = 0. Default: 0 - :t3: Valve positioner time constant (T3). Typical Value = 0. Default: 0 - :uo: Maximum valve opening velocity (Uo). Unit = PU/sec. Typical Value = 0.1. Default: 0.0 - :uc: Maximum valve closing velocity (Uc). Unit = PU/sec. Typical Value = -1. Default: 0.0 - :pmax: Maximum valve opening, PU of MWbase (Pmax). Typical Value = 1. Default: 0.0 - :pmin: Minimum valve opening, PU of MWbase (Pmin). Typical Value = 0. Default: 0.0 - :t4: Inlet piping/steam bowl time constant (T4). Typical Value = 0.2. Default: 0 - :k1: Fraction of turbine power developed after first boiler pass (K1). Typical Value = 0.2. Default: 0.0 - :t5: Time constant of second boiler pass (i.e. reheater) (T5). Typical Value = 0.5. Default: 0 - :k2: Fraction of turbine power developed after second boiler pass (K2). Typical Value = 0.2. Default: 0.0 - :t6: Time constant of crossover or third boiler pass (T6). Typical Value = 10. Default: 0 - :k3: Fraction of hp turbine power developed after crossover or third boiler pass (K3). Typical Value = 0.6. Default: 0.0 - :ta: Time to close intercept valve (IV) (Ta). Typical Value = 0.97. Default: 0 - :tb: Time until IV starts to reopen (Tb). Typical Value = 0.98. Default: 0 - :tc: Time until IV is fully open (Tc). Typical Value = 0.99. Default: 0 - :prmax: Max. pressure in reheater (Prmax). Typical Value = 1. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 'uo': [cgmesProfile.DY.value, ], - 'uc': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 'k3': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'prmax': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, k = 0.0, t1 = 0, t2 = 0, t3 = 0, uo = 0.0, uc = 0.0, pmax = 0.0, pmin = 0.0, t4 = 0, k1 = 0.0, t5 = 0, k2 = 0.0, t6 = 0, k3 = 0.0, ta = 0, tb = 0, tc = 0, prmax = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.k = k - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.uo = uo - self.uc = uc - self.pmax = pmax - self.pmin = pmin - self.t4 = t4 - self.k1 = k1 - self.t5 = t5 - self.k2 = k2 - self.t6 = t6 - self.k3 = k3 - self.ta = ta - self.tb = tb - self.tc = tc - self.prmax = prmax - - def __str__(self): - str = 'class=GovSteamFV3\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovSteamFV3(TurbineGovernorDynamics): + """ + Simplified GovSteamIEEE1 Steam turbine governor model with Prmax limit and fast valving. + + :k: Governor gain, (reciprocal of droop) (K). Typical Value = 20. Default: 0.0 + :k1: Fraction of turbine power developed after first boiler pass (K1). Typical Value = 0.2. Default: 0.0 + :k2: Fraction of turbine power developed after second boiler pass (K2). Typical Value = 0.2. Default: 0.0 + :k3: Fraction of hp turbine power developed after crossover or third boiler pass (K3). Typical Value = 0.6. Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :pmax: Maximum valve opening, PU of MWbase (Pmax). Typical Value = 1. Default: 0.0 + :pmin: Minimum valve opening, PU of MWbase (Pmin). Typical Value = 0. Default: 0.0 + :prmax: Max. pressure in reheater (Prmax). Typical Value = 1. Default: 0.0 + :t1: Governor lead time constant (T1). Typical Value = 0. Default: 0.0 + :t2: Governor lag time constant (T2). Typical Value = 0. Default: 0.0 + :t3: Valve positioner time constant (T3). Typical Value = 0. Default: 0.0 + :t4: Inlet piping/steam bowl time constant (T4). Typical Value = 0.2. Default: 0.0 + :t5: Time constant of second boiler pass (i.e. reheater) (T5). Typical Value = 0.5. Default: 0.0 + :t6: Time constant of crossover or third boiler pass (T6). Typical Value = 10. Default: 0.0 + :ta: Time to close intercept valve (IV) (Ta). Typical Value = 0.97. Default: 0.0 + :tb: Time until IV starts to reopen (Tb). Typical Value = 0.98. Default: 0.0 + :tc: Time until IV is fully open (Tc). Typical Value = 0.99. Default: 0.0 + :uc: Maximum valve closing velocity (Uc). Unit = PU/sec. Typical Value = -1. Default: 0.0 + :uo: Maximum valve opening velocity (Uo). Unit = PU/sec. Typical Value = 0.1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "k3": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "prmax": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "uc": [Profile.DY.value, ], + "uo": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, k = 0.0, k1 = 0.0, k2 = 0.0, k3 = 0.0, mwbase = 0.0, pmax = 0.0, pmin = 0.0, prmax = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, t6 = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, uc = 0.0, uo = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.k = k + self.k1 = k1 + self.k2 = k2 + self.k3 = k3 + self.mwbase = mwbase + self.pmax = pmax + self.pmin = pmin + self.prmax = prmax + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.t6 = t6 + self.ta = ta + self.tb = tb + self.tc = tc + self.uc = uc + self.uo = uo + + def __str__(self): + str = "class=GovSteamFV3\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovSteamFV4.py b/cimpy/cgmes_v2_4_15/GovSteamFV4.py index 468f3d01..87843b73 100644 --- a/cimpy/cgmes_v2_4_15/GovSteamFV4.py +++ b/cimpy/cgmes_v2_4_15/GovSteamFV4.py @@ -1,181 +1,183 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovSteamFV4(TurbineGovernorDynamics): - ''' - Detailed electro-hydraulic governor for steam unit. - - :kf1: Frequency bias (reciprocal of droop) (Kf1). Typical Value = 20. Default: 0.0 - :kf3: Frequency control (reciprocal of droop) (Kf3). Typical Value = 20. Default: 0.0 - :lps: Maximum positive power error (Lps). Typical Value = 0.03. Default: 0.0 - :lpi: Maximum negative power error (Lpi). Typical Value = -0.15. Default: 0.0 - :mxef: Upper limit for frequency correction (MX). Typical Value = 0.05. Default: 0.0 - :mnef: Lower limit for frequency correction (MN). Typical Value = -0.05. Default: 0.0 - :crmx: Maximum value of regulator set-point (Crmx). Typical Value = 1.2. Default: 0.0 - :crmn: Minimum value of regulator set-point (Crmn). Typical Value = 0. Default: 0.0 - :kpt: Proportional gain of electro-hydraulic regulator (Kpt). Typical Value = 0.3. Default: 0.0 - :kit: Integral gain of electro-hydraulic regulator (Kit). Typical Value = 0.04. Default: 0.0 - :rvgmx: Maximum value of integral regulator (Rvgmx). Typical Value = 1.2. Default: 0.0 - :rvgmn: Minimum value of integral regulator (Rvgmn). Typical Value = 0. Default: 0.0 - :svmx: Maximum regulator gate opening velocity (Svmx). Typical Value = 0.0333. Default: 0.0 - :svmn: Maximum regulator gate closing velocity (Svmn). Typical Value = -0.0333. Default: 0.0 - :srmx: Maximum valve opening (Srmx). Typical Value = 1.1. Default: 0.0 - :srmn: Minimum valve opening (Srmn). Typical Value = 0. Default: 0.0 - :kpp: Proportional gain of pressure feedback regulator (Kpp). Typical Value = 1. Default: 0.0 - :kip: Integral gain of pressure feedback regulator (Kip). Typical Value = 0.5. Default: 0.0 - :rsmimx: Maximum value of integral regulator (Rsmimx). Typical Value = 1.1. Default: 0.0 - :rsmimn: Minimum value of integral regulator (Rsmimn). Typical Value = 0. Default: 0.0 - :kmp1: First gain coefficient of intercept valves characteristic (Kmp1). Typical Value = 0.5. Default: 0.0 - :kmp2: Second gain coefficient of intercept valves characteristic (Kmp2). Typical Value = 3.5. Default: 0.0 - :srsmp: Intercept valves characteristic discontinuity point (Srsmp). Typical Value = 0.43. Default: 0.0 - :ta: Control valves rate opening time (Ta). Typical Value = 0.8. Default: 0 - :tc: Control valves rate closing time (Tc). Typical Value = 0.5. Default: 0 - :ty: Control valves servo time constant (Ty). Typical Value = 0.1. Default: 0 - :yhpmx: Maximum control valve position (Yhpmx). Typical Value = 1.1. Default: 0.0 - :yhpmn: Minimum control valve position (Yhpmn). Typical Value = 0. Default: 0.0 - :tam: Intercept valves rate opening time (Tam). Typical Value = 0.8. Default: 0 - :tcm: Intercept valves rate closing time (Tcm). Typical Value = 0.5. Default: 0 - :ympmx: Maximum intercept valve position (Ympmx). Typical Value = 1.1. Default: 0.0 - :ympmn: Minimum intercept valve position (Ympmn). Typical Value = 0. Default: 0.0 - :y: Coefficient of linearized equations of turbine (Stodola formulation) (Y). Typical Value = 0.13. Default: 0.0 - :thp: High pressure (HP) time constant of the turbine (Thp). Typical Value = 0.15. Default: 0 - :trh: Reheater time constant of the turbine (Trh). Typical Value = 10. Default: 0 - :tmp: Low pressure (LP) time constant of the turbine (Tmp). Typical Value = 0.4. Default: 0 - :khp: Fraction of total turbine output generated by HP part (Khp). Typical Value = 0.35. Default: 0.0 - :pr1: First value of pressure set point static characteristic (Pr1). Typical Value = 0.2. Default: 0.0 - :pr2: Second value of pressure set point static characteristic, corresponding to Ps0 = 1.0 PU (Pr2). Typical Value = 0.75. Default: 0.0 - :psmn: Minimum value of pressure set point static characteristic (Psmn). Typical Value = 1. Default: 0.0 - :kpc: Proportional gain of pressure regulator (Kpc). Typical Value = 0.5. Default: 0.0 - :kic: Integral gain of pressure regulator (Kic). Typical Value = 0.0033. Default: 0.0 - :kdc: Derivative gain of pressure regulator (Kdc). Typical Value = 1. Default: 0.0 - :tdc: Derivative time constant of pressure regulator (Tdc). Typical Value = 90. Default: 0 - :cpsmx: Maximum value of pressure regulator output (Cpsmx). Typical Value = 1. Default: 0.0 - :cpsmn: Minimum value of pressure regulator output (Cpsmn). Typical Value = -1. Default: 0.0 - :krc: Maximum variation of fuel flow (Krc). Typical Value = 0.05. Default: 0.0 - :tf1: Time constant of fuel regulation (Tf1). Typical Value = 10. Default: 0 - :tf2: Time constant of steam chest (Tf2). Typical Value = 10. Default: 0 - :tv: Boiler time constant (Tv). Typical Value = 60. Default: 0 - :ksh: Pressure loss due to flow friction in the boiler tubes (Ksh). Typical Value = 0.08. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kf1': [cgmesProfile.DY.value, ], - 'kf3': [cgmesProfile.DY.value, ], - 'lps': [cgmesProfile.DY.value, ], - 'lpi': [cgmesProfile.DY.value, ], - 'mxef': [cgmesProfile.DY.value, ], - 'mnef': [cgmesProfile.DY.value, ], - 'crmx': [cgmesProfile.DY.value, ], - 'crmn': [cgmesProfile.DY.value, ], - 'kpt': [cgmesProfile.DY.value, ], - 'kit': [cgmesProfile.DY.value, ], - 'rvgmx': [cgmesProfile.DY.value, ], - 'rvgmn': [cgmesProfile.DY.value, ], - 'svmx': [cgmesProfile.DY.value, ], - 'svmn': [cgmesProfile.DY.value, ], - 'srmx': [cgmesProfile.DY.value, ], - 'srmn': [cgmesProfile.DY.value, ], - 'kpp': [cgmesProfile.DY.value, ], - 'kip': [cgmesProfile.DY.value, ], - 'rsmimx': [cgmesProfile.DY.value, ], - 'rsmimn': [cgmesProfile.DY.value, ], - 'kmp1': [cgmesProfile.DY.value, ], - 'kmp2': [cgmesProfile.DY.value, ], - 'srsmp': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'ty': [cgmesProfile.DY.value, ], - 'yhpmx': [cgmesProfile.DY.value, ], - 'yhpmn': [cgmesProfile.DY.value, ], - 'tam': [cgmesProfile.DY.value, ], - 'tcm': [cgmesProfile.DY.value, ], - 'ympmx': [cgmesProfile.DY.value, ], - 'ympmn': [cgmesProfile.DY.value, ], - 'y': [cgmesProfile.DY.value, ], - 'thp': [cgmesProfile.DY.value, ], - 'trh': [cgmesProfile.DY.value, ], - 'tmp': [cgmesProfile.DY.value, ], - 'khp': [cgmesProfile.DY.value, ], - 'pr1': [cgmesProfile.DY.value, ], - 'pr2': [cgmesProfile.DY.value, ], - 'psmn': [cgmesProfile.DY.value, ], - 'kpc': [cgmesProfile.DY.value, ], - 'kic': [cgmesProfile.DY.value, ], - 'kdc': [cgmesProfile.DY.value, ], - 'tdc': [cgmesProfile.DY.value, ], - 'cpsmx': [cgmesProfile.DY.value, ], - 'cpsmn': [cgmesProfile.DY.value, ], - 'krc': [cgmesProfile.DY.value, ], - 'tf1': [cgmesProfile.DY.value, ], - 'tf2': [cgmesProfile.DY.value, ], - 'tv': [cgmesProfile.DY.value, ], - 'ksh': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, kf1 = 0.0, kf3 = 0.0, lps = 0.0, lpi = 0.0, mxef = 0.0, mnef = 0.0, crmx = 0.0, crmn = 0.0, kpt = 0.0, kit = 0.0, rvgmx = 0.0, rvgmn = 0.0, svmx = 0.0, svmn = 0.0, srmx = 0.0, srmn = 0.0, kpp = 0.0, kip = 0.0, rsmimx = 0.0, rsmimn = 0.0, kmp1 = 0.0, kmp2 = 0.0, srsmp = 0.0, ta = 0, tc = 0, ty = 0, yhpmx = 0.0, yhpmn = 0.0, tam = 0, tcm = 0, ympmx = 0.0, ympmn = 0.0, y = 0.0, thp = 0, trh = 0, tmp = 0, khp = 0.0, pr1 = 0.0, pr2 = 0.0, psmn = 0.0, kpc = 0.0, kic = 0.0, kdc = 0.0, tdc = 0, cpsmx = 0.0, cpsmn = 0.0, krc = 0.0, tf1 = 0, tf2 = 0, tv = 0, ksh = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kf1 = kf1 - self.kf3 = kf3 - self.lps = lps - self.lpi = lpi - self.mxef = mxef - self.mnef = mnef - self.crmx = crmx - self.crmn = crmn - self.kpt = kpt - self.kit = kit - self.rvgmx = rvgmx - self.rvgmn = rvgmn - self.svmx = svmx - self.svmn = svmn - self.srmx = srmx - self.srmn = srmn - self.kpp = kpp - self.kip = kip - self.rsmimx = rsmimx - self.rsmimn = rsmimn - self.kmp1 = kmp1 - self.kmp2 = kmp2 - self.srsmp = srsmp - self.ta = ta - self.tc = tc - self.ty = ty - self.yhpmx = yhpmx - self.yhpmn = yhpmn - self.tam = tam - self.tcm = tcm - self.ympmx = ympmx - self.ympmn = ympmn - self.y = y - self.thp = thp - self.trh = trh - self.tmp = tmp - self.khp = khp - self.pr1 = pr1 - self.pr2 = pr2 - self.psmn = psmn - self.kpc = kpc - self.kic = kic - self.kdc = kdc - self.tdc = tdc - self.cpsmx = cpsmx - self.cpsmn = cpsmn - self.krc = krc - self.tf1 = tf1 - self.tf2 = tf2 - self.tv = tv - self.ksh = ksh - - def __str__(self): - str = 'class=GovSteamFV4\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovSteamFV4(TurbineGovernorDynamics): + """ + Detailed electro-hydraulic governor for steam unit. + + :cpsmn: Minimum value of pressure regulator output (Cpsmn). Typical Value = -1. Default: 0.0 + :cpsmx: Maximum value of pressure regulator output (Cpsmx). Typical Value = 1. Default: 0.0 + :crmn: Minimum value of regulator set-point (Crmn). Typical Value = 0. Default: 0.0 + :crmx: Maximum value of regulator set-point (Crmx). Typical Value = 1.2. Default: 0.0 + :kdc: Derivative gain of pressure regulator (Kdc). Typical Value = 1. Default: 0.0 + :kf1: Frequency bias (reciprocal of droop) (Kf1). Typical Value = 20. Default: 0.0 + :kf3: Frequency control (reciprocal of droop) (Kf3). Typical Value = 20. Default: 0.0 + :khp: Fraction of total turbine output generated by HP part (Khp). Typical Value = 0.35. Default: 0.0 + :kic: Integral gain of pressure regulator (Kic). Typical Value = 0.0033. Default: 0.0 + :kip: Integral gain of pressure feedback regulator (Kip). Typical Value = 0.5. Default: 0.0 + :kit: Integral gain of electro-hydraulic regulator (Kit). Typical Value = 0.04. Default: 0.0 + :kmp1: First gain coefficient of intercept valves characteristic (Kmp1). Typical Value = 0.5. Default: 0.0 + :kmp2: Second gain coefficient of intercept valves characteristic (Kmp2). Typical Value = 3.5. Default: 0.0 + :kpc: Proportional gain of pressure regulator (Kpc). Typical Value = 0.5. Default: 0.0 + :kpp: Proportional gain of pressure feedback regulator (Kpp). Typical Value = 1. Default: 0.0 + :kpt: Proportional gain of electro-hydraulic regulator (Kpt). Typical Value = 0.3. Default: 0.0 + :krc: Maximum variation of fuel flow (Krc). Typical Value = 0.05. Default: 0.0 + :ksh: Pressure loss due to flow friction in the boiler tubes (Ksh). Typical Value = 0.08. Default: 0.0 + :lpi: Maximum negative power error (Lpi). Typical Value = -0.15. Default: 0.0 + :lps: Maximum positive power error (Lps). Typical Value = 0.03. Default: 0.0 + :mnef: Lower limit for frequency correction (MN). Typical Value = -0.05. Default: 0.0 + :mxef: Upper limit for frequency correction (MX). Typical Value = 0.05. Default: 0.0 + :pr1: First value of pressure set point static characteristic (Pr1). Typical Value = 0.2. Default: 0.0 + :pr2: Second value of pressure set point static characteristic, corresponding to Ps0 = 1.0 PU (Pr2). Typical Value = 0.75. Default: 0.0 + :psmn: Minimum value of pressure set point static characteristic (Psmn). Typical Value = 1. Default: 0.0 + :rsmimn: Minimum value of integral regulator (Rsmimn). Typical Value = 0. Default: 0.0 + :rsmimx: Maximum value of integral regulator (Rsmimx). Typical Value = 1.1. Default: 0.0 + :rvgmn: Minimum value of integral regulator (Rvgmn). Typical Value = 0. Default: 0.0 + :rvgmx: Maximum value of integral regulator (Rvgmx). Typical Value = 1.2. Default: 0.0 + :srmn: Minimum valve opening (Srmn). Typical Value = 0. Default: 0.0 + :srmx: Maximum valve opening (Srmx). Typical Value = 1.1. Default: 0.0 + :srsmp: Intercept valves characteristic discontinuity point (Srsmp). Typical Value = 0.43. Default: 0.0 + :svmn: Maximum regulator gate closing velocity (Svmn). Typical Value = -0.0333. Default: 0.0 + :svmx: Maximum regulator gate opening velocity (Svmx). Typical Value = 0.0333. Default: 0.0 + :ta: Control valves rate opening time (Ta). Typical Value = 0.8. Default: 0.0 + :tam: Intercept valves rate opening time (Tam). Typical Value = 0.8. Default: 0.0 + :tc: Control valves rate closing time (Tc). Typical Value = 0.5. Default: 0.0 + :tcm: Intercept valves rate closing time (Tcm). Typical Value = 0.5. Default: 0.0 + :tdc: Derivative time constant of pressure regulator (Tdc). Typical Value = 90. Default: 0.0 + :tf1: Time constant of fuel regulation (Tf1). Typical Value = 10. Default: 0.0 + :tf2: Time constant of steam chest (Tf2). Typical Value = 10. Default: 0.0 + :thp: High pressure (HP) time constant of the turbine (Thp). Typical Value = 0.15. Default: 0.0 + :tmp: Low pressure (LP) time constant of the turbine (Tmp). Typical Value = 0.4. Default: 0.0 + :trh: Reheater time constant of the turbine (Trh). Typical Value = 10. Default: 0.0 + :tv: Boiler time constant (Tv). Typical Value = 60. Default: 0.0 + :ty: Control valves servo time constant (Ty). Typical Value = 0.1. Default: 0.0 + :y: Coefficient of linearized equations of turbine (Stodola formulation) (Y). Typical Value = 0.13. Default: 0.0 + :yhpmn: Minimum control valve position (Yhpmn). Typical Value = 0. Default: 0.0 + :yhpmx: Maximum control valve position (Yhpmx). Typical Value = 1.1. Default: 0.0 + :ympmn: Minimum intercept valve position (Ympmn). Typical Value = 0. Default: 0.0 + :ympmx: Maximum intercept valve position (Ympmx). Typical Value = 1.1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "cpsmn": [Profile.DY.value, ], + "cpsmx": [Profile.DY.value, ], + "crmn": [Profile.DY.value, ], + "crmx": [Profile.DY.value, ], + "kdc": [Profile.DY.value, ], + "kf1": [Profile.DY.value, ], + "kf3": [Profile.DY.value, ], + "khp": [Profile.DY.value, ], + "kic": [Profile.DY.value, ], + "kip": [Profile.DY.value, ], + "kit": [Profile.DY.value, ], + "kmp1": [Profile.DY.value, ], + "kmp2": [Profile.DY.value, ], + "kpc": [Profile.DY.value, ], + "kpp": [Profile.DY.value, ], + "kpt": [Profile.DY.value, ], + "krc": [Profile.DY.value, ], + "ksh": [Profile.DY.value, ], + "lpi": [Profile.DY.value, ], + "lps": [Profile.DY.value, ], + "mnef": [Profile.DY.value, ], + "mxef": [Profile.DY.value, ], + "pr1": [Profile.DY.value, ], + "pr2": [Profile.DY.value, ], + "psmn": [Profile.DY.value, ], + "rsmimn": [Profile.DY.value, ], + "rsmimx": [Profile.DY.value, ], + "rvgmn": [Profile.DY.value, ], + "rvgmx": [Profile.DY.value, ], + "srmn": [Profile.DY.value, ], + "srmx": [Profile.DY.value, ], + "srsmp": [Profile.DY.value, ], + "svmn": [Profile.DY.value, ], + "svmx": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tam": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "tcm": [Profile.DY.value, ], + "tdc": [Profile.DY.value, ], + "tf1": [Profile.DY.value, ], + "tf2": [Profile.DY.value, ], + "thp": [Profile.DY.value, ], + "tmp": [Profile.DY.value, ], + "trh": [Profile.DY.value, ], + "tv": [Profile.DY.value, ], + "ty": [Profile.DY.value, ], + "y": [Profile.DY.value, ], + "yhpmn": [Profile.DY.value, ], + "yhpmx": [Profile.DY.value, ], + "ympmn": [Profile.DY.value, ], + "ympmx": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, cpsmn = 0.0, cpsmx = 0.0, crmn = 0.0, crmx = 0.0, kdc = 0.0, kf1 = 0.0, kf3 = 0.0, khp = 0.0, kic = 0.0, kip = 0.0, kit = 0.0, kmp1 = 0.0, kmp2 = 0.0, kpc = 0.0, kpp = 0.0, kpt = 0.0, krc = 0.0, ksh = 0.0, lpi = 0.0, lps = 0.0, mnef = 0.0, mxef = 0.0, pr1 = 0.0, pr2 = 0.0, psmn = 0.0, rsmimn = 0.0, rsmimx = 0.0, rvgmn = 0.0, rvgmx = 0.0, srmn = 0.0, srmx = 0.0, srsmp = 0.0, svmn = 0.0, svmx = 0.0, ta = 0.0, tam = 0.0, tc = 0.0, tcm = 0.0, tdc = 0.0, tf1 = 0.0, tf2 = 0.0, thp = 0.0, tmp = 0.0, trh = 0.0, tv = 0.0, ty = 0.0, y = 0.0, yhpmn = 0.0, yhpmx = 0.0, ympmn = 0.0, ympmx = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.cpsmn = cpsmn + self.cpsmx = cpsmx + self.crmn = crmn + self.crmx = crmx + self.kdc = kdc + self.kf1 = kf1 + self.kf3 = kf3 + self.khp = khp + self.kic = kic + self.kip = kip + self.kit = kit + self.kmp1 = kmp1 + self.kmp2 = kmp2 + self.kpc = kpc + self.kpp = kpp + self.kpt = kpt + self.krc = krc + self.ksh = ksh + self.lpi = lpi + self.lps = lps + self.mnef = mnef + self.mxef = mxef + self.pr1 = pr1 + self.pr2 = pr2 + self.psmn = psmn + self.rsmimn = rsmimn + self.rsmimx = rsmimx + self.rvgmn = rvgmn + self.rvgmx = rvgmx + self.srmn = srmn + self.srmx = srmx + self.srsmp = srsmp + self.svmn = svmn + self.svmx = svmx + self.ta = ta + self.tam = tam + self.tc = tc + self.tcm = tcm + self.tdc = tdc + self.tf1 = tf1 + self.tf2 = tf2 + self.thp = thp + self.tmp = tmp + self.trh = trh + self.tv = tv + self.ty = ty + self.y = y + self.yhpmn = yhpmn + self.yhpmx = yhpmx + self.ympmn = ympmn + self.ympmx = ympmx + + def __str__(self): + str = "class=GovSteamFV4\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovSteamIEEE1.py b/cimpy/cgmes_v2_4_15/GovSteamIEEE1.py index 2f6f517f..c688ef45 100644 --- a/cimpy/cgmes_v2_4_15/GovSteamIEEE1.py +++ b/cimpy/cgmes_v2_4_15/GovSteamIEEE1.py @@ -1,91 +1,93 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovSteamIEEE1(TurbineGovernorDynamics): - ''' - IEEE steam turbine governor model. Ref - - :mwbase: Base for power values (MWbase) (> 0) Default: 0.0 - :k: Governor gain (reciprocal of droop) (K) (> 0). Typical Value = 25. Default: 0.0 - :t1: Governor lag time constant (T1). Typical Value = 0. Default: 0 - :t2: Governor lead time constant (T2). Typical Value = 0. Default: 0 - :t3: Valve positioner time constant (T3) (> 0). Typical Value = 0.1. Default: 0 - :uo: Maximum valve opening velocity (Uo) (> 0). Unit = PU/sec. Typical Value = 1. Default: 0.0 - :uc: Maximum valve closing velocity (Uc) (< 0). Unit = PU/sec. Typical Value = -10. Default: 0.0 - :pmax: Maximum valve opening (Pmax) (> Pmin). Typical Value = 1. Default: 0.0 - :pmin: Minimum valve opening (Pmin) (>= 0). Typical Value = 0. Default: 0.0 - :t4: Inlet piping/steam bowl time constant (T4). Typical Value = 0.3. Default: 0 - :k1: Fraction of HP shaft power after first boiler pass (K1). Typical Value = 0.2. Default: 0.0 - :k2: Fraction of LP shaft power after first boiler pass (K2). Typical Value = 0. Default: 0.0 - :t5: Time constant of second boiler pass (T5). Typical Value = 5. Default: 0 - :k3: Fraction of HP shaft power after second boiler pass (K3). Typical Value = 0.3. Default: 0.0 - :k4: Fraction of LP shaft power after second boiler pass (K4). Typical Value = 0. Default: 0.0 - :t6: Time constant of third boiler pass (T6). Typical Value = 0.5. Default: 0 - :k5: Fraction of HP shaft power after third boiler pass (K5). Typical Value = 0.5. Default: 0.0 - :k6: Fraction of LP shaft power after third boiler pass (K6). Typical Value = 0. Default: 0.0 - :t7: Time constant of fourth boiler pass (T7). Typical Value = 0. Default: 0 - :k7: Fraction of HP shaft power after fourth boiler pass (K7). Typical Value = 0. Default: 0.0 - :k8: Fraction of LP shaft power after fourth boiler pass (K8). Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 'uo': [cgmesProfile.DY.value, ], - 'uc': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 'k3': [cgmesProfile.DY.value, ], - 'k4': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 'k5': [cgmesProfile.DY.value, ], - 'k6': [cgmesProfile.DY.value, ], - 't7': [cgmesProfile.DY.value, ], - 'k7': [cgmesProfile.DY.value, ], - 'k8': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, k = 0.0, t1 = 0, t2 = 0, t3 = 0, uo = 0.0, uc = 0.0, pmax = 0.0, pmin = 0.0, t4 = 0, k1 = 0.0, k2 = 0.0, t5 = 0, k3 = 0.0, k4 = 0.0, t6 = 0, k5 = 0.0, k6 = 0.0, t7 = 0, k7 = 0.0, k8 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.k = k - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.uo = uo - self.uc = uc - self.pmax = pmax - self.pmin = pmin - self.t4 = t4 - self.k1 = k1 - self.k2 = k2 - self.t5 = t5 - self.k3 = k3 - self.k4 = k4 - self.t6 = t6 - self.k5 = k5 - self.k6 = k6 - self.t7 = t7 - self.k7 = k7 - self.k8 = k8 - - def __str__(self): - str = 'class=GovSteamIEEE1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovSteamIEEE1(TurbineGovernorDynamics): + """ + IEEE steam turbine governor model. Ref + + :k: Governor gain (reciprocal of droop) (K) (> 0). Typical Value = 25. Default: 0.0 + :k1: Fraction of HP shaft power after first boiler pass (K1). Typical Value = 0.2. Default: 0.0 + :k2: Fraction of LP shaft power after first boiler pass (K2). Typical Value = 0. Default: 0.0 + :k3: Fraction of HP shaft power after second boiler pass (K3). Typical Value = 0.3. Default: 0.0 + :k4: Fraction of LP shaft power after second boiler pass (K4). Typical Value = 0. Default: 0.0 + :k5: Fraction of HP shaft power after third boiler pass (K5). Typical Value = 0.5. Default: 0.0 + :k6: Fraction of LP shaft power after third boiler pass (K6). Typical Value = 0. Default: 0.0 + :k7: Fraction of HP shaft power after fourth boiler pass (K7). Typical Value = 0. Default: 0.0 + :k8: Fraction of LP shaft power after fourth boiler pass (K8). Typical Value = 0. Default: 0.0 + :mwbase: Base for power values (MWbase) (> 0) Default: 0.0 + :pmax: Maximum valve opening (Pmax) (> Pmin). Typical Value = 1. Default: 0.0 + :pmin: Minimum valve opening (Pmin) (>= 0). Typical Value = 0. Default: 0.0 + :t1: Governor lag time constant (T1). Typical Value = 0. Default: 0.0 + :t2: Governor lead time constant (T2). Typical Value = 0. Default: 0.0 + :t3: Valve positioner time constant (T3) (> 0). Typical Value = 0.1. Default: 0.0 + :t4: Inlet piping/steam bowl time constant (T4). Typical Value = 0.3. Default: 0.0 + :t5: Time constant of second boiler pass (T5). Typical Value = 5. Default: 0.0 + :t6: Time constant of third boiler pass (T6). Typical Value = 0.5. Default: 0.0 + :t7: Time constant of fourth boiler pass (T7). Typical Value = 0. Default: 0.0 + :uc: Maximum valve closing velocity (Uc) (< 0). Unit = PU/sec. Typical Value = -10. Default: 0.0 + :uo: Maximum valve opening velocity (Uo) (> 0). Unit = PU/sec. Typical Value = 1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "k3": [Profile.DY.value, ], + "k4": [Profile.DY.value, ], + "k5": [Profile.DY.value, ], + "k6": [Profile.DY.value, ], + "k7": [Profile.DY.value, ], + "k8": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "t7": [Profile.DY.value, ], + "uc": [Profile.DY.value, ], + "uo": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, k = 0.0, k1 = 0.0, k2 = 0.0, k3 = 0.0, k4 = 0.0, k5 = 0.0, k6 = 0.0, k7 = 0.0, k8 = 0.0, mwbase = 0.0, pmax = 0.0, pmin = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, t6 = 0.0, t7 = 0.0, uc = 0.0, uo = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.k = k + self.k1 = k1 + self.k2 = k2 + self.k3 = k3 + self.k4 = k4 + self.k5 = k5 + self.k6 = k6 + self.k7 = k7 + self.k8 = k8 + self.mwbase = mwbase + self.pmax = pmax + self.pmin = pmin + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.t6 = t6 + self.t7 = t7 + self.uc = uc + self.uo = uo + + def __str__(self): + str = "class=GovSteamIEEE1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GovSteamSGO.py b/cimpy/cgmes_v2_4_15/GovSteamSGO.py index a5c7a4b2..cac2f373 100644 --- a/cimpy/cgmes_v2_4_15/GovSteamSGO.py +++ b/cimpy/cgmes_v2_4_15/GovSteamSGO.py @@ -1,64 +1,66 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class GovSteamSGO(TurbineGovernorDynamics): - ''' - Simplified Steam turbine governor model. - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :t1: Controller lag (T1). Default: 0 - :t2: Controller lead compensation (T2). Default: 0 - :t3: Governor lag (T3) (>0). Default: 0 - :t4: Delay due to steam inlet volumes associated with steam chest and inlet piping (T4). Default: 0 - :t5: Reheater delay including hot and cold leads (T5). Default: 0 - :t6: Delay due to IP-LP turbine, crossover pipes and LP end hoods (T6). Default: 0 - :k1: One/per unit regulation (K1). Default: 0.0 - :k2: Fraction (K2). Default: 0.0 - :k3: Fraction (K3). Default: 0.0 - :pmax: Upper power limit (Pmax). Default: 0.0 - :pmin: Lower power limit (Pmin). Default: 0 - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - 'k3': [cgmesProfile.DY.value, ], - 'pmax': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, mwbase = 0.0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, t5 = 0, t6 = 0, k1 = 0.0, k2 = 0.0, k3 = 0.0, pmax = 0.0, pmin = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.t5 = t5 - self.t6 = t6 - self.k1 = k1 - self.k2 = k2 - self.k3 = k3 - self.pmax = pmax - self.pmin = pmin - - def __str__(self): - str = 'class=GovSteamSGO\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class GovSteamSGO(TurbineGovernorDynamics): + """ + Simplified Steam turbine governor model. + + :k1: One/per unit regulation (K1). Default: 0.0 + :k2: Fraction (K2). Default: 0.0 + :k3: Fraction (K3). Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :pmax: Upper power limit (Pmax). Default: 0.0 + :pmin: Lower power limit (Pmin). Default: 0.0 + :t1: Controller lag (T1). Default: 0.0 + :t2: Controller lead compensation (T2). Default: 0.0 + :t3: Governor lag (T3) (>0). Default: 0.0 + :t4: Delay due to steam inlet volumes associated with steam chest and inlet piping (T4). Default: 0.0 + :t5: Reheater delay including hot and cold leads (T5). Default: 0.0 + :t6: Delay due to IP-LP turbine, crossover pipes and LP end hoods (T6). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "k3": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pmax": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, k1 = 0.0, k2 = 0.0, k3 = 0.0, mwbase = 0.0, pmax = 0.0, pmin = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, t6 = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.k1 = k1 + self.k2 = k2 + self.k3 = k3 + self.mwbase = mwbase + self.pmax = pmax + self.pmin = pmin + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.t6 = t6 + + def __str__(self): + str = "class=GovSteamSGO\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GrossToNetActivePowerCurve.py b/cimpy/cgmes_v2_4_15/GrossToNetActivePowerCurve.py index be343bf9..deff4e82 100644 --- a/cimpy/cgmes_v2_4_15/GrossToNetActivePowerCurve.py +++ b/cimpy/cgmes_v2_4_15/GrossToNetActivePowerCurve.py @@ -1,31 +1,33 @@ -from .Curve import Curve - - -class GrossToNetActivePowerCurve(Curve): - ''' - Relationship between the generating unit's gross active power output on the X-axis (measured at the terminals of the machine(s)) and the generating unit's net active power output on the Y-axis (based on utility-defined measurements at the power station). Station service loads, when modeled, should be treated as non-conforming bus loads. There may be more than one curve, depending on the auxiliary equipment that is in service. - - :GeneratingUnit: A generating unit may have a gross active power to net active power curve, describing the losses and auxiliary power requirements of the unit. Default: None - ''' - - cgmesProfile = Curve.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'GeneratingUnit': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Curve: \n' + Curve.__doc__ - - def __init__(self, GeneratingUnit = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.GeneratingUnit = GeneratingUnit - - def __str__(self): - str = 'class=GrossToNetActivePowerCurve\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Curve import Curve +from .CGMESProfile import Profile + + +class GrossToNetActivePowerCurve(Curve): + """ + Relationship between the generating unit's gross active power output on the X-axis (measured at the terminals of the machine(s)) and the generating unit's net active power output on the Y-axis (based on utility-defined measurements at the power station). Station service loads, when modeled, should be treated as non-conforming bus loads. There may be more than one curve, depending on the auxiliary equipment that is in service. + + :GeneratingUnit: A generating unit may have a gross active power to net active power curve, describing the losses and auxiliary power requirements of the unit. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "GeneratingUnit": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Curve:\n" + Curve.__doc__ + + def __init__(self, GeneratingUnit = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.GeneratingUnit = GeneratingUnit + + def __str__(self): + str = "class=GrossToNetActivePowerCurve\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Ground.py b/cimpy/cgmes_v2_4_15/Ground.py index 151d7e0f..1f30f99c 100644 --- a/cimpy/cgmes_v2_4_15/Ground.py +++ b/cimpy/cgmes_v2_4_15/Ground.py @@ -1,29 +1,31 @@ -from .ConductingEquipment import ConductingEquipment - - -class Ground(ConductingEquipment): - ''' - A point where the system is grounded used for connecting conducting equipment to ground. The power system model can have any number of grounds. - - ''' - - cgmesProfile = ConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConductingEquipment: \n' + ConductingEquipment.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=Ground\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConductingEquipment import ConductingEquipment +from .CGMESProfile import Profile + + +class Ground(ConductingEquipment): + """ + A point where the system is grounded used for connecting conducting equipment to ground. The power system model can have any number of grounds. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConductingEquipment:\n" + ConductingEquipment.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=Ground\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GroundDisconnector.py b/cimpy/cgmes_v2_4_15/GroundDisconnector.py index 6d6cba79..5bdfdc9c 100644 --- a/cimpy/cgmes_v2_4_15/GroundDisconnector.py +++ b/cimpy/cgmes_v2_4_15/GroundDisconnector.py @@ -1,29 +1,31 @@ -from .Switch import Switch - - -class GroundDisconnector(Switch): - ''' - A manually operated or motor operated mechanical switching device used for isolating a circuit or equipment from ground. - - ''' - - cgmesProfile = Switch.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Switch: \n' + Switch.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=GroundDisconnector\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Switch import Switch +from .CGMESProfile import Profile + + +class GroundDisconnector(Switch): + """ + A manually operated or motor operated mechanical switching device used for isolating a circuit or equipment from ground. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Switch:\n" + Switch.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=GroundDisconnector\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/GroundingImpedance.py b/cimpy/cgmes_v2_4_15/GroundingImpedance.py index c2cf38e8..5c2ef3ac 100644 --- a/cimpy/cgmes_v2_4_15/GroundingImpedance.py +++ b/cimpy/cgmes_v2_4_15/GroundingImpedance.py @@ -1,31 +1,33 @@ -from .EarthFaultCompensator import EarthFaultCompensator - - -class GroundingImpedance(EarthFaultCompensator): - ''' - A fixed impedance device used for grounding. - - :x: Reactance of device. Default: 0.0 - ''' - - cgmesProfile = EarthFaultCompensator.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'x': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EarthFaultCompensator: \n' + EarthFaultCompensator.__doc__ - - def __init__(self, x = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.x = x - - def __str__(self): - str = 'class=GroundingImpedance\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EarthFaultCompensator import EarthFaultCompensator +from .CGMESProfile import Profile + + +class GroundingImpedance(EarthFaultCompensator): + """ + A fixed impedance device used for grounding. + + :x: Reactance of device. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "x": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EarthFaultCompensator:\n" + EarthFaultCompensator.__doc__ + + def __init__(self, x = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.x = x + + def __str__(self): + str = "class=GroundingImpedance\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/HydroEnergyConversionKind.py b/cimpy/cgmes_v2_4_15/HydroEnergyConversionKind.py index 5f38ed4f..af9c7903 100644 --- a/cimpy/cgmes_v2_4_15/HydroEnergyConversionKind.py +++ b/cimpy/cgmes_v2_4_15/HydroEnergyConversionKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class HydroEnergyConversionKind(Base): - ''' - Specifies the capability of the hydro generating unit to convert energy as a generator or pump. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=HydroEnergyConversionKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class HydroEnergyConversionKind(Base): + """ + Specifies the capability of the hydro generating unit to convert energy as a generator or pump. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=HydroEnergyConversionKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/HydroGeneratingUnit.py b/cimpy/cgmes_v2_4_15/HydroGeneratingUnit.py index 52294dd1..3330591e 100644 --- a/cimpy/cgmes_v2_4_15/HydroGeneratingUnit.py +++ b/cimpy/cgmes_v2_4_15/HydroGeneratingUnit.py @@ -1,34 +1,36 @@ -from .GeneratingUnit import GeneratingUnit - - -class HydroGeneratingUnit(GeneratingUnit): - ''' - A generating unit whose prime mover is a hydraulic turbine (e.g., Francis, Pelton, Kaplan). - - :energyConversionCapability: Energy conversion capability for generating. Default: None - :HydroPowerPlant: The hydro generating unit belongs to a hydro power plant. Default: None - ''' - - cgmesProfile = GeneratingUnit.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'energyConversionCapability': [cgmesProfile.EQ.value, ], - 'HydroPowerPlant': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class GeneratingUnit: \n' + GeneratingUnit.__doc__ - - def __init__(self, energyConversionCapability = None, HydroPowerPlant = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.energyConversionCapability = energyConversionCapability - self.HydroPowerPlant = HydroPowerPlant - - def __str__(self): - str = 'class=HydroGeneratingUnit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .GeneratingUnit import GeneratingUnit +from .CGMESProfile import Profile + + +class HydroGeneratingUnit(GeneratingUnit): + """ + A generating unit whose prime mover is a hydraulic turbine (e.g., Francis, Pelton, Kaplan). + + :HydroPowerPlant: The hydro generating unit belongs to a hydro power plant. Default: None + :energyConversionCapability: Energy conversion capability for generating. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "HydroPowerPlant": [Profile.EQ.value, ], + "energyConversionCapability": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class GeneratingUnit:\n" + GeneratingUnit.__doc__ + + def __init__(self, HydroPowerPlant = None, energyConversionCapability = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.HydroPowerPlant = HydroPowerPlant + self.energyConversionCapability = energyConversionCapability + + def __str__(self): + str = "class=HydroGeneratingUnit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/HydroPlantStorageKind.py b/cimpy/cgmes_v2_4_15/HydroPlantStorageKind.py index c4a48018..167673c4 100644 --- a/cimpy/cgmes_v2_4_15/HydroPlantStorageKind.py +++ b/cimpy/cgmes_v2_4_15/HydroPlantStorageKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class HydroPlantStorageKind(Base): - ''' - The type of hydro power plant. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=HydroPlantStorageKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class HydroPlantStorageKind(Base): + """ + The type of hydro power plant. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=HydroPlantStorageKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/HydroPowerPlant.py b/cimpy/cgmes_v2_4_15/HydroPowerPlant.py index 81fbbff8..8c2a41c3 100644 --- a/cimpy/cgmes_v2_4_15/HydroPowerPlant.py +++ b/cimpy/cgmes_v2_4_15/HydroPowerPlant.py @@ -1,37 +1,39 @@ -from .PowerSystemResource import PowerSystemResource - - -class HydroPowerPlant(PowerSystemResource): - ''' - A hydro power station which can generate or pump. When generating, the generator turbines receive water from an upper reservoir. When pumping, the pumps receive their water from a lower reservoir. - - :HydroGeneratingUnits: The hydro generating unit belongs to a hydro power plant. Default: "list" - :hydroPlantStorageType: The type of hydro power plant water storage. Default: None - :HydroPumps: The hydro pump may be a member of a pumped storage plant or a pump for distributing water. Default: "list" - ''' - - cgmesProfile = PowerSystemResource.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'HydroGeneratingUnits': [cgmesProfile.EQ.value, ], - 'hydroPlantStorageType': [cgmesProfile.EQ.value, ], - 'HydroPumps': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemResource: \n' + PowerSystemResource.__doc__ - - def __init__(self, HydroGeneratingUnits = "list", hydroPlantStorageType = None, HydroPumps = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.HydroGeneratingUnits = HydroGeneratingUnits - self.hydroPlantStorageType = hydroPlantStorageType - self.HydroPumps = HydroPumps - - def __str__(self): - str = 'class=HydroPowerPlant\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemResource import PowerSystemResource +from .CGMESProfile import Profile + + +class HydroPowerPlant(PowerSystemResource): + """ + A hydro power station which can generate or pump. When generating, the generator turbines receive water from an upper reservoir. When pumping, the pumps receive their water from a lower reservoir. + + :HydroGeneratingUnits: The hydro generating unit belongs to a hydro power plant. Default: "list" + :HydroPumps: The hydro pump may be a member of a pumped storage plant or a pump for distributing water. Default: "list" + :hydroPlantStorageType: The type of hydro power plant water storage. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "HydroGeneratingUnits": [Profile.EQ.value, ], + "HydroPumps": [Profile.EQ.value, ], + "hydroPlantStorageType": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class PowerSystemResource:\n" + PowerSystemResource.__doc__ + + def __init__(self, HydroGeneratingUnits = "list", HydroPumps = "list", hydroPlantStorageType = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.HydroGeneratingUnits = HydroGeneratingUnits + self.HydroPumps = HydroPumps + self.hydroPlantStorageType = hydroPlantStorageType + + def __str__(self): + str = "class=HydroPowerPlant\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/HydroPump.py b/cimpy/cgmes_v2_4_15/HydroPump.py index 9cceeb48..62b8d6ab 100644 --- a/cimpy/cgmes_v2_4_15/HydroPump.py +++ b/cimpy/cgmes_v2_4_15/HydroPump.py @@ -1,34 +1,36 @@ -from .Equipment import Equipment - - -class HydroPump(Equipment): - ''' - A synchronous motor-driven pump, typically associated with a pumped storage plant. - - :HydroPowerPlant: The hydro pump may be a member of a pumped storage plant or a pump for distributing water. Default: None - :RotatingMachine: The synchronous machine drives the turbine which moves the water from a low elevation to a higher elevation. The direction of machine rotation for pumping may or may not be the same as for generating. Default: None - ''' - - cgmesProfile = Equipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'HydroPowerPlant': [cgmesProfile.EQ.value, ], - 'RotatingMachine': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Equipment: \n' + Equipment.__doc__ - - def __init__(self, HydroPowerPlant = None, RotatingMachine = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.HydroPowerPlant = HydroPowerPlant - self.RotatingMachine = RotatingMachine - - def __str__(self): - str = 'class=HydroPump\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Equipment import Equipment +from .CGMESProfile import Profile + + +class HydroPump(Equipment): + """ + A synchronous motor-driven pump, typically associated with a pumped storage plant. + + :HydroPowerPlant: The hydro pump may be a member of a pumped storage plant or a pump for distributing water. Default: None + :RotatingMachine: The synchronous machine drives the turbine which moves the water from a low elevation to a higher elevation. The direction of machine rotation for pumping may or may not be the same as for generating. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "HydroPowerPlant": [Profile.EQ.value, ], + "RotatingMachine": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Equipment:\n" + Equipment.__doc__ + + def __init__(self, HydroPowerPlant = None, RotatingMachine = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.HydroPowerPlant = HydroPowerPlant + self.RotatingMachine = RotatingMachine + + def __str__(self): + str = "class=HydroPump\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/IdentifiedObject.py b/cimpy/cgmes_v2_4_15/IdentifiedObject.py index 50287a81..07969902 100644 --- a/cimpy/cgmes_v2_4_15/IdentifiedObject.py +++ b/cimpy/cgmes_v2_4_15/IdentifiedObject.py @@ -1,45 +1,46 @@ -from .Base import Base - - -class IdentifiedObject(Base): - ''' - This is a root class to provide common identification for all classes needing identification and naming attributes. - - :DiagramObjects: The domain object to which this diagram object is associated. Default: "list" - :mRID: Master resource identifier issued by a model authority. The mRID is globally unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552 Edition 1, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements. Default: '' - :name: The name is any free human readable and possibly non unique text naming the object. Default: '' - :description: The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy. Default: '' - :energyIdentCodeEic: The attribute is used for an exchange of the EIC code (Energy identification Code). The length of the string is 16 characters as defined by the EIC code. References: Default: '' - :shortName: The attribute is used for an exchange of a human readable short name with length of the string 12 characters maximum. Default: '' - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.GL.value, cgmesProfile.DY.value, cgmesProfile.TP.value, cgmesProfile.TP_BD.value, cgmesProfile.EQ_BD.value, ], - 'DiagramObjects': [cgmesProfile.DL.value, ], - 'mRID': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.GL.value, cgmesProfile.DY.value, cgmesProfile.TP.value, cgmesProfile.TP_BD.value, cgmesProfile.EQ_BD.value, ], - 'name': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.GL.value, cgmesProfile.DY.value, cgmesProfile.TP.value, cgmesProfile.TP_BD.value, cgmesProfile.EQ_BD.value, ], - 'description': [cgmesProfile.EQ.value, cgmesProfile.DY.value, cgmesProfile.TP.value, cgmesProfile.TP_BD.value, cgmesProfile.EQ_BD.value, ], - 'energyIdentCodeEic': [cgmesProfile.EQ.value, cgmesProfile.TP.value, cgmesProfile.TP_BD.value, cgmesProfile.EQ_BD.value, ], - 'shortName': [cgmesProfile.EQ.value, cgmesProfile.TP.value, cgmesProfile.TP_BD.value, cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - - - def __init__(self, DiagramObjects = "list", mRID = '', name = '', description = '', energyIdentCodeEic = '', shortName = '', ): - - self.DiagramObjects = DiagramObjects - self.mRID = mRID - self.name = name - self.description = description - self.energyIdentCodeEic = energyIdentCodeEic - self.shortName = shortName - - def __str__(self): - str = 'class=IdentifiedObject\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class IdentifiedObject(Base): + """ + This is a root class to provide common identification for all classes needing identification and naming attributes. + + :DiagramObjects: The domain object to which this diagram object is associated. Default: "list" + :description: The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy. Default: '' + :energyIdentCodeEic: The attribute is used for an exchange of the EIC code (Energy identification Code). The length of the string is 16 characters as defined by the EIC code. References: Default: '' + :mRID: Master resource identifier issued by a model authority. The mRID is globally unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552 Edition 1, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements. Default: '' + :name: The name is any free human readable and possibly non unique text naming the object. Default: '' + :shortName: The attribute is used for an exchange of a human readable short name with length of the string 12 characters maximum. Default: '' + """ + + possibleProfileList = { + "class": [Profile.DL.value, Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.GL.value, Profile.SV.value, Profile.SSH.value, Profile.TP_BD.value, Profile.TP.value, ], + "DiagramObjects": [Profile.DL.value, ], + "description": [Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.TP_BD.value, Profile.TP.value, ], + "energyIdentCodeEic": [Profile.EQ_BD.value, Profile.EQ.value, Profile.TP_BD.value, Profile.TP.value, ], + "mRID": [Profile.DL.value, Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.GL.value, Profile.SV.value, Profile.SSH.value, Profile.TP_BD.value, Profile.TP.value, ], + "name": [Profile.DL.value, Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.GL.value, Profile.SV.value, Profile.SSH.value, Profile.TP_BD.value, Profile.TP.value, ], + "shortName": [Profile.EQ_BD.value, Profile.EQ.value, Profile.TP_BD.value, Profile.TP.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, DiagramObjects = "list", description = '', energyIdentCodeEic = '', mRID = '', name = '', shortName = ''): + + self.DiagramObjects = DiagramObjects + self.description = description + self.energyIdentCodeEic = energyIdentCodeEic + self.mRID = mRID + self.name = name + self.shortName = shortName + + def __str__(self): + str = "class=IdentifiedObject\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/IfdBaseKind.py b/cimpy/cgmes_v2_4_15/IfdBaseKind.py index 61a69d68..372b87e0 100644 --- a/cimpy/cgmes_v2_4_15/IfdBaseKind.py +++ b/cimpy/cgmes_v2_4_15/IfdBaseKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class IfdBaseKind(Base): - ''' - Excitation base system mode. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=IfdBaseKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class IfdBaseKind(Base): + """ + Excitation base system mode. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=IfdBaseKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Inductance.py b/cimpy/cgmes_v2_4_15/Inductance.py index 4f0de585..088a56c3 100644 --- a/cimpy/cgmes_v2_4_15/Inductance.py +++ b/cimpy/cgmes_v2_4_15/Inductance.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class Inductance(Base): - ''' - Inductive part of reactance (imaginary part of impedance), at rated frequency. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=Inductance\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Inductance(Base): + """ + Inductive part of reactance (imaginary part of impedance), at rated frequency. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=Inductance\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/InductancePerLength.py b/cimpy/cgmes_v2_4_15/InductancePerLength.py index df68e717..fa589cbf 100644 --- a/cimpy/cgmes_v2_4_15/InductancePerLength.py +++ b/cimpy/cgmes_v2_4_15/InductancePerLength.py @@ -1,42 +1,43 @@ -from .Base import Base - - -class InductancePerLength(Base): - ''' - Inductance per unit of length. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - :denominatorUnit: Default: None - :denominatorMultiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - 'denominatorUnit': [cgmesProfile.EQ.value, ], - 'denominatorMultiplier': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, denominatorUnit = None, denominatorMultiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - self.denominatorUnit = denominatorUnit - self.denominatorMultiplier = denominatorMultiplier - - def __str__(self): - str = 'class=InductancePerLength\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class InductancePerLength(Base): + """ + Inductance per unit of length. + + :denominatorMultiplier: Default: None + :denominatorUnit: Default: None + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "denominatorMultiplier": [Profile.EQ.value, ], + "denominatorUnit": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, denominatorMultiplier = None, denominatorUnit = None, multiplier = None, unit = None, value = 0.0): + + self.denominatorMultiplier = denominatorMultiplier + self.denominatorUnit = denominatorUnit + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=InductancePerLength\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/InputSignalKind.py b/cimpy/cgmes_v2_4_15/InputSignalKind.py index b7d9440e..0e624d46 100644 --- a/cimpy/cgmes_v2_4_15/InputSignalKind.py +++ b/cimpy/cgmes_v2_4_15/InputSignalKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class InputSignalKind(Base): - ''' - Input signal type. In Dynamics modelling, commonly represented by j parameter. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=InputSignalKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class InputSignalKind(Base): + """ + Input signal type. In Dynamics modelling, commonly represented by j parameter. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=InputSignalKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Integer.py b/cimpy/cgmes_v2_4_15/Integer.py index 920f9952..f87de79c 100644 --- a/cimpy/cgmes_v2_4_15/Integer.py +++ b/cimpy/cgmes_v2_4_15/Integer.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class Integer(Base): - ''' - An integer number. The range is unspecified and not limited. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.GL.value, cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=Integer\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Integer(Base): + """ + An integer number. The range is unspecified and not limited. + + """ + + possibleProfileList = { + "class": [Profile.DL.value, Profile.DY.value, Profile.EQ.value, Profile.GL.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=Integer\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Junction.py b/cimpy/cgmes_v2_4_15/Junction.py index f229c3cb..dc9a6fcc 100644 --- a/cimpy/cgmes_v2_4_15/Junction.py +++ b/cimpy/cgmes_v2_4_15/Junction.py @@ -1,29 +1,31 @@ -from .Connector import Connector - - -class Junction(Connector): - ''' - A point where one or more conducting equipments are connected with zero resistance. - - ''' - - cgmesProfile = Connector.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Connector: \n' + Connector.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=Junction\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Connector import Connector +from .CGMESProfile import Profile + + +class Junction(Connector): + """ + A point where one or more conducting equipments are connected with zero resistance. + + """ + + possibleProfileList = { + "class": [Profile.EQ_BD.value, Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Connector:\n" + Connector.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=Junction\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Length.py b/cimpy/cgmes_v2_4_15/Length.py index ec838972..c34aced2 100644 --- a/cimpy/cgmes_v2_4_15/Length.py +++ b/cimpy/cgmes_v2_4_15/Length.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class Length(Base): - ''' - Unit of length. Never negative. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'value': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'unit': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'multiplier': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=Length\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Length(Base): + """ + Unit of length. Never negative. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, ], + "multiplier": [Profile.DY.value, Profile.EQ.value, ], + "unit": [Profile.DY.value, Profile.EQ.value, ], + "value": [Profile.DY.value, Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=Length\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Limit.py b/cimpy/cgmes_v2_4_15/Limit.py index a6b42c64..c51d63a0 100644 --- a/cimpy/cgmes_v2_4_15/Limit.py +++ b/cimpy/cgmes_v2_4_15/Limit.py @@ -1,29 +1,31 @@ -from .IdentifiedObject import IdentifiedObject - - -class Limit(IdentifiedObject): - ''' - Specifies one limit value for a Measurement. A Measurement typically has several limits that are kept together by the LimitSet class. The actual meaning and use of a Limit instance (i.e., if it is an alarm or warning limit or if it is a high or low limit) is not captured in the Limit class. However the name of a Limit instance may indicate both meaning and use. - - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=Limit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class Limit(IdentifiedObject): + """ + Specifies one limit value for a Measurement. A Measurement typically has several limits that are kept together by the LimitSet class. The actual meaning and use of a Limit instance (i.e., if it is an alarm or warning limit or if it is a high or low limit) is not captured in the Limit class. However the name of a Limit instance may indicate both meaning and use. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=Limit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LimitSet.py b/cimpy/cgmes_v2_4_15/LimitSet.py index 0ab9bc04..4e3d50b5 100644 --- a/cimpy/cgmes_v2_4_15/LimitSet.py +++ b/cimpy/cgmes_v2_4_15/LimitSet.py @@ -1,31 +1,33 @@ -from .IdentifiedObject import IdentifiedObject - - -class LimitSet(IdentifiedObject): - ''' - Specifies a set of Limits that are associated with a Measurement. A Measurement may have several LimitSets corresponding to seasonal or other changing conditions. The condition is captured in the name and description attributes. The same LimitSet may be used for several Measurements. In particular percentage limits are used this way. - - :isPercentageLimits: Tells if the limit values are in percentage of normalValue or the specified Unit for Measurements and Controls. Default: False - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'isPercentageLimits': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, isPercentageLimits = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.isPercentageLimits = isPercentageLimits - - def __str__(self): - str = 'class=LimitSet\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class LimitSet(IdentifiedObject): + """ + Specifies a set of Limits that are associated with a Measurement. A Measurement may have several LimitSets corresponding to seasonal or other changing conditions. The condition is captured in the name and description attributes. The same LimitSet may be used for several Measurements. In particular percentage limits are used this way. + + :isPercentageLimits: Tells if the limit values are in percentage of normalValue or the specified Unit for Measurements and Controls. Default: False + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "isPercentageLimits": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, isPercentageLimits = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.isPercentageLimits = isPercentageLimits + + def __str__(self): + str = "class=LimitSet\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LimitTypeKind.py b/cimpy/cgmes_v2_4_15/LimitTypeKind.py index de332e69..9e34bc87 100644 --- a/cimpy/cgmes_v2_4_15/LimitTypeKind.py +++ b/cimpy/cgmes_v2_4_15/LimitTypeKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class LimitTypeKind(Base): - ''' - The enumeration defines the kinds of the limit types. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=LimitTypeKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class LimitTypeKind(Base): + """ + The enumeration defines the kinds of the limit types. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=LimitTypeKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Line.py b/cimpy/cgmes_v2_4_15/Line.py index 6e20766a..ad666b8e 100644 --- a/cimpy/cgmes_v2_4_15/Line.py +++ b/cimpy/cgmes_v2_4_15/Line.py @@ -1,31 +1,33 @@ -from .EquipmentContainer import EquipmentContainer - - -class Line(EquipmentContainer): - ''' - Contains equipment beyond a substation belonging to a power transmission line. - - :Region: The sub-geographical region of the line. Default: None - ''' - - cgmesProfile = EquipmentContainer.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - 'Region': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EquipmentContainer: \n' + EquipmentContainer.__doc__ - - def __init__(self, Region = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Region = Region - - def __str__(self): - str = 'class=Line\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EquipmentContainer import EquipmentContainer +from .CGMESProfile import Profile + + +class Line(EquipmentContainer): + """ + Contains equipment beyond a substation belonging to a power transmission line. + + :Region: The lines within the sub-geographical region. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ_BD.value, Profile.EQ.value, ], + "Region": [Profile.EQ_BD.value, Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EquipmentContainer:\n" + EquipmentContainer.__doc__ + + def __init__(self, Region = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Region = Region + + def __str__(self): + str = "class=Line\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LinearShuntCompensator.py b/cimpy/cgmes_v2_4_15/LinearShuntCompensator.py index 7915ed2f..62c82f9e 100644 --- a/cimpy/cgmes_v2_4_15/LinearShuntCompensator.py +++ b/cimpy/cgmes_v2_4_15/LinearShuntCompensator.py @@ -1,40 +1,42 @@ -from .ShuntCompensator import ShuntCompensator - - -class LinearShuntCompensator(ShuntCompensator): - ''' - A linear shunt compensator has banks or sections with equal admittance values. - - :bPerSection: Positive sequence shunt (charging) susceptance per section Default: 0.0 - :gPerSection: Positive sequence shunt (charging) conductance per section Default: 0.0 - :b0PerSection: Zero sequence shunt (charging) susceptance per section Default: 0.0 - :g0PerSection: Zero sequence shunt (charging) conductance per section Default: 0.0 - ''' - - cgmesProfile = ShuntCompensator.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'bPerSection': [cgmesProfile.EQ.value, ], - 'gPerSection': [cgmesProfile.EQ.value, ], - 'b0PerSection': [cgmesProfile.EQ.value, ], - 'g0PerSection': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ShuntCompensator: \n' + ShuntCompensator.__doc__ - - def __init__(self, bPerSection = 0.0, gPerSection = 0.0, b0PerSection = 0.0, g0PerSection = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.bPerSection = bPerSection - self.gPerSection = gPerSection - self.b0PerSection = b0PerSection - self.g0PerSection = g0PerSection - - def __str__(self): - str = 'class=LinearShuntCompensator\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ShuntCompensator import ShuntCompensator +from .CGMESProfile import Profile + + +class LinearShuntCompensator(ShuntCompensator): + """ + A linear shunt compensator has banks or sections with equal admittance values. + + :b0PerSection: Zero sequence shunt (charging) susceptance per section Default: 0.0 + :bPerSection: Positive sequence shunt (charging) susceptance per section Default: 0.0 + :g0PerSection: Zero sequence shunt (charging) conductance per section Default: 0.0 + :gPerSection: Positive sequence shunt (charging) conductance per section Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "b0PerSection": [Profile.EQ.value, ], + "bPerSection": [Profile.EQ.value, ], + "g0PerSection": [Profile.EQ.value, ], + "gPerSection": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ShuntCompensator:\n" + ShuntCompensator.__doc__ + + def __init__(self, b0PerSection = 0.0, bPerSection = 0.0, g0PerSection = 0.0, gPerSection = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.b0PerSection = b0PerSection + self.bPerSection = bPerSection + self.g0PerSection = g0PerSection + self.gPerSection = gPerSection + + def __str__(self): + str = "class=LinearShuntCompensator\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LoadAggregate.py b/cimpy/cgmes_v2_4_15/LoadAggregate.py index 8461892e..a91313bf 100644 --- a/cimpy/cgmes_v2_4_15/LoadAggregate.py +++ b/cimpy/cgmes_v2_4_15/LoadAggregate.py @@ -1,34 +1,36 @@ -from .LoadDynamics import LoadDynamics - - -class LoadAggregate(LoadDynamics): - ''' - Standard aggregate load model comprised of static and/or dynamic components. A static load model represents the sensitivity of the real and reactive power consumed by the load to the amplitude and frequency of the bus voltage. A dynamic load model can used to represent the aggregate response of the motor components of the load. - - :LoadStatic: Aggregate static load associated with this aggregate load. Default: None - :LoadMotor: Aggregate motor (dynamic) load associated with this aggregate load. Default: None - ''' - - cgmesProfile = LoadDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'LoadStatic': [cgmesProfile.DY.value, ], - 'LoadMotor': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class LoadDynamics: \n' + LoadDynamics.__doc__ - - def __init__(self, LoadStatic = None, LoadMotor = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.LoadStatic = LoadStatic - self.LoadMotor = LoadMotor - - def __str__(self): - str = 'class=LoadAggregate\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .LoadDynamics import LoadDynamics +from .CGMESProfile import Profile + + +class LoadAggregate(LoadDynamics): + """ + Standard aggregate load model comprised of static and/or dynamic components. A static load model represents the sensitivity of the real and reactive power consumed by the load to the amplitude and frequency of the bus voltage. A dynamic load model can used to represent the aggregate response of the motor components of the load. + + :LoadMotor: Aggregate motor (dynamic) load associated with this aggregate load. Default: None + :LoadStatic: Aggregate static load associated with this aggregate load. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "LoadMotor": [Profile.DY.value, ], + "LoadStatic": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class LoadDynamics:\n" + LoadDynamics.__doc__ + + def __init__(self, LoadMotor = None, LoadStatic = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.LoadMotor = LoadMotor + self.LoadStatic = LoadStatic + + def __str__(self): + str = "class=LoadAggregate\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LoadArea.py b/cimpy/cgmes_v2_4_15/LoadArea.py index 5cbcb0fb..3f3fa533 100644 --- a/cimpy/cgmes_v2_4_15/LoadArea.py +++ b/cimpy/cgmes_v2_4_15/LoadArea.py @@ -1,31 +1,33 @@ -from .EnergyArea import EnergyArea - - -class LoadArea(EnergyArea): - ''' - The class is the root or first level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling. - - :SubLoadAreas: The SubLoadAreas in the LoadArea. Default: "list" - ''' - - cgmesProfile = EnergyArea.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'SubLoadAreas': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EnergyArea: \n' + EnergyArea.__doc__ - - def __init__(self, SubLoadAreas = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.SubLoadAreas = SubLoadAreas - - def __str__(self): - str = 'class=LoadArea\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EnergyArea import EnergyArea +from .CGMESProfile import Profile + + +class LoadArea(EnergyArea): + """ + The class is the root or first level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling. + + :SubLoadAreas: The SubLoadAreas in the LoadArea. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "SubLoadAreas": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EnergyArea:\n" + EnergyArea.__doc__ + + def __init__(self, SubLoadAreas = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.SubLoadAreas = SubLoadAreas + + def __str__(self): + str = "class=LoadArea\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LoadBreakSwitch.py b/cimpy/cgmes_v2_4_15/LoadBreakSwitch.py index bcdd0b12..a8b8f947 100644 --- a/cimpy/cgmes_v2_4_15/LoadBreakSwitch.py +++ b/cimpy/cgmes_v2_4_15/LoadBreakSwitch.py @@ -1,29 +1,31 @@ -from .ProtectedSwitch import ProtectedSwitch - - -class LoadBreakSwitch(ProtectedSwitch): - ''' - A mechanical switching device capable of making, carrying, and breaking currents under normal operating conditions. - - ''' - - cgmesProfile = ProtectedSwitch.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ProtectedSwitch: \n' + ProtectedSwitch.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=LoadBreakSwitch\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ProtectedSwitch import ProtectedSwitch +from .CGMESProfile import Profile + + +class LoadBreakSwitch(ProtectedSwitch): + """ + A mechanical switching device capable of making, carrying, and breaking currents under normal operating conditions. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ProtectedSwitch:\n" + ProtectedSwitch.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=LoadBreakSwitch\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LoadComposite.py b/cimpy/cgmes_v2_4_15/LoadComposite.py index d8170870..e1ad4452 100644 --- a/cimpy/cgmes_v2_4_15/LoadComposite.py +++ b/cimpy/cgmes_v2_4_15/LoadComposite.py @@ -1,61 +1,63 @@ -from .LoadDynamics import LoadDynamics - - -class LoadComposite(LoadDynamics): - ''' - This models combines static load and induction motor load effects. The dynamics of the motor are simplified by linearizing the induction machine equations. - - :epvs: Active load-voltage dependence index (static) (Epvs). Typical Value = 0.7. Default: 0.0 - :epfs: Active load-frequency dependence index (static) (Epfs). Typical Value = 1.5. Default: 0.0 - :eqvs: Reactive load-voltage dependence index (static) (Eqvs). Typical Value = 2. Default: 0.0 - :eqfs: Reactive load-frequency dependence index (static) (Eqfs). Typical Value = 0. Default: 0.0 - :epvd: Active load-voltage dependence index (dynamic) (Epvd). Typical Value = 0.7. Default: 0.0 - :epfd: Active load-frequency dependence index (dynamic) (Epfd). Typical Value = 1.5. Default: 0.0 - :eqvd: Reactive load-voltage dependence index (dynamic) (Eqvd). Typical Value = 2. Default: 0.0 - :eqfd: Reactive load-frequency dependence index (dynamic) (Eqfd). Typical Value = 0. Default: 0.0 - :lfrac: Loading factor - ratio of initial P to motor MVA base (Lfrac). Typical Value = 0.8. Default: 0.0 - :h: Inertia constant (H). Typical Value = 2.5. Default: 0 - :pfrac: Fraction of constant-power load to be represented by this motor model (Pfrac) (>=0.0 and <=1.0). Typical Value = 0.5. Default: 0.0 - ''' - - cgmesProfile = LoadDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'epvs': [cgmesProfile.DY.value, ], - 'epfs': [cgmesProfile.DY.value, ], - 'eqvs': [cgmesProfile.DY.value, ], - 'eqfs': [cgmesProfile.DY.value, ], - 'epvd': [cgmesProfile.DY.value, ], - 'epfd': [cgmesProfile.DY.value, ], - 'eqvd': [cgmesProfile.DY.value, ], - 'eqfd': [cgmesProfile.DY.value, ], - 'lfrac': [cgmesProfile.DY.value, ], - 'h': [cgmesProfile.DY.value, ], - 'pfrac': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class LoadDynamics: \n' + LoadDynamics.__doc__ - - def __init__(self, epvs = 0.0, epfs = 0.0, eqvs = 0.0, eqfs = 0.0, epvd = 0.0, epfd = 0.0, eqvd = 0.0, eqfd = 0.0, lfrac = 0.0, h = 0, pfrac = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.epvs = epvs - self.epfs = epfs - self.eqvs = eqvs - self.eqfs = eqfs - self.epvd = epvd - self.epfd = epfd - self.eqvd = eqvd - self.eqfd = eqfd - self.lfrac = lfrac - self.h = h - self.pfrac = pfrac - - def __str__(self): - str = 'class=LoadComposite\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .LoadDynamics import LoadDynamics +from .CGMESProfile import Profile + + +class LoadComposite(LoadDynamics): + """ + This models combines static load and induction motor load effects. The dynamics of the motor are simplified by linearizing the induction machine equations. + + :epfd: Active load-frequency dependence index (dynamic) (Epfd). Typical Value = 1.5. Default: 0.0 + :epfs: Active load-frequency dependence index (static) (Epfs). Typical Value = 1.5. Default: 0.0 + :epvd: Active load-voltage dependence index (dynamic) (Epvd). Typical Value = 0.7. Default: 0.0 + :epvs: Active load-voltage dependence index (static) (Epvs). Typical Value = 0.7. Default: 0.0 + :eqfd: Reactive load-frequency dependence index (dynamic) (Eqfd). Typical Value = 0. Default: 0.0 + :eqfs: Reactive load-frequency dependence index (static) (Eqfs). Typical Value = 0. Default: 0.0 + :eqvd: Reactive load-voltage dependence index (dynamic) (Eqvd). Typical Value = 2. Default: 0.0 + :eqvs: Reactive load-voltage dependence index (static) (Eqvs). Typical Value = 2. Default: 0.0 + :h: Inertia constant (H). Typical Value = 2.5. Default: 0.0 + :lfrac: Loading factor - ratio of initial P to motor MVA base (Lfrac). Typical Value = 0.8. Default: 0.0 + :pfrac: Fraction of constant-power load to be represented by this motor model (Pfrac) (>=0.0 and <=1.0). Typical Value = 0.5. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "epfd": [Profile.DY.value, ], + "epfs": [Profile.DY.value, ], + "epvd": [Profile.DY.value, ], + "epvs": [Profile.DY.value, ], + "eqfd": [Profile.DY.value, ], + "eqfs": [Profile.DY.value, ], + "eqvd": [Profile.DY.value, ], + "eqvs": [Profile.DY.value, ], + "h": [Profile.DY.value, ], + "lfrac": [Profile.DY.value, ], + "pfrac": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class LoadDynamics:\n" + LoadDynamics.__doc__ + + def __init__(self, epfd = 0.0, epfs = 0.0, epvd = 0.0, epvs = 0.0, eqfd = 0.0, eqfs = 0.0, eqvd = 0.0, eqvs = 0.0, h = 0.0, lfrac = 0.0, pfrac = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.epfd = epfd + self.epfs = epfs + self.epvd = epvd + self.epvs = epvs + self.eqfd = eqfd + self.eqfs = eqfs + self.eqvd = eqvd + self.eqvs = eqvs + self.h = h + self.lfrac = lfrac + self.pfrac = pfrac + + def __str__(self): + str = "class=LoadComposite\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LoadDynamics.py b/cimpy/cgmes_v2_4_15/LoadDynamics.py index 508c0c36..16983bcc 100644 --- a/cimpy/cgmes_v2_4_15/LoadDynamics.py +++ b/cimpy/cgmes_v2_4_15/LoadDynamics.py @@ -1,31 +1,33 @@ -from .IdentifiedObject import IdentifiedObject - - -class LoadDynamics(IdentifiedObject): - ''' - Load whose behaviour is described by reference to a standard model A standard feature of dynamic load behaviour modelling is the ability to associate the same behaviour to multiple energy consumers by means of a single aggregate load definition. Aggregate loads are used to represent all or part of the real and reactive load from one or more loads in the static (power flow) data. This load is usually the aggregation of many individual load devices and the load model is approximate representation of the aggregate response of the load devices to system disturbances. The load model is always applied to individual bus loads (energy consumers) but a single set of load model parameters can used for all loads in the grouping. - - :EnergyConsumer: Energy consumer to which this dynamics load model applies. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'EnergyConsumer': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, EnergyConsumer = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.EnergyConsumer = EnergyConsumer - - def __str__(self): - str = 'class=LoadDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class LoadDynamics(IdentifiedObject): + """ + Load whose behaviour is described by reference to a standard model A standard feature of dynamic load behaviour modelling is the ability to associate the same behaviour to multiple energy consumers by means of a single aggregate load definition. Aggregate loads are used to represent all or part of the real and reactive load from one or more loads in the static (power flow) data. This load is usually the aggregation of many individual load devices and the load model is approximate representation of the aggregate response of the load devices to system disturbances. The load model is always applied to individual bus loads (energy consumers) but a single set of load model parameters can used for all loads in the grouping. + + :EnergyConsumer: Energy consumer to which this dynamics load model applies. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "EnergyConsumer": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, EnergyConsumer = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.EnergyConsumer = EnergyConsumer + + def __str__(self): + str = "class=LoadDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LoadGenericNonLinear.py b/cimpy/cgmes_v2_4_15/LoadGenericNonLinear.py index 8caeb1a9..320df579 100644 --- a/cimpy/cgmes_v2_4_15/LoadGenericNonLinear.py +++ b/cimpy/cgmes_v2_4_15/LoadGenericNonLinear.py @@ -1,55 +1,57 @@ -from .LoadDynamics import LoadDynamics - - -class LoadGenericNonLinear(LoadDynamics): - ''' - These load models (known also as generic non-linear dynamic (GNLD) load models) can be used in mid-term and long-term voltage stability simulations (i.e., to study voltage collapse), as they can replace a more detailed representation of aggregate load, including induction motors, thermostatically controlled and static loads. - - :genericNonLinearLoadModelType: Type of generic non-linear load model. Default: None - :pt: Dynamic portion of active load (P). Default: 0.0 - :qt: Dynamic portion of reactive load (Q). Default: 0.0 - :tp: Time constant of lag function of active power (T). Default: 0 - :tq: Time constant of lag function of reactive power (T). Default: 0 - :ls: Steady state voltage index for active power (LS). Default: 0.0 - :lt: Transient voltage index for active power (LT). Default: 0.0 - :bs: Steady state voltage index for reactive power (BS). Default: 0.0 - :bt: Transient voltage index for reactive power (BT). Default: 0.0 - ''' - - cgmesProfile = LoadDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'genericNonLinearLoadModelType': [cgmesProfile.DY.value, ], - 'pt': [cgmesProfile.DY.value, ], - 'qt': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 'tq': [cgmesProfile.DY.value, ], - 'ls': [cgmesProfile.DY.value, ], - 'lt': [cgmesProfile.DY.value, ], - 'bs': [cgmesProfile.DY.value, ], - 'bt': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class LoadDynamics: \n' + LoadDynamics.__doc__ - - def __init__(self, genericNonLinearLoadModelType = None, pt = 0.0, qt = 0.0, tp = 0, tq = 0, ls = 0.0, lt = 0.0, bs = 0.0, bt = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.genericNonLinearLoadModelType = genericNonLinearLoadModelType - self.pt = pt - self.qt = qt - self.tp = tp - self.tq = tq - self.ls = ls - self.lt = lt - self.bs = bs - self.bt = bt - - def __str__(self): - str = 'class=LoadGenericNonLinear\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .LoadDynamics import LoadDynamics +from .CGMESProfile import Profile + + +class LoadGenericNonLinear(LoadDynamics): + """ + These load models (known also as generic non-linear dynamic (GNLD) load models) can be used in mid-term and long-term voltage stability simulations (i.e., to study voltage collapse), as they can replace a more detailed representation of aggregate load, including induction motors, thermostatically controlled and static loads. + + :bs: Steady state voltage index for reactive power (BS). Default: 0.0 + :bt: Transient voltage index for reactive power (BT). Default: 0.0 + :genericNonLinearLoadModelType: Type of generic non-linear load model. Default: None + :ls: Steady state voltage index for active power (LS). Default: 0.0 + :lt: Transient voltage index for active power (LT). Default: 0.0 + :pt: Dynamic portion of active load (P). Default: 0.0 + :qt: Dynamic portion of reactive load (Q). Default: 0.0 + :tp: Time constant of lag function of active power (T). Default: 0.0 + :tq: Time constant of lag function of reactive power (T). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "bs": [Profile.DY.value, ], + "bt": [Profile.DY.value, ], + "genericNonLinearLoadModelType": [Profile.DY.value, ], + "ls": [Profile.DY.value, ], + "lt": [Profile.DY.value, ], + "pt": [Profile.DY.value, ], + "qt": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + "tq": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class LoadDynamics:\n" + LoadDynamics.__doc__ + + def __init__(self, bs = 0.0, bt = 0.0, genericNonLinearLoadModelType = None, ls = 0.0, lt = 0.0, pt = 0.0, qt = 0.0, tp = 0.0, tq = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.bs = bs + self.bt = bt + self.genericNonLinearLoadModelType = genericNonLinearLoadModelType + self.ls = ls + self.lt = lt + self.pt = pt + self.qt = qt + self.tp = tp + self.tq = tq + + def __str__(self): + str = "class=LoadGenericNonLinear\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LoadGroup.py b/cimpy/cgmes_v2_4_15/LoadGroup.py index 63afa945..ca939879 100644 --- a/cimpy/cgmes_v2_4_15/LoadGroup.py +++ b/cimpy/cgmes_v2_4_15/LoadGroup.py @@ -1,31 +1,33 @@ -from .IdentifiedObject import IdentifiedObject - - -class LoadGroup(IdentifiedObject): - ''' - The class is the third level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling. - - :SubLoadArea: The SubLoadArea where the Loadgroup belongs. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'SubLoadArea': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, SubLoadArea = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.SubLoadArea = SubLoadArea - - def __str__(self): - str = 'class=LoadGroup\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class LoadGroup(IdentifiedObject): + """ + The class is the third level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling. + + :SubLoadArea: The SubLoadArea where the Loadgroup belongs. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "SubLoadArea": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, SubLoadArea = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.SubLoadArea = SubLoadArea + + def __str__(self): + str = "class=LoadGroup\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LoadMotor.py b/cimpy/cgmes_v2_4_15/LoadMotor.py index 63dfb38f..cf082a74 100644 --- a/cimpy/cgmes_v2_4_15/LoadMotor.py +++ b/cimpy/cgmes_v2_4_15/LoadMotor.py @@ -1,70 +1,72 @@ -from .IdentifiedObject import IdentifiedObject - - -class LoadMotor(IdentifiedObject): - ''' - Aggregate induction motor load. This model is used to represent a fraction of an ordinary load as "induction motor load". It allows load that is treated as ordinary constant power in power flow analysis to be represented by an induction motor in dynamic simulation. If = 0. or = , or = 0., only one cage is represented. Magnetic saturation is not modelled. Either a "one-cage" or "two-cage" model of the induction machine can be modelled. Magnetic saturation is not modelled. This model is intended for representation of aggregations of many motors dispersed through a load represented at a high voltage bus but where there is no information on the characteristics of individual motors. This model treats a fraction of the constant power part of a load as a motor. During initialisation, the initial power drawn by the motor is set equal to times the constant part of the static load. The remainder of the load is left as static load. The reactive power demand of the motor is calculated during initialisation as a function of voltage at the load bus. This reactive power demand may be less than or greater than the constant component of the load. If the motor's reactive demand is greater than the constant component of the load, the model inserts a shunt capacitor at the terminal of the motor to bring its reactive demand down to equal the constant reactive load. If a motor model and a static load model are both present for a load, the motor is assumed to be subtracted from the power flow constant load before the static load model is applied. The remainder of the load, if any, is then represented by the static load model. - - :LoadAggregate: Aggregate load to which this aggregate motor (dynamic) load belongs. Default: None - :pfrac: Fraction of constant-power load to be represented by this motor model (Pfrac) (>=0.0 and <=1.0). Typical Value = 0.3. Default: 0.0 - :lfac: Loading factor - ratio of initial P to motor MVA base (Lfac). Typical Value = 0.8. Default: 0.0 - :ls: Synchronous reactance (Ls). Typical Value = 3.2. Default: 0.0 - :lp: Transient reactance (Lp). Typical Value = 0.15. Default: 0.0 - :lpp: Subtransient reactance (Lpp). Typical Value = 0.15. Default: 0.0 - :ra: Stator resistance (Ra). Typical Value = 0. Default: 0.0 - :tpo: Transient rotor time constant (Tpo) (not=0). Typical Value = 1. Default: 0 - :tppo: Subtransient rotor time constant (Tppo). Typical Value = 0.02. Default: 0 - :h: Inertia constant (H) (not=0). Typical Value = 0.4. Default: 0 - :d: Damping factor (D). Unit = delta P/delta speed. Typical Value = 2. Default: 0.0 - :vt: Voltage threshold for tripping (Vt). Typical Value = 0.7. Default: 0.0 - :tv: Voltage trip pickup time (Tv). Typical Value = 0.1. Default: 0 - :tbkr: Circuit breaker operating time (Tbkr). Typical Value = 0.08. Default: 0 - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'LoadAggregate': [cgmesProfile.DY.value, ], - 'pfrac': [cgmesProfile.DY.value, ], - 'lfac': [cgmesProfile.DY.value, ], - 'ls': [cgmesProfile.DY.value, ], - 'lp': [cgmesProfile.DY.value, ], - 'lpp': [cgmesProfile.DY.value, ], - 'ra': [cgmesProfile.DY.value, ], - 'tpo': [cgmesProfile.DY.value, ], - 'tppo': [cgmesProfile.DY.value, ], - 'h': [cgmesProfile.DY.value, ], - 'd': [cgmesProfile.DY.value, ], - 'vt': [cgmesProfile.DY.value, ], - 'tv': [cgmesProfile.DY.value, ], - 'tbkr': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, LoadAggregate = None, pfrac = 0.0, lfac = 0.0, ls = 0.0, lp = 0.0, lpp = 0.0, ra = 0.0, tpo = 0, tppo = 0, h = 0, d = 0.0, vt = 0.0, tv = 0, tbkr = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.LoadAggregate = LoadAggregate - self.pfrac = pfrac - self.lfac = lfac - self.ls = ls - self.lp = lp - self.lpp = lpp - self.ra = ra - self.tpo = tpo - self.tppo = tppo - self.h = h - self.d = d - self.vt = vt - self.tv = tv - self.tbkr = tbkr - - def __str__(self): - str = 'class=LoadMotor\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class LoadMotor(IdentifiedObject): + """ + Aggregate induction motor load. This model is used to represent a fraction of an ordinary load as "induction motor load". It allows load that is treated as ordinary constant power in power flow analysis to be represented by an induction motor in dynamic simulation. If = 0. or = , or = 0., only one cage is represented. Magnetic saturation is not modelled. Either a "one-cage" or "two-cage" model of the induction machine can be modelled. Magnetic saturation is not modelled. This model is intended for representation of aggregations of many motors dispersed through a load represented at a high voltage bus but where there is no information on the characteristics of individual motors. This model treats a fraction of the constant power part of a load as a motor. During initialisation, the initial power drawn by the motor is set equal to times the constant part of the static load. The remainder of the load is left as static load. The reactive power demand of the motor is calculated during initialisation as a function of voltage at the load bus. This reactive power demand may be less than or greater than the constant component of the load. If the motor's reactive demand is greater than the constant component of the load, the model inserts a shunt capacitor at the terminal of the motor to bring its reactive demand down to equal the constant reactive load. If a motor model and a static load model are both present for a load, the motor is assumed to be subtracted from the power flow constant load before the static load model is applied. The remainder of the load, if any, is then represented by the static load model. + + :LoadAggregate: Aggregate load to which this aggregate motor (dynamic) load belongs. Default: None + :d: Damping factor (D). Unit = delta P/delta speed. Typical Value = 2. Default: 0.0 + :h: Inertia constant (H) (not=0). Typical Value = 0.4. Default: 0.0 + :lfac: Loading factor - ratio of initial P to motor MVA base (Lfac). Typical Value = 0.8. Default: 0.0 + :lp: Transient reactance (Lp). Typical Value = 0.15. Default: 0.0 + :lpp: Subtransient reactance (Lpp). Typical Value = 0.15. Default: 0.0 + :ls: Synchronous reactance (Ls). Typical Value = 3.2. Default: 0.0 + :pfrac: Fraction of constant-power load to be represented by this motor model (Pfrac) (>=0.0 and <=1.0). Typical Value = 0.3. Default: 0.0 + :ra: Stator resistance (Ra). Typical Value = 0. Default: 0.0 + :tbkr: Circuit breaker operating time (Tbkr). Typical Value = 0.08. Default: 0.0 + :tpo: Transient rotor time constant (Tpo) (not=0). Typical Value = 1. Default: 0.0 + :tppo: Subtransient rotor time constant (Tppo). Typical Value = 0.02. Default: 0.0 + :tv: Voltage trip pickup time (Tv). Typical Value = 0.1. Default: 0.0 + :vt: Voltage threshold for tripping (Vt). Typical Value = 0.7. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "LoadAggregate": [Profile.DY.value, ], + "d": [Profile.DY.value, ], + "h": [Profile.DY.value, ], + "lfac": [Profile.DY.value, ], + "lp": [Profile.DY.value, ], + "lpp": [Profile.DY.value, ], + "ls": [Profile.DY.value, ], + "pfrac": [Profile.DY.value, ], + "ra": [Profile.DY.value, ], + "tbkr": [Profile.DY.value, ], + "tpo": [Profile.DY.value, ], + "tppo": [Profile.DY.value, ], + "tv": [Profile.DY.value, ], + "vt": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, LoadAggregate = None, d = 0.0, h = 0.0, lfac = 0.0, lp = 0.0, lpp = 0.0, ls = 0.0, pfrac = 0.0, ra = 0.0, tbkr = 0.0, tpo = 0.0, tppo = 0.0, tv = 0.0, vt = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.LoadAggregate = LoadAggregate + self.d = d + self.h = h + self.lfac = lfac + self.lp = lp + self.lpp = lpp + self.ls = ls + self.pfrac = pfrac + self.ra = ra + self.tbkr = tbkr + self.tpo = tpo + self.tppo = tppo + self.tv = tv + self.vt = vt + + def __str__(self): + str = "class=LoadMotor\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LoadResponseCharacteristic.py b/cimpy/cgmes_v2_4_15/LoadResponseCharacteristic.py index 69878bb9..3a6f23e5 100644 --- a/cimpy/cgmes_v2_4_15/LoadResponseCharacteristic.py +++ b/cimpy/cgmes_v2_4_15/LoadResponseCharacteristic.py @@ -1,64 +1,66 @@ -from .IdentifiedObject import IdentifiedObject - - -class LoadResponseCharacteristic(IdentifiedObject): - ''' - Models the characteristic response of the load demand due to changes in system conditions such as voltage and frequency. This is not related to demand response. If LoadResponseCharacteristic.exponentModel is True, the voltage exponents are specified and used as to calculate: Active power component = Pnominal * (Voltage/cim:BaseVoltage.nominalVoltage) ** cim:LoadResponseCharacteristic.pVoltageExponent Reactive power component = Qnominal * (Voltage/cim:BaseVoltage.nominalVoltage)** cim:LoadResponseCharacteristic.qVoltageExponent Where * means "multiply" and ** is "raised to power of". - - :EnergyConsumer: The set of loads that have the response characteristics. Default: "list" - :exponentModel: Indicates the exponential voltage dependency model is to be used. If false, the coefficient model is to be used. The exponential voltage dependency model consist of the attributes - pVoltageExponent - qVoltageExponent. The coefficient model consist of the attributes - pConstantImpedance - pConstantCurrent - pConstantPower - qConstantImpedance - qConstantCurrent - qConstantPower. The sum of pConstantImpedance, pConstantCurrent and pConstantPower shall equal 1. The sum of qConstantImpedance, qConstantCurrent and qConstantPower shall equal 1. Default: False - :pConstantCurrent: Portion of active power load modeled as constant current. Default: 0.0 - :pConstantImpedance: Portion of active power load modeled as constant impedance. Default: 0.0 - :pConstantPower: Portion of active power load modeled as constant power. Default: 0.0 - :pFrequencyExponent: Exponent of per unit frequency effecting active power. Default: 0.0 - :pVoltageExponent: Exponent of per unit voltage effecting real power. Default: 0.0 - :qConstantCurrent: Portion of reactive power load modeled as constant current. Default: 0.0 - :qConstantImpedance: Portion of reactive power load modeled as constant impedance. Default: 0.0 - :qConstantPower: Portion of reactive power load modeled as constant power. Default: 0.0 - :qFrequencyExponent: Exponent of per unit frequency effecting reactive power. Default: 0.0 - :qVoltageExponent: Exponent of per unit voltage effecting reactive power. Default: 0.0 - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'EnergyConsumer': [cgmesProfile.EQ.value, ], - 'exponentModel': [cgmesProfile.EQ.value, ], - 'pConstantCurrent': [cgmesProfile.EQ.value, ], - 'pConstantImpedance': [cgmesProfile.EQ.value, ], - 'pConstantPower': [cgmesProfile.EQ.value, ], - 'pFrequencyExponent': [cgmesProfile.EQ.value, ], - 'pVoltageExponent': [cgmesProfile.EQ.value, ], - 'qConstantCurrent': [cgmesProfile.EQ.value, ], - 'qConstantImpedance': [cgmesProfile.EQ.value, ], - 'qConstantPower': [cgmesProfile.EQ.value, ], - 'qFrequencyExponent': [cgmesProfile.EQ.value, ], - 'qVoltageExponent': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, EnergyConsumer = "list", exponentModel = False, pConstantCurrent = 0.0, pConstantImpedance = 0.0, pConstantPower = 0.0, pFrequencyExponent = 0.0, pVoltageExponent = 0.0, qConstantCurrent = 0.0, qConstantImpedance = 0.0, qConstantPower = 0.0, qFrequencyExponent = 0.0, qVoltageExponent = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.EnergyConsumer = EnergyConsumer - self.exponentModel = exponentModel - self.pConstantCurrent = pConstantCurrent - self.pConstantImpedance = pConstantImpedance - self.pConstantPower = pConstantPower - self.pFrequencyExponent = pFrequencyExponent - self.pVoltageExponent = pVoltageExponent - self.qConstantCurrent = qConstantCurrent - self.qConstantImpedance = qConstantImpedance - self.qConstantPower = qConstantPower - self.qFrequencyExponent = qFrequencyExponent - self.qVoltageExponent = qVoltageExponent - - def __str__(self): - str = 'class=LoadResponseCharacteristic\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class LoadResponseCharacteristic(IdentifiedObject): + """ + Models the characteristic response of the load demand due to changes in system conditions such as voltage and frequency. This is not related to demand response. If LoadResponseCharacteristic.exponentModel is True, the voltage exponents are specified and used as to calculate: Active power component = Pnominal * (Voltage/cim:BaseVoltage.nominalVoltage) ** cim:LoadResponseCharacteristic.pVoltageExponent Reactive power component = Qnominal * (Voltage/cim:BaseVoltage.nominalVoltage)** cim:LoadResponseCharacteristic.qVoltageExponent Where * means "multiply" and ** is "raised to power of". + + :EnergyConsumer: The set of loads that have the response characteristics. Default: "list" + :exponentModel: Indicates the exponential voltage dependency model is to be used. If false, the coefficient model is to be used. The exponential voltage dependency model consist of the attributes - pVoltageExponent - qVoltageExponent. The coefficient model consist of the attributes - pConstantImpedance - pConstantCurrent - pConstantPower - qConstantImpedance - qConstantCurrent - qConstantPower. The sum of pConstantImpedance, pConstantCurrent and pConstantPower shall equal 1. The sum of qConstantImpedance, qConstantCurrent and qConstantPower shall equal 1. Default: False + :pConstantCurrent: Portion of active power load modeled as constant current. Default: 0.0 + :pConstantImpedance: Portion of active power load modeled as constant impedance. Default: 0.0 + :pConstantPower: Portion of active power load modeled as constant power. Default: 0.0 + :pFrequencyExponent: Exponent of per unit frequency effecting active power. Default: 0.0 + :pVoltageExponent: Exponent of per unit voltage effecting real power. Default: 0.0 + :qConstantCurrent: Portion of reactive power load modeled as constant current. Default: 0.0 + :qConstantImpedance: Portion of reactive power load modeled as constant impedance. Default: 0.0 + :qConstantPower: Portion of reactive power load modeled as constant power. Default: 0.0 + :qFrequencyExponent: Exponent of per unit frequency effecting reactive power. Default: 0.0 + :qVoltageExponent: Exponent of per unit voltage effecting reactive power. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "EnergyConsumer": [Profile.EQ.value, ], + "exponentModel": [Profile.EQ.value, ], + "pConstantCurrent": [Profile.EQ.value, ], + "pConstantImpedance": [Profile.EQ.value, ], + "pConstantPower": [Profile.EQ.value, ], + "pFrequencyExponent": [Profile.EQ.value, ], + "pVoltageExponent": [Profile.EQ.value, ], + "qConstantCurrent": [Profile.EQ.value, ], + "qConstantImpedance": [Profile.EQ.value, ], + "qConstantPower": [Profile.EQ.value, ], + "qFrequencyExponent": [Profile.EQ.value, ], + "qVoltageExponent": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, EnergyConsumer = "list", exponentModel = False, pConstantCurrent = 0.0, pConstantImpedance = 0.0, pConstantPower = 0.0, pFrequencyExponent = 0.0, pVoltageExponent = 0.0, qConstantCurrent = 0.0, qConstantImpedance = 0.0, qConstantPower = 0.0, qFrequencyExponent = 0.0, qVoltageExponent = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.EnergyConsumer = EnergyConsumer + self.exponentModel = exponentModel + self.pConstantCurrent = pConstantCurrent + self.pConstantImpedance = pConstantImpedance + self.pConstantPower = pConstantPower + self.pFrequencyExponent = pFrequencyExponent + self.pVoltageExponent = pVoltageExponent + self.qConstantCurrent = qConstantCurrent + self.qConstantImpedance = qConstantImpedance + self.qConstantPower = qConstantPower + self.qFrequencyExponent = qFrequencyExponent + self.qVoltageExponent = qVoltageExponent + + def __str__(self): + str = "class=LoadResponseCharacteristic\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LoadStatic.py b/cimpy/cgmes_v2_4_15/LoadStatic.py index 90199eeb..86a3a1ce 100644 --- a/cimpy/cgmes_v2_4_15/LoadStatic.py +++ b/cimpy/cgmes_v2_4_15/LoadStatic.py @@ -1,82 +1,84 @@ -from .IdentifiedObject import IdentifiedObject - - -class LoadStatic(IdentifiedObject): - ''' - General static load model representing the sensitivity of the real and reactive power consumed by the load to the amplitude and frequency of the bus voltage. - - :LoadAggregate: Aggregate load to which this aggregate static load belongs. Default: None - :staticLoadModelType: Type of static load model. Typical Value = constantZ. Default: None - :kp1: First term voltage coefficient for active power (Kp1). Not used when .staticLoadModelType = constantZ. Default: 0.0 - :kp2: Second term voltage coefficient for active power (Kp2). Not used when .staticLoadModelType = constantZ. Default: 0.0 - :kp3: Third term voltage coefficient for active power (Kp3). Not used when .staticLoadModelType = constantZ. Default: 0.0 - :kp4: Frequency coefficient for active power (Kp4). Must be non-zero when .staticLoadModelType = ZIP2. Not used for all other values of .staticLoadModelType. Default: 0.0 - :ep1: First term voltage exponent for active power (Ep1). Used only when .staticLoadModelType = exponential. Default: 0.0 - :ep2: Second term voltage exponent for active power (Ep2). Used only when .staticLoadModelType = exponential. Default: 0.0 - :ep3: Third term voltage exponent for active power (Ep3). Used only when .staticLoadModelType = exponential. Default: 0.0 - :kpf: Frequency deviation coefficient for active power (Kpf). Not used when .staticLoadModelType = constantZ. Default: 0.0 - :kq1: First term voltage coefficient for reactive power (Kq1). Not used when .staticLoadModelType = constantZ. Default: 0.0 - :kq2: Second term voltage coefficient for reactive power (Kq2). Not used when .staticLoadModelType = constantZ. Default: 0.0 - :kq3: Third term voltage coefficient for reactive power (Kq3). Not used when .staticLoadModelType = constantZ. Default: 0.0 - :kq4: Frequency coefficient for reactive power (Kq4). Must be non-zero when .staticLoadModelType = ZIP2. Not used for all other values of .staticLoadModelType. Default: 0.0 - :eq1: First term voltage exponent for reactive power (Eq1). Used only when .staticLoadModelType = exponential. Default: 0.0 - :eq2: Second term voltage exponent for reactive power (Eq2). Used only when .staticLoadModelType = exponential. Default: 0.0 - :eq3: Third term voltage exponent for reactive power (Eq3). Used only when .staticLoadModelType = exponential. Default: 0.0 - :kqf: Frequency deviation coefficient for reactive power (Kqf). Not used when .staticLoadModelType = constantZ. Default: 0.0 - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'LoadAggregate': [cgmesProfile.DY.value, ], - 'staticLoadModelType': [cgmesProfile.DY.value, ], - 'kp1': [cgmesProfile.DY.value, ], - 'kp2': [cgmesProfile.DY.value, ], - 'kp3': [cgmesProfile.DY.value, ], - 'kp4': [cgmesProfile.DY.value, ], - 'ep1': [cgmesProfile.DY.value, ], - 'ep2': [cgmesProfile.DY.value, ], - 'ep3': [cgmesProfile.DY.value, ], - 'kpf': [cgmesProfile.DY.value, ], - 'kq1': [cgmesProfile.DY.value, ], - 'kq2': [cgmesProfile.DY.value, ], - 'kq3': [cgmesProfile.DY.value, ], - 'kq4': [cgmesProfile.DY.value, ], - 'eq1': [cgmesProfile.DY.value, ], - 'eq2': [cgmesProfile.DY.value, ], - 'eq3': [cgmesProfile.DY.value, ], - 'kqf': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, LoadAggregate = None, staticLoadModelType = None, kp1 = 0.0, kp2 = 0.0, kp3 = 0.0, kp4 = 0.0, ep1 = 0.0, ep2 = 0.0, ep3 = 0.0, kpf = 0.0, kq1 = 0.0, kq2 = 0.0, kq3 = 0.0, kq4 = 0.0, eq1 = 0.0, eq2 = 0.0, eq3 = 0.0, kqf = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.LoadAggregate = LoadAggregate - self.staticLoadModelType = staticLoadModelType - self.kp1 = kp1 - self.kp2 = kp2 - self.kp3 = kp3 - self.kp4 = kp4 - self.ep1 = ep1 - self.ep2 = ep2 - self.ep3 = ep3 - self.kpf = kpf - self.kq1 = kq1 - self.kq2 = kq2 - self.kq3 = kq3 - self.kq4 = kq4 - self.eq1 = eq1 - self.eq2 = eq2 - self.eq3 = eq3 - self.kqf = kqf - - def __str__(self): - str = 'class=LoadStatic\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class LoadStatic(IdentifiedObject): + """ + General static load model representing the sensitivity of the real and reactive power consumed by the load to the amplitude and frequency of the bus voltage. + + :LoadAggregate: Aggregate load to which this aggregate static load belongs. Default: None + :ep1: First term voltage exponent for active power (Ep1). Used only when .staticLoadModelType = exponential. Default: 0.0 + :ep2: Second term voltage exponent for active power (Ep2). Used only when .staticLoadModelType = exponential. Default: 0.0 + :ep3: Third term voltage exponent for active power (Ep3). Used only when .staticLoadModelType = exponential. Default: 0.0 + :eq1: First term voltage exponent for reactive power (Eq1). Used only when .staticLoadModelType = exponential. Default: 0.0 + :eq2: Second term voltage exponent for reactive power (Eq2). Used only when .staticLoadModelType = exponential. Default: 0.0 + :eq3: Third term voltage exponent for reactive power (Eq3). Used only when .staticLoadModelType = exponential. Default: 0.0 + :kp1: First term voltage coefficient for active power (Kp1). Not used when .staticLoadModelType = constantZ. Default: 0.0 + :kp2: Second term voltage coefficient for active power (Kp2). Not used when .staticLoadModelType = constantZ. Default: 0.0 + :kp3: Third term voltage coefficient for active power (Kp3). Not used when .staticLoadModelType = constantZ. Default: 0.0 + :kp4: Frequency coefficient for active power (Kp4). Must be non-zero when .staticLoadModelType = ZIP2. Not used for all other values of .staticLoadModelType. Default: 0.0 + :kpf: Frequency deviation coefficient for active power (Kpf). Not used when .staticLoadModelType = constantZ. Default: 0.0 + :kq1: First term voltage coefficient for reactive power (Kq1). Not used when .staticLoadModelType = constantZ. Default: 0.0 + :kq2: Second term voltage coefficient for reactive power (Kq2). Not used when .staticLoadModelType = constantZ. Default: 0.0 + :kq3: Third term voltage coefficient for reactive power (Kq3). Not used when .staticLoadModelType = constantZ. Default: 0.0 + :kq4: Frequency coefficient for reactive power (Kq4). Must be non-zero when .staticLoadModelType = ZIP2. Not used for all other values of .staticLoadModelType. Default: 0.0 + :kqf: Frequency deviation coefficient for reactive power (Kqf). Not used when .staticLoadModelType = constantZ. Default: 0.0 + :staticLoadModelType: Type of static load model. Typical Value = constantZ. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "LoadAggregate": [Profile.DY.value, ], + "ep1": [Profile.DY.value, ], + "ep2": [Profile.DY.value, ], + "ep3": [Profile.DY.value, ], + "eq1": [Profile.DY.value, ], + "eq2": [Profile.DY.value, ], + "eq3": [Profile.DY.value, ], + "kp1": [Profile.DY.value, ], + "kp2": [Profile.DY.value, ], + "kp3": [Profile.DY.value, ], + "kp4": [Profile.DY.value, ], + "kpf": [Profile.DY.value, ], + "kq1": [Profile.DY.value, ], + "kq2": [Profile.DY.value, ], + "kq3": [Profile.DY.value, ], + "kq4": [Profile.DY.value, ], + "kqf": [Profile.DY.value, ], + "staticLoadModelType": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, LoadAggregate = None, ep1 = 0.0, ep2 = 0.0, ep3 = 0.0, eq1 = 0.0, eq2 = 0.0, eq3 = 0.0, kp1 = 0.0, kp2 = 0.0, kp3 = 0.0, kp4 = 0.0, kpf = 0.0, kq1 = 0.0, kq2 = 0.0, kq3 = 0.0, kq4 = 0.0, kqf = 0.0, staticLoadModelType = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.LoadAggregate = LoadAggregate + self.ep1 = ep1 + self.ep2 = ep2 + self.ep3 = ep3 + self.eq1 = eq1 + self.eq2 = eq2 + self.eq3 = eq3 + self.kp1 = kp1 + self.kp2 = kp2 + self.kp3 = kp3 + self.kp4 = kp4 + self.kpf = kpf + self.kq1 = kq1 + self.kq2 = kq2 + self.kq3 = kq3 + self.kq4 = kq4 + self.kqf = kqf + self.staticLoadModelType = staticLoadModelType + + def __str__(self): + str = "class=LoadStatic\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/LoadUserDefined.py b/cimpy/cgmes_v2_4_15/LoadUserDefined.py index dec3cc95..c0f17d37 100644 --- a/cimpy/cgmes_v2_4_15/LoadUserDefined.py +++ b/cimpy/cgmes_v2_4_15/LoadUserDefined.py @@ -1,34 +1,36 @@ -from .LoadDynamics import LoadDynamics - - -class LoadUserDefined(LoadDynamics): - ''' - Load whose dynamic behaviour is described by a user-defined model. - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = LoadDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class LoadDynamics: \n' + LoadDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=LoadUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .LoadDynamics import LoadDynamics +from .CGMESProfile import Profile + + +class LoadUserDefined(LoadDynamics): + """ + Load whose dynamic behaviour is described by a user-defined model. + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class LoadDynamics:\n" + LoadDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=LoadUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Location.py b/cimpy/cgmes_v2_4_15/Location.py index 59415ae4..ab144e80 100644 --- a/cimpy/cgmes_v2_4_15/Location.py +++ b/cimpy/cgmes_v2_4_15/Location.py @@ -1,37 +1,39 @@ -from .IdentifiedObject import IdentifiedObject - - -class Location(IdentifiedObject): - ''' - The place, scene, or point of something where someone or something has been, is, and/or will be at a given moment in time. It can be defined with one or more postition points (coordinates) in a given coordinate system. - - :CoordinateSystem: Coordinate system used to describe position points of this location. Default: None - :PowerSystemResources: All power system resources at this location. Default: None - :PositionPoints: Sequence of position points describing this location, expressed in coordinate system `Location.CoordinateSystem`. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.GL.value, ], - 'CoordinateSystem': [cgmesProfile.GL.value, ], - 'PowerSystemResources': [cgmesProfile.GL.value, ], - 'PositionPoints': [cgmesProfile.GL.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, CoordinateSystem = None, PowerSystemResources = None, PositionPoints = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.CoordinateSystem = CoordinateSystem - self.PowerSystemResources = PowerSystemResources - self.PositionPoints = PositionPoints - - def __str__(self): - str = 'class=Location\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class Location(IdentifiedObject): + """ + The place, scene, or point of something where someone or something has been, is, and/or will be at a given moment in time. It can be defined with one or more postition points (coordinates) in a given coordinate system. + + :CoordinateSystem: Coordinate system used to describe position points of this location. Default: None + :PositionPoints: Sequence of position points describing this location, expressed in coordinate system `Location.CoordinateSystem`. Default: "list" + :PowerSystemResources: All power system resources at this location. Default: None + """ + + possibleProfileList = { + "class": [Profile.GL.value, ], + "CoordinateSystem": [Profile.GL.value, ], + "PositionPoints": [Profile.GL.value, ], + "PowerSystemResources": [Profile.GL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.GL.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, CoordinateSystem = None, PositionPoints = "list", PowerSystemResources = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.CoordinateSystem = CoordinateSystem + self.PositionPoints = PositionPoints + self.PowerSystemResources = PowerSystemResources + + def __str__(self): + str = "class=Location\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Measurement.py b/cimpy/cgmes_v2_4_15/Measurement.py index 209d54c4..bf0d8754 100644 --- a/cimpy/cgmes_v2_4_15/Measurement.py +++ b/cimpy/cgmes_v2_4_15/Measurement.py @@ -1,46 +1,48 @@ -from .IdentifiedObject import IdentifiedObject - - -class Measurement(IdentifiedObject): - ''' - A Measurement represents any measured, calculated or non-measured non-calculated quantity. Any piece of equipment may contain Measurements, e.g. a substation may have temperature measurements and door open indications, a transformer may have oil temperature and tank pressure measurements, a bay may contain a number of power flow measurements and a Breaker may contain a switch status measurement. The PSR - Measurement association is intended to capture this use of Measurement and is included in the naming hierarchy based on EquipmentContainer. The naming hierarchy typically has Measurements as leafs, e.g. Substation-VoltageLevel-Bay-Switch-Measurement. Some Measurements represent quantities related to a particular sensor location in the network, e.g. a voltage transformer (PT) at a busbar or a current transformer (CT) at the bar between a breaker and an isolator. The sensing position is not captured in the PSR - Measurement association. Instead it is captured by the Measurement - Terminal association that is used to define the sensing location in the network topology. The location is defined by the connection of the Terminal to ConductingEquipment. If both a Terminal and PSR are associated, and the PSR is of type ConductingEquipment, the associated Terminal should belong to that ConductingEquipment instance. When the sensor location is needed both Measurement-PSR and Measurement-Terminal are used. The Measurement-Terminal association is never used alone. - - :measurementType: Specifies the type of measurement. For example, this specifies if the measurement represents an indoor temperature, outdoor temperature, bus voltage, line flow, etc. Default: '' - :phases: Indicates to which phases the measurement applies and avoids the need to use `measurementType` to also encode phase information (which would explode the types). The phase information in Measurement, along with `measurementType` and `phases` uniquely defines a Measurement for a device, based on normal network phase. Their meaning will not change when the computed energizing phasing is changed due to jumpers or other reasons. If the attribute is missing three phases (ABC) shall be assumed. Default: None - :unitSymbol: The unit of measure of the measured quantity. Default: None - :unitMultiplier: The unit multiplier of the measured quantity. Default: None - :Terminal: One or more measurements may be associated with a terminal in the network. Default: None - :PowerSystemResource: The measurements associated with this power system resource. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'measurementType': [cgmesProfile.EQ.value, ], - 'phases': [cgmesProfile.EQ.value, ], - 'unitSymbol': [cgmesProfile.EQ.value, ], - 'unitMultiplier': [cgmesProfile.EQ.value, ], - 'Terminal': [cgmesProfile.EQ.value, ], - 'PowerSystemResource': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, measurementType = '', phases = None, unitSymbol = None, unitMultiplier = None, Terminal = None, PowerSystemResource = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.measurementType = measurementType - self.phases = phases - self.unitSymbol = unitSymbol - self.unitMultiplier = unitMultiplier - self.Terminal = Terminal - self.PowerSystemResource = PowerSystemResource - - def __str__(self): - str = 'class=Measurement\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class Measurement(IdentifiedObject): + """ + A Measurement represents any measured, calculated or non-measured non-calculated quantity. Any piece of equipment may contain Measurements, e.g. a substation may have temperature measurements and door open indications, a transformer may have oil temperature and tank pressure measurements, a bay may contain a number of power flow measurements and a Breaker may contain a switch status measurement. The PSR - Measurement association is intended to capture this use of Measurement and is included in the naming hierarchy based on EquipmentContainer. The naming hierarchy typically has Measurements as leafs, e.g. Substation-VoltageLevel-Bay-Switch-Measurement. Some Measurements represent quantities related to a particular sensor location in the network, e.g. a voltage transformer (PT) at a busbar or a current transformer (CT) at the bar between a breaker and an isolator. The sensing position is not captured in the PSR - Measurement association. Instead it is captured by the Measurement - Terminal association that is used to define the sensing location in the network topology. The location is defined by the connection of the Terminal to ConductingEquipment. If both a Terminal and PSR are associated, and the PSR is of type ConductingEquipment, the associated Terminal should belong to that ConductingEquipment instance. When the sensor location is needed both Measurement-PSR and Measurement-Terminal are used. The Measurement-Terminal association is never used alone. + + :PowerSystemResource: The measurements associated with this power system resource. Default: None + :Terminal: One or more measurements may be associated with a terminal in the network. Default: None + :measurementType: Specifies the type of measurement. For example, this specifies if the measurement represents an indoor temperature, outdoor temperature, bus voltage, line flow, etc. Default: '' + :phases: Indicates to which phases the measurement applies and avoids the need to use `measurementType` to also encode phase information (which would explode the types). The phase information in Measurement, along with `measurementType` and `phases` uniquely defines a Measurement for a device, based on normal network phase. Their meaning will not change when the computed energizing phasing is changed due to jumpers or other reasons. If the attribute is missing three phases (ABC) shall be assumed. Default: None + :unitMultiplier: The unit multiplier of the measured quantity. Default: None + :unitSymbol: The unit of measure of the measured quantity. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "PowerSystemResource": [Profile.EQ.value, ], + "Terminal": [Profile.EQ.value, ], + "measurementType": [Profile.EQ.value, ], + "phases": [Profile.EQ.value, ], + "unitMultiplier": [Profile.EQ.value, ], + "unitSymbol": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, PowerSystemResource = None, Terminal = None, measurementType = '', phases = None, unitMultiplier = None, unitSymbol = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.PowerSystemResource = PowerSystemResource + self.Terminal = Terminal + self.measurementType = measurementType + self.phases = phases + self.unitMultiplier = unitMultiplier + self.unitSymbol = unitSymbol + + def __str__(self): + str = "class=Measurement\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/MeasurementValue.py b/cimpy/cgmes_v2_4_15/MeasurementValue.py index 20d69430..526176fe 100644 --- a/cimpy/cgmes_v2_4_15/MeasurementValue.py +++ b/cimpy/cgmes_v2_4_15/MeasurementValue.py @@ -1,40 +1,42 @@ -from .IdentifiedObject import IdentifiedObject - - -class MeasurementValue(IdentifiedObject): - ''' - The current state for a measurement. A state value is an instance of a measurement from a specific source. Measurements can be associated with many state values, each representing a different source for the measurement. - - :timeStamp: The time when the value was last updated Default: '' - :sensorAccuracy: The limit, expressed as a percentage of the sensor maximum, that errors will not exceed when the sensor is used under reference conditions. Default: 0.0 - :MeasurementValueQuality: A MeasurementValue has a MeasurementValueQuality associated with it. Default: None - :MeasurementValueSource: The MeasurementValues updated by the source. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'timeStamp': [cgmesProfile.EQ.value, ], - 'sensorAccuracy': [cgmesProfile.EQ.value, ], - 'MeasurementValueQuality': [cgmesProfile.EQ.value, ], - 'MeasurementValueSource': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, timeStamp = '', sensorAccuracy = 0.0, MeasurementValueQuality = None, MeasurementValueSource = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.timeStamp = timeStamp - self.sensorAccuracy = sensorAccuracy - self.MeasurementValueQuality = MeasurementValueQuality - self.MeasurementValueSource = MeasurementValueSource - - def __str__(self): - str = 'class=MeasurementValue\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class MeasurementValue(IdentifiedObject): + """ + The current state for a measurement. A state value is an instance of a measurement from a specific source. Measurements can be associated with many state values, each representing a different source for the measurement. + + :MeasurementValueQuality: A MeasurementValue has a MeasurementValueQuality associated with it. Default: None + :MeasurementValueSource: The MeasurementValues updated by the source. Default: None + :sensorAccuracy: The limit, expressed as a percentage of the sensor maximum, that errors will not exceed when the sensor is used under reference conditions. Default: 0.0 + :timeStamp: The time when the value was last updated Default: '' + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "MeasurementValueQuality": [Profile.EQ.value, ], + "MeasurementValueSource": [Profile.EQ.value, ], + "sensorAccuracy": [Profile.EQ.value, ], + "timeStamp": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, MeasurementValueQuality = None, MeasurementValueSource = None, sensorAccuracy = 0.0, timeStamp = '', *args, **kw_args): + super().__init__(*args, **kw_args) + + self.MeasurementValueQuality = MeasurementValueQuality + self.MeasurementValueSource = MeasurementValueSource + self.sensorAccuracy = sensorAccuracy + self.timeStamp = timeStamp + + def __str__(self): + str = "class=MeasurementValue\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/MeasurementValueQuality.py b/cimpy/cgmes_v2_4_15/MeasurementValueQuality.py index fd339844..eec42698 100644 --- a/cimpy/cgmes_v2_4_15/MeasurementValueQuality.py +++ b/cimpy/cgmes_v2_4_15/MeasurementValueQuality.py @@ -1,31 +1,33 @@ -from .Quality61850 import Quality61850 - - -class MeasurementValueQuality(Quality61850): - ''' - Measurement quality flags. Bits 0-10 are defined for substation automation in draft IEC 61850 part 7-3. Bits 11-15 are reserved for future expansion by that document. Bits 16-31 are reserved for EMS applications. - - :MeasurementValue: A MeasurementValue has a MeasurementValueQuality associated with it. Default: None - ''' - - cgmesProfile = Quality61850.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'MeasurementValue': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Quality61850: \n' + Quality61850.__doc__ - - def __init__(self, MeasurementValue = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.MeasurementValue = MeasurementValue - - def __str__(self): - str = 'class=MeasurementValueQuality\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Quality61850 import Quality61850 +from .CGMESProfile import Profile + + +class MeasurementValueQuality(Quality61850): + """ + Measurement quality flags. Bits 0-10 are defined for substation automation in draft IEC 61850 part 7-3. Bits 11-15 are reserved for future expansion by that document. Bits 16-31 are reserved for EMS applications. + + :MeasurementValue: A MeasurementValue has a MeasurementValueQuality associated with it. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "MeasurementValue": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Quality61850:\n" + Quality61850.__doc__ + + def __init__(self, MeasurementValue = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.MeasurementValue = MeasurementValue + + def __str__(self): + str = "class=MeasurementValueQuality\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/MeasurementValueSource.py b/cimpy/cgmes_v2_4_15/MeasurementValueSource.py index 34672f0d..304000da 100644 --- a/cimpy/cgmes_v2_4_15/MeasurementValueSource.py +++ b/cimpy/cgmes_v2_4_15/MeasurementValueSource.py @@ -1,31 +1,33 @@ -from .IdentifiedObject import IdentifiedObject - - -class MeasurementValueSource(IdentifiedObject): - ''' - MeasurementValueSource describes the alternative sources updating a MeasurementValue. User conventions for how to use the MeasurementValueSource attributes are described in the introduction to IEC 61970-301. - - :MeasurementValues: A reference to the type of source that updates the MeasurementValue, e.g. SCADA, CCLink, manual, etc. User conventions for the names of sources are contained in the introduction to IEC 61970-301. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'MeasurementValues': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, MeasurementValues = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.MeasurementValues = MeasurementValues - - def __str__(self): - str = 'class=MeasurementValueSource\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class MeasurementValueSource(IdentifiedObject): + """ + MeasurementValueSource describes the alternative sources updating a MeasurementValue. User conventions for how to use the MeasurementValueSource attributes are described in the introduction to IEC 61970-301. + + :MeasurementValues: A reference to the type of source that updates the MeasurementValue, e.g. SCADA, CCLink, manual, etc. User conventions for the names of sources are contained in the introduction to IEC 61970-301. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "MeasurementValues": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, MeasurementValues = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.MeasurementValues = MeasurementValues + + def __str__(self): + str = "class=MeasurementValueSource\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/MechLoad1.py b/cimpy/cgmes_v2_4_15/MechLoad1.py index d1a524a5..f8772b6b 100644 --- a/cimpy/cgmes_v2_4_15/MechLoad1.py +++ b/cimpy/cgmes_v2_4_15/MechLoad1.py @@ -1,40 +1,42 @@ -from .MechanicalLoadDynamics import MechanicalLoadDynamics - - -class MechLoad1(MechanicalLoadDynamics): - ''' - Mechanical load model type 1. - - :a: Speed squared coefficient (a). Default: 0.0 - :b: Speed coefficient (b). Default: 0.0 - :d: Speed to the exponent coefficient (d). Default: 0.0 - :e: Exponent (e). Default: 0.0 - ''' - - cgmesProfile = MechanicalLoadDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'a': [cgmesProfile.DY.value, ], - 'b': [cgmesProfile.DY.value, ], - 'd': [cgmesProfile.DY.value, ], - 'e': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class MechanicalLoadDynamics: \n' + MechanicalLoadDynamics.__doc__ - - def __init__(self, a = 0.0, b = 0.0, d = 0.0, e = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.a = a - self.b = b - self.d = d - self.e = e - - def __str__(self): - str = 'class=MechLoad1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .MechanicalLoadDynamics import MechanicalLoadDynamics +from .CGMESProfile import Profile + + +class MechLoad1(MechanicalLoadDynamics): + """ + Mechanical load model type 1. + + :a: Speed squared coefficient (a). Default: 0.0 + :b: Speed coefficient (b). Default: 0.0 + :d: Speed to the exponent coefficient (d). Default: 0.0 + :e: Exponent (e). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "a": [Profile.DY.value, ], + "b": [Profile.DY.value, ], + "d": [Profile.DY.value, ], + "e": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class MechanicalLoadDynamics:\n" + MechanicalLoadDynamics.__doc__ + + def __init__(self, a = 0.0, b = 0.0, d = 0.0, e = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.a = a + self.b = b + self.d = d + self.e = e + + def __str__(self): + str = "class=MechLoad1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/MechanicalLoadDynamics.py b/cimpy/cgmes_v2_4_15/MechanicalLoadDynamics.py index f8b406b9..ca599472 100644 --- a/cimpy/cgmes_v2_4_15/MechanicalLoadDynamics.py +++ b/cimpy/cgmes_v2_4_15/MechanicalLoadDynamics.py @@ -1,34 +1,36 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class MechanicalLoadDynamics(DynamicsFunctionBlock): - ''' - Mechanical load function block whose behavior is described by reference to a standard model - - :SynchronousMachineDynamics: Synchronous machine model with which this mechanical load model is associated. Default: None - :AsynchronousMachineDynamics: Asynchronous machine model with which this mechanical load model is associated. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'SynchronousMachineDynamics': [cgmesProfile.DY.value, ], - 'AsynchronousMachineDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, SynchronousMachineDynamics = None, AsynchronousMachineDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.SynchronousMachineDynamics = SynchronousMachineDynamics - self.AsynchronousMachineDynamics = AsynchronousMachineDynamics - - def __str__(self): - str = 'class=MechanicalLoadDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class MechanicalLoadDynamics(DynamicsFunctionBlock): + """ + Mechanical load function block whose behavior is described by reference to a standard model + + :AsynchronousMachineDynamics: Asynchronous machine model with which this mechanical load model is associated. Default: None + :SynchronousMachineDynamics: Synchronous machine model with which this mechanical load model is associated. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "AsynchronousMachineDynamics": [Profile.DY.value, ], + "SynchronousMachineDynamics": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, AsynchronousMachineDynamics = None, SynchronousMachineDynamics = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.AsynchronousMachineDynamics = AsynchronousMachineDynamics + self.SynchronousMachineDynamics = SynchronousMachineDynamics + + def __str__(self): + str = "class=MechanicalLoadDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/MechanicalLoadUserDefined.py b/cimpy/cgmes_v2_4_15/MechanicalLoadUserDefined.py index c3a7ae59..a18f618e 100644 --- a/cimpy/cgmes_v2_4_15/MechanicalLoadUserDefined.py +++ b/cimpy/cgmes_v2_4_15/MechanicalLoadUserDefined.py @@ -1,34 +1,36 @@ -from .MechanicalLoadDynamics import MechanicalLoadDynamics - - -class MechanicalLoadUserDefined(MechanicalLoadDynamics): - ''' - Mechanical load function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = MechanicalLoadDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class MechanicalLoadDynamics: \n' + MechanicalLoadDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=MechanicalLoadUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .MechanicalLoadDynamics import MechanicalLoadDynamics +from .CGMESProfile import Profile + + +class MechanicalLoadUserDefined(MechanicalLoadDynamics): + """ + Mechanical load function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class MechanicalLoadDynamics:\n" + MechanicalLoadDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=MechanicalLoadUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Money.py b/cimpy/cgmes_v2_4_15/Money.py index bc217466..f6e799a2 100644 --- a/cimpy/cgmes_v2_4_15/Money.py +++ b/cimpy/cgmes_v2_4_15/Money.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class Money(Base): - ''' - Amount of money. - - :unit: Default: None - :multiplier: Default: None - :value: Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, unit = None, multiplier = None, value = 0.0, ): - - self.unit = unit - self.multiplier = multiplier - self.value = value - - def __str__(self): - str = 'class=Money\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Money(Base): + """ + Amount of money. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=Money\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/MonthDay.py b/cimpy/cgmes_v2_4_15/MonthDay.py index 372ff19c..001e1628 100644 --- a/cimpy/cgmes_v2_4_15/MonthDay.py +++ b/cimpy/cgmes_v2_4_15/MonthDay.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class MonthDay(Base): - ''' - MonthDay format as "--mm-dd", which conforms with XSD data type gMonthDay. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=MonthDay\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class MonthDay(Base): + """ + MonthDay format as "--mm-dd", which conforms with XSD data type gMonthDay. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=MonthDay\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/MutualCoupling.py b/cimpy/cgmes_v2_4_15/MutualCoupling.py index 34c0832b..e9d85ab8 100644 --- a/cimpy/cgmes_v2_4_15/MutualCoupling.py +++ b/cimpy/cgmes_v2_4_15/MutualCoupling.py @@ -1,58 +1,60 @@ -from .IdentifiedObject import IdentifiedObject - - -class MutualCoupling(IdentifiedObject): - ''' - This class represents the zero sequence line mutual coupling. - - :First_Terminal: The starting terminal for the calculation of distances along the first branch of the mutual coupling. Normally MutualCoupling would only be used for terminals of AC line segments. The first and second terminals of a mutual coupling should point to different AC line segments. Default: None - :Second_Terminal: The starting terminal for the calculation of distances along the second branch of the mutual coupling. Default: None - :b0ch: Zero sequence mutual coupling shunt (charging) susceptance, uniformly distributed, of the entire line section. Default: 0.0 - :distance11: Distance to the start of the coupled region from the first line`s terminal having sequence number equal to 1. Default: 0.0 - :distance12: Distance to the end of the coupled region from the first line`s terminal with sequence number equal to 1. Default: 0.0 - :distance21: Distance to the start of coupled region from the second line`s terminal with sequence number equal to 1. Default: 0.0 - :distance22: Distance to the end of coupled region from the second line`s terminal with sequence number equal to 1. Default: 0.0 - :g0ch: Zero sequence mutual coupling shunt (charging) conductance, uniformly distributed, of the entire line section. Default: 0.0 - :r0: Zero sequence branch-to-branch mutual impedance coupling, resistance. Default: 0.0 - :x0: Zero sequence branch-to-branch mutual impedance coupling, reactance. Default: 0.0 - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'First_Terminal': [cgmesProfile.EQ.value, ], - 'Second_Terminal': [cgmesProfile.EQ.value, ], - 'b0ch': [cgmesProfile.EQ.value, ], - 'distance11': [cgmesProfile.EQ.value, ], - 'distance12': [cgmesProfile.EQ.value, ], - 'distance21': [cgmesProfile.EQ.value, ], - 'distance22': [cgmesProfile.EQ.value, ], - 'g0ch': [cgmesProfile.EQ.value, ], - 'r0': [cgmesProfile.EQ.value, ], - 'x0': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, First_Terminal = None, Second_Terminal = None, b0ch = 0.0, distance11 = 0.0, distance12 = 0.0, distance21 = 0.0, distance22 = 0.0, g0ch = 0.0, r0 = 0.0, x0 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.First_Terminal = First_Terminal - self.Second_Terminal = Second_Terminal - self.b0ch = b0ch - self.distance11 = distance11 - self.distance12 = distance12 - self.distance21 = distance21 - self.distance22 = distance22 - self.g0ch = g0ch - self.r0 = r0 - self.x0 = x0 - - def __str__(self): - str = 'class=MutualCoupling\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class MutualCoupling(IdentifiedObject): + """ + This class represents the zero sequence line mutual coupling. + + :First_Terminal: The starting terminal for the calculation of distances along the first branch of the mutual coupling. Normally MutualCoupling would only be used for terminals of AC line segments. The first and second terminals of a mutual coupling should point to different AC line segments. Default: None + :Second_Terminal: The starting terminal for the calculation of distances along the second branch of the mutual coupling. Default: None + :b0ch: Zero sequence mutual coupling shunt (charging) susceptance, uniformly distributed, of the entire line section. Default: 0.0 + :distance11: Distance to the start of the coupled region from the first line`s terminal having sequence number equal to 1. Default: 0.0 + :distance12: Distance to the end of the coupled region from the first line`s terminal with sequence number equal to 1. Default: 0.0 + :distance21: Distance to the start of coupled region from the second line`s terminal with sequence number equal to 1. Default: 0.0 + :distance22: Distance to the end of coupled region from the second line`s terminal with sequence number equal to 1. Default: 0.0 + :g0ch: Zero sequence mutual coupling shunt (charging) conductance, uniformly distributed, of the entire line section. Default: 0.0 + :r0: Zero sequence branch-to-branch mutual impedance coupling, resistance. Default: 0.0 + :x0: Zero sequence branch-to-branch mutual impedance coupling, reactance. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "First_Terminal": [Profile.EQ.value, ], + "Second_Terminal": [Profile.EQ.value, ], + "b0ch": [Profile.EQ.value, ], + "distance11": [Profile.EQ.value, ], + "distance12": [Profile.EQ.value, ], + "distance21": [Profile.EQ.value, ], + "distance22": [Profile.EQ.value, ], + "g0ch": [Profile.EQ.value, ], + "r0": [Profile.EQ.value, ], + "x0": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, First_Terminal = None, Second_Terminal = None, b0ch = 0.0, distance11 = 0.0, distance12 = 0.0, distance21 = 0.0, distance22 = 0.0, g0ch = 0.0, r0 = 0.0, x0 = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.First_Terminal = First_Terminal + self.Second_Terminal = Second_Terminal + self.b0ch = b0ch + self.distance11 = distance11 + self.distance12 = distance12 + self.distance21 = distance21 + self.distance22 = distance22 + self.g0ch = g0ch + self.r0 = r0 + self.x0 = x0 + + def __str__(self): + str = "class=MutualCoupling\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/NonConformLoad.py b/cimpy/cgmes_v2_4_15/NonConformLoad.py index 73a7b3d7..d9a88be1 100644 --- a/cimpy/cgmes_v2_4_15/NonConformLoad.py +++ b/cimpy/cgmes_v2_4_15/NonConformLoad.py @@ -1,31 +1,33 @@ -from .EnergyConsumer import EnergyConsumer - - -class NonConformLoad(EnergyConsumer): - ''' - NonConformLoad represent loads that do not follow a daily load change pattern and changes are not correlated with the daily load change pattern. - - :LoadGroup: Conform loads assigned to this ConformLoadGroup. Default: None - ''' - - cgmesProfile = EnergyConsumer.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'LoadGroup': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EnergyConsumer: \n' + EnergyConsumer.__doc__ - - def __init__(self, LoadGroup = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.LoadGroup = LoadGroup - - def __str__(self): - str = 'class=NonConformLoad\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EnergyConsumer import EnergyConsumer +from .CGMESProfile import Profile + + +class NonConformLoad(EnergyConsumer): + """ + NonConformLoad represent loads that do not follow a daily load change pattern and changes are not correlated with the daily load change pattern. + + :LoadGroup: Conform loads assigned to this ConformLoadGroup. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "LoadGroup": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EnergyConsumer:\n" + EnergyConsumer.__doc__ + + def __init__(self, LoadGroup = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.LoadGroup = LoadGroup + + def __str__(self): + str = "class=NonConformLoad\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/NonConformLoadGroup.py b/cimpy/cgmes_v2_4_15/NonConformLoadGroup.py index 90058b8c..0b17c032 100644 --- a/cimpy/cgmes_v2_4_15/NonConformLoadGroup.py +++ b/cimpy/cgmes_v2_4_15/NonConformLoadGroup.py @@ -1,34 +1,36 @@ -from .LoadGroup import LoadGroup - - -class NonConformLoadGroup(LoadGroup): - ''' - Loads that do not follow a daily and seasonal load variation pattern. - - :EnergyConsumers: Group of this ConformLoad. Default: "list" - :NonConformLoadSchedules: The NonConformLoadSchedules in the NonConformLoadGroup. Default: "list" - ''' - - cgmesProfile = LoadGroup.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'EnergyConsumers': [cgmesProfile.EQ.value, ], - 'NonConformLoadSchedules': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class LoadGroup: \n' + LoadGroup.__doc__ - - def __init__(self, EnergyConsumers = "list", NonConformLoadSchedules = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.EnergyConsumers = EnergyConsumers - self.NonConformLoadSchedules = NonConformLoadSchedules - - def __str__(self): - str = 'class=NonConformLoadGroup\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .LoadGroup import LoadGroup +from .CGMESProfile import Profile + + +class NonConformLoadGroup(LoadGroup): + """ + Loads that do not follow a daily and seasonal load variation pattern. + + :EnergyConsumers: Group of this ConformLoad. Default: "list" + :NonConformLoadSchedules: The NonConformLoadSchedules in the NonConformLoadGroup. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "EnergyConsumers": [Profile.EQ.value, ], + "NonConformLoadSchedules": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class LoadGroup:\n" + LoadGroup.__doc__ + + def __init__(self, EnergyConsumers = "list", NonConformLoadSchedules = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.EnergyConsumers = EnergyConsumers + self.NonConformLoadSchedules = NonConformLoadSchedules + + def __str__(self): + str = "class=NonConformLoadGroup\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/NonConformLoadSchedule.py b/cimpy/cgmes_v2_4_15/NonConformLoadSchedule.py index b9872b1e..214a294b 100644 --- a/cimpy/cgmes_v2_4_15/NonConformLoadSchedule.py +++ b/cimpy/cgmes_v2_4_15/NonConformLoadSchedule.py @@ -1,31 +1,33 @@ -from .SeasonDayTypeSchedule import SeasonDayTypeSchedule - - -class NonConformLoadSchedule(SeasonDayTypeSchedule): - ''' - An active power (Y1-axis) and reactive power (Y2-axis) schedule (curves) versus time (X-axis) for non-conforming loads, e.g., large industrial load or power station service (where modeled). - - :NonConformLoadGroup: The NonConformLoadGroup where the NonConformLoadSchedule belongs. Default: None - ''' - - cgmesProfile = SeasonDayTypeSchedule.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'NonConformLoadGroup': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class SeasonDayTypeSchedule: \n' + SeasonDayTypeSchedule.__doc__ - - def __init__(self, NonConformLoadGroup = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.NonConformLoadGroup = NonConformLoadGroup - - def __str__(self): - str = 'class=NonConformLoadSchedule\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .SeasonDayTypeSchedule import SeasonDayTypeSchedule +from .CGMESProfile import Profile + + +class NonConformLoadSchedule(SeasonDayTypeSchedule): + """ + An active power (Y1-axis) and reactive power (Y2-axis) schedule (curves) versus time (X-axis) for non-conforming loads, e.g., large industrial load or power station service (where modeled). + + :NonConformLoadGroup: The NonConformLoadGroup where the NonConformLoadSchedule belongs. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "NonConformLoadGroup": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class SeasonDayTypeSchedule:\n" + SeasonDayTypeSchedule.__doc__ + + def __init__(self, NonConformLoadGroup = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.NonConformLoadGroup = NonConformLoadGroup + + def __str__(self): + str = "class=NonConformLoadSchedule\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/NonlinearShuntCompensator.py b/cimpy/cgmes_v2_4_15/NonlinearShuntCompensator.py index 24826416..3e2c529d 100644 --- a/cimpy/cgmes_v2_4_15/NonlinearShuntCompensator.py +++ b/cimpy/cgmes_v2_4_15/NonlinearShuntCompensator.py @@ -1,31 +1,33 @@ -from .ShuntCompensator import ShuntCompensator - - -class NonlinearShuntCompensator(ShuntCompensator): - ''' - A non linear shunt compensator has bank or section admittance values that differs. - - :NonlinearShuntCompensatorPoints: All points of the non-linear shunt compensator. Default: "list" - ''' - - cgmesProfile = ShuntCompensator.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'NonlinearShuntCompensatorPoints': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ShuntCompensator: \n' + ShuntCompensator.__doc__ - - def __init__(self, NonlinearShuntCompensatorPoints = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.NonlinearShuntCompensatorPoints = NonlinearShuntCompensatorPoints - - def __str__(self): - str = 'class=NonlinearShuntCompensator\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ShuntCompensator import ShuntCompensator +from .CGMESProfile import Profile + + +class NonlinearShuntCompensator(ShuntCompensator): + """ + A non linear shunt compensator has bank or section admittance values that differs. + + :NonlinearShuntCompensatorPoints: All points of the non-linear shunt compensator. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "NonlinearShuntCompensatorPoints": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ShuntCompensator:\n" + ShuntCompensator.__doc__ + + def __init__(self, NonlinearShuntCompensatorPoints = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.NonlinearShuntCompensatorPoints = NonlinearShuntCompensatorPoints + + def __str__(self): + str = "class=NonlinearShuntCompensator\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/NonlinearShuntCompensatorPoint.py b/cimpy/cgmes_v2_4_15/NonlinearShuntCompensatorPoint.py index 1f9d46f4..bddca191 100644 --- a/cimpy/cgmes_v2_4_15/NonlinearShuntCompensatorPoint.py +++ b/cimpy/cgmes_v2_4_15/NonlinearShuntCompensatorPoint.py @@ -1,45 +1,46 @@ -from .Base import Base - - -class NonlinearShuntCompensatorPoint(Base): - ''' - A non linear shunt compensator bank or section admittance value. - - :NonlinearShuntCompensator: Non-linear shunt compensator owning this point. Default: None - :b: Positive sequence shunt (charging) susceptance per section Default: 0.0 - :g: Positive sequence shunt (charging) conductance per section Default: 0.0 - :sectionNumber: The number of the section. Default: 0 - :b0: Zero sequence shunt (charging) susceptance per section Default: 0.0 - :g0: Zero sequence shunt (charging) conductance per section Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'NonlinearShuntCompensator': [cgmesProfile.EQ.value, ], - 'b': [cgmesProfile.EQ.value, ], - 'g': [cgmesProfile.EQ.value, ], - 'sectionNumber': [cgmesProfile.EQ.value, ], - 'b0': [cgmesProfile.EQ.value, ], - 'g0': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, NonlinearShuntCompensator = None, b = 0.0, g = 0.0, sectionNumber = 0, b0 = 0.0, g0 = 0.0, ): - - self.NonlinearShuntCompensator = NonlinearShuntCompensator - self.b = b - self.g = g - self.sectionNumber = sectionNumber - self.b0 = b0 - self.g0 = g0 - - def __str__(self): - str = 'class=NonlinearShuntCompensatorPoint\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class NonlinearShuntCompensatorPoint(Base): + """ + A non linear shunt compensator bank or section admittance value. + + :NonlinearShuntCompensator: Non-linear shunt compensator owning this point. Default: None + :b: Positive sequence shunt (charging) susceptance per section Default: 0.0 + :b0: Zero sequence shunt (charging) susceptance per section Default: 0.0 + :g: Positive sequence shunt (charging) conductance per section Default: 0.0 + :g0: Zero sequence shunt (charging) conductance per section Default: 0.0 + :sectionNumber: The number of the section. Default: 0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "NonlinearShuntCompensator": [Profile.EQ.value, ], + "b": [Profile.EQ.value, ], + "b0": [Profile.EQ.value, ], + "g": [Profile.EQ.value, ], + "g0": [Profile.EQ.value, ], + "sectionNumber": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, NonlinearShuntCompensator = None, b = 0.0, b0 = 0.0, g = 0.0, g0 = 0.0, sectionNumber = 0): + + self.NonlinearShuntCompensator = NonlinearShuntCompensator + self.b = b + self.b0 = b0 + self.g = g + self.g0 = g0 + self.sectionNumber = sectionNumber + + def __str__(self): + str = "class=NonlinearShuntCompensatorPoint\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/NuclearGeneratingUnit.py b/cimpy/cgmes_v2_4_15/NuclearGeneratingUnit.py index 21e20e7c..88eb7b15 100644 --- a/cimpy/cgmes_v2_4_15/NuclearGeneratingUnit.py +++ b/cimpy/cgmes_v2_4_15/NuclearGeneratingUnit.py @@ -1,29 +1,31 @@ -from .GeneratingUnit import GeneratingUnit - - -class NuclearGeneratingUnit(GeneratingUnit): - ''' - A nuclear generating unit. - - ''' - - cgmesProfile = GeneratingUnit.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class GeneratingUnit: \n' + GeneratingUnit.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=NuclearGeneratingUnit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .GeneratingUnit import GeneratingUnit +from .CGMESProfile import Profile + + +class NuclearGeneratingUnit(GeneratingUnit): + """ + A nuclear generating unit. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class GeneratingUnit:\n" + GeneratingUnit.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=NuclearGeneratingUnit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/OperationalLimit.py b/cimpy/cgmes_v2_4_15/OperationalLimit.py index 13c7e71c..ca3bba65 100644 --- a/cimpy/cgmes_v2_4_15/OperationalLimit.py +++ b/cimpy/cgmes_v2_4_15/OperationalLimit.py @@ -1,34 +1,36 @@ -from .IdentifiedObject import IdentifiedObject - - -class OperationalLimit(IdentifiedObject): - ''' - A value associated with a specific kind of limit. The sub class value attribute shall be positive. The sub class value attribute is inversely proportional to OperationalLimitType.acceptableDuration (acceptableDuration for short). A pair of value_x and acceptableDuration_x are related to each other as follows: if value_1 > value_2 > value_3 >... then acceptableDuration_1 < acceptableDuration_2 < acceptableDuration_3 < ... A value_x with direction="high" shall be greater than a value_y with direction="low". - - :OperationalLimitSet: Values of equipment limits. Default: None - :OperationalLimitType: The limit type associated with this limit. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'OperationalLimitSet': [cgmesProfile.EQ.value, ], - 'OperationalLimitType': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, OperationalLimitSet = None, OperationalLimitType = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.OperationalLimitSet = OperationalLimitSet - self.OperationalLimitType = OperationalLimitType - - def __str__(self): - str = 'class=OperationalLimit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class OperationalLimit(IdentifiedObject): + """ + A value associated with a specific kind of limit. The sub class value attribute shall be positive. The sub class value attribute is inversely proportional to OperationalLimitType.acceptableDuration (acceptableDuration for short). A pair of value_x and acceptableDuration_x are related to each other as follows: if value_1 > value_2 > value_3 >... then acceptableDuration_1 < acceptableDuration_2 < acceptableDuration_3 < ... A value_x with direction="high" shall be greater than a value_y with direction="low". + + :OperationalLimitSet: Values of equipment limits. Default: None + :OperationalLimitType: The limit type associated with this limit. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "OperationalLimitSet": [Profile.EQ.value, ], + "OperationalLimitType": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, OperationalLimitSet = None, OperationalLimitType = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.OperationalLimitSet = OperationalLimitSet + self.OperationalLimitType = OperationalLimitType + + def __str__(self): + str = "class=OperationalLimit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/OperationalLimitDirectionKind.py b/cimpy/cgmes_v2_4_15/OperationalLimitDirectionKind.py index 04f3f3fa..d110dd2e 100644 --- a/cimpy/cgmes_v2_4_15/OperationalLimitDirectionKind.py +++ b/cimpy/cgmes_v2_4_15/OperationalLimitDirectionKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class OperationalLimitDirectionKind(Base): - ''' - The direction attribute describes the side of a limit that is a violation. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=OperationalLimitDirectionKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class OperationalLimitDirectionKind(Base): + """ + The direction attribute describes the side of a limit that is a violation. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=OperationalLimitDirectionKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/OperationalLimitSet.py b/cimpy/cgmes_v2_4_15/OperationalLimitSet.py index d9fb5124..dc4261a9 100644 --- a/cimpy/cgmes_v2_4_15/OperationalLimitSet.py +++ b/cimpy/cgmes_v2_4_15/OperationalLimitSet.py @@ -1,37 +1,39 @@ -from .IdentifiedObject import IdentifiedObject - - -class OperationalLimitSet(IdentifiedObject): - ''' - A set of limits associated with equipment. Sets of limits might apply to a specific temperature, or season for example. A set of limits may contain different severities of limit levels that would apply to the same equipment. The set may contain limits of different types such as apparent power and current limits or high and low voltage limits that are logically applied together as a set. - - :Terminal: Default: None - :Equipment: The equipment to which the limit set applies. Default: None - :OperationalLimitValue: The limit set to which the limit values belong. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'Terminal': [cgmesProfile.EQ.value, ], - 'Equipment': [cgmesProfile.EQ.value, ], - 'OperationalLimitValue': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, Terminal = None, Equipment = None, OperationalLimitValue = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Terminal = Terminal - self.Equipment = Equipment - self.OperationalLimitValue = OperationalLimitValue - - def __str__(self): - str = 'class=OperationalLimitSet\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class OperationalLimitSet(IdentifiedObject): + """ + A set of limits associated with equipment. Sets of limits might apply to a specific temperature, or season for example. A set of limits may contain different severities of limit levels that would apply to the same equipment. The set may contain limits of different types such as apparent power and current limits or high and low voltage limits that are logically applied together as a set. + + :Equipment: The equipment to which the limit set applies. Default: None + :OperationalLimitValue: The limit set to which the limit values belong. Default: "list" + :Terminal: Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "Equipment": [Profile.EQ.value, ], + "OperationalLimitValue": [Profile.EQ.value, ], + "Terminal": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, Equipment = None, OperationalLimitValue = "list", Terminal = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Equipment = Equipment + self.OperationalLimitValue = OperationalLimitValue + self.Terminal = Terminal + + def __str__(self): + str = "class=OperationalLimitSet\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/OperationalLimitType.py b/cimpy/cgmes_v2_4_15/OperationalLimitType.py index 7faf2195..a89dd41a 100644 --- a/cimpy/cgmes_v2_4_15/OperationalLimitType.py +++ b/cimpy/cgmes_v2_4_15/OperationalLimitType.py @@ -1,40 +1,42 @@ -from .IdentifiedObject import IdentifiedObject - - -class OperationalLimitType(IdentifiedObject): - ''' - The operational meaning of a category of limits. - - :OperationalLimit: The operational limits associated with this type of limit. Default: "list" - :acceptableDuration: The nominal acceptable duration of the limit. Limits are commonly expressed in terms of the a time limit for which the limit is normally acceptable. The actual acceptable duration of a specific limit may depend on other local factors such as temperature or wind speed. Default: 0 - :limitType: Types of limits defined in the ENTSO-E Operational Handbook Policy 3. Default: None - :direction: The direction of the limit. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'OperationalLimit': [cgmesProfile.EQ.value, ], - 'acceptableDuration': [cgmesProfile.EQ.value, ], - 'limitType': [cgmesProfile.EQ.value, ], - 'direction': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, OperationalLimit = "list", acceptableDuration = 0, limitType = None, direction = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.OperationalLimit = OperationalLimit - self.acceptableDuration = acceptableDuration - self.limitType = limitType - self.direction = direction - - def __str__(self): - str = 'class=OperationalLimitType\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class OperationalLimitType(IdentifiedObject): + """ + The operational meaning of a category of limits. + + :OperationalLimit: The operational limits associated with this type of limit. Default: "list" + :acceptableDuration: The nominal acceptable duration of the limit. Limits are commonly expressed in terms of the a time limit for which the limit is normally acceptable. The actual acceptable duration of a specific limit may depend on other local factors such as temperature or wind speed. Default: 0.0 + :direction: The direction of the limit. Default: None + :limitType: Types of limits defined in the ENTSO-E Operational Handbook Policy 3. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "OperationalLimit": [Profile.EQ.value, ], + "acceptableDuration": [Profile.EQ.value, ], + "direction": [Profile.EQ.value, ], + "limitType": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, OperationalLimit = "list", acceptableDuration = 0.0, direction = None, limitType = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.OperationalLimit = OperationalLimit + self.acceptableDuration = acceptableDuration + self.direction = direction + self.limitType = limitType + + def __str__(self): + str = "class=OperationalLimitType\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/OrientationKind.py b/cimpy/cgmes_v2_4_15/OrientationKind.py index 67f1d367..ff51b0e0 100644 --- a/cimpy/cgmes_v2_4_15/OrientationKind.py +++ b/cimpy/cgmes_v2_4_15/OrientationKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class OrientationKind(Base): - ''' - The orientation of the coordinate system with respect to top, left, and the coordinate number system. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=OrientationKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class OrientationKind(Base): + """ + The orientation of the coordinate system with respect to top, left, and the coordinate number system. + + """ + + possibleProfileList = { + "class": [Profile.DL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DL.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=OrientationKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/OverexcLim2.py b/cimpy/cgmes_v2_4_15/OverexcLim2.py index 8b4e02c5..f9cd2fd5 100644 --- a/cimpy/cgmes_v2_4_15/OverexcLim2.py +++ b/cimpy/cgmes_v2_4_15/OverexcLim2.py @@ -1,40 +1,42 @@ -from .OverexcitationLimiterDynamics import OverexcitationLimiterDynamics - - -class OverexcLim2(OverexcitationLimiterDynamics): - ''' - Different from LimIEEEOEL, LimOEL2 has a fixed pickup threshold and reduces the excitation set-point by mean of non-windup integral regulator. Irated is the rated machine excitation current (calculated from nameplate conditions: V, P, CosPhi). - - :koi: Gain Over excitation limiter (K). Typical Value = 0.1. Default: 0.0 - :voimax: Maximum error signal (V). Typical Value = 0. Default: 0.0 - :voimin: Minimum error signal (V). Typical Value = -9999. Default: 0.0 - :ifdlim: Limit value of rated field current (I). Typical Value = 1.05. Default: 0.0 - ''' - - cgmesProfile = OverexcitationLimiterDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'koi': [cgmesProfile.DY.value, ], - 'voimax': [cgmesProfile.DY.value, ], - 'voimin': [cgmesProfile.DY.value, ], - 'ifdlim': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class OverexcitationLimiterDynamics: \n' + OverexcitationLimiterDynamics.__doc__ - - def __init__(self, koi = 0.0, voimax = 0.0, voimin = 0.0, ifdlim = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.koi = koi - self.voimax = voimax - self.voimin = voimin - self.ifdlim = ifdlim - - def __str__(self): - str = 'class=OverexcLim2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .OverexcitationLimiterDynamics import OverexcitationLimiterDynamics +from .CGMESProfile import Profile + + +class OverexcLim2(OverexcitationLimiterDynamics): + """ + Different from LimIEEEOEL, LimOEL2 has a fixed pickup threshold and reduces the excitation set-point by mean of non-windup integral regulator. Irated is the rated machine excitation current (calculated from nameplate conditions: V, P, CosPhi). + + :ifdlim: Limit value of rated field current (I). Typical Value = 1.05. Default: 0.0 + :koi: Gain Over excitation limiter (K). Typical Value = 0.1. Default: 0.0 + :voimax: Maximum error signal (V). Typical Value = 0. Default: 0.0 + :voimin: Minimum error signal (V). Typical Value = -9999. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ifdlim": [Profile.DY.value, ], + "koi": [Profile.DY.value, ], + "voimax": [Profile.DY.value, ], + "voimin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class OverexcitationLimiterDynamics:\n" + OverexcitationLimiterDynamics.__doc__ + + def __init__(self, ifdlim = 0.0, koi = 0.0, voimax = 0.0, voimin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ifdlim = ifdlim + self.koi = koi + self.voimax = voimax + self.voimin = voimin + + def __str__(self): + str = "class=OverexcLim2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/OverexcLimIEEE.py b/cimpy/cgmes_v2_4_15/OverexcLimIEEE.py index ef7c43e0..52fffea1 100644 --- a/cimpy/cgmes_v2_4_15/OverexcLimIEEE.py +++ b/cimpy/cgmes_v2_4_15/OverexcLimIEEE.py @@ -1,46 +1,48 @@ -from .OverexcitationLimiterDynamics import OverexcitationLimiterDynamics - - -class OverexcLimIEEE(OverexcitationLimiterDynamics): - ''' - The over excitation limiter model is intended to represent the significant features of OELs necessary for some large-scale system studies. It is the result of a pragmatic approach to obtain a model that can be widely applied with attainable data from generator owners. An attempt to include all variations in the functionality of OELs and duplicate how they interact with the rest of the excitation systems would likely result in a level of application insufficient for the studies for which they are intended. Reference: IEEE OEL 421.5-2005 Section 9. - - :itfpu: OEL timed field current limiter pickup level (I). Typical Value = 1.05. Default: 0.0 - :ifdmax: OEL instantaneous field current limit (I). Typical Value = 1.5. Default: 0.0 - :ifdlim: OEL timed field current limit (I). Typical Value = 1.05. Default: 0.0 - :hyst: OEL pickup/drop-out hysteresis (HYST). Typical Value = 0.03. Default: 0.0 - :kcd: OEL cooldown gain (K). Typical Value = 1. Default: 0.0 - :kramp: OEL ramped limit rate (K). Unit = PU/sec. Typical Value = 10. Default: 0.0 - ''' - - cgmesProfile = OverexcitationLimiterDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'itfpu': [cgmesProfile.DY.value, ], - 'ifdmax': [cgmesProfile.DY.value, ], - 'ifdlim': [cgmesProfile.DY.value, ], - 'hyst': [cgmesProfile.DY.value, ], - 'kcd': [cgmesProfile.DY.value, ], - 'kramp': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class OverexcitationLimiterDynamics: \n' + OverexcitationLimiterDynamics.__doc__ - - def __init__(self, itfpu = 0.0, ifdmax = 0.0, ifdlim = 0.0, hyst = 0.0, kcd = 0.0, kramp = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.itfpu = itfpu - self.ifdmax = ifdmax - self.ifdlim = ifdlim - self.hyst = hyst - self.kcd = kcd - self.kramp = kramp - - def __str__(self): - str = 'class=OverexcLimIEEE\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .OverexcitationLimiterDynamics import OverexcitationLimiterDynamics +from .CGMESProfile import Profile + + +class OverexcLimIEEE(OverexcitationLimiterDynamics): + """ + The over excitation limiter model is intended to represent the significant features of OELs necessary for some large-scale system studies. It is the result of a pragmatic approach to obtain a model that can be widely applied with attainable data from generator owners. An attempt to include all variations in the functionality of OELs and duplicate how they interact with the rest of the excitation systems would likely result in a level of application insufficient for the studies for which they are intended. Reference: IEEE OEL 421.5-2005 Section 9. + + :hyst: OEL pickup/drop-out hysteresis (HYST). Typical Value = 0.03. Default: 0.0 + :ifdlim: OEL timed field current limit (I). Typical Value = 1.05. Default: 0.0 + :ifdmax: OEL instantaneous field current limit (I). Typical Value = 1.5. Default: 0.0 + :itfpu: OEL timed field current limiter pickup level (I). Typical Value = 1.05. Default: 0.0 + :kcd: OEL cooldown gain (K). Typical Value = 1. Default: 0.0 + :kramp: OEL ramped limit rate (K). Unit = PU/sec. Typical Value = 10. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "hyst": [Profile.DY.value, ], + "ifdlim": [Profile.DY.value, ], + "ifdmax": [Profile.DY.value, ], + "itfpu": [Profile.DY.value, ], + "kcd": [Profile.DY.value, ], + "kramp": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class OverexcitationLimiterDynamics:\n" + OverexcitationLimiterDynamics.__doc__ + + def __init__(self, hyst = 0.0, ifdlim = 0.0, ifdmax = 0.0, itfpu = 0.0, kcd = 0.0, kramp = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.hyst = hyst + self.ifdlim = ifdlim + self.ifdmax = ifdmax + self.itfpu = itfpu + self.kcd = kcd + self.kramp = kramp + + def __str__(self): + str = "class=OverexcLimIEEE\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/OverexcLimX1.py b/cimpy/cgmes_v2_4_15/OverexcLimX1.py index 74af98d7..1941ae10 100644 --- a/cimpy/cgmes_v2_4_15/OverexcLimX1.py +++ b/cimpy/cgmes_v2_4_15/OverexcLimX1.py @@ -1,58 +1,60 @@ -from .OverexcitationLimiterDynamics import OverexcitationLimiterDynamics - - -class OverexcLimX1(OverexcitationLimiterDynamics): - ''' - Field voltage over excitation limiter. - - :efdrated: Rated field voltage (EFD). Typical Value = 1.05. Default: 0.0 - :efd1: Low voltage point on the inverse time characteristic (EFD). Typical Value = 1.1. Default: 0.0 - :t1: Time to trip the exciter at the low voltage point on the inverse time characteristic (TIME). Typical Value = 120. Default: 0 - :efd2: Mid voltage point on the inverse time characteristic (EFD). Typical Value = 1.2. Default: 0.0 - :t2: Time to trip the exciter at the mid voltage point on the inverse time characteristic (TIME). Typical Value = 40. Default: 0 - :efd3: High voltage point on the inverse time characteristic (EFD). Typical Value = 1.5. Default: 0.0 - :t3: Time to trip the exciter at the high voltage point on the inverse time characteristic (TIME). Typical Value = 15. Default: 0 - :efddes: Desired field voltage (EFD). Typical Value = 0.9. Default: 0.0 - :kmx: Gain (K). Typical Value = 0.01. Default: 0.0 - :vlow: Low voltage limit (V) (>0). Default: 0.0 - ''' - - cgmesProfile = OverexcitationLimiterDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'efdrated': [cgmesProfile.DY.value, ], - 'efd1': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 'efd2': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 'efd3': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 'efddes': [cgmesProfile.DY.value, ], - 'kmx': [cgmesProfile.DY.value, ], - 'vlow': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class OverexcitationLimiterDynamics: \n' + OverexcitationLimiterDynamics.__doc__ - - def __init__(self, efdrated = 0.0, efd1 = 0.0, t1 = 0, efd2 = 0.0, t2 = 0, efd3 = 0.0, t3 = 0, efddes = 0.0, kmx = 0.0, vlow = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.efdrated = efdrated - self.efd1 = efd1 - self.t1 = t1 - self.efd2 = efd2 - self.t2 = t2 - self.efd3 = efd3 - self.t3 = t3 - self.efddes = efddes - self.kmx = kmx - self.vlow = vlow - - def __str__(self): - str = 'class=OverexcLimX1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .OverexcitationLimiterDynamics import OverexcitationLimiterDynamics +from .CGMESProfile import Profile + + +class OverexcLimX1(OverexcitationLimiterDynamics): + """ + Field voltage over excitation limiter. + + :efd1: Low voltage point on the inverse time characteristic (EFD). Typical Value = 1.1. Default: 0.0 + :efd2: Mid voltage point on the inverse time characteristic (EFD). Typical Value = 1.2. Default: 0.0 + :efd3: High voltage point on the inverse time characteristic (EFD). Typical Value = 1.5. Default: 0.0 + :efddes: Desired field voltage (EFD). Typical Value = 0.9. Default: 0.0 + :efdrated: Rated field voltage (EFD). Typical Value = 1.05. Default: 0.0 + :kmx: Gain (K). Typical Value = 0.01. Default: 0.0 + :t1: Time to trip the exciter at the low voltage point on the inverse time characteristic (TIME). Typical Value = 120. Default: 0.0 + :t2: Time to trip the exciter at the mid voltage point on the inverse time characteristic (TIME). Typical Value = 40. Default: 0.0 + :t3: Time to trip the exciter at the high voltage point on the inverse time characteristic (TIME). Typical Value = 15. Default: 0.0 + :vlow: Low voltage limit (V) (>0). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efd1": [Profile.DY.value, ], + "efd2": [Profile.DY.value, ], + "efd3": [Profile.DY.value, ], + "efddes": [Profile.DY.value, ], + "efdrated": [Profile.DY.value, ], + "kmx": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "vlow": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class OverexcitationLimiterDynamics:\n" + OverexcitationLimiterDynamics.__doc__ + + def __init__(self, efd1 = 0.0, efd2 = 0.0, efd3 = 0.0, efddes = 0.0, efdrated = 0.0, kmx = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, vlow = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efd1 = efd1 + self.efd2 = efd2 + self.efd3 = efd3 + self.efddes = efddes + self.efdrated = efdrated + self.kmx = kmx + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.vlow = vlow + + def __str__(self): + str = "class=OverexcLimX1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/OverexcLimX2.py b/cimpy/cgmes_v2_4_15/OverexcLimX2.py index 9e234eaf..443cc5be 100644 --- a/cimpy/cgmes_v2_4_15/OverexcLimX2.py +++ b/cimpy/cgmes_v2_4_15/OverexcLimX2.py @@ -1,61 +1,63 @@ -from .OverexcitationLimiterDynamics import OverexcitationLimiterDynamics - - -class OverexcLimX2(OverexcitationLimiterDynamics): - ''' - Field Voltage or Current overexcitation limiter designed to protect the generator field of an AC machine with automatic excitation control from overheating due to prolonged overexcitation. - - :m: (m). true = IFD limiting false = EFD limiting. Default: False - :efdrated: Rated field voltage if m=F or field current if m=T (EFD). Typical Value = 1.05. Default: 0.0 - :efd1: Low voltage or current point on the inverse time characteristic (EFD). Typical Value = 1.1. Default: 0.0 - :t1: Time to trip the exciter at the low voltage or current point on the inverse time characteristic (TIME). Typical Value = 120. Default: 0 - :efd2: Mid voltage or current point on the inverse time characteristic (EFD). Typical Value = 1.2. Default: 0.0 - :t2: Time to trip the exciter at the mid voltage or current point on the inverse time characteristic (TIME). Typical Value = 40. Default: 0 - :efd3: High voltage or current point on the inverse time characteristic (EFD). Typical Value = 1.5. Default: 0.0 - :t3: Time to trip the exciter at the high voltage or current point on the inverse time characteristic (TIME). Typical Value = 15. Default: 0 - :efddes: Desired field voltage if m=F or field current if m=T (EFD). Typical Value = 1. Default: 0.0 - :kmx: Gain (K). Typical Value = 0.002. Default: 0.0 - :vlow: Low voltage limit (V) (>0). Default: 0.0 - ''' - - cgmesProfile = OverexcitationLimiterDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'm': [cgmesProfile.DY.value, ], - 'efdrated': [cgmesProfile.DY.value, ], - 'efd1': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 'efd2': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 'efd3': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 'efddes': [cgmesProfile.DY.value, ], - 'kmx': [cgmesProfile.DY.value, ], - 'vlow': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class OverexcitationLimiterDynamics: \n' + OverexcitationLimiterDynamics.__doc__ - - def __init__(self, m = False, efdrated = 0.0, efd1 = 0.0, t1 = 0, efd2 = 0.0, t2 = 0, efd3 = 0.0, t3 = 0, efddes = 0.0, kmx = 0.0, vlow = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.m = m - self.efdrated = efdrated - self.efd1 = efd1 - self.t1 = t1 - self.efd2 = efd2 - self.t2 = t2 - self.efd3 = efd3 - self.t3 = t3 - self.efddes = efddes - self.kmx = kmx - self.vlow = vlow - - def __str__(self): - str = 'class=OverexcLimX2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .OverexcitationLimiterDynamics import OverexcitationLimiterDynamics +from .CGMESProfile import Profile + + +class OverexcLimX2(OverexcitationLimiterDynamics): + """ + Field Voltage or Current overexcitation limiter designed to protect the generator field of an AC machine with automatic excitation control from overheating due to prolonged overexcitation. + + :efd1: Low voltage or current point on the inverse time characteristic (EFD). Typical Value = 1.1. Default: 0.0 + :efd2: Mid voltage or current point on the inverse time characteristic (EFD). Typical Value = 1.2. Default: 0.0 + :efd3: High voltage or current point on the inverse time characteristic (EFD). Typical Value = 1.5. Default: 0.0 + :efddes: Desired field voltage if m=F or field current if m=T (EFD). Typical Value = 1. Default: 0.0 + :efdrated: Rated field voltage if m=F or field current if m=T (EFD). Typical Value = 1.05. Default: 0.0 + :kmx: Gain (K). Typical Value = 0.002. Default: 0.0 + :m: (m). true = IFD limiting false = EFD limiting. Default: False + :t1: Time to trip the exciter at the low voltage or current point on the inverse time characteristic (TIME). Typical Value = 120. Default: 0.0 + :t2: Time to trip the exciter at the mid voltage or current point on the inverse time characteristic (TIME). Typical Value = 40. Default: 0.0 + :t3: Time to trip the exciter at the high voltage or current point on the inverse time characteristic (TIME). Typical Value = 15. Default: 0.0 + :vlow: Low voltage limit (V) (>0). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efd1": [Profile.DY.value, ], + "efd2": [Profile.DY.value, ], + "efd3": [Profile.DY.value, ], + "efddes": [Profile.DY.value, ], + "efdrated": [Profile.DY.value, ], + "kmx": [Profile.DY.value, ], + "m": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "vlow": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class OverexcitationLimiterDynamics:\n" + OverexcitationLimiterDynamics.__doc__ + + def __init__(self, efd1 = 0.0, efd2 = 0.0, efd3 = 0.0, efddes = 0.0, efdrated = 0.0, kmx = 0.0, m = False, t1 = 0.0, t2 = 0.0, t3 = 0.0, vlow = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efd1 = efd1 + self.efd2 = efd2 + self.efd3 = efd3 + self.efddes = efddes + self.efdrated = efdrated + self.kmx = kmx + self.m = m + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.vlow = vlow + + def __str__(self): + str = "class=OverexcLimX2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/OverexcitationLimiterDynamics.py b/cimpy/cgmes_v2_4_15/OverexcitationLimiterDynamics.py index 1ccd0268..562d52b8 100644 --- a/cimpy/cgmes_v2_4_15/OverexcitationLimiterDynamics.py +++ b/cimpy/cgmes_v2_4_15/OverexcitationLimiterDynamics.py @@ -1,31 +1,33 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class OverexcitationLimiterDynamics(DynamicsFunctionBlock): - ''' - Overexcitation limiter function block whose behaviour is described by reference to a standard model - - :ExcitationSystemDynamics: Excitation system model with which this overexcitation limiter model is associated. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ExcitationSystemDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, ExcitationSystemDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ExcitationSystemDynamics = ExcitationSystemDynamics - - def __str__(self): - str = 'class=OverexcitationLimiterDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class OverexcitationLimiterDynamics(DynamicsFunctionBlock): + """ + Overexcitation limiter function block whose behaviour is described by reference to a standard model + + :ExcitationSystemDynamics: Excitation system model with which this overexcitation limiter model is associated. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ExcitationSystemDynamics": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, ExcitationSystemDynamics = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ExcitationSystemDynamics = ExcitationSystemDynamics + + def __str__(self): + str = "class=OverexcitationLimiterDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/OverexcitationLimiterUserDefined.py b/cimpy/cgmes_v2_4_15/OverexcitationLimiterUserDefined.py index 65d0a7db..be035aa1 100644 --- a/cimpy/cgmes_v2_4_15/OverexcitationLimiterUserDefined.py +++ b/cimpy/cgmes_v2_4_15/OverexcitationLimiterUserDefined.py @@ -1,34 +1,36 @@ -from .OverexcitationLimiterDynamics import OverexcitationLimiterDynamics - - -class OverexcitationLimiterUserDefined(OverexcitationLimiterDynamics): - ''' - Overexcitation limiter system function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = OverexcitationLimiterDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class OverexcitationLimiterDynamics: \n' + OverexcitationLimiterDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=OverexcitationLimiterUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .OverexcitationLimiterDynamics import OverexcitationLimiterDynamics +from .CGMESProfile import Profile + + +class OverexcitationLimiterUserDefined(OverexcitationLimiterDynamics): + """ + Overexcitation limiter system function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class OverexcitationLimiterDynamics:\n" + OverexcitationLimiterDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=OverexcitationLimiterUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PFVArControllerType1Dynamics.py b/cimpy/cgmes_v2_4_15/PFVArControllerType1Dynamics.py index 8c41504c..86fb2f8d 100644 --- a/cimpy/cgmes_v2_4_15/PFVArControllerType1Dynamics.py +++ b/cimpy/cgmes_v2_4_15/PFVArControllerType1Dynamics.py @@ -1,37 +1,39 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class PFVArControllerType1Dynamics(DynamicsFunctionBlock): - ''' - Power Factor or VAr controller Type I function block whose behaviour is described by reference to a standard model - - :RemoteInputSignal: Remote input signal used by this Power Factor or VAr controller Type I model. Default: None - :ExcitationSystemDynamics: Excitation system model with which this Power Factor or VAr controller Type I model is associated. Default: None - :VoltageAdjusterDynamics: Voltage adjuster model associated with this Power Factor or VA controller Type I model. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'RemoteInputSignal': [cgmesProfile.DY.value, ], - 'ExcitationSystemDynamics': [cgmesProfile.DY.value, ], - 'VoltageAdjusterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, RemoteInputSignal = None, ExcitationSystemDynamics = None, VoltageAdjusterDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.RemoteInputSignal = RemoteInputSignal - self.ExcitationSystemDynamics = ExcitationSystemDynamics - self.VoltageAdjusterDynamics = VoltageAdjusterDynamics - - def __str__(self): - str = 'class=PFVArControllerType1Dynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class PFVArControllerType1Dynamics(DynamicsFunctionBlock): + """ + Power Factor or VAr controller Type I function block whose behaviour is described by reference to a standard model + + :ExcitationSystemDynamics: Excitation system model with which this Power Factor or VAr controller Type I model is associated. Default: None + :RemoteInputSignal: Remote input signal used by this Power Factor or VAr controller Type I model. Default: None + :VoltageAdjusterDynamics: Voltage adjuster model associated with this Power Factor or VA controller Type I model. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ExcitationSystemDynamics": [Profile.DY.value, ], + "RemoteInputSignal": [Profile.DY.value, ], + "VoltageAdjusterDynamics": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, ExcitationSystemDynamics = None, RemoteInputSignal = None, VoltageAdjusterDynamics = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ExcitationSystemDynamics = ExcitationSystemDynamics + self.RemoteInputSignal = RemoteInputSignal + self.VoltageAdjusterDynamics = VoltageAdjusterDynamics + + def __str__(self): + str = "class=PFVArControllerType1Dynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PFVArControllerType1UserDefined.py b/cimpy/cgmes_v2_4_15/PFVArControllerType1UserDefined.py index c043b4d8..e942fddf 100644 --- a/cimpy/cgmes_v2_4_15/PFVArControllerType1UserDefined.py +++ b/cimpy/cgmes_v2_4_15/PFVArControllerType1UserDefined.py @@ -1,34 +1,36 @@ -from .PFVArControllerType1Dynamics import PFVArControllerType1Dynamics - - -class PFVArControllerType1UserDefined(PFVArControllerType1Dynamics): - ''' - Power Factor or VAr controller Type I function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = PFVArControllerType1Dynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PFVArControllerType1Dynamics: \n' + PFVArControllerType1Dynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=PFVArControllerType1UserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PFVArControllerType1Dynamics import PFVArControllerType1Dynamics +from .CGMESProfile import Profile + + +class PFVArControllerType1UserDefined(PFVArControllerType1Dynamics): + """ + Power Factor or VAr controller Type I function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PFVArControllerType1Dynamics:\n" + PFVArControllerType1Dynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=PFVArControllerType1UserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PFVArControllerType2Dynamics.py b/cimpy/cgmes_v2_4_15/PFVArControllerType2Dynamics.py index e678b004..b54261f0 100644 --- a/cimpy/cgmes_v2_4_15/PFVArControllerType2Dynamics.py +++ b/cimpy/cgmes_v2_4_15/PFVArControllerType2Dynamics.py @@ -1,31 +1,33 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class PFVArControllerType2Dynamics(DynamicsFunctionBlock): - ''' - Power Factor or VAr controller Type II function block whose behaviour is described by reference to a standard model - - :ExcitationSystemDynamics: Excitation system model with which this Power Factor or VAr controller Type II is associated. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ExcitationSystemDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, ExcitationSystemDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ExcitationSystemDynamics = ExcitationSystemDynamics - - def __str__(self): - str = 'class=PFVArControllerType2Dynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class PFVArControllerType2Dynamics(DynamicsFunctionBlock): + """ + Power Factor or VAr controller Type II function block whose behaviour is described by reference to a standard model + + :ExcitationSystemDynamics: Excitation system model with which this Power Factor or VAr controller Type II is associated. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ExcitationSystemDynamics": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, ExcitationSystemDynamics = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ExcitationSystemDynamics = ExcitationSystemDynamics + + def __str__(self): + str = "class=PFVArControllerType2Dynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PFVArControllerType2UserDefined.py b/cimpy/cgmes_v2_4_15/PFVArControllerType2UserDefined.py index 65284d35..4ea1c622 100644 --- a/cimpy/cgmes_v2_4_15/PFVArControllerType2UserDefined.py +++ b/cimpy/cgmes_v2_4_15/PFVArControllerType2UserDefined.py @@ -1,34 +1,36 @@ -from .PFVArControllerType2Dynamics import PFVArControllerType2Dynamics - - -class PFVArControllerType2UserDefined(PFVArControllerType2Dynamics): - ''' - Power Factor or VAr controller Type II function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = PFVArControllerType2Dynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PFVArControllerType2Dynamics: \n' + PFVArControllerType2Dynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=PFVArControllerType2UserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PFVArControllerType2Dynamics import PFVArControllerType2Dynamics +from .CGMESProfile import Profile + + +class PFVArControllerType2UserDefined(PFVArControllerType2Dynamics): + """ + Power Factor or VAr controller Type II function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PFVArControllerType2Dynamics:\n" + PFVArControllerType2Dynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=PFVArControllerType2UserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PFVArType1IEEEPFController.py b/cimpy/cgmes_v2_4_15/PFVArType1IEEEPFController.py index 4f8d77fa..608228d8 100644 --- a/cimpy/cgmes_v2_4_15/PFVArType1IEEEPFController.py +++ b/cimpy/cgmes_v2_4_15/PFVArType1IEEEPFController.py @@ -1,52 +1,54 @@ -from .PFVArControllerType1Dynamics import PFVArControllerType1Dynamics - - -class PFVArType1IEEEPFController(PFVArControllerType1Dynamics): - ''' - The class represents IEEE PF Controller Type 1 which operates by moving the voltage reference directly. Reference: IEEE Standard 421.5-2005 Section 11.2. - - :ovex: Overexcitation Flag () true = overexcited false = underexcited. Default: False - :tpfc: PF controller time delay (). Typical Value = 5. Default: 0 - :vitmin: Minimum machine terminal current needed to enable pf/var controller (). Default: 0.0 - :vpf: Synchronous machine power factor (). Default: 0.0 - :vpfcbw: PF controller dead band (). Typical Value = 0.05. Default: 0.0 - :vpfref: PF controller reference (). Default: 0.0 - :vvtmax: Maximum machine terminal voltage needed for pf/var controller to be enabled (). Default: 0.0 - :vvtmin: Minimum machine terminal voltage needed to enable pf/var controller (). Default: 0.0 - ''' - - cgmesProfile = PFVArControllerType1Dynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ovex': [cgmesProfile.DY.value, ], - 'tpfc': [cgmesProfile.DY.value, ], - 'vitmin': [cgmesProfile.DY.value, ], - 'vpf': [cgmesProfile.DY.value, ], - 'vpfcbw': [cgmesProfile.DY.value, ], - 'vpfref': [cgmesProfile.DY.value, ], - 'vvtmax': [cgmesProfile.DY.value, ], - 'vvtmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PFVArControllerType1Dynamics: \n' + PFVArControllerType1Dynamics.__doc__ - - def __init__(self, ovex = False, tpfc = 0, vitmin = 0.0, vpf = 0.0, vpfcbw = 0.0, vpfref = 0.0, vvtmax = 0.0, vvtmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ovex = ovex - self.tpfc = tpfc - self.vitmin = vitmin - self.vpf = vpf - self.vpfcbw = vpfcbw - self.vpfref = vpfref - self.vvtmax = vvtmax - self.vvtmin = vvtmin - - def __str__(self): - str = 'class=PFVArType1IEEEPFController\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PFVArControllerType1Dynamics import PFVArControllerType1Dynamics +from .CGMESProfile import Profile + + +class PFVArType1IEEEPFController(PFVArControllerType1Dynamics): + """ + The class represents IEEE PF Controller Type 1 which operates by moving the voltage reference directly. Reference: IEEE Standard 421.5-2005 Section 11.2. + + :ovex: Overexcitation Flag () true = overexcited false = underexcited. Default: False + :tpfc: PF controller time delay (). Typical Value = 5. Default: 0.0 + :vitmin: Minimum machine terminal current needed to enable pf/var controller (). Default: 0.0 + :vpf: Synchronous machine power factor (). Default: 0.0 + :vpfcbw: PF controller dead band (). Typical Value = 0.05. Default: 0.0 + :vpfref: PF controller reference (). Default: 0.0 + :vvtmax: Maximum machine terminal voltage needed for pf/var controller to be enabled (). Default: 0.0 + :vvtmin: Minimum machine terminal voltage needed to enable pf/var controller (). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ovex": [Profile.DY.value, ], + "tpfc": [Profile.DY.value, ], + "vitmin": [Profile.DY.value, ], + "vpf": [Profile.DY.value, ], + "vpfcbw": [Profile.DY.value, ], + "vpfref": [Profile.DY.value, ], + "vvtmax": [Profile.DY.value, ], + "vvtmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PFVArControllerType1Dynamics:\n" + PFVArControllerType1Dynamics.__doc__ + + def __init__(self, ovex = False, tpfc = 0.0, vitmin = 0.0, vpf = 0.0, vpfcbw = 0.0, vpfref = 0.0, vvtmax = 0.0, vvtmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ovex = ovex + self.tpfc = tpfc + self.vitmin = vitmin + self.vpf = vpf + self.vpfcbw = vpfcbw + self.vpfref = vpfref + self.vvtmax = vvtmax + self.vvtmin = vvtmin + + def __str__(self): + str = "class=PFVArType1IEEEPFController\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PFVArType1IEEEVArController.py b/cimpy/cgmes_v2_4_15/PFVArType1IEEEVArController.py index d215f698..edeacb2c 100644 --- a/cimpy/cgmes_v2_4_15/PFVArType1IEEEVArController.py +++ b/cimpy/cgmes_v2_4_15/PFVArType1IEEEVArController.py @@ -1,46 +1,48 @@ -from .PFVArControllerType1Dynamics import PFVArControllerType1Dynamics - - -class PFVArType1IEEEVArController(PFVArControllerType1Dynamics): - ''' - The class represents IEEE VAR Controller Type 1 which operates by moving the voltage reference directly. Reference: IEEE Standard 421.5-2005 Section 11.3. - - :tvarc: Var controller time delay (). Typical Value = 5. Default: 0 - :vvar: Synchronous machine power factor (). Default: 0.0 - :vvarcbw: Var controller dead band (). Typical Value = 0.02. Default: 0.0 - :vvarref: Var controller reference (). Default: 0.0 - :vvtmax: Maximum machine terminal voltage needed for pf/var controller to be enabled (). Default: 0.0 - :vvtmin: Minimum machine terminal voltage needed to enable pf/var controller (). Default: 0.0 - ''' - - cgmesProfile = PFVArControllerType1Dynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tvarc': [cgmesProfile.DY.value, ], - 'vvar': [cgmesProfile.DY.value, ], - 'vvarcbw': [cgmesProfile.DY.value, ], - 'vvarref': [cgmesProfile.DY.value, ], - 'vvtmax': [cgmesProfile.DY.value, ], - 'vvtmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PFVArControllerType1Dynamics: \n' + PFVArControllerType1Dynamics.__doc__ - - def __init__(self, tvarc = 0, vvar = 0.0, vvarcbw = 0.0, vvarref = 0.0, vvtmax = 0.0, vvtmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tvarc = tvarc - self.vvar = vvar - self.vvarcbw = vvarcbw - self.vvarref = vvarref - self.vvtmax = vvtmax - self.vvtmin = vvtmin - - def __str__(self): - str = 'class=PFVArType1IEEEVArController\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PFVArControllerType1Dynamics import PFVArControllerType1Dynamics +from .CGMESProfile import Profile + + +class PFVArType1IEEEVArController(PFVArControllerType1Dynamics): + """ + The class represents IEEE VAR Controller Type 1 which operates by moving the voltage reference directly. Reference: IEEE Standard 421.5-2005 Section 11.3. + + :tvarc: Var controller time delay (). Typical Value = 5. Default: 0.0 + :vvar: Synchronous machine power factor (). Default: 0.0 + :vvarcbw: Var controller dead band (). Typical Value = 0.02. Default: 0.0 + :vvarref: Var controller reference (). Default: 0.0 + :vvtmax: Maximum machine terminal voltage needed for pf/var controller to be enabled (). Default: 0.0 + :vvtmin: Minimum machine terminal voltage needed to enable pf/var controller (). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "tvarc": [Profile.DY.value, ], + "vvar": [Profile.DY.value, ], + "vvarcbw": [Profile.DY.value, ], + "vvarref": [Profile.DY.value, ], + "vvtmax": [Profile.DY.value, ], + "vvtmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PFVArControllerType1Dynamics:\n" + PFVArControllerType1Dynamics.__doc__ + + def __init__(self, tvarc = 0.0, vvar = 0.0, vvarcbw = 0.0, vvarref = 0.0, vvtmax = 0.0, vvtmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.tvarc = tvarc + self.vvar = vvar + self.vvarcbw = vvarcbw + self.vvarref = vvarref + self.vvtmax = vvtmax + self.vvtmin = vvtmin + + def __str__(self): + str = "class=PFVArType1IEEEVArController\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PFVArType2Common1.py b/cimpy/cgmes_v2_4_15/PFVArType2Common1.py index add58576..2486d7c1 100644 --- a/cimpy/cgmes_v2_4_15/PFVArType2Common1.py +++ b/cimpy/cgmes_v2_4_15/PFVArType2Common1.py @@ -1,43 +1,45 @@ -from .PFVArControllerType2Dynamics import PFVArControllerType2Dynamics - - -class PFVArType2Common1(PFVArControllerType2Dynamics): - ''' - Power factor / Reactive power regulator. This model represents the power factor or reactive power controller such as the Basler SCP-250. The controller measures power factor or reactive power (PU on generator rated power) and compares it with the operator's set point. - - :j: Selector (J). true = control mode for reactive power false = control mode for power factor. Default: False - :kp: Proportional gain (Kp). Default: 0.0 - :ki: Reset gain (Ki). Default: 0.0 - :max: Output limit (max). Default: 0.0 - :ref: Reference value of reactive power or power factor (Ref). The reference value is initialised by this model. This initialisation may override the value exchanged by this attribute to represent a plant operator`s change of the reference setting. Default: 0.0 - ''' - - cgmesProfile = PFVArControllerType2Dynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'j': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'max': [cgmesProfile.DY.value, ], - 'ref': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PFVArControllerType2Dynamics: \n' + PFVArControllerType2Dynamics.__doc__ - - def __init__(self, j = False, kp = 0.0, ki = 0.0, max = 0.0, ref = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.j = j - self.kp = kp - self.ki = ki - self.max = max - self.ref = ref - - def __str__(self): - str = 'class=PFVArType2Common1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PFVArControllerType2Dynamics import PFVArControllerType2Dynamics +from .CGMESProfile import Profile + + +class PFVArType2Common1(PFVArControllerType2Dynamics): + """ + Power factor / Reactive power regulator. This model represents the power factor or reactive power controller such as the Basler SCP-250. The controller measures power factor or reactive power (PU on generator rated power) and compares it with the operator's set point. + + :j: Selector (J). true = control mode for reactive power false = control mode for power factor. Default: False + :ki: Reset gain (Ki). Default: 0.0 + :kp: Proportional gain (Kp). Default: 0.0 + :max: Output limit (max). Default: 0.0 + :ref: Reference value of reactive power or power factor (Ref). The reference value is initialised by this model. This initialisation may override the value exchanged by this attribute to represent a plant operator`s change of the reference setting. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "j": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "max": [Profile.DY.value, ], + "ref": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PFVArControllerType2Dynamics:\n" + PFVArControllerType2Dynamics.__doc__ + + def __init__(self, j = False, ki = 0.0, kp = 0.0, max = 0.0, ref = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.j = j + self.ki = ki + self.kp = kp + self.max = max + self.ref = ref + + def __str__(self): + str = "class=PFVArType2Common1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PFVArType2IEEEPFController.py b/cimpy/cgmes_v2_4_15/PFVArType2IEEEPFController.py index bc744d31..9e4dd1a4 100644 --- a/cimpy/cgmes_v2_4_15/PFVArType2IEEEPFController.py +++ b/cimpy/cgmes_v2_4_15/PFVArType2IEEEPFController.py @@ -1,49 +1,51 @@ -from .PFVArControllerType2Dynamics import PFVArControllerType2Dynamics - - -class PFVArType2IEEEPFController(PFVArControllerType2Dynamics): - ''' - The class represents IEEE PF Controller Type 2 which is a summing point type controller and makes up the outside loop of a two-loop system. This controller is implemented as a slow PI type controller. The voltage regulator forms the inner loop and is implemented as a fast controller. Reference: IEEE Standard 421.5-2005 Section 11.4. - - :pfref: Power factor reference (). Default: 0.0 - :vref: Voltage regulator reference (). Default: 0.0 - :vclmt: Maximum output of the pf controller (). Typical Value = 0.1. Default: 0.0 - :kp: Proportional gain of the pf controller (). Typical Value = 1. Default: 0.0 - :ki: Integral gain of the pf controller (). Typical Value = 1. Default: 0.0 - :vs: Generator sensing voltage (). Default: 0.0 - :exlon: Overexcitation or under excitation flag () true = 1 (not in the overexcitation or underexcitation state, integral action is active) false = 0 (in the overexcitation or underexcitation state, so integral action is disabled to allow the limiter to play its role). Default: False - ''' - - cgmesProfile = PFVArControllerType2Dynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'pfref': [cgmesProfile.DY.value, ], - 'vref': [cgmesProfile.DY.value, ], - 'vclmt': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'vs': [cgmesProfile.DY.value, ], - 'exlon': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PFVArControllerType2Dynamics: \n' + PFVArControllerType2Dynamics.__doc__ - - def __init__(self, pfref = 0.0, vref = 0.0, vclmt = 0.0, kp = 0.0, ki = 0.0, vs = 0.0, exlon = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.pfref = pfref - self.vref = vref - self.vclmt = vclmt - self.kp = kp - self.ki = ki - self.vs = vs - self.exlon = exlon - - def __str__(self): - str = 'class=PFVArType2IEEEPFController\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PFVArControllerType2Dynamics import PFVArControllerType2Dynamics +from .CGMESProfile import Profile + + +class PFVArType2IEEEPFController(PFVArControllerType2Dynamics): + """ + The class represents IEEE PF Controller Type 2 which is a summing point type controller and makes up the outside loop of a two-loop system. This controller is implemented as a slow PI type controller. The voltage regulator forms the inner loop and is implemented as a fast controller. Reference: IEEE Standard 421.5-2005 Section 11.4. + + :exlon: Overexcitation or under excitation flag () true = 1 (not in the overexcitation or underexcitation state, integral action is active) false = 0 (in the overexcitation or underexcitation state, so integral action is disabled to allow the limiter to play its role). Default: False + :ki: Integral gain of the pf controller (). Typical Value = 1. Default: 0.0 + :kp: Proportional gain of the pf controller (). Typical Value = 1. Default: 0.0 + :pfref: Power factor reference (). Default: 0.0 + :vclmt: Maximum output of the pf controller (). Typical Value = 0.1. Default: 0.0 + :vref: Voltage regulator reference (). Default: 0.0 + :vs: Generator sensing voltage (). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "exlon": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "pfref": [Profile.DY.value, ], + "vclmt": [Profile.DY.value, ], + "vref": [Profile.DY.value, ], + "vs": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PFVArControllerType2Dynamics:\n" + PFVArControllerType2Dynamics.__doc__ + + def __init__(self, exlon = False, ki = 0.0, kp = 0.0, pfref = 0.0, vclmt = 0.0, vref = 0.0, vs = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.exlon = exlon + self.ki = ki + self.kp = kp + self.pfref = pfref + self.vclmt = vclmt + self.vref = vref + self.vs = vs + + def __str__(self): + str = "class=PFVArType2IEEEPFController\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PFVArType2IEEEVArController.py b/cimpy/cgmes_v2_4_15/PFVArType2IEEEVArController.py index 7511dbbd..87b5e97a 100644 --- a/cimpy/cgmes_v2_4_15/PFVArType2IEEEVArController.py +++ b/cimpy/cgmes_v2_4_15/PFVArType2IEEEVArController.py @@ -1,49 +1,51 @@ -from .PFVArControllerType2Dynamics import PFVArControllerType2Dynamics - - -class PFVArType2IEEEVArController(PFVArControllerType2Dynamics): - ''' - The class represents IEEE VAR Controller Type 2 which is a summing point type controller. It makes up the outside loop of a two-loop system. This controller is implemented as a slow PI type controller, and the voltage regulator forms the inner loop and is implemented as a fast controller. Reference: IEEE Standard 421.5-2005 Section 11.5. - - :qref: Reactive power reference (). Default: 0.0 - :vref: Voltage regulator reference (). Default: 0.0 - :vclmt: Maximum output of the pf controller (). Default: 0.0 - :kp: Proportional gain of the pf controller (). Default: 0.0 - :ki: Integral gain of the pf controller (). Default: 0.0 - :vs: Generator sensing voltage (). Default: 0.0 - :exlon: Overexcitation or under excitation flag () true = 1 (not in the overexcitation or underexcitation state, integral action is active) false = 0 (in the overexcitation or underexcitation state, so integral action is disabled to allow the limiter to play its role). Default: False - ''' - - cgmesProfile = PFVArControllerType2Dynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'qref': [cgmesProfile.DY.value, ], - 'vref': [cgmesProfile.DY.value, ], - 'vclmt': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'vs': [cgmesProfile.DY.value, ], - 'exlon': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PFVArControllerType2Dynamics: \n' + PFVArControllerType2Dynamics.__doc__ - - def __init__(self, qref = 0.0, vref = 0.0, vclmt = 0.0, kp = 0.0, ki = 0.0, vs = 0.0, exlon = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.qref = qref - self.vref = vref - self.vclmt = vclmt - self.kp = kp - self.ki = ki - self.vs = vs - self.exlon = exlon - - def __str__(self): - str = 'class=PFVArType2IEEEVArController\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PFVArControllerType2Dynamics import PFVArControllerType2Dynamics +from .CGMESProfile import Profile + + +class PFVArType2IEEEVArController(PFVArControllerType2Dynamics): + """ + The class represents IEEE VAR Controller Type 2 which is a summing point type controller. It makes up the outside loop of a two-loop system. This controller is implemented as a slow PI type controller, and the voltage regulator forms the inner loop and is implemented as a fast controller. Reference: IEEE Standard 421.5-2005 Section 11.5. + + :exlon: Overexcitation or under excitation flag () true = 1 (not in the overexcitation or underexcitation state, integral action is active) false = 0 (in the overexcitation or underexcitation state, so integral action is disabled to allow the limiter to play its role). Default: False + :ki: Integral gain of the pf controller (). Default: 0.0 + :kp: Proportional gain of the pf controller (). Default: 0.0 + :qref: Reactive power reference (). Default: 0.0 + :vclmt: Maximum output of the pf controller (). Default: 0.0 + :vref: Voltage regulator reference (). Default: 0.0 + :vs: Generator sensing voltage (). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "exlon": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "qref": [Profile.DY.value, ], + "vclmt": [Profile.DY.value, ], + "vref": [Profile.DY.value, ], + "vs": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PFVArControllerType2Dynamics:\n" + PFVArControllerType2Dynamics.__doc__ + + def __init__(self, exlon = False, ki = 0.0, kp = 0.0, qref = 0.0, vclmt = 0.0, vref = 0.0, vs = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.exlon = exlon + self.ki = ki + self.kp = kp + self.qref = qref + self.vclmt = vclmt + self.vref = vref + self.vs = vs + + def __str__(self): + str = "class=PFVArType2IEEEVArController\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PU.py b/cimpy/cgmes_v2_4_15/PU.py index a6141548..0b7a353f 100644 --- a/cimpy/cgmes_v2_4_15/PU.py +++ b/cimpy/cgmes_v2_4_15/PU.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class PU(Base): - ''' - Per Unit - a positive or negative value referred to a defined base. Values typically range from -10 to +10. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.DY.value, ], - 'value': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.DY.value, ], - 'unit': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.DY.value, ], - 'multiplier': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=PU\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class PU(Base): + """ + Per Unit - a positive or negative value referred to a defined base. Values typically range from -10 to +10. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, Profile.SSH.value, ], + "multiplier": [Profile.DY.value, Profile.EQ.value, Profile.SSH.value, ], + "unit": [Profile.DY.value, Profile.EQ.value, Profile.SSH.value, ], + "value": [Profile.DY.value, Profile.EQ.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=PU\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PerCent.py b/cimpy/cgmes_v2_4_15/PerCent.py index 3671e75f..99e7da5c 100644 --- a/cimpy/cgmes_v2_4_15/PerCent.py +++ b/cimpy/cgmes_v2_4_15/PerCent.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class PerCent(Base): - ''' - Percentage on a defined base. For example, specify as 100 to indicate at the defined base. - - :value: Normally 0 - 100 on a defined base Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'value': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'unit': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'multiplier': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=PerCent\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class PerCent(Base): + """ + Percentage on a defined base. For example, specify as 100 to indicate at the defined base. + + :multiplier: Default: None + :unit: Default: None + :value: Normally 0 - 100 on a defined base Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "multiplier": [Profile.EQ.value, Profile.SSH.value, ], + "unit": [Profile.EQ.value, Profile.SSH.value, ], + "value": [Profile.EQ.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=PerCent\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PerLengthDCLineParameter.py b/cimpy/cgmes_v2_4_15/PerLengthDCLineParameter.py index 38e0ddda..125df1be 100644 --- a/cimpy/cgmes_v2_4_15/PerLengthDCLineParameter.py +++ b/cimpy/cgmes_v2_4_15/PerLengthDCLineParameter.py @@ -1,39 +1,40 @@ -from .Base import Base - - -class PerLengthDCLineParameter(Base): - ''' - - - :DCLineSegments: All line segments described by this set of per-length parameters. Default: "list" - :capacitance: Capacitance per unit of length of the DC line segment; significant for cables only. Default: 0.0 - :inductance: Inductance per unit of length of the DC line segment. Default: 0.0 - :resistance: Resistance per length of the DC line segment. Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'DCLineSegments': [cgmesProfile.EQ.value, ], - 'capacitance': [cgmesProfile.EQ.value, ], - 'inductance': [cgmesProfile.EQ.value, ], - 'resistance': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, DCLineSegments = "list", capacitance = 0.0, inductance = 0.0, resistance = 0.0, ): - - self.DCLineSegments = DCLineSegments - self.capacitance = capacitance - self.inductance = inductance - self.resistance = resistance - - def __str__(self): - str = 'class=PerLengthDCLineParameter\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class PerLengthDCLineParameter(Base): + """ + + + :DCLineSegments: All line segments described by this set of per-length parameters. Default: "list" + :capacitance: Capacitance per unit of length of the DC line segment; significant for cables only. Default: 0.0 + :inductance: Inductance per unit of length of the DC line segment. Default: 0.0 + :resistance: Resistance per length of the DC line segment. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "DCLineSegments": [Profile.EQ.value, ], + "capacitance": [Profile.EQ.value, ], + "inductance": [Profile.EQ.value, ], + "resistance": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, DCLineSegments = "list", capacitance = 0.0, inductance = 0.0, resistance = 0.0): + + self.DCLineSegments = DCLineSegments + self.capacitance = capacitance + self.inductance = inductance + self.resistance = resistance + + def __str__(self): + str = "class=PerLengthDCLineParameter\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PetersenCoil.py b/cimpy/cgmes_v2_4_15/PetersenCoil.py index 3ed35db6..ebf2a60c 100644 --- a/cimpy/cgmes_v2_4_15/PetersenCoil.py +++ b/cimpy/cgmes_v2_4_15/PetersenCoil.py @@ -1,49 +1,51 @@ -from .EarthFaultCompensator import EarthFaultCompensator - - -class PetersenCoil(EarthFaultCompensator): - ''' - A tunable impedance device normally used to offset line charging during single line faults in an ungrounded section of network. - - :mode: The mode of operation of the Petersen coil. Default: None - :nominalU: The nominal voltage for which the coil is designed. Default: 0.0 - :offsetCurrent: The offset current that the Petersen coil controller is operating from the resonant point. This is normally a fixed amount for which the controller is configured and could be positive or negative. Typically 0 to 60 Amperes depending on voltage and resonance conditions. Default: 0.0 - :positionCurrent: The control current used to control the Petersen coil also known as the position current. Typically in the range of 20-200mA. Default: 0.0 - :xGroundMax: The maximum reactance. Default: 0.0 - :xGroundMin: The minimum reactance. Default: 0.0 - :xGroundNominal: The nominal reactance. This is the operating point (normally over compensation) that is defined based on the resonance point in the healthy network condition. The impedance is calculated based on nominal voltage divided by position current. Default: 0.0 - ''' - - cgmesProfile = EarthFaultCompensator.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'mode': [cgmesProfile.EQ.value, ], - 'nominalU': [cgmesProfile.EQ.value, ], - 'offsetCurrent': [cgmesProfile.EQ.value, ], - 'positionCurrent': [cgmesProfile.EQ.value, ], - 'xGroundMax': [cgmesProfile.EQ.value, ], - 'xGroundMin': [cgmesProfile.EQ.value, ], - 'xGroundNominal': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EarthFaultCompensator: \n' + EarthFaultCompensator.__doc__ - - def __init__(self, mode = None, nominalU = 0.0, offsetCurrent = 0.0, positionCurrent = 0.0, xGroundMax = 0.0, xGroundMin = 0.0, xGroundNominal = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mode = mode - self.nominalU = nominalU - self.offsetCurrent = offsetCurrent - self.positionCurrent = positionCurrent - self.xGroundMax = xGroundMax - self.xGroundMin = xGroundMin - self.xGroundNominal = xGroundNominal - - def __str__(self): - str = 'class=PetersenCoil\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EarthFaultCompensator import EarthFaultCompensator +from .CGMESProfile import Profile + + +class PetersenCoil(EarthFaultCompensator): + """ + A tunable impedance device normally used to offset line charging during single line faults in an ungrounded section of network. + + :mode: The mode of operation of the Petersen coil. Default: None + :nominalU: The nominal voltage for which the coil is designed. Default: 0.0 + :offsetCurrent: The offset current that the Petersen coil controller is operating from the resonant point. This is normally a fixed amount for which the controller is configured and could be positive or negative. Typically 0 to 60 Amperes depending on voltage and resonance conditions. Default: 0.0 + :positionCurrent: The control current used to control the Petersen coil also known as the position current. Typically in the range of 20-200mA. Default: 0.0 + :xGroundMax: The maximum reactance. Default: 0.0 + :xGroundMin: The minimum reactance. Default: 0.0 + :xGroundNominal: The nominal reactance. This is the operating point (normally over compensation) that is defined based on the resonance point in the healthy network condition. The impedance is calculated based on nominal voltage divided by position current. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "mode": [Profile.EQ.value, ], + "nominalU": [Profile.EQ.value, ], + "offsetCurrent": [Profile.EQ.value, ], + "positionCurrent": [Profile.EQ.value, ], + "xGroundMax": [Profile.EQ.value, ], + "xGroundMin": [Profile.EQ.value, ], + "xGroundNominal": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EarthFaultCompensator:\n" + EarthFaultCompensator.__doc__ + + def __init__(self, mode = None, nominalU = 0.0, offsetCurrent = 0.0, positionCurrent = 0.0, xGroundMax = 0.0, xGroundMin = 0.0, xGroundNominal = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.mode = mode + self.nominalU = nominalU + self.offsetCurrent = offsetCurrent + self.positionCurrent = positionCurrent + self.xGroundMax = xGroundMax + self.xGroundMin = xGroundMin + self.xGroundNominal = xGroundNominal + + def __str__(self): + str = "class=PetersenCoil\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PetersenCoilModeKind.py b/cimpy/cgmes_v2_4_15/PetersenCoilModeKind.py index b4a27f40..3b218194 100644 --- a/cimpy/cgmes_v2_4_15/PetersenCoilModeKind.py +++ b/cimpy/cgmes_v2_4_15/PetersenCoilModeKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class PetersenCoilModeKind(Base): - ''' - The mode of operation for a Petersen coil. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=PetersenCoilModeKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class PetersenCoilModeKind(Base): + """ + The mode of operation for a Petersen coil. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=PetersenCoilModeKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PhaseCode.py b/cimpy/cgmes_v2_4_15/PhaseCode.py index 589b17f7..4bb53167 100644 --- a/cimpy/cgmes_v2_4_15/PhaseCode.py +++ b/cimpy/cgmes_v2_4_15/PhaseCode.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class PhaseCode(Base): - ''' - Enumeration of phase identifiers. Allows designation of phases for both transmission and distribution equipment, circuits and loads. Residential and small commercial loads are often served from single-phase, or split-phase, secondary circuits. For example of s12N, phases 1 and 2 refer to hot wires that are 180 degrees out of phase, while N refers to the neutral wire. Through single-phase transformer connections, these secondary circuits may be served from one or two of the primary phases A, B, and C. For three-phase loads, use the A, B, C phase codes instead of s12N. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=PhaseCode\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class PhaseCode(Base): + """ + Enumeration of phase identifiers. Allows designation of phases for both transmission and distribution equipment, circuits and loads. Residential and small commercial loads are often served from single-phase, or split-phase, secondary circuits. For example of s12N, phases 1 and 2 refer to hot wires that are 180 degrees out of phase, while N refers to the neutral wire. Through single-phase transformer connections, these secondary circuits may be served from one or two of the primary phases A, B, and C. For three-phase loads, use the A, B, C phase codes instead of s12N. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=PhaseCode\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PhaseTapChanger.py b/cimpy/cgmes_v2_4_15/PhaseTapChanger.py index 1d0419a6..185032e8 100644 --- a/cimpy/cgmes_v2_4_15/PhaseTapChanger.py +++ b/cimpy/cgmes_v2_4_15/PhaseTapChanger.py @@ -1,31 +1,33 @@ -from .TapChanger import TapChanger - - -class PhaseTapChanger(TapChanger): - ''' - A transformer phase shifting tap model that controls the phase angle difference across the power transformer and potentially the active power flow through the power transformer. This phase tap model may also impact the voltage magnitude. - - :TransformerEnd: Phase tap changer associated with this transformer end. Default: None - ''' - - cgmesProfile = TapChanger.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'TransformerEnd': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TapChanger: \n' + TapChanger.__doc__ - - def __init__(self, TransformerEnd = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.TransformerEnd = TransformerEnd - - def __str__(self): - str = 'class=PhaseTapChanger\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TapChanger import TapChanger +from .CGMESProfile import Profile + + +class PhaseTapChanger(TapChanger): + """ + A transformer phase shifting tap model that controls the phase angle difference across the power transformer and potentially the active power flow through the power transformer. This phase tap model may also impact the voltage magnitude. + + :TransformerEnd: Phase tap changer associated with this transformer end. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "TransformerEnd": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class TapChanger:\n" + TapChanger.__doc__ + + def __init__(self, TransformerEnd = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.TransformerEnd = TransformerEnd + + def __str__(self): + str = "class=PhaseTapChanger\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PhaseTapChangerAsymmetrical.py b/cimpy/cgmes_v2_4_15/PhaseTapChangerAsymmetrical.py index e5feea68..6878dbb1 100644 --- a/cimpy/cgmes_v2_4_15/PhaseTapChangerAsymmetrical.py +++ b/cimpy/cgmes_v2_4_15/PhaseTapChangerAsymmetrical.py @@ -1,31 +1,33 @@ -from .PhaseTapChangerNonLinear import PhaseTapChangerNonLinear - - -class PhaseTapChangerAsymmetrical(PhaseTapChangerNonLinear): - ''' - Describes the tap model for an asymmetrical phase shifting transformer in which the difference voltage vector adds to the primary side voltage. The angle between the primary side voltage and the difference voltage is named the winding connection angle. The phase shift depends on both the difference voltage magnitude and the winding connection angle. - - :windingConnectionAngle: The phase angle between the in-phase winding and the out-of -phase winding used for creating phase shift. The out-of-phase winding produces what is known as the difference voltage. Setting this angle to 90 degrees is not the same as a symmemtrical transformer. Default: 0.0 - ''' - - cgmesProfile = PhaseTapChangerNonLinear.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'windingConnectionAngle': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PhaseTapChangerNonLinear: \n' + PhaseTapChangerNonLinear.__doc__ - - def __init__(self, windingConnectionAngle = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.windingConnectionAngle = windingConnectionAngle - - def __str__(self): - str = 'class=PhaseTapChangerAsymmetrical\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PhaseTapChangerNonLinear import PhaseTapChangerNonLinear +from .CGMESProfile import Profile + + +class PhaseTapChangerAsymmetrical(PhaseTapChangerNonLinear): + """ + Describes the tap model for an asymmetrical phase shifting transformer in which the difference voltage vector adds to the primary side voltage. The angle between the primary side voltage and the difference voltage is named the winding connection angle. The phase shift depends on both the difference voltage magnitude and the winding connection angle. + + :windingConnectionAngle: The phase angle between the in-phase winding and the out-of -phase winding used for creating phase shift. The out-of-phase winding produces what is known as the difference voltage. Setting this angle to 90 degrees is not the same as a symmemtrical transformer. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "windingConnectionAngle": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class PhaseTapChangerNonLinear:\n" + PhaseTapChangerNonLinear.__doc__ + + def __init__(self, windingConnectionAngle = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.windingConnectionAngle = windingConnectionAngle + + def __str__(self): + str = "class=PhaseTapChangerAsymmetrical\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PhaseTapChangerLinear.py b/cimpy/cgmes_v2_4_15/PhaseTapChangerLinear.py index 4d7257ae..dca3e0b5 100644 --- a/cimpy/cgmes_v2_4_15/PhaseTapChangerLinear.py +++ b/cimpy/cgmes_v2_4_15/PhaseTapChangerLinear.py @@ -1,37 +1,39 @@ -from .PhaseTapChanger import PhaseTapChanger - - -class PhaseTapChangerLinear(PhaseTapChanger): - ''' - Describes a tap changer with a linear relation between the tap step and the phase angle difference across the transformer. This is a mathematical model that is an approximation of a real phase tap changer. The phase angle is computed as stepPhaseShitfIncrement times the tap position. The secondary side voltage magnitude is the same as at the primary side. - - :stepPhaseShiftIncrement: Phase shift per step position. A positive value indicates a positive phase shift from the winding where the tap is located to the other winding (for a two-winding transformer). The actual phase shift increment might be more accurately computed from the symmetrical or asymmetrical models or a tap step table lookup if those are available. Default: 0.0 - :xMax: The reactance depend on the tap position according to a `u` shaped curve. The maximum reactance (xMax) appear at the low and high tap positions. Default: 0.0 - :xMin: The reactance depend on the tap position according to a `u` shaped curve. The minimum reactance (xMin) appear at the mid tap position. Default: 0.0 - ''' - - cgmesProfile = PhaseTapChanger.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'stepPhaseShiftIncrement': [cgmesProfile.EQ.value, ], - 'xMax': [cgmesProfile.EQ.value, ], - 'xMin': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PhaseTapChanger: \n' + PhaseTapChanger.__doc__ - - def __init__(self, stepPhaseShiftIncrement = 0.0, xMax = 0.0, xMin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.stepPhaseShiftIncrement = stepPhaseShiftIncrement - self.xMax = xMax - self.xMin = xMin - - def __str__(self): - str = 'class=PhaseTapChangerLinear\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PhaseTapChanger import PhaseTapChanger +from .CGMESProfile import Profile + + +class PhaseTapChangerLinear(PhaseTapChanger): + """ + Describes a tap changer with a linear relation between the tap step and the phase angle difference across the transformer. This is a mathematical model that is an approximation of a real phase tap changer. The phase angle is computed as stepPhaseShitfIncrement times the tap position. The secondary side voltage magnitude is the same as at the primary side. + + :stepPhaseShiftIncrement: Phase shift per step position. A positive value indicates a positive phase shift from the winding where the tap is located to the other winding (for a two-winding transformer). The actual phase shift increment might be more accurately computed from the symmetrical or asymmetrical models or a tap step table lookup if those are available. Default: 0.0 + :xMax: The reactance depend on the tap position according to a `u` shaped curve. The maximum reactance (xMax) appear at the low and high tap positions. Default: 0.0 + :xMin: The reactance depend on the tap position according to a `u` shaped curve. The minimum reactance (xMin) appear at the mid tap position. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "stepPhaseShiftIncrement": [Profile.EQ.value, ], + "xMax": [Profile.EQ.value, ], + "xMin": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class PhaseTapChanger:\n" + PhaseTapChanger.__doc__ + + def __init__(self, stepPhaseShiftIncrement = 0.0, xMax = 0.0, xMin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.stepPhaseShiftIncrement = stepPhaseShiftIncrement + self.xMax = xMax + self.xMin = xMin + + def __str__(self): + str = "class=PhaseTapChangerLinear\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PhaseTapChangerNonLinear.py b/cimpy/cgmes_v2_4_15/PhaseTapChangerNonLinear.py index 8d3c7f07..43c2674a 100644 --- a/cimpy/cgmes_v2_4_15/PhaseTapChangerNonLinear.py +++ b/cimpy/cgmes_v2_4_15/PhaseTapChangerNonLinear.py @@ -1,37 +1,39 @@ -from .PhaseTapChanger import PhaseTapChanger - - -class PhaseTapChangerNonLinear(PhaseTapChanger): - ''' - The non-linear phase tap changer describes the non-linear behavior of a phase tap changer. This is a base class for the symmetrical and asymmetrical phase tap changer models. The details of these models can be found in the IEC 61970-301 document. - - :voltageStepIncrement: The voltage step increment on the out of phase winding specified in percent of nominal voltage of the transformer end. Default: 0.0 - :xMax: The reactance depend on the tap position according to a `u` shaped curve. The maximum reactance (xMax) appear at the low and high tap positions. Default: 0.0 - :xMin: The reactance depend on the tap position according to a `u` shaped curve. The minimum reactance (xMin) appear at the mid tap position. Default: 0.0 - ''' - - cgmesProfile = PhaseTapChanger.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'voltageStepIncrement': [cgmesProfile.EQ.value, ], - 'xMax': [cgmesProfile.EQ.value, ], - 'xMin': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PhaseTapChanger: \n' + PhaseTapChanger.__doc__ - - def __init__(self, voltageStepIncrement = 0.0, xMax = 0.0, xMin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.voltageStepIncrement = voltageStepIncrement - self.xMax = xMax - self.xMin = xMin - - def __str__(self): - str = 'class=PhaseTapChangerNonLinear\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PhaseTapChanger import PhaseTapChanger +from .CGMESProfile import Profile + + +class PhaseTapChangerNonLinear(PhaseTapChanger): + """ + The non-linear phase tap changer describes the non-linear behavior of a phase tap changer. This is a base class for the symmetrical and asymmetrical phase tap changer models. The details of these models can be found in the IEC 61970-301 document. + + :voltageStepIncrement: The voltage step increment on the out of phase winding specified in percent of nominal voltage of the transformer end. Default: 0.0 + :xMax: The reactance depend on the tap position according to a `u` shaped curve. The maximum reactance (xMax) appear at the low and high tap positions. Default: 0.0 + :xMin: The reactance depend on the tap position according to a `u` shaped curve. The minimum reactance (xMin) appear at the mid tap position. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "voltageStepIncrement": [Profile.EQ.value, ], + "xMax": [Profile.EQ.value, ], + "xMin": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class PhaseTapChanger:\n" + PhaseTapChanger.__doc__ + + def __init__(self, voltageStepIncrement = 0.0, xMax = 0.0, xMin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.voltageStepIncrement = voltageStepIncrement + self.xMax = xMax + self.xMin = xMin + + def __str__(self): + str = "class=PhaseTapChangerNonLinear\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PhaseTapChangerSymmetrical.py b/cimpy/cgmes_v2_4_15/PhaseTapChangerSymmetrical.py index b052e879..de82d618 100644 --- a/cimpy/cgmes_v2_4_15/PhaseTapChangerSymmetrical.py +++ b/cimpy/cgmes_v2_4_15/PhaseTapChangerSymmetrical.py @@ -1,29 +1,31 @@ -from .PhaseTapChangerNonLinear import PhaseTapChangerNonLinear - - -class PhaseTapChangerSymmetrical(PhaseTapChangerNonLinear): - ''' - Describes a symmetrical phase shifting transformer tap model in which the secondary side voltage magnitude is the same as at the primary side. The difference voltage magnitude is the base in an equal-sided triangle where the sides corresponds to the primary and secondary voltages. The phase angle difference corresponds to the top angle and can be expressed as twice the arctangent of half the total difference voltage. - - ''' - - cgmesProfile = PhaseTapChangerNonLinear.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PhaseTapChangerNonLinear: \n' + PhaseTapChangerNonLinear.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=PhaseTapChangerSymmetrical\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PhaseTapChangerNonLinear import PhaseTapChangerNonLinear +from .CGMESProfile import Profile + + +class PhaseTapChangerSymmetrical(PhaseTapChangerNonLinear): + """ + Describes a symmetrical phase shifting transformer tap model in which the secondary side voltage magnitude is the same as at the primary side. The difference voltage magnitude is the base in an equal-sided triangle where the sides corresponds to the primary and secondary voltages. The phase angle difference corresponds to the top angle and can be expressed as twice the arctangent of half the total difference voltage. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class PhaseTapChangerNonLinear:\n" + PhaseTapChangerNonLinear.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=PhaseTapChangerSymmetrical\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PhaseTapChangerTable.py b/cimpy/cgmes_v2_4_15/PhaseTapChangerTable.py index a017461c..83bb3ee5 100644 --- a/cimpy/cgmes_v2_4_15/PhaseTapChangerTable.py +++ b/cimpy/cgmes_v2_4_15/PhaseTapChangerTable.py @@ -1,34 +1,36 @@ -from .IdentifiedObject import IdentifiedObject - - -class PhaseTapChangerTable(IdentifiedObject): - ''' - Describes a tabular curve for how the phase angle difference and impedance varies with the tap step. - - :PhaseTapChangerTablePoint: The points of this table. Default: "list" - :PhaseTapChangerTabular: The phase tap changers to which this phase tap table applies. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'PhaseTapChangerTablePoint': [cgmesProfile.EQ.value, ], - 'PhaseTapChangerTabular': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, PhaseTapChangerTablePoint = "list", PhaseTapChangerTabular = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.PhaseTapChangerTablePoint = PhaseTapChangerTablePoint - self.PhaseTapChangerTabular = PhaseTapChangerTabular - - def __str__(self): - str = 'class=PhaseTapChangerTable\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class PhaseTapChangerTable(IdentifiedObject): + """ + Describes a tabular curve for how the phase angle difference and impedance varies with the tap step. + + :PhaseTapChangerTablePoint: The points of this table. Default: "list" + :PhaseTapChangerTabular: The phase tap changers to which this phase tap table applies. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "PhaseTapChangerTablePoint": [Profile.EQ.value, ], + "PhaseTapChangerTabular": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, PhaseTapChangerTablePoint = "list", PhaseTapChangerTabular = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.PhaseTapChangerTablePoint = PhaseTapChangerTablePoint + self.PhaseTapChangerTabular = PhaseTapChangerTabular + + def __str__(self): + str = "class=PhaseTapChangerTable\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PhaseTapChangerTablePoint.py b/cimpy/cgmes_v2_4_15/PhaseTapChangerTablePoint.py index 0f6f618b..c98b7671 100644 --- a/cimpy/cgmes_v2_4_15/PhaseTapChangerTablePoint.py +++ b/cimpy/cgmes_v2_4_15/PhaseTapChangerTablePoint.py @@ -1,34 +1,36 @@ -from .TapChangerTablePoint import TapChangerTablePoint - - -class PhaseTapChangerTablePoint(TapChangerTablePoint): - ''' - Describes each tap step in the phase tap changer tabular curve. - - :PhaseTapChangerTable: The table of this point. Default: None - :angle: The angle difference in degrees. Default: 0.0 - ''' - - cgmesProfile = TapChangerTablePoint.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'PhaseTapChangerTable': [cgmesProfile.EQ.value, ], - 'angle': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TapChangerTablePoint: \n' + TapChangerTablePoint.__doc__ - - def __init__(self, PhaseTapChangerTable = None, angle = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.PhaseTapChangerTable = PhaseTapChangerTable - self.angle = angle - - def __str__(self): - str = 'class=PhaseTapChangerTablePoint\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TapChangerTablePoint import TapChangerTablePoint +from .CGMESProfile import Profile + + +class PhaseTapChangerTablePoint(TapChangerTablePoint): + """ + Describes each tap step in the phase tap changer tabular curve. + + :PhaseTapChangerTable: The table of this point. Default: None + :angle: The angle difference in degrees. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "PhaseTapChangerTable": [Profile.EQ.value, ], + "angle": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class TapChangerTablePoint:\n" + TapChangerTablePoint.__doc__ + + def __init__(self, PhaseTapChangerTable = None, angle = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.PhaseTapChangerTable = PhaseTapChangerTable + self.angle = angle + + def __str__(self): + str = "class=PhaseTapChangerTablePoint\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PhaseTapChangerTabular.py b/cimpy/cgmes_v2_4_15/PhaseTapChangerTabular.py index 6f51fa15..f70468cf 100644 --- a/cimpy/cgmes_v2_4_15/PhaseTapChangerTabular.py +++ b/cimpy/cgmes_v2_4_15/PhaseTapChangerTabular.py @@ -1,31 +1,33 @@ -from .PhaseTapChanger import PhaseTapChanger - - -class PhaseTapChangerTabular(PhaseTapChanger): - ''' - - - :PhaseTapChangerTable: The phase tap changer table for this phase tap changer. Default: None - ''' - - cgmesProfile = PhaseTapChanger.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'PhaseTapChangerTable': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PhaseTapChanger: \n' + PhaseTapChanger.__doc__ - - def __init__(self, PhaseTapChangerTable = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.PhaseTapChangerTable = PhaseTapChangerTable - - def __str__(self): - str = 'class=PhaseTapChangerTabular\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PhaseTapChanger import PhaseTapChanger +from .CGMESProfile import Profile + + +class PhaseTapChangerTabular(PhaseTapChanger): + """ + + + :PhaseTapChangerTable: The phase tap changer table for this phase tap changer. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "PhaseTapChangerTable": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class PhaseTapChanger:\n" + PhaseTapChanger.__doc__ + + def __init__(self, PhaseTapChangerTable = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.PhaseTapChangerTable = PhaseTapChangerTable + + def __str__(self): + str = "class=PhaseTapChangerTabular\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PositionPoint.py b/cimpy/cgmes_v2_4_15/PositionPoint.py index 3989740d..daab49ba 100644 --- a/cimpy/cgmes_v2_4_15/PositionPoint.py +++ b/cimpy/cgmes_v2_4_15/PositionPoint.py @@ -1,42 +1,43 @@ -from .Base import Base - - -class PositionPoint(Base): - ''' - Set of spatial coordinates that determine a point, defined in the coordinate system specified in 'Location.CoordinateSystem'. Use a single position point instance to desribe a point-oriented location. Use a sequence of position points to describe a line-oriented object (physical location of non-point oriented objects like cables or lines), or area of an object (like a substation or a geographical zone - in this case, have first and last position point with the same values). - - :Location: Location described by this position point. Default: None - :sequenceNumber: Zero-relative sequence number of this point within a series of points. Default: 0 - :xPosition: X axis position. Default: '' - :yPosition: Y axis position. Default: '' - :zPosition: (if applicable) Z axis position. Default: '' - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.GL.value, ], - 'Location': [cgmesProfile.GL.value, ], - 'sequenceNumber': [cgmesProfile.GL.value, ], - 'xPosition': [cgmesProfile.GL.value, ], - 'yPosition': [cgmesProfile.GL.value, ], - 'zPosition': [cgmesProfile.GL.value, ], - } - - serializationProfile = {} - - - - def __init__(self, Location = None, sequenceNumber = 0, xPosition = '', yPosition = '', zPosition = '', ): - - self.Location = Location - self.sequenceNumber = sequenceNumber - self.xPosition = xPosition - self.yPosition = yPosition - self.zPosition = zPosition - - def __str__(self): - str = 'class=PositionPoint\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class PositionPoint(Base): + """ + Set of spatial coordinates that determine a point, defined in the coordinate system specified in 'Location.CoordinateSystem'. Use a single position point instance to desribe a point-oriented location. Use a sequence of position points to describe a line-oriented object (physical location of non-point oriented objects like cables or lines), or area of an object (like a substation or a geographical zone - in this case, have first and last position point with the same values). + + :Location: Location described by this position point. Default: None + :sequenceNumber: Zero-relative sequence number of this point within a series of points. Default: 0 + :xPosition: X axis position. Default: '' + :yPosition: Y axis position. Default: '' + :zPosition: (if applicable) Z axis position. Default: '' + """ + + possibleProfileList = { + "class": [Profile.GL.value, ], + "Location": [Profile.GL.value, ], + "sequenceNumber": [Profile.GL.value, ], + "xPosition": [Profile.GL.value, ], + "yPosition": [Profile.GL.value, ], + "zPosition": [Profile.GL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.GL.value + + + def __init__(self, Location = None, sequenceNumber = 0, xPosition = '', yPosition = '', zPosition = ''): + + self.Location = Location + self.sequenceNumber = sequenceNumber + self.xPosition = xPosition + self.yPosition = yPosition + self.zPosition = zPosition + + def __str__(self): + str = "class=PositionPoint\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PowerSystemResource.py b/cimpy/cgmes_v2_4_15/PowerSystemResource.py index 6ac0ffe2..421cbc05 100644 --- a/cimpy/cgmes_v2_4_15/PowerSystemResource.py +++ b/cimpy/cgmes_v2_4_15/PowerSystemResource.py @@ -1,37 +1,39 @@ -from .IdentifiedObject import IdentifiedObject - - -class PowerSystemResource(IdentifiedObject): - ''' - A power system resource can be an item of equipment such as a switch, an equipment container containing many individual items of equipment such as a substation, or an organisational entity such as sub-control area. Power system resources can have measurements associated. - - :Controls: Regulating device governed by this control output. Default: "list" - :Measurements: The power system resource that contains the measurement. Default: "list" - :Location: Location of this power system resource. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.GL.value, cgmesProfile.DY.value, cgmesProfile.EQ_BD.value, ], - 'Controls': [cgmesProfile.EQ.value, ], - 'Measurements': [cgmesProfile.EQ.value, ], - 'Location': [cgmesProfile.GL.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, Controls = "list", Measurements = "list", Location = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Controls = Controls - self.Measurements = Measurements - self.Location = Location - - def __str__(self): - str = 'class=PowerSystemResource\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class PowerSystemResource(IdentifiedObject): + """ + A power system resource can be an item of equipment such as a switch, an equipment container containing many individual items of equipment such as a substation, or an organisational entity such as sub-control area. Power system resources can have measurements associated. + + :Controls: Regulating device governed by this control output. Default: "list" + :Location: Location of this power system resource. Default: None + :Measurements: The power system resource that contains the measurement. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.GL.value, Profile.SSH.value, ], + "Controls": [Profile.EQ.value, ], + "Location": [Profile.GL.value, ], + "Measurements": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, Controls = "list", Location = None, Measurements = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Controls = Controls + self.Location = Location + self.Measurements = Measurements + + def __str__(self): + str = "class=PowerSystemResource\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PowerSystemStabilizerDynamics.py b/cimpy/cgmes_v2_4_15/PowerSystemStabilizerDynamics.py index 570c4b8b..8db5a018 100644 --- a/cimpy/cgmes_v2_4_15/PowerSystemStabilizerDynamics.py +++ b/cimpy/cgmes_v2_4_15/PowerSystemStabilizerDynamics.py @@ -1,34 +1,36 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class PowerSystemStabilizerDynamics(DynamicsFunctionBlock): - ''' - Power system stabilizer function block whose behaviour is described by reference to a standard model - - :RemoteInputSignal: Remote input signal used by this power system stabilizer model. Default: "list" - :ExcitationSystemDynamics: Excitation system model with which this power system stabilizer model is associated. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'RemoteInputSignal': [cgmesProfile.DY.value, ], - 'ExcitationSystemDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, RemoteInputSignal = "list", ExcitationSystemDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.RemoteInputSignal = RemoteInputSignal - self.ExcitationSystemDynamics = ExcitationSystemDynamics - - def __str__(self): - str = 'class=PowerSystemStabilizerDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class PowerSystemStabilizerDynamics(DynamicsFunctionBlock): + """ + Power system stabilizer function block whose behaviour is described by reference to a standard model + + :ExcitationSystemDynamics: Excitation system model with which this power system stabilizer model is associated. Default: None + :RemoteInputSignal: Remote input signal used by this power system stabilizer model. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ExcitationSystemDynamics": [Profile.DY.value, ], + "RemoteInputSignal": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, ExcitationSystemDynamics = None, RemoteInputSignal = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ExcitationSystemDynamics = ExcitationSystemDynamics + self.RemoteInputSignal = RemoteInputSignal + + def __str__(self): + str = "class=PowerSystemStabilizerDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PowerSystemStabilizerUserDefined.py b/cimpy/cgmes_v2_4_15/PowerSystemStabilizerUserDefined.py index 5f68b8f7..427c29f2 100644 --- a/cimpy/cgmes_v2_4_15/PowerSystemStabilizerUserDefined.py +++ b/cimpy/cgmes_v2_4_15/PowerSystemStabilizerUserDefined.py @@ -1,34 +1,36 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class PowerSystemStabilizerUserDefined(PowerSystemStabilizerDynamics): - ''' - function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=PowerSystemStabilizerUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class PowerSystemStabilizerUserDefined(PowerSystemStabilizerDynamics): + """ + function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=PowerSystemStabilizerUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PowerTransformer.py b/cimpy/cgmes_v2_4_15/PowerTransformer.py index 731786f2..168cccd3 100644 --- a/cimpy/cgmes_v2_4_15/PowerTransformer.py +++ b/cimpy/cgmes_v2_4_15/PowerTransformer.py @@ -1,49 +1,51 @@ -from .ConductingEquipment import ConductingEquipment - - -class PowerTransformer(ConductingEquipment): - ''' - An electrical device consisting of two or more coupled windings, with or without a magnetic core, for introducing mutual coupling between electric circuits. Transformers can be used to control voltage and phase shift (active power flow). A power transformer may be composed of separate transformer tanks that need not be identical. A power transformer can be modeled with or without tanks and is intended for use in both balanced and unbalanced representations. A power transformer typically has two terminals, but may have one (grounding), three or more terminals. The inherited association ConductingEquipment.BaseVoltage should not be used. The association from TransformerEnd to BaseVoltage should be used instead. - - :PowerTransformerEnd: The power transformer of this power transformer end. Default: "list" - :beforeShCircuitHighestOperatingCurrent: The highest operating current (Ib in the IEC 60909-0) before short circuit (depends on network configuration and relevant reliability philosophy). It is used for calculation of the impedance correction factor KT defined in IEC 60909-0. Default: 0.0 - :beforeShCircuitHighestOperatingVoltage: The highest operating voltage (Ub in the IEC 60909-0) before short circuit. It is used for calculation of the impedance correction factor KT defined in IEC 60909-0. This is worst case voltage on the low side winding (Section 3.7.1 in the standard). Used to define operating conditions. Default: 0.0 - :beforeShortCircuitAnglePf: The angle of power factor before short circuit (phib in the IEC 60909-0). It is used for calculation of the impedance correction factor KT defined in IEC 60909-0. This is the worst case power factor. Used to define operating conditions. Default: 0.0 - :highSideMinOperatingU: The minimum operating voltage (uQmin in the IEC 60909-0) at the high voltage side (Q side) of the unit transformer of the power station unit. A value well established from long-term operating experience of the system. It is used for calculation of the impedance correction factor KG defined in IEC 60909-0 Default: 0.0 - :isPartOfGeneratorUnit: Indicates whether the machine is part of a power station unit. Used for short circuit data exchange according to IEC 60909 Default: False - :operationalValuesConsidered: It is used to define if the data (other attributes related to short circuit data exchange) defines long term operational conditions or not. Used for short circuit data exchange according to IEC 60909. Default: False - ''' - - cgmesProfile = ConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'PowerTransformerEnd': [cgmesProfile.EQ.value, ], - 'beforeShCircuitHighestOperatingCurrent': [cgmesProfile.EQ.value, ], - 'beforeShCircuitHighestOperatingVoltage': [cgmesProfile.EQ.value, ], - 'beforeShortCircuitAnglePf': [cgmesProfile.EQ.value, ], - 'highSideMinOperatingU': [cgmesProfile.EQ.value, ], - 'isPartOfGeneratorUnit': [cgmesProfile.EQ.value, ], - 'operationalValuesConsidered': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConductingEquipment: \n' + ConductingEquipment.__doc__ - - def __init__(self, PowerTransformerEnd = "list", beforeShCircuitHighestOperatingCurrent = 0.0, beforeShCircuitHighestOperatingVoltage = 0.0, beforeShortCircuitAnglePf = 0.0, highSideMinOperatingU = 0.0, isPartOfGeneratorUnit = False, operationalValuesConsidered = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.PowerTransformerEnd = PowerTransformerEnd - self.beforeShCircuitHighestOperatingCurrent = beforeShCircuitHighestOperatingCurrent - self.beforeShCircuitHighestOperatingVoltage = beforeShCircuitHighestOperatingVoltage - self.beforeShortCircuitAnglePf = beforeShortCircuitAnglePf - self.highSideMinOperatingU = highSideMinOperatingU - self.isPartOfGeneratorUnit = isPartOfGeneratorUnit - self.operationalValuesConsidered = operationalValuesConsidered - - def __str__(self): - str = 'class=PowerTransformer\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConductingEquipment import ConductingEquipment +from .CGMESProfile import Profile + + +class PowerTransformer(ConductingEquipment): + """ + An electrical device consisting of two or more coupled windings, with or without a magnetic core, for introducing mutual coupling between electric circuits. Transformers can be used to control voltage and phase shift (active power flow). A power transformer may be composed of separate transformer tanks that need not be identical. A power transformer can be modeled with or without tanks and is intended for use in both balanced and unbalanced representations. A power transformer typically has two terminals, but may have one (grounding), three or more terminals. The inherited association ConductingEquipment.BaseVoltage should not be used. The association from TransformerEnd to BaseVoltage should be used instead. + + :PowerTransformerEnd: The power transformer of this power transformer end. Default: "list" + :beforeShCircuitHighestOperatingCurrent: The highest operating current (Ib in the IEC 60909-0) before short circuit (depends on network configuration and relevant reliability philosophy). It is used for calculation of the impedance correction factor KT defined in IEC 60909-0. Default: 0.0 + :beforeShCircuitHighestOperatingVoltage: The highest operating voltage (Ub in the IEC 60909-0) before short circuit. It is used for calculation of the impedance correction factor KT defined in IEC 60909-0. This is worst case voltage on the low side winding (Section 3.7.1 in the standard). Used to define operating conditions. Default: 0.0 + :beforeShortCircuitAnglePf: The angle of power factor before short circuit (phib in the IEC 60909-0). It is used for calculation of the impedance correction factor KT defined in IEC 60909-0. This is the worst case power factor. Used to define operating conditions. Default: 0.0 + :highSideMinOperatingU: The minimum operating voltage (uQmin in the IEC 60909-0) at the high voltage side (Q side) of the unit transformer of the power station unit. A value well established from long-term operating experience of the system. It is used for calculation of the impedance correction factor KG defined in IEC 60909-0 Default: 0.0 + :isPartOfGeneratorUnit: Indicates whether the machine is part of a power station unit. Used for short circuit data exchange according to IEC 60909 Default: False + :operationalValuesConsidered: It is used to define if the data (other attributes related to short circuit data exchange) defines long term operational conditions or not. Used for short circuit data exchange according to IEC 60909. Default: False + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "PowerTransformerEnd": [Profile.EQ.value, ], + "beforeShCircuitHighestOperatingCurrent": [Profile.EQ.value, ], + "beforeShCircuitHighestOperatingVoltage": [Profile.EQ.value, ], + "beforeShortCircuitAnglePf": [Profile.EQ.value, ], + "highSideMinOperatingU": [Profile.EQ.value, ], + "isPartOfGeneratorUnit": [Profile.EQ.value, ], + "operationalValuesConsidered": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConductingEquipment:\n" + ConductingEquipment.__doc__ + + def __init__(self, PowerTransformerEnd = "list", beforeShCircuitHighestOperatingCurrent = 0.0, beforeShCircuitHighestOperatingVoltage = 0.0, beforeShortCircuitAnglePf = 0.0, highSideMinOperatingU = 0.0, isPartOfGeneratorUnit = False, operationalValuesConsidered = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.PowerTransformerEnd = PowerTransformerEnd + self.beforeShCircuitHighestOperatingCurrent = beforeShCircuitHighestOperatingCurrent + self.beforeShCircuitHighestOperatingVoltage = beforeShCircuitHighestOperatingVoltage + self.beforeShortCircuitAnglePf = beforeShortCircuitAnglePf + self.highSideMinOperatingU = highSideMinOperatingU + self.isPartOfGeneratorUnit = isPartOfGeneratorUnit + self.operationalValuesConsidered = operationalValuesConsidered + + def __str__(self): + str = "class=PowerTransformer\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PowerTransformerEnd.py b/cimpy/cgmes_v2_4_15/PowerTransformerEnd.py index 9e76847f..79c924ea 100644 --- a/cimpy/cgmes_v2_4_15/PowerTransformerEnd.py +++ b/cimpy/cgmes_v2_4_15/PowerTransformerEnd.py @@ -1,67 +1,69 @@ -from .TransformerEnd import TransformerEnd - - -class PowerTransformerEnd(TransformerEnd): - ''' - A PowerTransformerEnd is associated with each Terminal of a PowerTransformer. The impedance values r, r0, x, and x0 of a PowerTransformerEnd represents a star equivalent as follows 1) for a two Terminal PowerTransformer the high voltage PowerTransformerEnd has non zero values on r, r0, x, and x0 while the low voltage PowerTransformerEnd has zero values for r, r0, x, and x0. 2) for a three Terminal PowerTransformer the three PowerTransformerEnds represents a star equivalent with each leg in the star represented by r, r0, x, and x0 values. 3) for a PowerTransformer with more than three Terminals the PowerTransformerEnd impedance values cannot be used. Instead use the TransformerMeshImpedance or split the transformer into multiple PowerTransformers. - - :PowerTransformer: The ends of this power transformer. Default: None - :b: Magnetizing branch susceptance (B mag). The value can be positive or negative. Default: 0.0 - :connectionKind: Kind of connection. Default: None - :ratedS: Normal apparent power rating. The attribute shall be a positive value. For a two-winding transformer the values for the high and low voltage sides shall be identical. Default: 0.0 - :g: Magnetizing branch conductance. Default: 0.0 - :ratedU: Rated voltage: phase-phase for three-phase windings, and either phase-phase or phase-neutral for single-phase windings. A high voltage side, as given by TransformerEnd.endNumber, shall have a ratedU that is greater or equal than ratedU for the lower voltage sides. Default: 0.0 - :r: Resistance (star-model) of the transformer end. The attribute shall be equal or greater than zero for non-equivalent transformers. Default: 0.0 - :x: Positive sequence series reactance (star-model) of the transformer end. Default: 0.0 - :b0: Zero sequence magnetizing branch susceptance. Default: 0.0 - :phaseAngleClock: Terminal voltage phase angle displacement where 360 degrees are represented with clock hours. The valid values are 0 to 11. For example, for the secondary side end of a transformer with vector group code of `Dyn11`, specify the connection kind as wye with neutral and specify the phase angle of the clock as 11. The clock value of the transformer end number specified as 1, is assumed to be zero. Note the transformer end number is not assumed to be the same as the terminal sequence number. Default: 0 - :g0: Zero sequence magnetizing branch conductance (star-model). Default: 0.0 - :r0: Zero sequence series resistance (star-model) of the transformer end. Default: 0.0 - :x0: Zero sequence series reactance of the transformer end. Default: 0.0 - ''' - - cgmesProfile = TransformerEnd.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'PowerTransformer': [cgmesProfile.EQ.value, ], - 'b': [cgmesProfile.EQ.value, ], - 'connectionKind': [cgmesProfile.EQ.value, ], - 'ratedS': [cgmesProfile.EQ.value, ], - 'g': [cgmesProfile.EQ.value, ], - 'ratedU': [cgmesProfile.EQ.value, ], - 'r': [cgmesProfile.EQ.value, ], - 'x': [cgmesProfile.EQ.value, ], - 'b0': [cgmesProfile.EQ.value, ], - 'phaseAngleClock': [cgmesProfile.EQ.value, ], - 'g0': [cgmesProfile.EQ.value, ], - 'r0': [cgmesProfile.EQ.value, ], - 'x0': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TransformerEnd: \n' + TransformerEnd.__doc__ - - def __init__(self, PowerTransformer = None, b = 0.0, connectionKind = None, ratedS = 0.0, g = 0.0, ratedU = 0.0, r = 0.0, x = 0.0, b0 = 0.0, phaseAngleClock = 0, g0 = 0.0, r0 = 0.0, x0 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.PowerTransformer = PowerTransformer - self.b = b - self.connectionKind = connectionKind - self.ratedS = ratedS - self.g = g - self.ratedU = ratedU - self.r = r - self.x = x - self.b0 = b0 - self.phaseAngleClock = phaseAngleClock - self.g0 = g0 - self.r0 = r0 - self.x0 = x0 - - def __str__(self): - str = 'class=PowerTransformerEnd\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TransformerEnd import TransformerEnd +from .CGMESProfile import Profile + + +class PowerTransformerEnd(TransformerEnd): + """ + A PowerTransformerEnd is associated with each Terminal of a PowerTransformer. The impedance values r, r0, x, and x0 of a PowerTransformerEnd represents a star equivalent as follows 1) for a two Terminal PowerTransformer the high voltage PowerTransformerEnd has non zero values on r, r0, x, and x0 while the low voltage PowerTransformerEnd has zero values for r, r0, x, and x0. 2) for a three Terminal PowerTransformer the three PowerTransformerEnds represents a star equivalent with each leg in the star represented by r, r0, x, and x0 values. 3) for a PowerTransformer with more than three Terminals the PowerTransformerEnd impedance values cannot be used. Instead use the TransformerMeshImpedance or split the transformer into multiple PowerTransformers. + + :PowerTransformer: The ends of this power transformer. Default: None + :b: Magnetizing branch susceptance (B mag). The value can be positive or negative. Default: 0.0 + :b0: Zero sequence magnetizing branch susceptance. Default: 0.0 + :connectionKind: Kind of connection. Default: None + :g: Magnetizing branch conductance. Default: 0.0 + :g0: Zero sequence magnetizing branch conductance (star-model). Default: 0.0 + :phaseAngleClock: Terminal voltage phase angle displacement where 360 degrees are represented with clock hours. The valid values are 0 to 11. For example, for the secondary side end of a transformer with vector group code of `Dyn11`, specify the connection kind as wye with neutral and specify the phase angle of the clock as 11. The clock value of the transformer end number specified as 1, is assumed to be zero. Note the transformer end number is not assumed to be the same as the terminal sequence number. Default: 0 + :r: Resistance (star-model) of the transformer end. The attribute shall be equal or greater than zero for non-equivalent transformers. Default: 0.0 + :r0: Zero sequence series resistance (star-model) of the transformer end. Default: 0.0 + :ratedS: Normal apparent power rating. The attribute shall be a positive value. For a two-winding transformer the values for the high and low voltage sides shall be identical. Default: 0.0 + :ratedU: Rated voltage: phase-phase for three-phase windings, and either phase-phase or phase-neutral for single-phase windings. A high voltage side, as given by TransformerEnd.endNumber, shall have a ratedU that is greater or equal than ratedU for the lower voltage sides. Default: 0.0 + :x: Positive sequence series reactance (star-model) of the transformer end. Default: 0.0 + :x0: Zero sequence series reactance of the transformer end. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "PowerTransformer": [Profile.EQ.value, ], + "b": [Profile.EQ.value, ], + "b0": [Profile.EQ.value, ], + "connectionKind": [Profile.EQ.value, ], + "g": [Profile.EQ.value, ], + "g0": [Profile.EQ.value, ], + "phaseAngleClock": [Profile.EQ.value, ], + "r": [Profile.EQ.value, ], + "r0": [Profile.EQ.value, ], + "ratedS": [Profile.EQ.value, ], + "ratedU": [Profile.EQ.value, ], + "x": [Profile.EQ.value, ], + "x0": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class TransformerEnd:\n" + TransformerEnd.__doc__ + + def __init__(self, PowerTransformer = None, b = 0.0, b0 = 0.0, connectionKind = None, g = 0.0, g0 = 0.0, phaseAngleClock = 0, r = 0.0, r0 = 0.0, ratedS = 0.0, ratedU = 0.0, x = 0.0, x0 = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.PowerTransformer = PowerTransformer + self.b = b + self.b0 = b0 + self.connectionKind = connectionKind + self.g = g + self.g0 = g0 + self.phaseAngleClock = phaseAngleClock + self.r = r + self.r0 = r0 + self.ratedS = ratedS + self.ratedU = ratedU + self.x = x + self.x0 = x0 + + def __str__(self): + str = "class=PowerTransformerEnd\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ProprietaryParameterDynamics.py b/cimpy/cgmes_v2_4_15/ProprietaryParameterDynamics.py index ab441997..40a14b65 100644 --- a/cimpy/cgmes_v2_4_15/ProprietaryParameterDynamics.py +++ b/cimpy/cgmes_v2_4_15/ProprietaryParameterDynamics.py @@ -1,93 +1,94 @@ -from .Base import Base - - -class ProprietaryParameterDynamics(Base): - ''' - Supports definition of one or more parameters of several different datatypes for use by proprietary user-defined models. NOTE: This class does not inherit from IdentifiedObject since it is not intended that a single instance of it be referenced by more than one proprietary user-defined model instance. - - :WindPlantUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :WindType1or2UserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :WindType3or4UserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :SynchronousMachineUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :AsynchronousMachineUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :TurbineGovernorUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :TurbineLoadControllerUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :MechanicalLoadUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :ExcitationSystemUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :OverexcitationLimiterUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :UnderexcitationLimiterUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :PowerSystemStabilizerUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :DiscontinuousExcitationControlUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :PFVArControllerType1UserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :VoltageAdjusterUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :PFVArControllerType2UserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :VoltageCompensatorUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :LoadUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None - :parameterNumber: Sequence number of the parameter among the set of parameters associated with the related proprietary user-defined model. Default: 0 - :booleanParameterValue: Used for boolean parameter value. If this attribute is populated, integerParameterValue and floatParameterValue will not be. Default: False - :integerParameterValue: Used for integer parameter value. If this attribute is populated, booleanParameterValue and floatParameterValue will not be. Default: 0 - :floatParameterValue: Used for floating point parameter value. If this attribute is populated, booleanParameterValue and integerParameterValue will not be. Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindPlantUserDefined': [cgmesProfile.DY.value, ], - 'WindType1or2UserDefined': [cgmesProfile.DY.value, ], - 'WindType3or4UserDefined': [cgmesProfile.DY.value, ], - 'SynchronousMachineUserDefined': [cgmesProfile.DY.value, ], - 'AsynchronousMachineUserDefined': [cgmesProfile.DY.value, ], - 'TurbineGovernorUserDefined': [cgmesProfile.DY.value, ], - 'TurbineLoadControllerUserDefined': [cgmesProfile.DY.value, ], - 'MechanicalLoadUserDefined': [cgmesProfile.DY.value, ], - 'ExcitationSystemUserDefined': [cgmesProfile.DY.value, ], - 'OverexcitationLimiterUserDefined': [cgmesProfile.DY.value, ], - 'UnderexcitationLimiterUserDefined': [cgmesProfile.DY.value, ], - 'PowerSystemStabilizerUserDefined': [cgmesProfile.DY.value, ], - 'DiscontinuousExcitationControlUserDefined': [cgmesProfile.DY.value, ], - 'PFVArControllerType1UserDefined': [cgmesProfile.DY.value, ], - 'VoltageAdjusterUserDefined': [cgmesProfile.DY.value, ], - 'PFVArControllerType2UserDefined': [cgmesProfile.DY.value, ], - 'VoltageCompensatorUserDefined': [cgmesProfile.DY.value, ], - 'LoadUserDefined': [cgmesProfile.DY.value, ], - 'parameterNumber': [cgmesProfile.DY.value, ], - 'booleanParameterValue': [cgmesProfile.DY.value, ], - 'integerParameterValue': [cgmesProfile.DY.value, ], - 'floatParameterValue': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, WindPlantUserDefined = None, WindType1or2UserDefined = None, WindType3or4UserDefined = None, SynchronousMachineUserDefined = None, AsynchronousMachineUserDefined = None, TurbineGovernorUserDefined = None, TurbineLoadControllerUserDefined = None, MechanicalLoadUserDefined = None, ExcitationSystemUserDefined = None, OverexcitationLimiterUserDefined = None, UnderexcitationLimiterUserDefined = None, PowerSystemStabilizerUserDefined = None, DiscontinuousExcitationControlUserDefined = None, PFVArControllerType1UserDefined = None, VoltageAdjusterUserDefined = None, PFVArControllerType2UserDefined = None, VoltageCompensatorUserDefined = None, LoadUserDefined = None, parameterNumber = 0, booleanParameterValue = False, integerParameterValue = 0, floatParameterValue = 0.0, ): - - self.WindPlantUserDefined = WindPlantUserDefined - self.WindType1or2UserDefined = WindType1or2UserDefined - self.WindType3or4UserDefined = WindType3or4UserDefined - self.SynchronousMachineUserDefined = SynchronousMachineUserDefined - self.AsynchronousMachineUserDefined = AsynchronousMachineUserDefined - self.TurbineGovernorUserDefined = TurbineGovernorUserDefined - self.TurbineLoadControllerUserDefined = TurbineLoadControllerUserDefined - self.MechanicalLoadUserDefined = MechanicalLoadUserDefined - self.ExcitationSystemUserDefined = ExcitationSystemUserDefined - self.OverexcitationLimiterUserDefined = OverexcitationLimiterUserDefined - self.UnderexcitationLimiterUserDefined = UnderexcitationLimiterUserDefined - self.PowerSystemStabilizerUserDefined = PowerSystemStabilizerUserDefined - self.DiscontinuousExcitationControlUserDefined = DiscontinuousExcitationControlUserDefined - self.PFVArControllerType1UserDefined = PFVArControllerType1UserDefined - self.VoltageAdjusterUserDefined = VoltageAdjusterUserDefined - self.PFVArControllerType2UserDefined = PFVArControllerType2UserDefined - self.VoltageCompensatorUserDefined = VoltageCompensatorUserDefined - self.LoadUserDefined = LoadUserDefined - self.parameterNumber = parameterNumber - self.booleanParameterValue = booleanParameterValue - self.integerParameterValue = integerParameterValue - self.floatParameterValue = floatParameterValue - - def __str__(self): - str = 'class=ProprietaryParameterDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ProprietaryParameterDynamics(Base): + """ + Supports definition of one or more parameters of several different datatypes for use by proprietary user-defined models. NOTE: This class does not inherit from IdentifiedObject since it is not intended that a single instance of it be referenced by more than one proprietary user-defined model instance. + + :AsynchronousMachineUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :DiscontinuousExcitationControlUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :ExcitationSystemUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :LoadUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :MechanicalLoadUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :OverexcitationLimiterUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :PFVArControllerType1UserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :PFVArControllerType2UserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :PowerSystemStabilizerUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :SynchronousMachineUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :TurbineGovernorUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :TurbineLoadControllerUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :UnderexcitationLimiterUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :VoltageAdjusterUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :VoltageCompensatorUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :WindPlantUserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :WindType1or2UserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :WindType3or4UserDefined: Proprietary user-defined model with which this parameter is associated. Default: None + :booleanParameterValue: Used for boolean parameter value. If this attribute is populated, integerParameterValue and floatParameterValue will not be. Default: False + :floatParameterValue: Used for floating point parameter value. If this attribute is populated, booleanParameterValue and integerParameterValue will not be. Default: 0.0 + :integerParameterValue: Used for integer parameter value. If this attribute is populated, booleanParameterValue and floatParameterValue will not be. Default: 0 + :parameterNumber: Sequence number of the parameter among the set of parameters associated with the related proprietary user-defined model. Default: 0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "AsynchronousMachineUserDefined": [Profile.DY.value, ], + "DiscontinuousExcitationControlUserDefined": [Profile.DY.value, ], + "ExcitationSystemUserDefined": [Profile.DY.value, ], + "LoadUserDefined": [Profile.DY.value, ], + "MechanicalLoadUserDefined": [Profile.DY.value, ], + "OverexcitationLimiterUserDefined": [Profile.DY.value, ], + "PFVArControllerType1UserDefined": [Profile.DY.value, ], + "PFVArControllerType2UserDefined": [Profile.DY.value, ], + "PowerSystemStabilizerUserDefined": [Profile.DY.value, ], + "SynchronousMachineUserDefined": [Profile.DY.value, ], + "TurbineGovernorUserDefined": [Profile.DY.value, ], + "TurbineLoadControllerUserDefined": [Profile.DY.value, ], + "UnderexcitationLimiterUserDefined": [Profile.DY.value, ], + "VoltageAdjusterUserDefined": [Profile.DY.value, ], + "VoltageCompensatorUserDefined": [Profile.DY.value, ], + "WindPlantUserDefined": [Profile.DY.value, ], + "WindType1or2UserDefined": [Profile.DY.value, ], + "WindType3or4UserDefined": [Profile.DY.value, ], + "booleanParameterValue": [Profile.DY.value, ], + "floatParameterValue": [Profile.DY.value, ], + "integerParameterValue": [Profile.DY.value, ], + "parameterNumber": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self, AsynchronousMachineUserDefined = None, DiscontinuousExcitationControlUserDefined = None, ExcitationSystemUserDefined = None, LoadUserDefined = None, MechanicalLoadUserDefined = None, OverexcitationLimiterUserDefined = None, PFVArControllerType1UserDefined = None, PFVArControllerType2UserDefined = None, PowerSystemStabilizerUserDefined = None, SynchronousMachineUserDefined = None, TurbineGovernorUserDefined = None, TurbineLoadControllerUserDefined = None, UnderexcitationLimiterUserDefined = None, VoltageAdjusterUserDefined = None, VoltageCompensatorUserDefined = None, WindPlantUserDefined = None, WindType1or2UserDefined = None, WindType3or4UserDefined = None, booleanParameterValue = False, floatParameterValue = 0.0, integerParameterValue = 0, parameterNumber = 0): + + self.AsynchronousMachineUserDefined = AsynchronousMachineUserDefined + self.DiscontinuousExcitationControlUserDefined = DiscontinuousExcitationControlUserDefined + self.ExcitationSystemUserDefined = ExcitationSystemUserDefined + self.LoadUserDefined = LoadUserDefined + self.MechanicalLoadUserDefined = MechanicalLoadUserDefined + self.OverexcitationLimiterUserDefined = OverexcitationLimiterUserDefined + self.PFVArControllerType1UserDefined = PFVArControllerType1UserDefined + self.PFVArControllerType2UserDefined = PFVArControllerType2UserDefined + self.PowerSystemStabilizerUserDefined = PowerSystemStabilizerUserDefined + self.SynchronousMachineUserDefined = SynchronousMachineUserDefined + self.TurbineGovernorUserDefined = TurbineGovernorUserDefined + self.TurbineLoadControllerUserDefined = TurbineLoadControllerUserDefined + self.UnderexcitationLimiterUserDefined = UnderexcitationLimiterUserDefined + self.VoltageAdjusterUserDefined = VoltageAdjusterUserDefined + self.VoltageCompensatorUserDefined = VoltageCompensatorUserDefined + self.WindPlantUserDefined = WindPlantUserDefined + self.WindType1or2UserDefined = WindType1or2UserDefined + self.WindType3or4UserDefined = WindType3or4UserDefined + self.booleanParameterValue = booleanParameterValue + self.floatParameterValue = floatParameterValue + self.integerParameterValue = integerParameterValue + self.parameterNumber = parameterNumber + + def __str__(self): + str = "class=ProprietaryParameterDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ProtectedSwitch.py b/cimpy/cgmes_v2_4_15/ProtectedSwitch.py index dcf4373d..3c770e8e 100644 --- a/cimpy/cgmes_v2_4_15/ProtectedSwitch.py +++ b/cimpy/cgmes_v2_4_15/ProtectedSwitch.py @@ -1,29 +1,31 @@ -from .Switch import Switch - - -class ProtectedSwitch(Switch): - ''' - A ProtectedSwitch is a switching device that can be operated by ProtectionEquipment. - - ''' - - cgmesProfile = Switch.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Switch: \n' + Switch.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=ProtectedSwitch\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Switch import Switch +from .CGMESProfile import Profile + + +class ProtectedSwitch(Switch): + """ + A ProtectedSwitch is a switching device that can be operated by ProtectionEquipment. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Switch:\n" + Switch.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=ProtectedSwitch\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Pss1.py b/cimpy/cgmes_v2_4_15/Pss1.py index b28e5eac..16492394 100644 --- a/cimpy/cgmes_v2_4_15/Pss1.py +++ b/cimpy/cgmes_v2_4_15/Pss1.py @@ -1,73 +1,75 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class Pss1(PowerSystemStabilizerDynamics): - ''' - Italian PSS - three input PSS (speed, frequency, power). - - :kw: Shaft speed power input gain (K). Typical Value = 0. Default: 0.0 - :kf: Frequency power input gain (K). Typical Value = 5. Default: 0.0 - :kpe: Electric power input gain (K). Typical Value = 0.3. Default: 0.0 - :pmin: Minimum power PSS enabling (P). Typical Value = 0.25. Default: 0.0 - :ks: PSS gain (K). Typical Value = 1. Default: 0.0 - :vsmn: Stabilizer output max limit (V). Typical Value = -0.06. Default: 0.0 - :vsmx: Stabilizer output min limit (V). Typical Value = 0.06. Default: 0.0 - :tpe: Electric power filter time constant (T). Typical Value = 0.05. Default: 0 - :t5: Washout (T). Typical Value = 3.5. Default: 0 - :t6: Filter time constant (T). Typical Value = 0. Default: 0 - :t7: Lead/lag time constant (T). Typical Value = 0. Default: 0 - :t8: Lead/lag time constant (T). Typical Value = 0. Default: 0 - :t9: Lead/lag time constant (T). Typical Value = 0. Default: 0 - :t10: Lead/lag time constant (T). Typical Value = 0. Default: 0 - :vadat: Default: False - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kw': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'kpe': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'vsmn': [cgmesProfile.DY.value, ], - 'vsmx': [cgmesProfile.DY.value, ], - 'tpe': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 't7': [cgmesProfile.DY.value, ], - 't8': [cgmesProfile.DY.value, ], - 't9': [cgmesProfile.DY.value, ], - 't10': [cgmesProfile.DY.value, ], - 'vadat': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, kw = 0.0, kf = 0.0, kpe = 0.0, pmin = 0.0, ks = 0.0, vsmn = 0.0, vsmx = 0.0, tpe = 0, t5 = 0, t6 = 0, t7 = 0, t8 = 0, t9 = 0, t10 = 0, vadat = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kw = kw - self.kf = kf - self.kpe = kpe - self.pmin = pmin - self.ks = ks - self.vsmn = vsmn - self.vsmx = vsmx - self.tpe = tpe - self.t5 = t5 - self.t6 = t6 - self.t7 = t7 - self.t8 = t8 - self.t9 = t9 - self.t10 = t10 - self.vadat = vadat - - def __str__(self): - str = 'class=Pss1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class Pss1(PowerSystemStabilizerDynamics): + """ + Italian PSS - three input PSS (speed, frequency, power). + + :kf: Frequency power input gain (K). Typical Value = 5. Default: 0.0 + :kpe: Electric power input gain (K). Typical Value = 0.3. Default: 0.0 + :ks: PSS gain (K). Typical Value = 1. Default: 0.0 + :kw: Shaft speed power input gain (K). Typical Value = 0. Default: 0.0 + :pmin: Minimum power PSS enabling (P). Typical Value = 0.25. Default: 0.0 + :t10: Lead/lag time constant (T). Typical Value = 0. Default: 0.0 + :t5: Washout (T). Typical Value = 3.5. Default: 0.0 + :t6: Filter time constant (T). Typical Value = 0. Default: 0.0 + :t7: Lead/lag time constant (T). Typical Value = 0. Default: 0.0 + :t8: Lead/lag time constant (T). Typical Value = 0. Default: 0.0 + :t9: Lead/lag time constant (T). Typical Value = 0. Default: 0.0 + :tpe: Electric power filter time constant (T). Typical Value = 0.05. Default: 0.0 + :vadat: Default: False + :vsmn: Stabilizer output max limit (V). Typical Value = -0.06. Default: 0.0 + :vsmx: Stabilizer output min limit (V). Typical Value = 0.06. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "kpe": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "kw": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "t10": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "t7": [Profile.DY.value, ], + "t8": [Profile.DY.value, ], + "t9": [Profile.DY.value, ], + "tpe": [Profile.DY.value, ], + "vadat": [Profile.DY.value, ], + "vsmn": [Profile.DY.value, ], + "vsmx": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, kf = 0.0, kpe = 0.0, ks = 0.0, kw = 0.0, pmin = 0.0, t10 = 0.0, t5 = 0.0, t6 = 0.0, t7 = 0.0, t8 = 0.0, t9 = 0.0, tpe = 0.0, vadat = False, vsmn = 0.0, vsmx = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.kf = kf + self.kpe = kpe + self.ks = ks + self.kw = kw + self.pmin = pmin + self.t10 = t10 + self.t5 = t5 + self.t6 = t6 + self.t7 = t7 + self.t8 = t8 + self.t9 = t9 + self.tpe = tpe + self.vadat = vadat + self.vsmn = vsmn + self.vsmx = vsmx + + def __str__(self): + str = "class=Pss1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Pss1A.py b/cimpy/cgmes_v2_4_15/Pss1A.py index bbe6a878..1b468240 100644 --- a/cimpy/cgmes_v2_4_15/Pss1A.py +++ b/cimpy/cgmes_v2_4_15/Pss1A.py @@ -1,94 +1,96 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class Pss1A(PowerSystemStabilizerDynamics): - ''' - Single input power system stabilizer. It is a modified version in order to allow representation of various vendors' implementations on PSS type 1A. - - :inputSignalType: Type of input signal. Default: None - :a1: Notch filter parameter (A1). Default: 0.0 - :a2: Notch filter parameter (A2). Default: 0.0 - :t1: Lead/lag time constant (T1). Default: 0 - :t2: Lead/lag time constant (T2). Default: 0 - :t3: Lead/lag time constant (T3). Default: 0 - :t4: Lead/lag time constant (T4). Default: 0 - :t5: Washout time constant (T5). Default: 0 - :t6: Transducer time constant (T6). Default: 0 - :ks: Stabilizer gain (Ks). Default: 0.0 - :vrmax: Maximum stabilizer output (Vrmax). Default: 0.0 - :vrmin: Minimum stabilizer output (Vrmin). Default: 0.0 - :vcu: Stabilizer input cutoff threshold (Vcu). Default: 0.0 - :vcl: Stabilizer input cutoff threshold (Vcl). Default: 0.0 - :a3: Notch filter parameter (A3). Default: 0.0 - :a4: Notch filter parameter (A4). Default: 0.0 - :a5: Notch filter parameter (A5). Default: 0.0 - :a6: Notch filter parameter (A6). Default: 0.0 - :a7: Notch filter parameter (A7). Default: 0.0 - :a8: Notch filter parameter (A8). Default: 0.0 - :kd: Selector (Kd). true = e used false = e not used. Default: False - :tdelay: Time constant (Tdelay). Default: 0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'inputSignalType': [cgmesProfile.DY.value, ], - 'a1': [cgmesProfile.DY.value, ], - 'a2': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - 'vcu': [cgmesProfile.DY.value, ], - 'vcl': [cgmesProfile.DY.value, ], - 'a3': [cgmesProfile.DY.value, ], - 'a4': [cgmesProfile.DY.value, ], - 'a5': [cgmesProfile.DY.value, ], - 'a6': [cgmesProfile.DY.value, ], - 'a7': [cgmesProfile.DY.value, ], - 'a8': [cgmesProfile.DY.value, ], - 'kd': [cgmesProfile.DY.value, ], - 'tdelay': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, inputSignalType = None, a1 = 0.0, a2 = 0.0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, t5 = 0, t6 = 0, ks = 0.0, vrmax = 0.0, vrmin = 0.0, vcu = 0.0, vcl = 0.0, a3 = 0.0, a4 = 0.0, a5 = 0.0, a6 = 0.0, a7 = 0.0, a8 = 0.0, kd = False, tdelay = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.inputSignalType = inputSignalType - self.a1 = a1 - self.a2 = a2 - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.t5 = t5 - self.t6 = t6 - self.ks = ks - self.vrmax = vrmax - self.vrmin = vrmin - self.vcu = vcu - self.vcl = vcl - self.a3 = a3 - self.a4 = a4 - self.a5 = a5 - self.a6 = a6 - self.a7 = a7 - self.a8 = a8 - self.kd = kd - self.tdelay = tdelay - - def __str__(self): - str = 'class=Pss1A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class Pss1A(PowerSystemStabilizerDynamics): + """ + Single input power system stabilizer. It is a modified version in order to allow representation of various vendors' implementations on PSS type 1A. + + :a1: Notch filter parameter (A1). Default: 0.0 + :a2: Notch filter parameter (A2). Default: 0.0 + :a3: Notch filter parameter (A3). Default: 0.0 + :a4: Notch filter parameter (A4). Default: 0.0 + :a5: Notch filter parameter (A5). Default: 0.0 + :a6: Notch filter parameter (A6). Default: 0.0 + :a7: Notch filter parameter (A7). Default: 0.0 + :a8: Notch filter parameter (A8). Default: 0.0 + :inputSignalType: Type of input signal. Default: None + :kd: Selector (Kd). true = e used false = e not used. Default: False + :ks: Stabilizer gain (Ks). Default: 0.0 + :t1: Lead/lag time constant (T1). Default: 0.0 + :t2: Lead/lag time constant (T2). Default: 0.0 + :t3: Lead/lag time constant (T3). Default: 0.0 + :t4: Lead/lag time constant (T4). Default: 0.0 + :t5: Washout time constant (T5). Default: 0.0 + :t6: Transducer time constant (T6). Default: 0.0 + :tdelay: Time constant (Tdelay). Default: 0.0 + :vcl: Stabilizer input cutoff threshold (Vcl). Default: 0.0 + :vcu: Stabilizer input cutoff threshold (Vcu). Default: 0.0 + :vrmax: Maximum stabilizer output (Vrmax). Default: 0.0 + :vrmin: Minimum stabilizer output (Vrmin). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "a1": [Profile.DY.value, ], + "a2": [Profile.DY.value, ], + "a3": [Profile.DY.value, ], + "a4": [Profile.DY.value, ], + "a5": [Profile.DY.value, ], + "a6": [Profile.DY.value, ], + "a7": [Profile.DY.value, ], + "a8": [Profile.DY.value, ], + "inputSignalType": [Profile.DY.value, ], + "kd": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "tdelay": [Profile.DY.value, ], + "vcl": [Profile.DY.value, ], + "vcu": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, a1 = 0.0, a2 = 0.0, a3 = 0.0, a4 = 0.0, a5 = 0.0, a6 = 0.0, a7 = 0.0, a8 = 0.0, inputSignalType = None, kd = False, ks = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, t6 = 0.0, tdelay = 0.0, vcl = 0.0, vcu = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.a1 = a1 + self.a2 = a2 + self.a3 = a3 + self.a4 = a4 + self.a5 = a5 + self.a6 = a6 + self.a7 = a7 + self.a8 = a8 + self.inputSignalType = inputSignalType + self.kd = kd + self.ks = ks + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.t6 = t6 + self.tdelay = tdelay + self.vcl = vcl + self.vcu = vcu + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=Pss1A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Pss2B.py b/cimpy/cgmes_v2_4_15/Pss2B.py index 8930959d..8843cd45 100644 --- a/cimpy/cgmes_v2_4_15/Pss2B.py +++ b/cimpy/cgmes_v2_4_15/Pss2B.py @@ -1,121 +1,123 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class Pss2B(PowerSystemStabilizerDynamics): - ''' - Modified IEEE PSS2B Model. Extra lead/lag (or rate) block added at end (up to 4 lead/lags total). - - :inputSignal1Type: Type of input signal #1. Typical Value = rotorSpeed. Default: None - :inputSignal2Type: Type of input signal #2. Typical Value = generatorElectricalPower. Default: None - :vsi1max: Input signal #1 max limit (Vsi1max). Typical Value = 2. Default: 0.0 - :vsi1min: Input signal #1 min limit (Vsi1min). Typical Value = -2. Default: 0.0 - :tw1: First washout on signal #1 (Tw1). Typical Value = 2. Default: 0 - :tw2: Second washout on signal #1 (Tw2). Typical Value = 2. Default: 0 - :vsi2max: Input signal #2 max limit (Vsi2max). Typical Value = 2. Default: 0.0 - :vsi2min: Input signal #2 min limit (Vsi2min). Typical Value = -2. Default: 0.0 - :tw3: First washout on signal #2 (Tw3). Typical Value = 2. Default: 0 - :tw4: Second washout on signal #2 (Tw4). Typical Value = 0. Default: 0 - :t1: Lead/lag time constant (T1). Typical Value = 0.12. Default: 0 - :t2: Lead/lag time constant (T2). Typical Value = 0.02. Default: 0 - :t3: Lead/lag time constant (T3). Typical Value = 0.3. Default: 0 - :t4: Lead/lag time constant (T4). Typical Value = 0.02. Default: 0 - :t6: Time constant on signal #1 (T6). Typical Value = 0. Default: 0 - :t7: Time constant on signal #2 (T7). Typical Value = 2. Default: 0 - :t8: Lead of ramp tracking filter (T8). Typical Value = 0.2. Default: 0 - :t9: Lag of ramp tracking filter (T9). Typical Value = 0.1. Default: 0 - :t10: Lead/lag time constant (T10). Typical Value = 0. Default: 0 - :t11: Lead/lag time constant (T11). Typical Value = 0. Default: 0 - :ks1: Stabilizer gain (Ks1). Typical Value = 12. Default: 0.0 - :ks2: Gain on signal #2 (Ks2). Typical Value = 0.2. Default: 0.0 - :ks3: Gain on signal #2 input before ramp-tracking filter (Ks3). Typical Value = 1. Default: 0.0 - :ks4: Gain on signal #2 input after ramp-tracking filter (Ks4). Typical Value = 1. Default: 0.0 - :n: Order of ramp tracking filter (N). Typical Value = 1. Default: 0 - :m: Denominator order of ramp tracking filter (M). Typical Value = 5. Default: 0 - :vstmax: Stabilizer output max limit (Vstmax). Typical Value = 0.1. Default: 0.0 - :vstmin: Stabilizer output min limit (Vstmin). Typical Value = -0.1. Default: 0.0 - :a: Numerator constant (a). Typical Value = 1. Default: 0.0 - :ta: Lead constant (Ta). Typical Value = 0. Default: 0 - :tb: Lag time constant (Tb). Typical Value = 0. Default: 0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'inputSignal1Type': [cgmesProfile.DY.value, ], - 'inputSignal2Type': [cgmesProfile.DY.value, ], - 'vsi1max': [cgmesProfile.DY.value, ], - 'vsi1min': [cgmesProfile.DY.value, ], - 'tw1': [cgmesProfile.DY.value, ], - 'tw2': [cgmesProfile.DY.value, ], - 'vsi2max': [cgmesProfile.DY.value, ], - 'vsi2min': [cgmesProfile.DY.value, ], - 'tw3': [cgmesProfile.DY.value, ], - 'tw4': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 't7': [cgmesProfile.DY.value, ], - 't8': [cgmesProfile.DY.value, ], - 't9': [cgmesProfile.DY.value, ], - 't10': [cgmesProfile.DY.value, ], - 't11': [cgmesProfile.DY.value, ], - 'ks1': [cgmesProfile.DY.value, ], - 'ks2': [cgmesProfile.DY.value, ], - 'ks3': [cgmesProfile.DY.value, ], - 'ks4': [cgmesProfile.DY.value, ], - 'n': [cgmesProfile.DY.value, ], - 'm': [cgmesProfile.DY.value, ], - 'vstmax': [cgmesProfile.DY.value, ], - 'vstmin': [cgmesProfile.DY.value, ], - 'a': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, inputSignal1Type = None, inputSignal2Type = None, vsi1max = 0.0, vsi1min = 0.0, tw1 = 0, tw2 = 0, vsi2max = 0.0, vsi2min = 0.0, tw3 = 0, tw4 = 0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, t6 = 0, t7 = 0, t8 = 0, t9 = 0, t10 = 0, t11 = 0, ks1 = 0.0, ks2 = 0.0, ks3 = 0.0, ks4 = 0.0, n = 0, m = 0, vstmax = 0.0, vstmin = 0.0, a = 0.0, ta = 0, tb = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.inputSignal1Type = inputSignal1Type - self.inputSignal2Type = inputSignal2Type - self.vsi1max = vsi1max - self.vsi1min = vsi1min - self.tw1 = tw1 - self.tw2 = tw2 - self.vsi2max = vsi2max - self.vsi2min = vsi2min - self.tw3 = tw3 - self.tw4 = tw4 - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.t6 = t6 - self.t7 = t7 - self.t8 = t8 - self.t9 = t9 - self.t10 = t10 - self.t11 = t11 - self.ks1 = ks1 - self.ks2 = ks2 - self.ks3 = ks3 - self.ks4 = ks4 - self.n = n - self.m = m - self.vstmax = vstmax - self.vstmin = vstmin - self.a = a - self.ta = ta - self.tb = tb - - def __str__(self): - str = 'class=Pss2B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class Pss2B(PowerSystemStabilizerDynamics): + """ + Modified IEEE PSS2B Model. Extra lead/lag (or rate) block added at end (up to 4 lead/lags total). + + :a: Numerator constant (a). Typical Value = 1. Default: 0.0 + :inputSignal1Type: Type of input signal #1. Typical Value = rotorSpeed. Default: None + :inputSignal2Type: Type of input signal #2. Typical Value = generatorElectricalPower. Default: None + :ks1: Stabilizer gain (Ks1). Typical Value = 12. Default: 0.0 + :ks2: Gain on signal #2 (Ks2). Typical Value = 0.2. Default: 0.0 + :ks3: Gain on signal #2 input before ramp-tracking filter (Ks3). Typical Value = 1. Default: 0.0 + :ks4: Gain on signal #2 input after ramp-tracking filter (Ks4). Typical Value = 1. Default: 0.0 + :m: Denominator order of ramp tracking filter (M). Typical Value = 5. Default: 0 + :n: Order of ramp tracking filter (N). Typical Value = 1. Default: 0 + :t1: Lead/lag time constant (T1). Typical Value = 0.12. Default: 0.0 + :t10: Lead/lag time constant (T10). Typical Value = 0. Default: 0.0 + :t11: Lead/lag time constant (T11). Typical Value = 0. Default: 0.0 + :t2: Lead/lag time constant (T2). Typical Value = 0.02. Default: 0.0 + :t3: Lead/lag time constant (T3). Typical Value = 0.3. Default: 0.0 + :t4: Lead/lag time constant (T4). Typical Value = 0.02. Default: 0.0 + :t6: Time constant on signal #1 (T6). Typical Value = 0. Default: 0.0 + :t7: Time constant on signal #2 (T7). Typical Value = 2. Default: 0.0 + :t8: Lead of ramp tracking filter (T8). Typical Value = 0.2. Default: 0.0 + :t9: Lag of ramp tracking filter (T9). Typical Value = 0.1. Default: 0.0 + :ta: Lead constant (Ta). Typical Value = 0. Default: 0.0 + :tb: Lag time constant (Tb). Typical Value = 0. Default: 0.0 + :tw1: First washout on signal #1 (Tw1). Typical Value = 2. Default: 0.0 + :tw2: Second washout on signal #1 (Tw2). Typical Value = 2. Default: 0.0 + :tw3: First washout on signal #2 (Tw3). Typical Value = 2. Default: 0.0 + :tw4: Second washout on signal #2 (Tw4). Typical Value = 0. Default: 0.0 + :vsi1max: Input signal #1 max limit (Vsi1max). Typical Value = 2. Default: 0.0 + :vsi1min: Input signal #1 min limit (Vsi1min). Typical Value = -2. Default: 0.0 + :vsi2max: Input signal #2 max limit (Vsi2max). Typical Value = 2. Default: 0.0 + :vsi2min: Input signal #2 min limit (Vsi2min). Typical Value = -2. Default: 0.0 + :vstmax: Stabilizer output max limit (Vstmax). Typical Value = 0.1. Default: 0.0 + :vstmin: Stabilizer output min limit (Vstmin). Typical Value = -0.1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "a": [Profile.DY.value, ], + "inputSignal1Type": [Profile.DY.value, ], + "inputSignal2Type": [Profile.DY.value, ], + "ks1": [Profile.DY.value, ], + "ks2": [Profile.DY.value, ], + "ks3": [Profile.DY.value, ], + "ks4": [Profile.DY.value, ], + "m": [Profile.DY.value, ], + "n": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t10": [Profile.DY.value, ], + "t11": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "t7": [Profile.DY.value, ], + "t8": [Profile.DY.value, ], + "t9": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tw1": [Profile.DY.value, ], + "tw2": [Profile.DY.value, ], + "tw3": [Profile.DY.value, ], + "tw4": [Profile.DY.value, ], + "vsi1max": [Profile.DY.value, ], + "vsi1min": [Profile.DY.value, ], + "vsi2max": [Profile.DY.value, ], + "vsi2min": [Profile.DY.value, ], + "vstmax": [Profile.DY.value, ], + "vstmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, a = 0.0, inputSignal1Type = None, inputSignal2Type = None, ks1 = 0.0, ks2 = 0.0, ks3 = 0.0, ks4 = 0.0, m = 0, n = 0, t1 = 0.0, t10 = 0.0, t11 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t6 = 0.0, t7 = 0.0, t8 = 0.0, t9 = 0.0, ta = 0.0, tb = 0.0, tw1 = 0.0, tw2 = 0.0, tw3 = 0.0, tw4 = 0.0, vsi1max = 0.0, vsi1min = 0.0, vsi2max = 0.0, vsi2min = 0.0, vstmax = 0.0, vstmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.a = a + self.inputSignal1Type = inputSignal1Type + self.inputSignal2Type = inputSignal2Type + self.ks1 = ks1 + self.ks2 = ks2 + self.ks3 = ks3 + self.ks4 = ks4 + self.m = m + self.n = n + self.t1 = t1 + self.t10 = t10 + self.t11 = t11 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t6 = t6 + self.t7 = t7 + self.t8 = t8 + self.t9 = t9 + self.ta = ta + self.tb = tb + self.tw1 = tw1 + self.tw2 = tw2 + self.tw3 = tw3 + self.tw4 = tw4 + self.vsi1max = vsi1max + self.vsi1min = vsi1min + self.vsi2max = vsi2max + self.vsi2min = vsi2min + self.vstmax = vstmax + self.vstmin = vstmin + + def __str__(self): + str = "class=Pss2B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Pss2ST.py b/cimpy/cgmes_v2_4_15/Pss2ST.py index 7f70da5c..cc5d6705 100644 --- a/cimpy/cgmes_v2_4_15/Pss2ST.py +++ b/cimpy/cgmes_v2_4_15/Pss2ST.py @@ -1,82 +1,84 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class Pss2ST(PowerSystemStabilizerDynamics): - ''' - PTI Microprocessor-Based Stabilizer type 1. - - :inputSignal1Type: Type of input signal #1. Typical Value = rotorAngularFrequencyDeviation. Default: None - :inputSignal2Type: Type of input signal #2. Typical Value = generatorElectricalPower. Default: None - :k1: Gain (K1). Default: 0.0 - :k2: Gain (K2). Default: 0.0 - :t1: Time constant (T1). Default: 0 - :t2: Time constant (T2). Default: 0 - :t3: Time constant (T3). Default: 0 - :t4: Time constant (T4). Default: 0 - :t5: Time constant (T5). Default: 0 - :t6: Time constant (T6). Default: 0 - :t7: Time constant (T7). Default: 0 - :t8: Time constant (T8). Default: 0 - :t9: Time constant (T9). Default: 0 - :t10: Time constant (T10). Default: 0 - :lsmax: Limiter (Lsmax). Default: 0.0 - :lsmin: Limiter (Lsmin). Default: 0.0 - :vcu: Cutoff limiter (Vcu). Default: 0.0 - :vcl: Cutoff limiter (Vcl). Default: 0.0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'inputSignal1Type': [cgmesProfile.DY.value, ], - 'inputSignal2Type': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 't7': [cgmesProfile.DY.value, ], - 't8': [cgmesProfile.DY.value, ], - 't9': [cgmesProfile.DY.value, ], - 't10': [cgmesProfile.DY.value, ], - 'lsmax': [cgmesProfile.DY.value, ], - 'lsmin': [cgmesProfile.DY.value, ], - 'vcu': [cgmesProfile.DY.value, ], - 'vcl': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, inputSignal1Type = None, inputSignal2Type = None, k1 = 0.0, k2 = 0.0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, t5 = 0, t6 = 0, t7 = 0, t8 = 0, t9 = 0, t10 = 0, lsmax = 0.0, lsmin = 0.0, vcu = 0.0, vcl = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.inputSignal1Type = inputSignal1Type - self.inputSignal2Type = inputSignal2Type - self.k1 = k1 - self.k2 = k2 - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.t5 = t5 - self.t6 = t6 - self.t7 = t7 - self.t8 = t8 - self.t9 = t9 - self.t10 = t10 - self.lsmax = lsmax - self.lsmin = lsmin - self.vcu = vcu - self.vcl = vcl - - def __str__(self): - str = 'class=Pss2ST\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class Pss2ST(PowerSystemStabilizerDynamics): + """ + PTI Microprocessor-Based Stabilizer type 1. + + :inputSignal1Type: Type of input signal #1. Typical Value = rotorAngularFrequencyDeviation. Default: None + :inputSignal2Type: Type of input signal #2. Typical Value = generatorElectricalPower. Default: None + :k1: Gain (K1). Default: 0.0 + :k2: Gain (K2). Default: 0.0 + :lsmax: Limiter (Lsmax). Default: 0.0 + :lsmin: Limiter (Lsmin). Default: 0.0 + :t1: Time constant (T1). Default: 0.0 + :t10: Time constant (T10). Default: 0.0 + :t2: Time constant (T2). Default: 0.0 + :t3: Time constant (T3). Default: 0.0 + :t4: Time constant (T4). Default: 0.0 + :t5: Time constant (T5). Default: 0.0 + :t6: Time constant (T6). Default: 0.0 + :t7: Time constant (T7). Default: 0.0 + :t8: Time constant (T8). Default: 0.0 + :t9: Time constant (T9). Default: 0.0 + :vcl: Cutoff limiter (Vcl). Default: 0.0 + :vcu: Cutoff limiter (Vcu). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "inputSignal1Type": [Profile.DY.value, ], + "inputSignal2Type": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "lsmax": [Profile.DY.value, ], + "lsmin": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t10": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "t7": [Profile.DY.value, ], + "t8": [Profile.DY.value, ], + "t9": [Profile.DY.value, ], + "vcl": [Profile.DY.value, ], + "vcu": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, inputSignal1Type = None, inputSignal2Type = None, k1 = 0.0, k2 = 0.0, lsmax = 0.0, lsmin = 0.0, t1 = 0.0, t10 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, t6 = 0.0, t7 = 0.0, t8 = 0.0, t9 = 0.0, vcl = 0.0, vcu = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.inputSignal1Type = inputSignal1Type + self.inputSignal2Type = inputSignal2Type + self.k1 = k1 + self.k2 = k2 + self.lsmax = lsmax + self.lsmin = lsmin + self.t1 = t1 + self.t10 = t10 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.t6 = t6 + self.t7 = t7 + self.t8 = t8 + self.t9 = t9 + self.vcl = vcl + self.vcu = vcu + + def __str__(self): + str = "class=Pss2ST\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Pss5.py b/cimpy/cgmes_v2_4_15/Pss5.py index a73c6939..43ad5617 100644 --- a/cimpy/cgmes_v2_4_15/Pss5.py +++ b/cimpy/cgmes_v2_4_15/Pss5.py @@ -1,79 +1,81 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class Pss5(PowerSystemStabilizerDynamics): - ''' - Italian PSS - Detailed PSS. - - :kpe: Electric power input gain (K). Typical Value = 0.3. Default: 0.0 - :kf: Frequency/shaft speed input gain (K). Typical Value = 5. Default: 0.0 - :isfreq: Selector for Frequency/shaft speed input (IsFreq). true = speed false = frequency. Typical Value = true. Default: False - :kpss: PSS gain (K). Typical Value = 1. Default: 0.0 - :ctw2: Selector for Second washout enabling (C). true = second washout filter is bypassed false = second washout filter in use. Typical Value = true. Default: False - :tw1: First WashOut (T). Typical Value = 3.5. Default: 0 - :tw2: Second WashOut (T). Typical Value = 0. Default: 0 - :tl1: Lead/lag time constant (T). Typical Value = 0. Default: 0 - :tl2: Lead/lag time constant (T). Typical Value = 0. Default: 0 - :tl3: Lead/lag time constant (T). Typical Value = 0. Default: 0 - :tl4: Lead/lag time constant (T). Typical Value = 0. Default: 0 - :vsmn: Stabilizer output max limit (V). Typical Value = -0.1. Default: 0.0 - :vsmx: Stabilizer output min limit (V). Typical Value = 0.1. Default: 0.0 - :tpe: Electric power filter time constant (T). Typical Value = 0.05. Default: 0 - :pmm: Minimum power PSS enabling (P). Typical Value = 0.25. Default: 0.0 - :deadband: Stabilizer output dead band (DeadBand). Typical Value = 0. Default: 0.0 - :vadat: Default: False - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kpe': [cgmesProfile.DY.value, ], - 'kf': [cgmesProfile.DY.value, ], - 'isfreq': [cgmesProfile.DY.value, ], - 'kpss': [cgmesProfile.DY.value, ], - 'ctw2': [cgmesProfile.DY.value, ], - 'tw1': [cgmesProfile.DY.value, ], - 'tw2': [cgmesProfile.DY.value, ], - 'tl1': [cgmesProfile.DY.value, ], - 'tl2': [cgmesProfile.DY.value, ], - 'tl3': [cgmesProfile.DY.value, ], - 'tl4': [cgmesProfile.DY.value, ], - 'vsmn': [cgmesProfile.DY.value, ], - 'vsmx': [cgmesProfile.DY.value, ], - 'tpe': [cgmesProfile.DY.value, ], - 'pmm': [cgmesProfile.DY.value, ], - 'deadband': [cgmesProfile.DY.value, ], - 'vadat': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, kpe = 0.0, kf = 0.0, isfreq = False, kpss = 0.0, ctw2 = False, tw1 = 0, tw2 = 0, tl1 = 0, tl2 = 0, tl3 = 0, tl4 = 0, vsmn = 0.0, vsmx = 0.0, tpe = 0, pmm = 0.0, deadband = 0.0, vadat = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kpe = kpe - self.kf = kf - self.isfreq = isfreq - self.kpss = kpss - self.ctw2 = ctw2 - self.tw1 = tw1 - self.tw2 = tw2 - self.tl1 = tl1 - self.tl2 = tl2 - self.tl3 = tl3 - self.tl4 = tl4 - self.vsmn = vsmn - self.vsmx = vsmx - self.tpe = tpe - self.pmm = pmm - self.deadband = deadband - self.vadat = vadat - - def __str__(self): - str = 'class=Pss5\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class Pss5(PowerSystemStabilizerDynamics): + """ + Italian PSS - Detailed PSS. + + :ctw2: Selector for Second washout enabling (C). true = second washout filter is bypassed false = second washout filter in use. Typical Value = true. Default: False + :deadband: Stabilizer output dead band (DeadBand). Typical Value = 0. Default: 0.0 + :isfreq: Selector for Frequency/shaft speed input (IsFreq). true = speed false = frequency. Typical Value = true. Default: False + :kf: Frequency/shaft speed input gain (K). Typical Value = 5. Default: 0.0 + :kpe: Electric power input gain (K). Typical Value = 0.3. Default: 0.0 + :kpss: PSS gain (K). Typical Value = 1. Default: 0.0 + :pmm: Minimum power PSS enabling (P). Typical Value = 0.25. Default: 0.0 + :tl1: Lead/lag time constant (T). Typical Value = 0. Default: 0.0 + :tl2: Lead/lag time constant (T). Typical Value = 0. Default: 0.0 + :tl3: Lead/lag time constant (T). Typical Value = 0. Default: 0.0 + :tl4: Lead/lag time constant (T). Typical Value = 0. Default: 0.0 + :tpe: Electric power filter time constant (T). Typical Value = 0.05. Default: 0.0 + :tw1: First WashOut (T). Typical Value = 3.5. Default: 0.0 + :tw2: Second WashOut (T). Typical Value = 0. Default: 0.0 + :vadat: Default: False + :vsmn: Stabilizer output max limit (V). Typical Value = -0.1. Default: 0.0 + :vsmx: Stabilizer output min limit (V). Typical Value = 0.1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ctw2": [Profile.DY.value, ], + "deadband": [Profile.DY.value, ], + "isfreq": [Profile.DY.value, ], + "kf": [Profile.DY.value, ], + "kpe": [Profile.DY.value, ], + "kpss": [Profile.DY.value, ], + "pmm": [Profile.DY.value, ], + "tl1": [Profile.DY.value, ], + "tl2": [Profile.DY.value, ], + "tl3": [Profile.DY.value, ], + "tl4": [Profile.DY.value, ], + "tpe": [Profile.DY.value, ], + "tw1": [Profile.DY.value, ], + "tw2": [Profile.DY.value, ], + "vadat": [Profile.DY.value, ], + "vsmn": [Profile.DY.value, ], + "vsmx": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, ctw2 = False, deadband = 0.0, isfreq = False, kf = 0.0, kpe = 0.0, kpss = 0.0, pmm = 0.0, tl1 = 0.0, tl2 = 0.0, tl3 = 0.0, tl4 = 0.0, tpe = 0.0, tw1 = 0.0, tw2 = 0.0, vadat = False, vsmn = 0.0, vsmx = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ctw2 = ctw2 + self.deadband = deadband + self.isfreq = isfreq + self.kf = kf + self.kpe = kpe + self.kpss = kpss + self.pmm = pmm + self.tl1 = tl1 + self.tl2 = tl2 + self.tl3 = tl3 + self.tl4 = tl4 + self.tpe = tpe + self.tw1 = tw1 + self.tw2 = tw2 + self.vadat = vadat + self.vsmn = vsmn + self.vsmx = vsmx + + def __str__(self): + str = "class=Pss5\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PssELIN2.py b/cimpy/cgmes_v2_4_15/PssELIN2.py index 09ccb184..2f19383c 100644 --- a/cimpy/cgmes_v2_4_15/PssELIN2.py +++ b/cimpy/cgmes_v2_4_15/PssELIN2.py @@ -1,61 +1,63 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class PssELIN2(PowerSystemStabilizerDynamics): - ''' - Power system stabilizer typically associated with ExcELIN2 (though PssIEEE2B or Pss2B can also be used). - - :ts1: Time constant (Ts1). Typical Value = 0. Default: 0 - :ts2: Time constant (Ts2). Typical Value = 1. Default: 0 - :ts3: Time constant (Ts3). Typical Value = 1. Default: 0 - :ts4: Time constant (Ts4). Typical Value = 0.1. Default: 0 - :ts5: Time constant (Ts5). Typical Value = 0. Default: 0 - :ts6: Time constant (Ts6). Typical Value = 1. Default: 0 - :ks1: Gain (Ks1). Typical Value = 1. Default: 0.0 - :ks2: Gain (Ks2). Typical Value = 0.1. Default: 0.0 - :ppss: Coefficient (p_PSS) (>=0 and <=4). Typical Value = 0.1. Default: 0.0 - :apss: Coefficient (a_PSS). Typical Value = 0.1. Default: 0.0 - :psslim: PSS limiter (psslim). Typical Value = 0.1. Default: 0.0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'ts1': [cgmesProfile.DY.value, ], - 'ts2': [cgmesProfile.DY.value, ], - 'ts3': [cgmesProfile.DY.value, ], - 'ts4': [cgmesProfile.DY.value, ], - 'ts5': [cgmesProfile.DY.value, ], - 'ts6': [cgmesProfile.DY.value, ], - 'ks1': [cgmesProfile.DY.value, ], - 'ks2': [cgmesProfile.DY.value, ], - 'ppss': [cgmesProfile.DY.value, ], - 'apss': [cgmesProfile.DY.value, ], - 'psslim': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, ts1 = 0, ts2 = 0, ts3 = 0, ts4 = 0, ts5 = 0, ts6 = 0, ks1 = 0.0, ks2 = 0.0, ppss = 0.0, apss = 0.0, psslim = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ts1 = ts1 - self.ts2 = ts2 - self.ts3 = ts3 - self.ts4 = ts4 - self.ts5 = ts5 - self.ts6 = ts6 - self.ks1 = ks1 - self.ks2 = ks2 - self.ppss = ppss - self.apss = apss - self.psslim = psslim - - def __str__(self): - str = 'class=PssELIN2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class PssELIN2(PowerSystemStabilizerDynamics): + """ + Power system stabilizer typically associated with ExcELIN2 (though PssIEEE2B or Pss2B can also be used). + + :apss: Coefficient (a_PSS). Typical Value = 0.1. Default: 0.0 + :ks1: Gain (Ks1). Typical Value = 1. Default: 0.0 + :ks2: Gain (Ks2). Typical Value = 0.1. Default: 0.0 + :ppss: Coefficient (p_PSS) (>=0 and <=4). Typical Value = 0.1. Default: 0.0 + :psslim: PSS limiter (psslim). Typical Value = 0.1. Default: 0.0 + :ts1: Time constant (Ts1). Typical Value = 0. Default: 0.0 + :ts2: Time constant (Ts2). Typical Value = 1. Default: 0.0 + :ts3: Time constant (Ts3). Typical Value = 1. Default: 0.0 + :ts4: Time constant (Ts4). Typical Value = 0.1. Default: 0.0 + :ts5: Time constant (Ts5). Typical Value = 0. Default: 0.0 + :ts6: Time constant (Ts6). Typical Value = 1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "apss": [Profile.DY.value, ], + "ks1": [Profile.DY.value, ], + "ks2": [Profile.DY.value, ], + "ppss": [Profile.DY.value, ], + "psslim": [Profile.DY.value, ], + "ts1": [Profile.DY.value, ], + "ts2": [Profile.DY.value, ], + "ts3": [Profile.DY.value, ], + "ts4": [Profile.DY.value, ], + "ts5": [Profile.DY.value, ], + "ts6": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, apss = 0.0, ks1 = 0.0, ks2 = 0.0, ppss = 0.0, psslim = 0.0, ts1 = 0.0, ts2 = 0.0, ts3 = 0.0, ts4 = 0.0, ts5 = 0.0, ts6 = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.apss = apss + self.ks1 = ks1 + self.ks2 = ks2 + self.ppss = ppss + self.psslim = psslim + self.ts1 = ts1 + self.ts2 = ts2 + self.ts3 = ts3 + self.ts4 = ts4 + self.ts5 = ts5 + self.ts6 = ts6 + + def __str__(self): + str = "class=PssELIN2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PssIEEE1A.py b/cimpy/cgmes_v2_4_15/PssIEEE1A.py index d33bc8de..88abe9be 100644 --- a/cimpy/cgmes_v2_4_15/PssIEEE1A.py +++ b/cimpy/cgmes_v2_4_15/PssIEEE1A.py @@ -1,64 +1,66 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class PssIEEE1A(PowerSystemStabilizerDynamics): - ''' - The class represents IEEE Std 421.5-2005 type PSS1A power system stabilizer model. PSS1A is the generalized form of a PSS with a single input. Some common stabilizer input signals are speed, frequency, and power. Reference: IEEE 1A 421.5-2005 Section 8.1. - - :inputSignalType: Type of input signal. Typical Value = rotorAngularFrequencyDeviation. Default: None - :a1: PSS signal conditioning frequency filter constant (A1). Typical Value = 0.061. Default: 0.0 - :a2: PSS signal conditioning frequency filter constant (A2). Typical Value = 0.0017. Default: 0.0 - :t1: Lead/lag time constant (T1). Typical Value = 0.3. Default: 0 - :t2: Lead/lag time constant (T2). Typical Value = 0.03. Default: 0 - :t3: Lead/lag time constant (T3). Typical Value = 0.3. Default: 0 - :t4: Lead/lag time constant (T4). Typical Value = 0.03. Default: 0 - :t5: Washout time constant (T5). Typical Value = 10. Default: 0 - :t6: Transducer time constant (T6). Typical Value = 0.01. Default: 0 - :ks: Stabilizer gain (Ks). Typical Value = 5. Default: 0.0 - :vrmax: Maximum stabilizer output (Vrmax). Typical Value = 0.05. Default: 0.0 - :vrmin: Minimum stabilizer output (Vrmin). Typical Value = -0.05. Default: 0.0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'inputSignalType': [cgmesProfile.DY.value, ], - 'a1': [cgmesProfile.DY.value, ], - 'a2': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'vrmax': [cgmesProfile.DY.value, ], - 'vrmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, inputSignalType = None, a1 = 0.0, a2 = 0.0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, t5 = 0, t6 = 0, ks = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.inputSignalType = inputSignalType - self.a1 = a1 - self.a2 = a2 - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.t5 = t5 - self.t6 = t6 - self.ks = ks - self.vrmax = vrmax - self.vrmin = vrmin - - def __str__(self): - str = 'class=PssIEEE1A\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class PssIEEE1A(PowerSystemStabilizerDynamics): + """ + The class represents IEEE Std 421.5-2005 type PSS1A power system stabilizer model. PSS1A is the generalized form of a PSS with a single input. Some common stabilizer input signals are speed, frequency, and power. Reference: IEEE 1A 421.5-2005 Section 8.1. + + :a1: PSS signal conditioning frequency filter constant (A1). Typical Value = 0.061. Default: 0.0 + :a2: PSS signal conditioning frequency filter constant (A2). Typical Value = 0.0017. Default: 0.0 + :inputSignalType: Type of input signal. Typical Value = rotorAngularFrequencyDeviation. Default: None + :ks: Stabilizer gain (Ks). Typical Value = 5. Default: 0.0 + :t1: Lead/lag time constant (T1). Typical Value = 0.3. Default: 0.0 + :t2: Lead/lag time constant (T2). Typical Value = 0.03. Default: 0.0 + :t3: Lead/lag time constant (T3). Typical Value = 0.3. Default: 0.0 + :t4: Lead/lag time constant (T4). Typical Value = 0.03. Default: 0.0 + :t5: Washout time constant (T5). Typical Value = 10. Default: 0.0 + :t6: Transducer time constant (T6). Typical Value = 0.01. Default: 0.0 + :vrmax: Maximum stabilizer output (Vrmax). Typical Value = 0.05. Default: 0.0 + :vrmin: Minimum stabilizer output (Vrmin). Typical Value = -0.05. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "a1": [Profile.DY.value, ], + "a2": [Profile.DY.value, ], + "inputSignalType": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "vrmax": [Profile.DY.value, ], + "vrmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, a1 = 0.0, a2 = 0.0, inputSignalType = None, ks = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, t6 = 0.0, vrmax = 0.0, vrmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.a1 = a1 + self.a2 = a2 + self.inputSignalType = inputSignalType + self.ks = ks + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.t6 = t6 + self.vrmax = vrmax + self.vrmin = vrmin + + def __str__(self): + str = "class=PssIEEE1A\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PssIEEE2B.py b/cimpy/cgmes_v2_4_15/PssIEEE2B.py index ccf04e71..a5de10e4 100644 --- a/cimpy/cgmes_v2_4_15/PssIEEE2B.py +++ b/cimpy/cgmes_v2_4_15/PssIEEE2B.py @@ -1,109 +1,111 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class PssIEEE2B(PowerSystemStabilizerDynamics): - ''' - The class represents IEEE Std 421.5-2005 type PSS2B power system stabilizer model. This stabilizer model is designed to represent a variety of dual-input stabilizers, which normally use combinations of power and speed or frequency to derive the stabilizing signal. Reference: IEEE 2B 421.5-2005 Section 8.2. - - :inputSignal1Type: Type of input signal #1. Typical Value = rotorSpeed. Default: None - :inputSignal2Type: Type of input signal #2. Typical Value = generatorElectricalPower. Default: None - :vsi1max: Input signal #1 max limit (Vsi1max). Typical Value = 2. Default: 0.0 - :vsi1min: Input signal #1 min limit (Vsi1min). Typical Value = -2. Default: 0.0 - :tw1: First washout on signal #1 (Tw1). Typical Value = 2. Default: 0 - :tw2: Second washout on signal #1 (Tw2). Typical Value = 2. Default: 0 - :vsi2max: Input signal #2 max limit (Vsi2max). Typical Value = 2. Default: 0.0 - :vsi2min: Input signal #2 min limit (Vsi2min). Typical Value = -2. Default: 0.0 - :tw3: First washout on signal #2 (Tw3). Typical Value = 2. Default: 0 - :tw4: Second washout on signal #2 (Tw4). Typical Value = 0. Default: 0 - :t1: Lead/lag time constant (T1). Typical Value = 0.12. Default: 0 - :t2: Lead/lag time constant (T2). Typical Value = 0.02. Default: 0 - :t3: Lead/lag time constant (T3). Typical Value = 0.3. Default: 0 - :t4: Lead/lag time constant (T4). Typical Value = 0.02. Default: 0 - :t6: Time constant on signal #1 (T6). Typical Value = 0. Default: 0 - :t7: Time constant on signal #2 (T7). Typical Value = 2. Default: 0 - :t8: Lead of ramp tracking filter (T8). Typical Value = 0.2. Default: 0 - :t9: Lag of ramp tracking filter (T9). Typical Value = 0.1. Default: 0 - :t10: Lead/lag time constant (T10). Typical Value = 0. Default: 0 - :t11: Lead/lag time constant (T11). Typical Value = 0. Default: 0 - :ks1: Stabilizer gain (Ks1). Typical Value = 12. Default: 0.0 - :ks2: Gain on signal #2 (Ks2). Typical Value = 0.2. Default: 0.0 - :ks3: Gain on signal #2 input before ramp-tracking filter (Ks3). Typical Value = 1. Default: 0.0 - :n: Order of ramp tracking filter (N). Typical Value = 1. Default: 0 - :m: Denominator order of ramp tracking filter (M). Typical Value = 5. Default: 0 - :vstmax: Stabilizer output max limit (Vstmax). Typical Value = 0.1. Default: 0.0 - :vstmin: Stabilizer output min limit (Vstmin). Typical Value = -0.1. Default: 0.0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'inputSignal1Type': [cgmesProfile.DY.value, ], - 'inputSignal2Type': [cgmesProfile.DY.value, ], - 'vsi1max': [cgmesProfile.DY.value, ], - 'vsi1min': [cgmesProfile.DY.value, ], - 'tw1': [cgmesProfile.DY.value, ], - 'tw2': [cgmesProfile.DY.value, ], - 'vsi2max': [cgmesProfile.DY.value, ], - 'vsi2min': [cgmesProfile.DY.value, ], - 'tw3': [cgmesProfile.DY.value, ], - 'tw4': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 't7': [cgmesProfile.DY.value, ], - 't8': [cgmesProfile.DY.value, ], - 't9': [cgmesProfile.DY.value, ], - 't10': [cgmesProfile.DY.value, ], - 't11': [cgmesProfile.DY.value, ], - 'ks1': [cgmesProfile.DY.value, ], - 'ks2': [cgmesProfile.DY.value, ], - 'ks3': [cgmesProfile.DY.value, ], - 'n': [cgmesProfile.DY.value, ], - 'm': [cgmesProfile.DY.value, ], - 'vstmax': [cgmesProfile.DY.value, ], - 'vstmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, inputSignal1Type = None, inputSignal2Type = None, vsi1max = 0.0, vsi1min = 0.0, tw1 = 0, tw2 = 0, vsi2max = 0.0, vsi2min = 0.0, tw3 = 0, tw4 = 0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, t6 = 0, t7 = 0, t8 = 0, t9 = 0, t10 = 0, t11 = 0, ks1 = 0.0, ks2 = 0.0, ks3 = 0.0, n = 0, m = 0, vstmax = 0.0, vstmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.inputSignal1Type = inputSignal1Type - self.inputSignal2Type = inputSignal2Type - self.vsi1max = vsi1max - self.vsi1min = vsi1min - self.tw1 = tw1 - self.tw2 = tw2 - self.vsi2max = vsi2max - self.vsi2min = vsi2min - self.tw3 = tw3 - self.tw4 = tw4 - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.t6 = t6 - self.t7 = t7 - self.t8 = t8 - self.t9 = t9 - self.t10 = t10 - self.t11 = t11 - self.ks1 = ks1 - self.ks2 = ks2 - self.ks3 = ks3 - self.n = n - self.m = m - self.vstmax = vstmax - self.vstmin = vstmin - - def __str__(self): - str = 'class=PssIEEE2B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class PssIEEE2B(PowerSystemStabilizerDynamics): + """ + The class represents IEEE Std 421.5-2005 type PSS2B power system stabilizer model. This stabilizer model is designed to represent a variety of dual-input stabilizers, which normally use combinations of power and speed or frequency to derive the stabilizing signal. Reference: IEEE 2B 421.5-2005 Section 8.2. + + :inputSignal1Type: Type of input signal #1. Typical Value = rotorSpeed. Default: None + :inputSignal2Type: Type of input signal #2. Typical Value = generatorElectricalPower. Default: None + :ks1: Stabilizer gain (Ks1). Typical Value = 12. Default: 0.0 + :ks2: Gain on signal #2 (Ks2). Typical Value = 0.2. Default: 0.0 + :ks3: Gain on signal #2 input before ramp-tracking filter (Ks3). Typical Value = 1. Default: 0.0 + :m: Denominator order of ramp tracking filter (M). Typical Value = 5. Default: 0 + :n: Order of ramp tracking filter (N). Typical Value = 1. Default: 0 + :t1: Lead/lag time constant (T1). Typical Value = 0.12. Default: 0.0 + :t10: Lead/lag time constant (T10). Typical Value = 0. Default: 0.0 + :t11: Lead/lag time constant (T11). Typical Value = 0. Default: 0.0 + :t2: Lead/lag time constant (T2). Typical Value = 0.02. Default: 0.0 + :t3: Lead/lag time constant (T3). Typical Value = 0.3. Default: 0.0 + :t4: Lead/lag time constant (T4). Typical Value = 0.02. Default: 0.0 + :t6: Time constant on signal #1 (T6). Typical Value = 0. Default: 0.0 + :t7: Time constant on signal #2 (T7). Typical Value = 2. Default: 0.0 + :t8: Lead of ramp tracking filter (T8). Typical Value = 0.2. Default: 0.0 + :t9: Lag of ramp tracking filter (T9). Typical Value = 0.1. Default: 0.0 + :tw1: First washout on signal #1 (Tw1). Typical Value = 2. Default: 0.0 + :tw2: Second washout on signal #1 (Tw2). Typical Value = 2. Default: 0.0 + :tw3: First washout on signal #2 (Tw3). Typical Value = 2. Default: 0.0 + :tw4: Second washout on signal #2 (Tw4). Typical Value = 0. Default: 0.0 + :vsi1max: Input signal #1 max limit (Vsi1max). Typical Value = 2. Default: 0.0 + :vsi1min: Input signal #1 min limit (Vsi1min). Typical Value = -2. Default: 0.0 + :vsi2max: Input signal #2 max limit (Vsi2max). Typical Value = 2. Default: 0.0 + :vsi2min: Input signal #2 min limit (Vsi2min). Typical Value = -2. Default: 0.0 + :vstmax: Stabilizer output max limit (Vstmax). Typical Value = 0.1. Default: 0.0 + :vstmin: Stabilizer output min limit (Vstmin). Typical Value = -0.1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "inputSignal1Type": [Profile.DY.value, ], + "inputSignal2Type": [Profile.DY.value, ], + "ks1": [Profile.DY.value, ], + "ks2": [Profile.DY.value, ], + "ks3": [Profile.DY.value, ], + "m": [Profile.DY.value, ], + "n": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t10": [Profile.DY.value, ], + "t11": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "t7": [Profile.DY.value, ], + "t8": [Profile.DY.value, ], + "t9": [Profile.DY.value, ], + "tw1": [Profile.DY.value, ], + "tw2": [Profile.DY.value, ], + "tw3": [Profile.DY.value, ], + "tw4": [Profile.DY.value, ], + "vsi1max": [Profile.DY.value, ], + "vsi1min": [Profile.DY.value, ], + "vsi2max": [Profile.DY.value, ], + "vsi2min": [Profile.DY.value, ], + "vstmax": [Profile.DY.value, ], + "vstmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, inputSignal1Type = None, inputSignal2Type = None, ks1 = 0.0, ks2 = 0.0, ks3 = 0.0, m = 0, n = 0, t1 = 0.0, t10 = 0.0, t11 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t6 = 0.0, t7 = 0.0, t8 = 0.0, t9 = 0.0, tw1 = 0.0, tw2 = 0.0, tw3 = 0.0, tw4 = 0.0, vsi1max = 0.0, vsi1min = 0.0, vsi2max = 0.0, vsi2min = 0.0, vstmax = 0.0, vstmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.inputSignal1Type = inputSignal1Type + self.inputSignal2Type = inputSignal2Type + self.ks1 = ks1 + self.ks2 = ks2 + self.ks3 = ks3 + self.m = m + self.n = n + self.t1 = t1 + self.t10 = t10 + self.t11 = t11 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t6 = t6 + self.t7 = t7 + self.t8 = t8 + self.t9 = t9 + self.tw1 = tw1 + self.tw2 = tw2 + self.tw3 = tw3 + self.tw4 = tw4 + self.vsi1max = vsi1max + self.vsi1min = vsi1min + self.vsi2max = vsi2max + self.vsi2min = vsi2min + self.vstmax = vstmax + self.vstmin = vstmin + + def __str__(self): + str = "class=PssIEEE2B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PssIEEE3B.py b/cimpy/cgmes_v2_4_15/PssIEEE3B.py index ccb71dd2..887785c6 100644 --- a/cimpy/cgmes_v2_4_15/PssIEEE3B.py +++ b/cimpy/cgmes_v2_4_15/PssIEEE3B.py @@ -1,85 +1,87 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class PssIEEE3B(PowerSystemStabilizerDynamics): - ''' - The class represents IEEE Std 421.5-2005 type PSS3B power system stabilizer model. The PSS model PSS3B has dual inputs of electrical power and rotor angular frequency deviation. The signals are used to derive an equivalent mechanical power signal. Reference: IEEE 3B 421.5-2005 Section 8.3. - - :inputSignal1Type: Type of input signal #1. Typical Value = generatorElectricalPower. Default: None - :inputSignal2Type: Type of input signal #2. Typical Value = rotorSpeed. Default: None - :t1: Transducer time constant (T1). Typical Value = 0.012. Default: 0 - :t2: Transducer time constant (T2). Typical Value = 0.012. Default: 0 - :tw1: Washout time constant (Tw1). Typical Value = 0.3. Default: 0 - :tw2: Washout time constant (Tw2). Typical Value = 0.3. Default: 0 - :tw3: Washout time constant (Tw3). Typical Value = 0.6. Default: 0 - :ks1: Gain on signal # 1 (Ks1). Typical Value = -0.602. Default: 0.0 - :ks2: Gain on signal # 2 (Ks2). Typical Value = 30.12. Default: 0.0 - :a1: Notch filter parameter (A1). Typical Value = 0.359. Default: 0.0 - :a2: Notch filter parameter (A2). Typical Value = 0.586. Default: 0.0 - :a3: Notch filter parameter (A3). Typical Value = 0.429. Default: 0.0 - :a4: Notch filter parameter (A4). Typical Value = 0.564. Default: 0.0 - :a5: Notch filter parameter (A5). Typical Value = 0.001. Default: 0.0 - :a6: Notch filter parameter (A6). Typical Value = 0. Default: 0.0 - :a7: Notch filter parameter (A7). Typical Value = 0.031. Default: 0.0 - :a8: Notch filter parameter (A8). Typical Value = 0. Default: 0.0 - :vstmax: Stabilizer output max limit (Vstmax). Typical Value = 0.1. Default: 0.0 - :vstmin: Stabilizer output min limit (Vstmin). Typical Value = -0.1. Default: 0.0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'inputSignal1Type': [cgmesProfile.DY.value, ], - 'inputSignal2Type': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 'tw1': [cgmesProfile.DY.value, ], - 'tw2': [cgmesProfile.DY.value, ], - 'tw3': [cgmesProfile.DY.value, ], - 'ks1': [cgmesProfile.DY.value, ], - 'ks2': [cgmesProfile.DY.value, ], - 'a1': [cgmesProfile.DY.value, ], - 'a2': [cgmesProfile.DY.value, ], - 'a3': [cgmesProfile.DY.value, ], - 'a4': [cgmesProfile.DY.value, ], - 'a5': [cgmesProfile.DY.value, ], - 'a6': [cgmesProfile.DY.value, ], - 'a7': [cgmesProfile.DY.value, ], - 'a8': [cgmesProfile.DY.value, ], - 'vstmax': [cgmesProfile.DY.value, ], - 'vstmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, inputSignal1Type = None, inputSignal2Type = None, t1 = 0, t2 = 0, tw1 = 0, tw2 = 0, tw3 = 0, ks1 = 0.0, ks2 = 0.0, a1 = 0.0, a2 = 0.0, a3 = 0.0, a4 = 0.0, a5 = 0.0, a6 = 0.0, a7 = 0.0, a8 = 0.0, vstmax = 0.0, vstmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.inputSignal1Type = inputSignal1Type - self.inputSignal2Type = inputSignal2Type - self.t1 = t1 - self.t2 = t2 - self.tw1 = tw1 - self.tw2 = tw2 - self.tw3 = tw3 - self.ks1 = ks1 - self.ks2 = ks2 - self.a1 = a1 - self.a2 = a2 - self.a3 = a3 - self.a4 = a4 - self.a5 = a5 - self.a6 = a6 - self.a7 = a7 - self.a8 = a8 - self.vstmax = vstmax - self.vstmin = vstmin - - def __str__(self): - str = 'class=PssIEEE3B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class PssIEEE3B(PowerSystemStabilizerDynamics): + """ + The class represents IEEE Std 421.5-2005 type PSS3B power system stabilizer model. The PSS model PSS3B has dual inputs of electrical power and rotor angular frequency deviation. The signals are used to derive an equivalent mechanical power signal. Reference: IEEE 3B 421.5-2005 Section 8.3. + + :a1: Notch filter parameter (A1). Typical Value = 0.359. Default: 0.0 + :a2: Notch filter parameter (A2). Typical Value = 0.586. Default: 0.0 + :a3: Notch filter parameter (A3). Typical Value = 0.429. Default: 0.0 + :a4: Notch filter parameter (A4). Typical Value = 0.564. Default: 0.0 + :a5: Notch filter parameter (A5). Typical Value = 0.001. Default: 0.0 + :a6: Notch filter parameter (A6). Typical Value = 0. Default: 0.0 + :a7: Notch filter parameter (A7). Typical Value = 0.031. Default: 0.0 + :a8: Notch filter parameter (A8). Typical Value = 0. Default: 0.0 + :inputSignal1Type: Type of input signal #1. Typical Value = generatorElectricalPower. Default: None + :inputSignal2Type: Type of input signal #2. Typical Value = rotorSpeed. Default: None + :ks1: Gain on signal # 1 (Ks1). Typical Value = -0.602. Default: 0.0 + :ks2: Gain on signal # 2 (Ks2). Typical Value = 30.12. Default: 0.0 + :t1: Transducer time constant (T1). Typical Value = 0.012. Default: 0.0 + :t2: Transducer time constant (T2). Typical Value = 0.012. Default: 0.0 + :tw1: Washout time constant (Tw1). Typical Value = 0.3. Default: 0.0 + :tw2: Washout time constant (Tw2). Typical Value = 0.3. Default: 0.0 + :tw3: Washout time constant (Tw3). Typical Value = 0.6. Default: 0.0 + :vstmax: Stabilizer output max limit (Vstmax). Typical Value = 0.1. Default: 0.0 + :vstmin: Stabilizer output min limit (Vstmin). Typical Value = -0.1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "a1": [Profile.DY.value, ], + "a2": [Profile.DY.value, ], + "a3": [Profile.DY.value, ], + "a4": [Profile.DY.value, ], + "a5": [Profile.DY.value, ], + "a6": [Profile.DY.value, ], + "a7": [Profile.DY.value, ], + "a8": [Profile.DY.value, ], + "inputSignal1Type": [Profile.DY.value, ], + "inputSignal2Type": [Profile.DY.value, ], + "ks1": [Profile.DY.value, ], + "ks2": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "tw1": [Profile.DY.value, ], + "tw2": [Profile.DY.value, ], + "tw3": [Profile.DY.value, ], + "vstmax": [Profile.DY.value, ], + "vstmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, a1 = 0.0, a2 = 0.0, a3 = 0.0, a4 = 0.0, a5 = 0.0, a6 = 0.0, a7 = 0.0, a8 = 0.0, inputSignal1Type = None, inputSignal2Type = None, ks1 = 0.0, ks2 = 0.0, t1 = 0.0, t2 = 0.0, tw1 = 0.0, tw2 = 0.0, tw3 = 0.0, vstmax = 0.0, vstmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.a1 = a1 + self.a2 = a2 + self.a3 = a3 + self.a4 = a4 + self.a5 = a5 + self.a6 = a6 + self.a7 = a7 + self.a8 = a8 + self.inputSignal1Type = inputSignal1Type + self.inputSignal2Type = inputSignal2Type + self.ks1 = ks1 + self.ks2 = ks2 + self.t1 = t1 + self.t2 = t2 + self.tw1 = tw1 + self.tw2 = tw2 + self.tw3 = tw3 + self.vstmax = vstmax + self.vstmin = vstmin + + def __str__(self): + str = "class=PssIEEE3B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PssIEEE4B.py b/cimpy/cgmes_v2_4_15/PssIEEE4B.py index b17fec99..8b036da6 100644 --- a/cimpy/cgmes_v2_4_15/PssIEEE4B.py +++ b/cimpy/cgmes_v2_4_15/PssIEEE4B.py @@ -1,229 +1,231 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class PssIEEE4B(PowerSystemStabilizerDynamics): - ''' - The class represents IEEE Std 421.5-2005 type PSS2B power system stabilizer model. The PSS4B model represents a structure based on multiple working frequency bands. Three separate bands, respectively dedicated to the low-, intermediate- and high-frequency modes of oscillations, are used in this delta-omega (speed input) PSS. Reference: IEEE 4B 421.5-2005 Section 8.4. - - :bwh1: Notch filter 1 (high-frequency band): Three dB bandwidth (B). Default: 0.0 - :bwh2: Notch filter 2 (high-frequency band): Three dB bandwidth (B). Default: 0.0 - :bwl1: Notch filter 1 (low-frequency band): Three dB bandwidth (B). Default: 0.0 - :bwl2: Notch filter 2 (low-frequency band): Three dB bandwidth (B). Default: 0.0 - :kh: High band gain (K). Typical Value = 120. Default: 0.0 - :kh1: High band differential filter gain (K). Typical Value = 66. Default: 0.0 - :kh11: High band first lead-lag blocks coefficient (K). Typical Value = 1. Default: 0.0 - :kh17: High band first lead-lag blocks coefficient (K). Typical Value = 1. Default: 0.0 - :kh2: High band differential filter gain (K). Typical Value = 66. Default: 0.0 - :ki: Intermediate band gain (K). Typical Value = 30. Default: 0.0 - :ki1: Intermediate band differential filter gain (K). Typical Value = 66. Default: 0.0 - :ki11: Intermediate band first lead-lag blocks coefficient (K). Typical Value = 1. Default: 0.0 - :ki17: Intermediate band first lead-lag blocks coefficient (K). Typical Value = 1. Default: 0.0 - :ki2: Intermediate band differential filter gain (K). Typical Value = 66. Default: 0.0 - :kl: Low band gain (K). Typical Value = 7.5. Default: 0.0 - :kl1: Low band differential filter gain (K). Typical Value = 66. Default: 0.0 - :kl11: Low band first lead-lag blocks coefficient (K). Typical Value = 1. Default: 0.0 - :kl17: Low band first lead-lag blocks coefficient (K). Typical Value = 1. Default: 0.0 - :kl2: Low band differential filter gain (K). Typical Value = 66. Default: 0.0 - :omeganh1: Notch filter 1 (high-frequency band): filter frequency (omega). Default: 0.0 - :omeganh2: Notch filter 2 (high-frequency band): filter frequency (omega). Default: 0.0 - :omeganl1: Notch filter 1 (low-frequency band): filter frequency (omega). Default: 0.0 - :omeganl2: Notch filter 2 (low-frequency band): filter frequency (omega). Default: 0.0 - :th1: High band time constant (T). Typical Value = 0.01513. Default: 0 - :th10: High band time constant (T). Typical Value = 0. Default: 0 - :th11: High band time constant (T). Typical Value = 0. Default: 0 - :th12: High band time constant (T). Typical Value = 0. Default: 0 - :th2: High band time constant (T). Typical Value = 0.01816. Default: 0 - :th3: High band time constant (T). Typical Value = 0. Default: 0 - :th4: High band time constant (T). Typical Value = 0. Default: 0 - :th5: High band time constant (T). Typical Value = 0. Default: 0 - :th6: High band time constant (T). Typical Value = 0. Default: 0 - :th7: High band time constant (T). Typical Value = 0.01816. Default: 0 - :th8: High band time constant (T). Typical Value = 0.02179. Default: 0 - :th9: High band time constant (T). Typical Value = 0. Default: 0 - :ti1: Intermediate band time constant (T). Typical Value = 0.173. Default: 0 - :ti10: Intermediate band time constant (T). Typical Value = 0. Default: 0 - :ti11: Intermediate band time constant (T). Typical Value = 0. Default: 0 - :ti12: Intermediate band time constant (T). Typical Value = 0. Default: 0 - :ti2: Intermediate band time constant (T). Typical Value = 0.2075. Default: 0 - :ti3: Intermediate band time constant (T). Typical Value = 0. Default: 0 - :ti4: Intermediate band time constant (T). Typical Value = 0. Default: 0 - :ti5: Intermediate band time constant (T). Typical Value = 0. Default: 0 - :ti6: Intermediate band time constant (T). Typical Value = 0. Default: 0 - :ti7: Intermediate band time constant (T). Typical Value = 0.2075. Default: 0 - :ti8: Intermediate band time constant (T). Typical Value = 0.2491. Default: 0 - :ti9: Intermediate band time constant (T). Typical Value = 0. Default: 0 - :tl1: Low band time constant (T). Typical Value = 1.73. Default: 0 - :tl10: Low band time constant (T). Typical Value = 0. Default: 0 - :tl11: Low band time constant (T). Typical Value = 0. Default: 0 - :tl12: Low band time constant (T). Typical Value = 0. Default: 0 - :tl2: Low band time constant (T). Typical Value = 2.075. Default: 0 - :tl3: Low band time constant (T). Typical Value = 0. Default: 0 - :tl4: Low band time constant (T). Typical Value = 0. Default: 0 - :tl5: Low band time constant (T). Typical Value = 0. Default: 0 - :tl6: Low band time constant (T). Typical Value = 0. Default: 0 - :tl7: Low band time constant (T). Typical Value = 2.075. Default: 0 - :tl8: Low band time constant (T). Typical Value = 2.491. Default: 0 - :tl9: Low band time constant (T). Typical Value = 0. Default: 0 - :vhmax: High band output maximum limit (V). Typical Value = 0.6. Default: 0.0 - :vhmin: High band output minimum limit (V). Typical Value = -0.6. Default: 0.0 - :vimax: Intermediate band output maximum limit (V). Typical Value = 0.6. Default: 0.0 - :vimin: Intermediate band output minimum limit (V). Typical Value = -0.6. Default: 0.0 - :vlmax: Low band output maximum limit (V). Typical Value = 0.075. Default: 0.0 - :vlmin: Low band output minimum limit (V). Typical Value = -0.075. Default: 0.0 - :vstmax: PSS output maximum limit (V). Typical Value = 0.15. Default: 0.0 - :vstmin: PSS output minimum limit (V). Typical Value = -0.15. Default: 0.0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'bwh1': [cgmesProfile.DY.value, ], - 'bwh2': [cgmesProfile.DY.value, ], - 'bwl1': [cgmesProfile.DY.value, ], - 'bwl2': [cgmesProfile.DY.value, ], - 'kh': [cgmesProfile.DY.value, ], - 'kh1': [cgmesProfile.DY.value, ], - 'kh11': [cgmesProfile.DY.value, ], - 'kh17': [cgmesProfile.DY.value, ], - 'kh2': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'ki1': [cgmesProfile.DY.value, ], - 'ki11': [cgmesProfile.DY.value, ], - 'ki17': [cgmesProfile.DY.value, ], - 'ki2': [cgmesProfile.DY.value, ], - 'kl': [cgmesProfile.DY.value, ], - 'kl1': [cgmesProfile.DY.value, ], - 'kl11': [cgmesProfile.DY.value, ], - 'kl17': [cgmesProfile.DY.value, ], - 'kl2': [cgmesProfile.DY.value, ], - 'omeganh1': [cgmesProfile.DY.value, ], - 'omeganh2': [cgmesProfile.DY.value, ], - 'omeganl1': [cgmesProfile.DY.value, ], - 'omeganl2': [cgmesProfile.DY.value, ], - 'th1': [cgmesProfile.DY.value, ], - 'th10': [cgmesProfile.DY.value, ], - 'th11': [cgmesProfile.DY.value, ], - 'th12': [cgmesProfile.DY.value, ], - 'th2': [cgmesProfile.DY.value, ], - 'th3': [cgmesProfile.DY.value, ], - 'th4': [cgmesProfile.DY.value, ], - 'th5': [cgmesProfile.DY.value, ], - 'th6': [cgmesProfile.DY.value, ], - 'th7': [cgmesProfile.DY.value, ], - 'th8': [cgmesProfile.DY.value, ], - 'th9': [cgmesProfile.DY.value, ], - 'ti1': [cgmesProfile.DY.value, ], - 'ti10': [cgmesProfile.DY.value, ], - 'ti11': [cgmesProfile.DY.value, ], - 'ti12': [cgmesProfile.DY.value, ], - 'ti2': [cgmesProfile.DY.value, ], - 'ti3': [cgmesProfile.DY.value, ], - 'ti4': [cgmesProfile.DY.value, ], - 'ti5': [cgmesProfile.DY.value, ], - 'ti6': [cgmesProfile.DY.value, ], - 'ti7': [cgmesProfile.DY.value, ], - 'ti8': [cgmesProfile.DY.value, ], - 'ti9': [cgmesProfile.DY.value, ], - 'tl1': [cgmesProfile.DY.value, ], - 'tl10': [cgmesProfile.DY.value, ], - 'tl11': [cgmesProfile.DY.value, ], - 'tl12': [cgmesProfile.DY.value, ], - 'tl2': [cgmesProfile.DY.value, ], - 'tl3': [cgmesProfile.DY.value, ], - 'tl4': [cgmesProfile.DY.value, ], - 'tl5': [cgmesProfile.DY.value, ], - 'tl6': [cgmesProfile.DY.value, ], - 'tl7': [cgmesProfile.DY.value, ], - 'tl8': [cgmesProfile.DY.value, ], - 'tl9': [cgmesProfile.DY.value, ], - 'vhmax': [cgmesProfile.DY.value, ], - 'vhmin': [cgmesProfile.DY.value, ], - 'vimax': [cgmesProfile.DY.value, ], - 'vimin': [cgmesProfile.DY.value, ], - 'vlmax': [cgmesProfile.DY.value, ], - 'vlmin': [cgmesProfile.DY.value, ], - 'vstmax': [cgmesProfile.DY.value, ], - 'vstmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, bwh1 = 0.0, bwh2 = 0.0, bwl1 = 0.0, bwl2 = 0.0, kh = 0.0, kh1 = 0.0, kh11 = 0.0, kh17 = 0.0, kh2 = 0.0, ki = 0.0, ki1 = 0.0, ki11 = 0.0, ki17 = 0.0, ki2 = 0.0, kl = 0.0, kl1 = 0.0, kl11 = 0.0, kl17 = 0.0, kl2 = 0.0, omeganh1 = 0.0, omeganh2 = 0.0, omeganl1 = 0.0, omeganl2 = 0.0, th1 = 0, th10 = 0, th11 = 0, th12 = 0, th2 = 0, th3 = 0, th4 = 0, th5 = 0, th6 = 0, th7 = 0, th8 = 0, th9 = 0, ti1 = 0, ti10 = 0, ti11 = 0, ti12 = 0, ti2 = 0, ti3 = 0, ti4 = 0, ti5 = 0, ti6 = 0, ti7 = 0, ti8 = 0, ti9 = 0, tl1 = 0, tl10 = 0, tl11 = 0, tl12 = 0, tl2 = 0, tl3 = 0, tl4 = 0, tl5 = 0, tl6 = 0, tl7 = 0, tl8 = 0, tl9 = 0, vhmax = 0.0, vhmin = 0.0, vimax = 0.0, vimin = 0.0, vlmax = 0.0, vlmin = 0.0, vstmax = 0.0, vstmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.bwh1 = bwh1 - self.bwh2 = bwh2 - self.bwl1 = bwl1 - self.bwl2 = bwl2 - self.kh = kh - self.kh1 = kh1 - self.kh11 = kh11 - self.kh17 = kh17 - self.kh2 = kh2 - self.ki = ki - self.ki1 = ki1 - self.ki11 = ki11 - self.ki17 = ki17 - self.ki2 = ki2 - self.kl = kl - self.kl1 = kl1 - self.kl11 = kl11 - self.kl17 = kl17 - self.kl2 = kl2 - self.omeganh1 = omeganh1 - self.omeganh2 = omeganh2 - self.omeganl1 = omeganl1 - self.omeganl2 = omeganl2 - self.th1 = th1 - self.th10 = th10 - self.th11 = th11 - self.th12 = th12 - self.th2 = th2 - self.th3 = th3 - self.th4 = th4 - self.th5 = th5 - self.th6 = th6 - self.th7 = th7 - self.th8 = th8 - self.th9 = th9 - self.ti1 = ti1 - self.ti10 = ti10 - self.ti11 = ti11 - self.ti12 = ti12 - self.ti2 = ti2 - self.ti3 = ti3 - self.ti4 = ti4 - self.ti5 = ti5 - self.ti6 = ti6 - self.ti7 = ti7 - self.ti8 = ti8 - self.ti9 = ti9 - self.tl1 = tl1 - self.tl10 = tl10 - self.tl11 = tl11 - self.tl12 = tl12 - self.tl2 = tl2 - self.tl3 = tl3 - self.tl4 = tl4 - self.tl5 = tl5 - self.tl6 = tl6 - self.tl7 = tl7 - self.tl8 = tl8 - self.tl9 = tl9 - self.vhmax = vhmax - self.vhmin = vhmin - self.vimax = vimax - self.vimin = vimin - self.vlmax = vlmax - self.vlmin = vlmin - self.vstmax = vstmax - self.vstmin = vstmin - - def __str__(self): - str = 'class=PssIEEE4B\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class PssIEEE4B(PowerSystemStabilizerDynamics): + """ + The class represents IEEE Std 421.5-2005 type PSS2B power system stabilizer model. The PSS4B model represents a structure based on multiple working frequency bands. Three separate bands, respectively dedicated to the low-, intermediate- and high-frequency modes of oscillations, are used in this delta-omega (speed input) PSS. Reference: IEEE 4B 421.5-2005 Section 8.4. + + :bwh1: Notch filter 1 (high-frequency band): Three dB bandwidth (B). Default: 0.0 + :bwh2: Notch filter 2 (high-frequency band): Three dB bandwidth (B). Default: 0.0 + :bwl1: Notch filter 1 (low-frequency band): Three dB bandwidth (B). Default: 0.0 + :bwl2: Notch filter 2 (low-frequency band): Three dB bandwidth (B). Default: 0.0 + :kh: High band gain (K). Typical Value = 120. Default: 0.0 + :kh1: High band differential filter gain (K). Typical Value = 66. Default: 0.0 + :kh11: High band first lead-lag blocks coefficient (K). Typical Value = 1. Default: 0.0 + :kh17: High band first lead-lag blocks coefficient (K). Typical Value = 1. Default: 0.0 + :kh2: High band differential filter gain (K). Typical Value = 66. Default: 0.0 + :ki: Intermediate band gain (K). Typical Value = 30. Default: 0.0 + :ki1: Intermediate band differential filter gain (K). Typical Value = 66. Default: 0.0 + :ki11: Intermediate band first lead-lag blocks coefficient (K). Typical Value = 1. Default: 0.0 + :ki17: Intermediate band first lead-lag blocks coefficient (K). Typical Value = 1. Default: 0.0 + :ki2: Intermediate band differential filter gain (K). Typical Value = 66. Default: 0.0 + :kl: Low band gain (K). Typical Value = 7.5. Default: 0.0 + :kl1: Low band differential filter gain (K). Typical Value = 66. Default: 0.0 + :kl11: Low band first lead-lag blocks coefficient (K). Typical Value = 1. Default: 0.0 + :kl17: Low band first lead-lag blocks coefficient (K). Typical Value = 1. Default: 0.0 + :kl2: Low band differential filter gain (K). Typical Value = 66. Default: 0.0 + :omeganh1: Notch filter 1 (high-frequency band): filter frequency (omega). Default: 0.0 + :omeganh2: Notch filter 2 (high-frequency band): filter frequency (omega). Default: 0.0 + :omeganl1: Notch filter 1 (low-frequency band): filter frequency (omega). Default: 0.0 + :omeganl2: Notch filter 2 (low-frequency band): filter frequency (omega). Default: 0.0 + :th1: High band time constant (T). Typical Value = 0.01513. Default: 0.0 + :th10: High band time constant (T). Typical Value = 0. Default: 0.0 + :th11: High band time constant (T). Typical Value = 0. Default: 0.0 + :th12: High band time constant (T). Typical Value = 0. Default: 0.0 + :th2: High band time constant (T). Typical Value = 0.01816. Default: 0.0 + :th3: High band time constant (T). Typical Value = 0. Default: 0.0 + :th4: High band time constant (T). Typical Value = 0. Default: 0.0 + :th5: High band time constant (T). Typical Value = 0. Default: 0.0 + :th6: High band time constant (T). Typical Value = 0. Default: 0.0 + :th7: High band time constant (T). Typical Value = 0.01816. Default: 0.0 + :th8: High band time constant (T). Typical Value = 0.02179. Default: 0.0 + :th9: High band time constant (T). Typical Value = 0. Default: 0.0 + :ti1: Intermediate band time constant (T). Typical Value = 0.173. Default: 0.0 + :ti10: Intermediate band time constant (T). Typical Value = 0. Default: 0.0 + :ti11: Intermediate band time constant (T). Typical Value = 0. Default: 0.0 + :ti12: Intermediate band time constant (T). Typical Value = 0. Default: 0.0 + :ti2: Intermediate band time constant (T). Typical Value = 0.2075. Default: 0.0 + :ti3: Intermediate band time constant (T). Typical Value = 0. Default: 0.0 + :ti4: Intermediate band time constant (T). Typical Value = 0. Default: 0.0 + :ti5: Intermediate band time constant (T). Typical Value = 0. Default: 0.0 + :ti6: Intermediate band time constant (T). Typical Value = 0. Default: 0.0 + :ti7: Intermediate band time constant (T). Typical Value = 0.2075. Default: 0.0 + :ti8: Intermediate band time constant (T). Typical Value = 0.2491. Default: 0.0 + :ti9: Intermediate band time constant (T). Typical Value = 0. Default: 0.0 + :tl1: Low band time constant (T). Typical Value = 1.73. Default: 0.0 + :tl10: Low band time constant (T). Typical Value = 0. Default: 0.0 + :tl11: Low band time constant (T). Typical Value = 0. Default: 0.0 + :tl12: Low band time constant (T). Typical Value = 0. Default: 0.0 + :tl2: Low band time constant (T). Typical Value = 2.075. Default: 0.0 + :tl3: Low band time constant (T). Typical Value = 0. Default: 0.0 + :tl4: Low band time constant (T). Typical Value = 0. Default: 0.0 + :tl5: Low band time constant (T). Typical Value = 0. Default: 0.0 + :tl6: Low band time constant (T). Typical Value = 0. Default: 0.0 + :tl7: Low band time constant (T). Typical Value = 2.075. Default: 0.0 + :tl8: Low band time constant (T). Typical Value = 2.491. Default: 0.0 + :tl9: Low band time constant (T). Typical Value = 0. Default: 0.0 + :vhmax: High band output maximum limit (V). Typical Value = 0.6. Default: 0.0 + :vhmin: High band output minimum limit (V). Typical Value = -0.6. Default: 0.0 + :vimax: Intermediate band output maximum limit (V). Typical Value = 0.6. Default: 0.0 + :vimin: Intermediate band output minimum limit (V). Typical Value = -0.6. Default: 0.0 + :vlmax: Low band output maximum limit (V). Typical Value = 0.075. Default: 0.0 + :vlmin: Low band output minimum limit (V). Typical Value = -0.075. Default: 0.0 + :vstmax: PSS output maximum limit (V). Typical Value = 0.15. Default: 0.0 + :vstmin: PSS output minimum limit (V). Typical Value = -0.15. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "bwh1": [Profile.DY.value, ], + "bwh2": [Profile.DY.value, ], + "bwl1": [Profile.DY.value, ], + "bwl2": [Profile.DY.value, ], + "kh": [Profile.DY.value, ], + "kh1": [Profile.DY.value, ], + "kh11": [Profile.DY.value, ], + "kh17": [Profile.DY.value, ], + "kh2": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "ki1": [Profile.DY.value, ], + "ki11": [Profile.DY.value, ], + "ki17": [Profile.DY.value, ], + "ki2": [Profile.DY.value, ], + "kl": [Profile.DY.value, ], + "kl1": [Profile.DY.value, ], + "kl11": [Profile.DY.value, ], + "kl17": [Profile.DY.value, ], + "kl2": [Profile.DY.value, ], + "omeganh1": [Profile.DY.value, ], + "omeganh2": [Profile.DY.value, ], + "omeganl1": [Profile.DY.value, ], + "omeganl2": [Profile.DY.value, ], + "th1": [Profile.DY.value, ], + "th10": [Profile.DY.value, ], + "th11": [Profile.DY.value, ], + "th12": [Profile.DY.value, ], + "th2": [Profile.DY.value, ], + "th3": [Profile.DY.value, ], + "th4": [Profile.DY.value, ], + "th5": [Profile.DY.value, ], + "th6": [Profile.DY.value, ], + "th7": [Profile.DY.value, ], + "th8": [Profile.DY.value, ], + "th9": [Profile.DY.value, ], + "ti1": [Profile.DY.value, ], + "ti10": [Profile.DY.value, ], + "ti11": [Profile.DY.value, ], + "ti12": [Profile.DY.value, ], + "ti2": [Profile.DY.value, ], + "ti3": [Profile.DY.value, ], + "ti4": [Profile.DY.value, ], + "ti5": [Profile.DY.value, ], + "ti6": [Profile.DY.value, ], + "ti7": [Profile.DY.value, ], + "ti8": [Profile.DY.value, ], + "ti9": [Profile.DY.value, ], + "tl1": [Profile.DY.value, ], + "tl10": [Profile.DY.value, ], + "tl11": [Profile.DY.value, ], + "tl12": [Profile.DY.value, ], + "tl2": [Profile.DY.value, ], + "tl3": [Profile.DY.value, ], + "tl4": [Profile.DY.value, ], + "tl5": [Profile.DY.value, ], + "tl6": [Profile.DY.value, ], + "tl7": [Profile.DY.value, ], + "tl8": [Profile.DY.value, ], + "tl9": [Profile.DY.value, ], + "vhmax": [Profile.DY.value, ], + "vhmin": [Profile.DY.value, ], + "vimax": [Profile.DY.value, ], + "vimin": [Profile.DY.value, ], + "vlmax": [Profile.DY.value, ], + "vlmin": [Profile.DY.value, ], + "vstmax": [Profile.DY.value, ], + "vstmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, bwh1 = 0.0, bwh2 = 0.0, bwl1 = 0.0, bwl2 = 0.0, kh = 0.0, kh1 = 0.0, kh11 = 0.0, kh17 = 0.0, kh2 = 0.0, ki = 0.0, ki1 = 0.0, ki11 = 0.0, ki17 = 0.0, ki2 = 0.0, kl = 0.0, kl1 = 0.0, kl11 = 0.0, kl17 = 0.0, kl2 = 0.0, omeganh1 = 0.0, omeganh2 = 0.0, omeganl1 = 0.0, omeganl2 = 0.0, th1 = 0.0, th10 = 0.0, th11 = 0.0, th12 = 0.0, th2 = 0.0, th3 = 0.0, th4 = 0.0, th5 = 0.0, th6 = 0.0, th7 = 0.0, th8 = 0.0, th9 = 0.0, ti1 = 0.0, ti10 = 0.0, ti11 = 0.0, ti12 = 0.0, ti2 = 0.0, ti3 = 0.0, ti4 = 0.0, ti5 = 0.0, ti6 = 0.0, ti7 = 0.0, ti8 = 0.0, ti9 = 0.0, tl1 = 0.0, tl10 = 0.0, tl11 = 0.0, tl12 = 0.0, tl2 = 0.0, tl3 = 0.0, tl4 = 0.0, tl5 = 0.0, tl6 = 0.0, tl7 = 0.0, tl8 = 0.0, tl9 = 0.0, vhmax = 0.0, vhmin = 0.0, vimax = 0.0, vimin = 0.0, vlmax = 0.0, vlmin = 0.0, vstmax = 0.0, vstmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.bwh1 = bwh1 + self.bwh2 = bwh2 + self.bwl1 = bwl1 + self.bwl2 = bwl2 + self.kh = kh + self.kh1 = kh1 + self.kh11 = kh11 + self.kh17 = kh17 + self.kh2 = kh2 + self.ki = ki + self.ki1 = ki1 + self.ki11 = ki11 + self.ki17 = ki17 + self.ki2 = ki2 + self.kl = kl + self.kl1 = kl1 + self.kl11 = kl11 + self.kl17 = kl17 + self.kl2 = kl2 + self.omeganh1 = omeganh1 + self.omeganh2 = omeganh2 + self.omeganl1 = omeganl1 + self.omeganl2 = omeganl2 + self.th1 = th1 + self.th10 = th10 + self.th11 = th11 + self.th12 = th12 + self.th2 = th2 + self.th3 = th3 + self.th4 = th4 + self.th5 = th5 + self.th6 = th6 + self.th7 = th7 + self.th8 = th8 + self.th9 = th9 + self.ti1 = ti1 + self.ti10 = ti10 + self.ti11 = ti11 + self.ti12 = ti12 + self.ti2 = ti2 + self.ti3 = ti3 + self.ti4 = ti4 + self.ti5 = ti5 + self.ti6 = ti6 + self.ti7 = ti7 + self.ti8 = ti8 + self.ti9 = ti9 + self.tl1 = tl1 + self.tl10 = tl10 + self.tl11 = tl11 + self.tl12 = tl12 + self.tl2 = tl2 + self.tl3 = tl3 + self.tl4 = tl4 + self.tl5 = tl5 + self.tl6 = tl6 + self.tl7 = tl7 + self.tl8 = tl8 + self.tl9 = tl9 + self.vhmax = vhmax + self.vhmin = vhmin + self.vimax = vimax + self.vimin = vimin + self.vlmax = vlmax + self.vlmin = vlmin + self.vstmax = vstmax + self.vstmin = vstmin + + def __str__(self): + str = "class=PssIEEE4B\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PssPTIST1.py b/cimpy/cgmes_v2_4_15/PssPTIST1.py index 2335ce3f..ae638ce0 100644 --- a/cimpy/cgmes_v2_4_15/PssPTIST1.py +++ b/cimpy/cgmes_v2_4_15/PssPTIST1.py @@ -1,61 +1,63 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class PssPTIST1(PowerSystemStabilizerDynamics): - ''' - PTI Microprocessor-Based Stabilizer type 1. - - :m: (M). M=2*H. Typical Value = 5. Default: 0.0 - :tf: Time constant (Tf). Typical Value = 0.2. Default: 0 - :tp: Time constant (Tp). Typical Value = 0.2. Default: 0 - :t1: Time constant (T1). Typical Value = 0.3. Default: 0 - :t2: Time constant (T2). Typical Value = 1. Default: 0 - :t3: Time constant (T3). Typical Value = 0.2. Default: 0 - :t4: Time constant (T4). Typical Value = 0.05. Default: 0 - :k: Gain (K). Typical Value = 9. Default: 0.0 - :dtf: Time step frequency calculation (Dtf). Typical Value = 0.025. Default: 0 - :dtc: Time step related to activation of controls (Dtc). Typical Value = 0.025. Default: 0 - :dtp: Time step active power calculation (Dtp). Typical Value = 0.0125. Default: 0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'm': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - 'dtf': [cgmesProfile.DY.value, ], - 'dtc': [cgmesProfile.DY.value, ], - 'dtp': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, m = 0.0, tf = 0, tp = 0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, k = 0.0, dtf = 0, dtc = 0, dtp = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.m = m - self.tf = tf - self.tp = tp - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.k = k - self.dtf = dtf - self.dtc = dtc - self.dtp = dtp - - def __str__(self): - str = 'class=PssPTIST1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class PssPTIST1(PowerSystemStabilizerDynamics): + """ + PTI Microprocessor-Based Stabilizer type 1. + + :dtc: Time step related to activation of controls (Dtc). Typical Value = 0.025. Default: 0.0 + :dtf: Time step frequency calculation (Dtf). Typical Value = 0.025. Default: 0.0 + :dtp: Time step active power calculation (Dtp). Typical Value = 0.0125. Default: 0.0 + :k: Gain (K). Typical Value = 9. Default: 0.0 + :m: (M). M=2*H. Typical Value = 5. Default: 0.0 + :t1: Time constant (T1). Typical Value = 0.3. Default: 0.0 + :t2: Time constant (T2). Typical Value = 1. Default: 0.0 + :t3: Time constant (T3). Typical Value = 0.2. Default: 0.0 + :t4: Time constant (T4). Typical Value = 0.05. Default: 0.0 + :tf: Time constant (Tf). Typical Value = 0.2. Default: 0.0 + :tp: Time constant (Tp). Typical Value = 0.2. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "dtc": [Profile.DY.value, ], + "dtf": [Profile.DY.value, ], + "dtp": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "m": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, dtc = 0.0, dtf = 0.0, dtp = 0.0, k = 0.0, m = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, tf = 0.0, tp = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.dtc = dtc + self.dtf = dtf + self.dtp = dtp + self.k = k + self.m = m + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.tf = tf + self.tp = tp + + def __str__(self): + str = "class=PssPTIST1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PssPTIST3.py b/cimpy/cgmes_v2_4_15/PssPTIST3.py index 5526bea0..30043330 100644 --- a/cimpy/cgmes_v2_4_15/PssPTIST3.py +++ b/cimpy/cgmes_v2_4_15/PssPTIST3.py @@ -1,130 +1,132 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class PssPTIST3(PowerSystemStabilizerDynamics): - ''' - PTI Microprocessor-Based Stabilizer type 3. - - :m: (M). M=2*H. Typical Value = 5. Default: 0.0 - :tf: Time constant (Tf). Typical Value = 0.2. Default: 0 - :tp: Time constant (Tp). Typical Value = 0.2. Default: 0 - :t1: Time constant (T1). Typical Value = 0.3. Default: 0 - :t2: Time constant (T2). Typical Value = 1. Default: 0 - :t3: Time constant (T3). Typical Value = 0.2. Default: 0 - :t4: Time constant (T4). Typical Value = 0.05. Default: 0 - :k: Gain (K). Typical Value = 9. Default: 0.0 - :dtf: Time step frequency calculation (0.03 for 50 Hz) (Dtf). Typical Value = 0.025. Default: 0 - :dtc: Time step related to activation of controls (0.03 for 50 Hz) (Dtc). Typical Value = 0.025. Default: 0 - :dtp: Time step active power calculation (0.015 for 50 Hz) (Dtp). Typical Value = 0.0125. Default: 0 - :t5: Time constant (T5). Default: 0 - :t6: Time constant (T6). Default: 0 - :a0: Filter coefficient (A0). Default: 0.0 - :a1: Limiter (Al). Default: 0.0 - :a2: Filter coefficient (A2). Default: 0.0 - :b0: Filter coefficient (B0). Default: 0.0 - :b1: Filter coefficient (B1). Default: 0.0 - :b2: Filter coefficient (B2). Default: 0.0 - :a3: Filter coefficient (A3). Default: 0.0 - :a4: Filter coefficient (A4). Default: 0.0 - :a5: Filter coefficient (A5). Default: 0.0 - :b3: Filter coefficient (B3). Default: 0.0 - :b4: Filter coefficient (B4). Default: 0.0 - :b5: Filter coefficient (B5). Default: 0.0 - :athres: Threshold value above which output averaging will be bypassed (Athres). Typical Value = 0.005. Default: 0.0 - :dl: Limiter (Dl). Default: 0.0 - :al: Limiter (Al). Default: 0.0 - :lthres: Threshold value (Lthres). Default: 0.0 - :pmin: (Pmin). Default: 0.0 - :isw: Digital/analog output switch (Isw). true = produce analog output false = convert to digital output, using tap selection table. Default: False - :nav: Number of control outputs to average (Nav) (1 <= Nav <= 16). Typical Value = 4. Default: 0.0 - :ncl: Number of counts at limit to active limit function (Ncl) (>0). Default: 0.0 - :ncr: Number of counts until reset after limit function is triggered (Ncr). Default: 0.0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'm': [cgmesProfile.DY.value, ], - 'tf': [cgmesProfile.DY.value, ], - 'tp': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - 'dtf': [cgmesProfile.DY.value, ], - 'dtc': [cgmesProfile.DY.value, ], - 'dtp': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 'a0': [cgmesProfile.DY.value, ], - 'a1': [cgmesProfile.DY.value, ], - 'a2': [cgmesProfile.DY.value, ], - 'b0': [cgmesProfile.DY.value, ], - 'b1': [cgmesProfile.DY.value, ], - 'b2': [cgmesProfile.DY.value, ], - 'a3': [cgmesProfile.DY.value, ], - 'a4': [cgmesProfile.DY.value, ], - 'a5': [cgmesProfile.DY.value, ], - 'b3': [cgmesProfile.DY.value, ], - 'b4': [cgmesProfile.DY.value, ], - 'b5': [cgmesProfile.DY.value, ], - 'athres': [cgmesProfile.DY.value, ], - 'dl': [cgmesProfile.DY.value, ], - 'al': [cgmesProfile.DY.value, ], - 'lthres': [cgmesProfile.DY.value, ], - 'pmin': [cgmesProfile.DY.value, ], - 'isw': [cgmesProfile.DY.value, ], - 'nav': [cgmesProfile.DY.value, ], - 'ncl': [cgmesProfile.DY.value, ], - 'ncr': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, m = 0.0, tf = 0, tp = 0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, k = 0.0, dtf = 0, dtc = 0, dtp = 0, t5 = 0, t6 = 0, a0 = 0.0, a1 = 0.0, a2 = 0.0, b0 = 0.0, b1 = 0.0, b2 = 0.0, a3 = 0.0, a4 = 0.0, a5 = 0.0, b3 = 0.0, b4 = 0.0, b5 = 0.0, athres = 0.0, dl = 0.0, al = 0.0, lthres = 0.0, pmin = 0.0, isw = False, nav = 0.0, ncl = 0.0, ncr = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.m = m - self.tf = tf - self.tp = tp - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.k = k - self.dtf = dtf - self.dtc = dtc - self.dtp = dtp - self.t5 = t5 - self.t6 = t6 - self.a0 = a0 - self.a1 = a1 - self.a2 = a2 - self.b0 = b0 - self.b1 = b1 - self.b2 = b2 - self.a3 = a3 - self.a4 = a4 - self.a5 = a5 - self.b3 = b3 - self.b4 = b4 - self.b5 = b5 - self.athres = athres - self.dl = dl - self.al = al - self.lthres = lthres - self.pmin = pmin - self.isw = isw - self.nav = nav - self.ncl = ncl - self.ncr = ncr - - def __str__(self): - str = 'class=PssPTIST3\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class PssPTIST3(PowerSystemStabilizerDynamics): + """ + PTI Microprocessor-Based Stabilizer type 3. + + :a0: Filter coefficient (A0). Default: 0.0 + :a1: Limiter (Al). Default: 0.0 + :a2: Filter coefficient (A2). Default: 0.0 + :a3: Filter coefficient (A3). Default: 0.0 + :a4: Filter coefficient (A4). Default: 0.0 + :a5: Filter coefficient (A5). Default: 0.0 + :al: Limiter (Al). Default: 0.0 + :athres: Threshold value above which output averaging will be bypassed (Athres). Typical Value = 0.005. Default: 0.0 + :b0: Filter coefficient (B0). Default: 0.0 + :b1: Filter coefficient (B1). Default: 0.0 + :b2: Filter coefficient (B2). Default: 0.0 + :b3: Filter coefficient (B3). Default: 0.0 + :b4: Filter coefficient (B4). Default: 0.0 + :b5: Filter coefficient (B5). Default: 0.0 + :dl: Limiter (Dl). Default: 0.0 + :dtc: Time step related to activation of controls (0.03 for 50 Hz) (Dtc). Typical Value = 0.025. Default: 0.0 + :dtf: Time step frequency calculation (0.03 for 50 Hz) (Dtf). Typical Value = 0.025. Default: 0.0 + :dtp: Time step active power calculation (0.015 for 50 Hz) (Dtp). Typical Value = 0.0125. Default: 0.0 + :isw: Digital/analog output switch (Isw). true = produce analog output false = convert to digital output, using tap selection table. Default: False + :k: Gain (K). Typical Value = 9. Default: 0.0 + :lthres: Threshold value (Lthres). Default: 0.0 + :m: (M). M=2*H. Typical Value = 5. Default: 0.0 + :nav: Number of control outputs to average (Nav) (1 <= Nav <= 16). Typical Value = 4. Default: 0.0 + :ncl: Number of counts at limit to active limit function (Ncl) (>0). Default: 0.0 + :ncr: Number of counts until reset after limit function is triggered (Ncr). Default: 0.0 + :pmin: (Pmin). Default: 0.0 + :t1: Time constant (T1). Typical Value = 0.3. Default: 0.0 + :t2: Time constant (T2). Typical Value = 1. Default: 0.0 + :t3: Time constant (T3). Typical Value = 0.2. Default: 0.0 + :t4: Time constant (T4). Typical Value = 0.05. Default: 0.0 + :t5: Time constant (T5). Default: 0.0 + :t6: Time constant (T6). Default: 0.0 + :tf: Time constant (Tf). Typical Value = 0.2. Default: 0.0 + :tp: Time constant (Tp). Typical Value = 0.2. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "a0": [Profile.DY.value, ], + "a1": [Profile.DY.value, ], + "a2": [Profile.DY.value, ], + "a3": [Profile.DY.value, ], + "a4": [Profile.DY.value, ], + "a5": [Profile.DY.value, ], + "al": [Profile.DY.value, ], + "athres": [Profile.DY.value, ], + "b0": [Profile.DY.value, ], + "b1": [Profile.DY.value, ], + "b2": [Profile.DY.value, ], + "b3": [Profile.DY.value, ], + "b4": [Profile.DY.value, ], + "b5": [Profile.DY.value, ], + "dl": [Profile.DY.value, ], + "dtc": [Profile.DY.value, ], + "dtf": [Profile.DY.value, ], + "dtp": [Profile.DY.value, ], + "isw": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "lthres": [Profile.DY.value, ], + "m": [Profile.DY.value, ], + "nav": [Profile.DY.value, ], + "ncl": [Profile.DY.value, ], + "ncr": [Profile.DY.value, ], + "pmin": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "tf": [Profile.DY.value, ], + "tp": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, a0 = 0.0, a1 = 0.0, a2 = 0.0, a3 = 0.0, a4 = 0.0, a5 = 0.0, al = 0.0, athres = 0.0, b0 = 0.0, b1 = 0.0, b2 = 0.0, b3 = 0.0, b4 = 0.0, b5 = 0.0, dl = 0.0, dtc = 0.0, dtf = 0.0, dtp = 0.0, isw = False, k = 0.0, lthres = 0.0, m = 0.0, nav = 0.0, ncl = 0.0, ncr = 0.0, pmin = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, t6 = 0.0, tf = 0.0, tp = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.a0 = a0 + self.a1 = a1 + self.a2 = a2 + self.a3 = a3 + self.a4 = a4 + self.a5 = a5 + self.al = al + self.athres = athres + self.b0 = b0 + self.b1 = b1 + self.b2 = b2 + self.b3 = b3 + self.b4 = b4 + self.b5 = b5 + self.dl = dl + self.dtc = dtc + self.dtf = dtf + self.dtp = dtp + self.isw = isw + self.k = k + self.lthres = lthres + self.m = m + self.nav = nav + self.ncl = ncl + self.ncr = ncr + self.pmin = pmin + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.t6 = t6 + self.tf = tf + self.tp = tp + + def __str__(self): + str = "class=PssPTIST3\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PssSB4.py b/cimpy/cgmes_v2_4_15/PssSB4.py index 50bbc9d7..f4f28d4f 100644 --- a/cimpy/cgmes_v2_4_15/PssSB4.py +++ b/cimpy/cgmes_v2_4_15/PssSB4.py @@ -1,61 +1,63 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class PssSB4(PowerSystemStabilizerDynamics): - ''' - Power sensitive stabilizer model. - - :tt: Time constant (Tt). Default: 0 - :kx: Gain (Kx). Default: 0.0 - :tx2: Time constant (Tx2). Default: 0 - :ta: Time constant (Ta). Default: 0 - :tx1: Reset time constant (Tx1). Default: 0 - :tb: Time constant (Tb). Default: 0 - :tc: Time constant (Tc). Default: 0 - :td: Time constant (Td). Default: 0 - :te: Time constant (Te). Default: 0 - :vsmax: Limiter (Vsmax). Default: 0.0 - :vsmin: Limiter (Vsmin). Default: 0.0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tt': [cgmesProfile.DY.value, ], - 'kx': [cgmesProfile.DY.value, ], - 'tx2': [cgmesProfile.DY.value, ], - 'ta': [cgmesProfile.DY.value, ], - 'tx1': [cgmesProfile.DY.value, ], - 'tb': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - 'td': [cgmesProfile.DY.value, ], - 'te': [cgmesProfile.DY.value, ], - 'vsmax': [cgmesProfile.DY.value, ], - 'vsmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, tt = 0, kx = 0.0, tx2 = 0, ta = 0, tx1 = 0, tb = 0, tc = 0, td = 0, te = 0, vsmax = 0.0, vsmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tt = tt - self.kx = kx - self.tx2 = tx2 - self.ta = ta - self.tx1 = tx1 - self.tb = tb - self.tc = tc - self.td = td - self.te = te - self.vsmax = vsmax - self.vsmin = vsmin - - def __str__(self): - str = 'class=PssSB4\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class PssSB4(PowerSystemStabilizerDynamics): + """ + Power sensitive stabilizer model. + + :kx: Gain (Kx). Default: 0.0 + :ta: Time constant (Ta). Default: 0.0 + :tb: Time constant (Tb). Default: 0.0 + :tc: Time constant (Tc). Default: 0.0 + :td: Time constant (Td). Default: 0.0 + :te: Time constant (Te). Default: 0.0 + :tt: Time constant (Tt). Default: 0.0 + :tx1: Reset time constant (Tx1). Default: 0.0 + :tx2: Time constant (Tx2). Default: 0.0 + :vsmax: Limiter (Vsmax). Default: 0.0 + :vsmin: Limiter (Vsmin). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "kx": [Profile.DY.value, ], + "ta": [Profile.DY.value, ], + "tb": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "td": [Profile.DY.value, ], + "te": [Profile.DY.value, ], + "tt": [Profile.DY.value, ], + "tx1": [Profile.DY.value, ], + "tx2": [Profile.DY.value, ], + "vsmax": [Profile.DY.value, ], + "vsmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, kx = 0.0, ta = 0.0, tb = 0.0, tc = 0.0, td = 0.0, te = 0.0, tt = 0.0, tx1 = 0.0, tx2 = 0.0, vsmax = 0.0, vsmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.kx = kx + self.ta = ta + self.tb = tb + self.tc = tc + self.td = td + self.te = te + self.tt = tt + self.tx1 = tx1 + self.tx2 = tx2 + self.vsmax = vsmax + self.vsmin = vsmin + + def __str__(self): + str = "class=PssSB4\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PssSH.py b/cimpy/cgmes_v2_4_15/PssSH.py index 948dff6c..a4486329 100644 --- a/cimpy/cgmes_v2_4_15/PssSH.py +++ b/cimpy/cgmes_v2_4_15/PssSH.py @@ -1,67 +1,69 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class PssSH(PowerSystemStabilizerDynamics): - ''' - Model for Siemens "H infinity" power system stabilizer with generator electrical power input. - - :k: Main gain (K). Typical Value = 1. Default: 0.0 - :k0: Gain 0 (K0). Typical Value = 0.012. Default: 0.0 - :k1: Gain 1 (K1). Typical Value = 0.488. Default: 0.0 - :k2: Gain 2 (K2). Typical Value = 0.064. Default: 0.0 - :k3: Gain 3 (K3). Typical Value = 0.224. Default: 0.0 - :k4: Gain 4 (K4). Typical Value = 0.1. Default: 0.0 - :td: Input time constant (Td). Typical Value = 10. Default: 0 - :t1: Time constant 1 (T1). Typical Value = 0.076. Default: 0 - :t2: Time constant 2 (T2). Typical Value = 0.086. Default: 0 - :t3: Time constant 3 (T3). Typical Value = 1.068. Default: 0 - :t4: Time constant 4 (T4). Typical Value = 1.913. Default: 0 - :vsmax: Output maximum limit (Vsmax). Typical Value = 0.1. Default: 0.0 - :vsmin: Output minimum limit (Vsmin). Typical Value = -0.1. Default: 0.0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - 'k0': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - 'k3': [cgmesProfile.DY.value, ], - 'k4': [cgmesProfile.DY.value, ], - 'td': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 'vsmax': [cgmesProfile.DY.value, ], - 'vsmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, k = 0.0, k0 = 0.0, k1 = 0.0, k2 = 0.0, k3 = 0.0, k4 = 0.0, td = 0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, vsmax = 0.0, vsmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.k = k - self.k0 = k0 - self.k1 = k1 - self.k2 = k2 - self.k3 = k3 - self.k4 = k4 - self.td = td - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.vsmax = vsmax - self.vsmin = vsmin - - def __str__(self): - str = 'class=PssSH\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class PssSH(PowerSystemStabilizerDynamics): + """ + Model for Siemens "H infinity" power system stabilizer with generator electrical power input. + + :k: Main gain (K). Typical Value = 1. Default: 0.0 + :k0: Gain 0 (K0). Typical Value = 0.012. Default: 0.0 + :k1: Gain 1 (K1). Typical Value = 0.488. Default: 0.0 + :k2: Gain 2 (K2). Typical Value = 0.064. Default: 0.0 + :k3: Gain 3 (K3). Typical Value = 0.224. Default: 0.0 + :k4: Gain 4 (K4). Typical Value = 0.1. Default: 0.0 + :t1: Time constant 1 (T1). Typical Value = 0.076. Default: 0.0 + :t2: Time constant 2 (T2). Typical Value = 0.086. Default: 0.0 + :t3: Time constant 3 (T3). Typical Value = 1.068. Default: 0.0 + :t4: Time constant 4 (T4). Typical Value = 1.913. Default: 0.0 + :td: Input time constant (Td). Typical Value = 10. Default: 0.0 + :vsmax: Output maximum limit (Vsmax). Typical Value = 0.1. Default: 0.0 + :vsmin: Output minimum limit (Vsmin). Typical Value = -0.1. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "k0": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "k3": [Profile.DY.value, ], + "k4": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "td": [Profile.DY.value, ], + "vsmax": [Profile.DY.value, ], + "vsmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, k = 0.0, k0 = 0.0, k1 = 0.0, k2 = 0.0, k3 = 0.0, k4 = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, td = 0.0, vsmax = 0.0, vsmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.k = k + self.k0 = k0 + self.k1 = k1 + self.k2 = k2 + self.k3 = k3 + self.k4 = k4 + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.td = td + self.vsmax = vsmax + self.vsmin = vsmin + + def __str__(self): + str = "class=PssSH\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PssSK.py b/cimpy/cgmes_v2_4_15/PssSK.py index 85d81f2a..e6d2bf97 100644 --- a/cimpy/cgmes_v2_4_15/PssSK.py +++ b/cimpy/cgmes_v2_4_15/PssSK.py @@ -1,61 +1,63 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class PssSK(PowerSystemStabilizerDynamics): - ''' - PSS Slovakian type - three inputs. - - :k1: Gain P (K1). Typical Value = -0.3. Default: 0.0 - :k2: Gain fe (K2). Typical Value = -0.15. Default: 0.0 - :k3: Gain If (K3). Typical Value = 10. Default: 0.0 - :t1: Denominator time constant (T1). Typical Value = 0.3. Default: 0 - :t2: Filter time constant (T2). Typical Value = 0.35. Default: 0 - :t3: Denominator time constant (T3). Typical Value = 0.22. Default: 0 - :t4: Filter time constant (T4). Typical Value = 0.02. Default: 0 - :t5: Denominator time constant (T5). Typical Value = 0.02. Default: 0 - :t6: Filter time constant (T6). Typical Value = 0.02. Default: 0 - :vsmax: Stabilizer output max limit (Vsmax). Typical Value = 0.4. Default: 0.0 - :vsmin: Stabilizer output min limit (Vsmin). Typical Value = -0.4. Default: 0.0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - 'k3': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 'vsmax': [cgmesProfile.DY.value, ], - 'vsmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, k1 = 0.0, k2 = 0.0, k3 = 0.0, t1 = 0, t2 = 0, t3 = 0, t4 = 0, t5 = 0, t6 = 0, vsmax = 0.0, vsmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.k1 = k1 - self.k2 = k2 - self.k3 = k3 - self.t1 = t1 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.t5 = t5 - self.t6 = t6 - self.vsmax = vsmax - self.vsmin = vsmin - - def __str__(self): - str = 'class=PssSK\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class PssSK(PowerSystemStabilizerDynamics): + """ + PSS Slovakian type - three inputs. + + :k1: Gain P (K1). Typical Value = -0.3. Default: 0.0 + :k2: Gain fe (K2). Typical Value = -0.15. Default: 0.0 + :k3: Gain If (K3). Typical Value = 10. Default: 0.0 + :t1: Denominator time constant (T1). Typical Value = 0.3. Default: 0.0 + :t2: Filter time constant (T2). Typical Value = 0.35. Default: 0.0 + :t3: Denominator time constant (T3). Typical Value = 0.22. Default: 0.0 + :t4: Filter time constant (T4). Typical Value = 0.02. Default: 0.0 + :t5: Denominator time constant (T5). Typical Value = 0.02. Default: 0.0 + :t6: Filter time constant (T6). Typical Value = 0.02. Default: 0.0 + :vsmax: Stabilizer output max limit (Vsmax). Typical Value = 0.4. Default: 0.0 + :vsmin: Stabilizer output min limit (Vsmin). Typical Value = -0.4. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "k3": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "vsmax": [Profile.DY.value, ], + "vsmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, k1 = 0.0, k2 = 0.0, k3 = 0.0, t1 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, t6 = 0.0, vsmax = 0.0, vsmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.k1 = k1 + self.k2 = k2 + self.k3 = k3 + self.t1 = t1 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.t6 = t6 + self.vsmax = vsmax + self.vsmin = vsmin + + def __str__(self): + str = "class=PssSK\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/PssWECC.py b/cimpy/cgmes_v2_4_15/PssWECC.py index 4bf7d190..7f068bc5 100644 --- a/cimpy/cgmes_v2_4_15/PssWECC.py +++ b/cimpy/cgmes_v2_4_15/PssWECC.py @@ -1,82 +1,84 @@ -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics - - -class PssWECC(PowerSystemStabilizerDynamics): - ''' - Dual input Power System Stabilizer, based on IEEE type 2, with modified output limiter defined by WECC (Western Electricity Coordinating Council, USA). - - :inputSignal1Type: Type of input signal #1. Default: None - :inputSignal2Type: Type of input signal #2. Default: None - :k1: Input signal 1 gain (K). Default: 0.0 - :t1: Input signal 1 transducer time constant (T). Default: 0 - :k2: Input signal 2 gain (K). Default: 0.0 - :t2: Input signal 2 transducer time constant (T). Default: 0 - :t3: Stabilizer washout time constant (T). Default: 0 - :t4: Stabilizer washout time lag constant (T) (>0). Default: 0 - :t5: Lead time constant (T). Default: 0 - :t6: Lag time constant (T). Default: 0 - :t7: Lead time constant (T). Default: 0 - :t8: Lag time constant (T). Default: 0 - :t10: Lag time constant (T). Default: 0 - :t9: Lead time constant (T). Default: 0 - :vsmax: Maximum output signal (Vsmax). Default: 0.0 - :vsmin: Minimum output signal (Vsmin). Default: 0.0 - :vcu: Maximum value for voltage compensator output (V). Default: 0.0 - :vcl: Minimum value for voltage compensator output (V). Default: 0.0 - ''' - - cgmesProfile = PowerSystemStabilizerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'inputSignal1Type': [cgmesProfile.DY.value, ], - 'inputSignal2Type': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 't3': [cgmesProfile.DY.value, ], - 't4': [cgmesProfile.DY.value, ], - 't5': [cgmesProfile.DY.value, ], - 't6': [cgmesProfile.DY.value, ], - 't7': [cgmesProfile.DY.value, ], - 't8': [cgmesProfile.DY.value, ], - 't10': [cgmesProfile.DY.value, ], - 't9': [cgmesProfile.DY.value, ], - 'vsmax': [cgmesProfile.DY.value, ], - 'vsmin': [cgmesProfile.DY.value, ], - 'vcu': [cgmesProfile.DY.value, ], - 'vcl': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemStabilizerDynamics: \n' + PowerSystemStabilizerDynamics.__doc__ - - def __init__(self, inputSignal1Type = None, inputSignal2Type = None, k1 = 0.0, t1 = 0, k2 = 0.0, t2 = 0, t3 = 0, t4 = 0, t5 = 0, t6 = 0, t7 = 0, t8 = 0, t10 = 0, t9 = 0, vsmax = 0.0, vsmin = 0.0, vcu = 0.0, vcl = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.inputSignal1Type = inputSignal1Type - self.inputSignal2Type = inputSignal2Type - self.k1 = k1 - self.t1 = t1 - self.k2 = k2 - self.t2 = t2 - self.t3 = t3 - self.t4 = t4 - self.t5 = t5 - self.t6 = t6 - self.t7 = t7 - self.t8 = t8 - self.t10 = t10 - self.t9 = t9 - self.vsmax = vsmax - self.vsmin = vsmin - self.vcu = vcu - self.vcl = vcl - - def __str__(self): - str = 'class=PssWECC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics +from .CGMESProfile import Profile + + +class PssWECC(PowerSystemStabilizerDynamics): + """ + Dual input Power System Stabilizer, based on IEEE type 2, with modified output limiter defined by WECC (Western Electricity Coordinating Council, USA). + + :inputSignal1Type: Type of input signal #1. Default: None + :inputSignal2Type: Type of input signal #2. Default: None + :k1: Input signal 1 gain (K). Default: 0.0 + :k2: Input signal 2 gain (K). Default: 0.0 + :t1: Input signal 1 transducer time constant (T). Default: 0.0 + :t10: Lag time constant (T). Default: 0.0 + :t2: Input signal 2 transducer time constant (T). Default: 0.0 + :t3: Stabilizer washout time constant (T). Default: 0.0 + :t4: Stabilizer washout time lag constant (T) (>0). Default: 0.0 + :t5: Lead time constant (T). Default: 0.0 + :t6: Lag time constant (T). Default: 0.0 + :t7: Lead time constant (T). Default: 0.0 + :t8: Lag time constant (T). Default: 0.0 + :t9: Lead time constant (T). Default: 0.0 + :vcl: Minimum value for voltage compensator output (V). Default: 0.0 + :vcu: Maximum value for voltage compensator output (V). Default: 0.0 + :vsmax: Maximum output signal (Vsmax). Default: 0.0 + :vsmin: Minimum output signal (Vsmin). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "inputSignal1Type": [Profile.DY.value, ], + "inputSignal2Type": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t10": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "t3": [Profile.DY.value, ], + "t4": [Profile.DY.value, ], + "t5": [Profile.DY.value, ], + "t6": [Profile.DY.value, ], + "t7": [Profile.DY.value, ], + "t8": [Profile.DY.value, ], + "t9": [Profile.DY.value, ], + "vcl": [Profile.DY.value, ], + "vcu": [Profile.DY.value, ], + "vsmax": [Profile.DY.value, ], + "vsmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class PowerSystemStabilizerDynamics:\n" + PowerSystemStabilizerDynamics.__doc__ + + def __init__(self, inputSignal1Type = None, inputSignal2Type = None, k1 = 0.0, k2 = 0.0, t1 = 0.0, t10 = 0.0, t2 = 0.0, t3 = 0.0, t4 = 0.0, t5 = 0.0, t6 = 0.0, t7 = 0.0, t8 = 0.0, t9 = 0.0, vcl = 0.0, vcu = 0.0, vsmax = 0.0, vsmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.inputSignal1Type = inputSignal1Type + self.inputSignal2Type = inputSignal2Type + self.k1 = k1 + self.k2 = k2 + self.t1 = t1 + self.t10 = t10 + self.t2 = t2 + self.t3 = t3 + self.t4 = t4 + self.t5 = t5 + self.t6 = t6 + self.t7 = t7 + self.t8 = t8 + self.t9 = t9 + self.vcl = vcl + self.vcu = vcu + self.vsmax = vsmax + self.vsmin = vsmin + + def __str__(self): + str = "class=PssWECC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Quality61850.py b/cimpy/cgmes_v2_4_15/Quality61850.py index a0930b86..e643a5a4 100644 --- a/cimpy/cgmes_v2_4_15/Quality61850.py +++ b/cimpy/cgmes_v2_4_15/Quality61850.py @@ -1,63 +1,64 @@ -from .Base import Base - - -class Quality61850(Base): - ''' - Quality flags in this class are as defined in IEC 61850, except for estimatorReplaced, which has been included in this class for convenience. - - :badReference: Measurement value may be incorrect due to a reference being out of calibration. Default: False - :estimatorReplaced: Value has been replaced by State Estimator. estimatorReplaced is not an IEC61850 quality bit but has been put in this class for convenience. Default: False - :failure: This identifier indicates that a supervision function has detected an internal or external failure, e.g. communication failure. Default: False - :oldData: Measurement value is old and possibly invalid, as it has not been successfully updated during a specified time interval. Default: False - :operatorBlocked: Measurement value is blocked and hence unavailable for transmission. Default: False - :oscillatory: To prevent some overload of the communication it is sensible to detect and suppress oscillating (fast changing) binary inputs. If a signal changes in a defined time (tosc) twice in the same direction (from 0 to 1 or from 1 to 0) then oscillation is detected and the detail quality identifier `oscillatory` is set. If it is detected a configured numbers of transient changes could be passed by. In this time the validity status `questionable` is set. If after this defined numbers of changes the signal is still in the oscillating state the value shall be set either to the opposite state of the previous stable value or to a defined default value. In this case the validity status `questionable` is reset and `invalid` is set as long as the signal is oscillating. If it is configured such that no transient changes should be passed by then the validity status `invalid` is set immediately in addition to the detail quality identifier `oscillatory` (used for status information only). Default: False - :outOfRange: Measurement value is beyond a predefined range of value. Default: False - :overFlow: Measurement value is beyond the capability of being represented properly. For example, a counter value overflows from maximum count back to a value of zero. Default: False - :source: Source gives information related to the origin of a value. The value may be acquired from the process, defaulted or substituted. Default: None - :suspect: A correlation function has detected that the value is not consitent with other values. Typically set by a network State Estimator. Default: False - :test: Measurement value is transmitted for test purposes. Default: False - :validity: Validity of the measurement value. Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'badReference': [cgmesProfile.EQ.value, ], - 'estimatorReplaced': [cgmesProfile.EQ.value, ], - 'failure': [cgmesProfile.EQ.value, ], - 'oldData': [cgmesProfile.EQ.value, ], - 'operatorBlocked': [cgmesProfile.EQ.value, ], - 'oscillatory': [cgmesProfile.EQ.value, ], - 'outOfRange': [cgmesProfile.EQ.value, ], - 'overFlow': [cgmesProfile.EQ.value, ], - 'source': [cgmesProfile.EQ.value, ], - 'suspect': [cgmesProfile.EQ.value, ], - 'test': [cgmesProfile.EQ.value, ], - 'validity': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, badReference = False, estimatorReplaced = False, failure = False, oldData = False, operatorBlocked = False, oscillatory = False, outOfRange = False, overFlow = False, source = None, suspect = False, test = False, validity = None, ): - - self.badReference = badReference - self.estimatorReplaced = estimatorReplaced - self.failure = failure - self.oldData = oldData - self.operatorBlocked = operatorBlocked - self.oscillatory = oscillatory - self.outOfRange = outOfRange - self.overFlow = overFlow - self.source = source - self.suspect = suspect - self.test = test - self.validity = validity - - def __str__(self): - str = 'class=Quality61850\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Quality61850(Base): + """ + Quality flags in this class are as defined in IEC 61850, except for estimatorReplaced, which has been included in this class for convenience. + + :badReference: Measurement value may be incorrect due to a reference being out of calibration. Default: False + :estimatorReplaced: Value has been replaced by State Estimator. estimatorReplaced is not an IEC61850 quality bit but has been put in this class for convenience. Default: False + :failure: This identifier indicates that a supervision function has detected an internal or external failure, e.g. communication failure. Default: False + :oldData: Measurement value is old and possibly invalid, as it has not been successfully updated during a specified time interval. Default: False + :operatorBlocked: Measurement value is blocked and hence unavailable for transmission. Default: False + :oscillatory: To prevent some overload of the communication it is sensible to detect and suppress oscillating (fast changing) binary inputs. If a signal changes in a defined time (tosc) twice in the same direction (from 0 to 1 or from 1 to 0) then oscillation is detected and the detail quality identifier `oscillatory` is set. If it is detected a configured numbers of transient changes could be passed by. In this time the validity status `questionable` is set. If after this defined numbers of changes the signal is still in the oscillating state the value shall be set either to the opposite state of the previous stable value or to a defined default value. In this case the validity status `questionable` is reset and `invalid` is set as long as the signal is oscillating. If it is configured such that no transient changes should be passed by then the validity status `invalid` is set immediately in addition to the detail quality identifier `oscillatory` (used for status information only). Default: False + :outOfRange: Measurement value is beyond a predefined range of value. Default: False + :overFlow: Measurement value is beyond the capability of being represented properly. For example, a counter value overflows from maximum count back to a value of zero. Default: False + :source: Source gives information related to the origin of a value. The value may be acquired from the process, defaulted or substituted. Default: None + :suspect: A correlation function has detected that the value is not consitent with other values. Typically set by a network State Estimator. Default: False + :test: Measurement value is transmitted for test purposes. Default: False + :validity: Validity of the measurement value. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "badReference": [Profile.EQ.value, ], + "estimatorReplaced": [Profile.EQ.value, ], + "failure": [Profile.EQ.value, ], + "oldData": [Profile.EQ.value, ], + "operatorBlocked": [Profile.EQ.value, ], + "oscillatory": [Profile.EQ.value, ], + "outOfRange": [Profile.EQ.value, ], + "overFlow": [Profile.EQ.value, ], + "source": [Profile.EQ.value, ], + "suspect": [Profile.EQ.value, ], + "test": [Profile.EQ.value, ], + "validity": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, badReference = False, estimatorReplaced = False, failure = False, oldData = False, operatorBlocked = False, oscillatory = False, outOfRange = False, overFlow = False, source = None, suspect = False, test = False, validity = None): + + self.badReference = badReference + self.estimatorReplaced = estimatorReplaced + self.failure = failure + self.oldData = oldData + self.operatorBlocked = operatorBlocked + self.oscillatory = oscillatory + self.outOfRange = outOfRange + self.overFlow = overFlow + self.source = source + self.suspect = suspect + self.test = test + self.validity = validity + + def __str__(self): + str = "class=Quality61850\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RaiseLowerCommand.py b/cimpy/cgmes_v2_4_15/RaiseLowerCommand.py index aefc385d..7e7ed418 100644 --- a/cimpy/cgmes_v2_4_15/RaiseLowerCommand.py +++ b/cimpy/cgmes_v2_4_15/RaiseLowerCommand.py @@ -1,31 +1,33 @@ -from .AnalogControl import AnalogControl - - -class RaiseLowerCommand(AnalogControl): - ''' - An analog control that increase or decrease a set point value with pulses. - - :ValueAliasSet: The ValueAliasSet used for translation of a Control value to a name. Default: None - ''' - - cgmesProfile = AnalogControl.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'ValueAliasSet': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class AnalogControl: \n' + AnalogControl.__doc__ - - def __init__(self, ValueAliasSet = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ValueAliasSet = ValueAliasSet - - def __str__(self): - str = 'class=RaiseLowerCommand\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .AnalogControl import AnalogControl +from .CGMESProfile import Profile + + +class RaiseLowerCommand(AnalogControl): + """ + An analog control that increase or decrease a set point value with pulses. + + :ValueAliasSet: The ValueAliasSet used for translation of a Control value to a name. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "ValueAliasSet": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class AnalogControl:\n" + AnalogControl.__doc__ + + def __init__(self, ValueAliasSet = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ValueAliasSet = ValueAliasSet + + def __str__(self): + str = "class=RaiseLowerCommand\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RatioTapChanger.py b/cimpy/cgmes_v2_4_15/RatioTapChanger.py index 7902c21b..3582367d 100644 --- a/cimpy/cgmes_v2_4_15/RatioTapChanger.py +++ b/cimpy/cgmes_v2_4_15/RatioTapChanger.py @@ -1,40 +1,42 @@ -from .TapChanger import TapChanger - - -class RatioTapChanger(TapChanger): - ''' - A tap changer that changes the voltage ratio impacting the voltage magnitude but not the phase angle across the transformer. - - :tculControlMode: Specifies the regulation control mode (voltage or reactive) of the RatioTapChanger. Default: None - :stepVoltageIncrement: Tap step increment, in per cent of nominal voltage, per step position. Default: 0.0 - :RatioTapChangerTable: The ratio tap changer of this tap ratio table. Default: None - :TransformerEnd: Ratio tap changer associated with this transformer end. Default: None - ''' - - cgmesProfile = TapChanger.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'tculControlMode': [cgmesProfile.EQ.value, ], - 'stepVoltageIncrement': [cgmesProfile.EQ.value, ], - 'RatioTapChangerTable': [cgmesProfile.EQ.value, ], - 'TransformerEnd': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TapChanger: \n' + TapChanger.__doc__ - - def __init__(self, tculControlMode = None, stepVoltageIncrement = 0.0, RatioTapChangerTable = None, TransformerEnd = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tculControlMode = tculControlMode - self.stepVoltageIncrement = stepVoltageIncrement - self.RatioTapChangerTable = RatioTapChangerTable - self.TransformerEnd = TransformerEnd - - def __str__(self): - str = 'class=RatioTapChanger\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TapChanger import TapChanger +from .CGMESProfile import Profile + + +class RatioTapChanger(TapChanger): + """ + A tap changer that changes the voltage ratio impacting the voltage magnitude but not the phase angle across the transformer. + + :RatioTapChangerTable: The ratio tap changer of this tap ratio table. Default: None + :TransformerEnd: Ratio tap changer associated with this transformer end. Default: None + :stepVoltageIncrement: Tap step increment, in per cent of nominal voltage, per step position. Default: 0.0 + :tculControlMode: Specifies the regulation control mode (voltage or reactive) of the RatioTapChanger. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "RatioTapChangerTable": [Profile.EQ.value, ], + "TransformerEnd": [Profile.EQ.value, ], + "stepVoltageIncrement": [Profile.EQ.value, ], + "tculControlMode": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class TapChanger:\n" + TapChanger.__doc__ + + def __init__(self, RatioTapChangerTable = None, TransformerEnd = None, stepVoltageIncrement = 0.0, tculControlMode = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.RatioTapChangerTable = RatioTapChangerTable + self.TransformerEnd = TransformerEnd + self.stepVoltageIncrement = stepVoltageIncrement + self.tculControlMode = tculControlMode + + def __str__(self): + str = "class=RatioTapChanger\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RatioTapChangerTable.py b/cimpy/cgmes_v2_4_15/RatioTapChangerTable.py index a0384288..e75149f2 100644 --- a/cimpy/cgmes_v2_4_15/RatioTapChangerTable.py +++ b/cimpy/cgmes_v2_4_15/RatioTapChangerTable.py @@ -1,34 +1,36 @@ -from .IdentifiedObject import IdentifiedObject - - -class RatioTapChangerTable(IdentifiedObject): - ''' - Describes a curve for how the voltage magnitude and impedance varies with the tap step. - - :RatioTapChanger: The tap ratio table for this ratio tap changer. Default: "list" - :RatioTapChangerTablePoint: Table of this point. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'RatioTapChanger': [cgmesProfile.EQ.value, ], - 'RatioTapChangerTablePoint': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, RatioTapChanger = "list", RatioTapChangerTablePoint = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.RatioTapChanger = RatioTapChanger - self.RatioTapChangerTablePoint = RatioTapChangerTablePoint - - def __str__(self): - str = 'class=RatioTapChangerTable\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class RatioTapChangerTable(IdentifiedObject): + """ + Describes a curve for how the voltage magnitude and impedance varies with the tap step. + + :RatioTapChanger: The tap ratio table for this ratio tap changer. Default: "list" + :RatioTapChangerTablePoint: Table of this point. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "RatioTapChanger": [Profile.EQ.value, ], + "RatioTapChangerTablePoint": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, RatioTapChanger = "list", RatioTapChangerTablePoint = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.RatioTapChanger = RatioTapChanger + self.RatioTapChangerTablePoint = RatioTapChangerTablePoint + + def __str__(self): + str = "class=RatioTapChangerTable\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RatioTapChangerTablePoint.py b/cimpy/cgmes_v2_4_15/RatioTapChangerTablePoint.py index 8040c1b8..bbe54632 100644 --- a/cimpy/cgmes_v2_4_15/RatioTapChangerTablePoint.py +++ b/cimpy/cgmes_v2_4_15/RatioTapChangerTablePoint.py @@ -1,31 +1,33 @@ -from .TapChangerTablePoint import TapChangerTablePoint - - -class RatioTapChangerTablePoint(TapChangerTablePoint): - ''' - Describes each tap step in the ratio tap changer tabular curve. - - :RatioTapChangerTable: Points of this table. Default: None - ''' - - cgmesProfile = TapChangerTablePoint.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'RatioTapChangerTable': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TapChangerTablePoint: \n' + TapChangerTablePoint.__doc__ - - def __init__(self, RatioTapChangerTable = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.RatioTapChangerTable = RatioTapChangerTable - - def __str__(self): - str = 'class=RatioTapChangerTablePoint\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TapChangerTablePoint import TapChangerTablePoint +from .CGMESProfile import Profile + + +class RatioTapChangerTablePoint(TapChangerTablePoint): + """ + Describes each tap step in the ratio tap changer tabular curve. + + :RatioTapChangerTable: Points of this table. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "RatioTapChangerTable": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class TapChangerTablePoint:\n" + TapChangerTablePoint.__doc__ + + def __init__(self, RatioTapChangerTable = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.RatioTapChangerTable = RatioTapChangerTable + + def __str__(self): + str = "class=RatioTapChangerTablePoint\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Reactance.py b/cimpy/cgmes_v2_4_15/Reactance.py index 9af4eb82..e9cf07a7 100644 --- a/cimpy/cgmes_v2_4_15/Reactance.py +++ b/cimpy/cgmes_v2_4_15/Reactance.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class Reactance(Base): - ''' - Reactance (imaginary part of impedance), at rated frequency. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=Reactance\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Reactance(Base): + """ + Reactance (imaginary part of impedance), at rated frequency. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=Reactance\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ReactiveCapabilityCurve.py b/cimpy/cgmes_v2_4_15/ReactiveCapabilityCurve.py index 9406b029..043f370b 100644 --- a/cimpy/cgmes_v2_4_15/ReactiveCapabilityCurve.py +++ b/cimpy/cgmes_v2_4_15/ReactiveCapabilityCurve.py @@ -1,34 +1,36 @@ -from .Curve import Curve - - -class ReactiveCapabilityCurve(Curve): - ''' - Reactive power rating envelope versus the synchronous machine's active power, in both the generating and motoring modes. For each active power value there is a corresponding high and low reactive power limit value. Typically there will be a separate curve for each coolant condition, such as hydrogen pressure. The Y1 axis values represent reactive minimum and the Y2 axis values represent reactive maximum. - - :EquivalentInjection: The reactive capability curve used by this equivalent injection. Default: "list" - :InitiallyUsedBySynchronousMachines: The default reactive capability curve for use by a synchronous machine. Default: "list" - ''' - - cgmesProfile = Curve.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'EquivalentInjection': [cgmesProfile.EQ.value, ], - 'InitiallyUsedBySynchronousMachines': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Curve: \n' + Curve.__doc__ - - def __init__(self, EquivalentInjection = "list", InitiallyUsedBySynchronousMachines = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.EquivalentInjection = EquivalentInjection - self.InitiallyUsedBySynchronousMachines = InitiallyUsedBySynchronousMachines - - def __str__(self): - str = 'class=ReactiveCapabilityCurve\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Curve import Curve +from .CGMESProfile import Profile + + +class ReactiveCapabilityCurve(Curve): + """ + Reactive power rating envelope versus the synchronous machine's active power, in both the generating and motoring modes. For each active power value there is a corresponding high and low reactive power limit value. Typically there will be a separate curve for each coolant condition, such as hydrogen pressure. The Y1 axis values represent reactive minimum and the Y2 axis values represent reactive maximum. + + :EquivalentInjection: The reactive capability curve used by this equivalent injection. Default: "list" + :InitiallyUsedBySynchronousMachines: The default reactive capability curve for use by a synchronous machine. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "EquivalentInjection": [Profile.EQ.value, ], + "InitiallyUsedBySynchronousMachines": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Curve:\n" + Curve.__doc__ + + def __init__(self, EquivalentInjection = "list", InitiallyUsedBySynchronousMachines = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.EquivalentInjection = EquivalentInjection + self.InitiallyUsedBySynchronousMachines = InitiallyUsedBySynchronousMachines + + def __str__(self): + str = "class=ReactiveCapabilityCurve\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ReactivePower.py b/cimpy/cgmes_v2_4_15/ReactivePower.py index a0c7f8d4..8f01e3bd 100644 --- a/cimpy/cgmes_v2_4_15/ReactivePower.py +++ b/cimpy/cgmes_v2_4_15/ReactivePower.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class ReactivePower(Base): - ''' - Product of RMS value of the voltage and the RMS value of the quadrature component of the current. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, ], - 'value': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, ], - 'unit': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, ], - 'multiplier': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=ReactivePower\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ReactivePower(Base): + """ + Product of RMS value of the voltage and the RMS value of the quadrature component of the current. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "multiplier": [Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "unit": [Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "value": [Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=ReactivePower\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RegularIntervalSchedule.py b/cimpy/cgmes_v2_4_15/RegularIntervalSchedule.py index ab6c56c5..82b037fa 100644 --- a/cimpy/cgmes_v2_4_15/RegularIntervalSchedule.py +++ b/cimpy/cgmes_v2_4_15/RegularIntervalSchedule.py @@ -1,37 +1,39 @@ -from .BasicIntervalSchedule import BasicIntervalSchedule - - -class RegularIntervalSchedule(BasicIntervalSchedule): - ''' - The schedule has time points where the time between them is constant. - - :timeStep: The time between each pair of subsequent regular time points in sequence order. Default: 0 - :endTime: The time for the last time point. Default: '' - :TimePoints: The regular interval time point data values that define this schedule. Default: "list" - ''' - - cgmesProfile = BasicIntervalSchedule.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'timeStep': [cgmesProfile.EQ.value, ], - 'endTime': [cgmesProfile.EQ.value, ], - 'TimePoints': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class BasicIntervalSchedule: \n' + BasicIntervalSchedule.__doc__ - - def __init__(self, timeStep = 0, endTime = '', TimePoints = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.timeStep = timeStep - self.endTime = endTime - self.TimePoints = TimePoints - - def __str__(self): - str = 'class=RegularIntervalSchedule\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .BasicIntervalSchedule import BasicIntervalSchedule +from .CGMESProfile import Profile + + +class RegularIntervalSchedule(BasicIntervalSchedule): + """ + The schedule has time points where the time between them is constant. + + :TimePoints: The regular interval time point data values that define this schedule. Default: "list" + :endTime: The time for the last time point. Default: '' + :timeStep: The time between each pair of subsequent regular time points in sequence order. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "TimePoints": [Profile.EQ.value, ], + "endTime": [Profile.EQ.value, ], + "timeStep": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class BasicIntervalSchedule:\n" + BasicIntervalSchedule.__doc__ + + def __init__(self, TimePoints = "list", endTime = '', timeStep = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.TimePoints = TimePoints + self.endTime = endTime + self.timeStep = timeStep + + def __str__(self): + str = "class=RegularIntervalSchedule\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RegularTimePoint.py b/cimpy/cgmes_v2_4_15/RegularTimePoint.py index c24efa25..f2d8c059 100644 --- a/cimpy/cgmes_v2_4_15/RegularTimePoint.py +++ b/cimpy/cgmes_v2_4_15/RegularTimePoint.py @@ -1,39 +1,40 @@ -from .Base import Base - - -class RegularTimePoint(Base): - ''' - Time point for a schedule where the time between the consecutive points is constant. - - :IntervalSchedule: Regular interval schedule containing this time point. Default: None - :sequenceNumber: The position of the regular time point in the sequence. Note that time points don`t have to be sequential, i.e. time points may be omitted. The actual time for a RegularTimePoint is computed by multiplying the associated regular interval schedule`s time step with the regular time point sequence number and adding the associated schedules start time. Default: 0 - :value1: The first value at the time. The meaning of the value is defined by the derived type of the associated schedule. Default: 0.0 - :value2: The second value at the time. The meaning of the value is defined by the derived type of the associated schedule. Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'IntervalSchedule': [cgmesProfile.EQ.value, ], - 'sequenceNumber': [cgmesProfile.EQ.value, ], - 'value1': [cgmesProfile.EQ.value, ], - 'value2': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, IntervalSchedule = None, sequenceNumber = 0, value1 = 0.0, value2 = 0.0, ): - - self.IntervalSchedule = IntervalSchedule - self.sequenceNumber = sequenceNumber - self.value1 = value1 - self.value2 = value2 - - def __str__(self): - str = 'class=RegularTimePoint\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class RegularTimePoint(Base): + """ + Time point for a schedule where the time between the consecutive points is constant. + + :IntervalSchedule: Regular interval schedule containing this time point. Default: None + :sequenceNumber: The position of the regular time point in the sequence. Note that time points don`t have to be sequential, i.e. time points may be omitted. The actual time for a RegularTimePoint is computed by multiplying the associated regular interval schedule`s time step with the regular time point sequence number and adding the associated schedules start time. Default: 0 + :value1: The first value at the time. The meaning of the value is defined by the derived type of the associated schedule. Default: 0.0 + :value2: The second value at the time. The meaning of the value is defined by the derived type of the associated schedule. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "IntervalSchedule": [Profile.EQ.value, ], + "sequenceNumber": [Profile.EQ.value, ], + "value1": [Profile.EQ.value, ], + "value2": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, IntervalSchedule = None, sequenceNumber = 0, value1 = 0.0, value2 = 0.0): + + self.IntervalSchedule = IntervalSchedule + self.sequenceNumber = sequenceNumber + self.value1 = value1 + self.value2 = value2 + + def __str__(self): + str = "class=RegularTimePoint\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RegulatingCondEq.py b/cimpy/cgmes_v2_4_15/RegulatingCondEq.py index 99a7d174..a1d80836 100644 --- a/cimpy/cgmes_v2_4_15/RegulatingCondEq.py +++ b/cimpy/cgmes_v2_4_15/RegulatingCondEq.py @@ -1,34 +1,36 @@ -from .ConductingEquipment import ConductingEquipment - - -class RegulatingCondEq(ConductingEquipment): - ''' - A type of conducting equipment that can regulate a quantity (i.e. voltage or flow) at a specific point in the network. - - :RegulatingControl: The regulating control scheme in which this equipment participates. Default: None - :controlEnabled: Specifies the regulation status of the equipment. True is regulating, false is not regulating. Default: False - ''' - - cgmesProfile = ConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.DY.value, ], - 'RegulatingControl': [cgmesProfile.EQ.value, ], - 'controlEnabled': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConductingEquipment: \n' + ConductingEquipment.__doc__ - - def __init__(self, RegulatingControl = None, controlEnabled = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.RegulatingControl = RegulatingControl - self.controlEnabled = controlEnabled - - def __str__(self): - str = 'class=RegulatingCondEq\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConductingEquipment import ConductingEquipment +from .CGMESProfile import Profile + + +class RegulatingCondEq(ConductingEquipment): + """ + A type of conducting equipment that can regulate a quantity (i.e. voltage or flow) at a specific point in the network. + + :RegulatingControl: The regulating control scheme in which this equipment participates. Default: None + :controlEnabled: Specifies the regulation status of the equipment. True is regulating, false is not regulating. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, Profile.SSH.value, ], + "RegulatingControl": [Profile.EQ.value, ], + "controlEnabled": [Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConductingEquipment:\n" + ConductingEquipment.__doc__ + + def __init__(self, RegulatingControl = None, controlEnabled = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.RegulatingControl = RegulatingControl + self.controlEnabled = controlEnabled + + def __str__(self): + str = "class=RegulatingCondEq\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RegulatingControl.py b/cimpy/cgmes_v2_4_15/RegulatingControl.py index 8c6c9bbd..06663db2 100644 --- a/cimpy/cgmes_v2_4_15/RegulatingControl.py +++ b/cimpy/cgmes_v2_4_15/RegulatingControl.py @@ -1,55 +1,57 @@ -from .PowerSystemResource import PowerSystemResource - - -class RegulatingControl(PowerSystemResource): - ''' - Specifies a set of equipment that works together to control a power system quantity such as voltage or flow. Remote bus voltage control is possible by specifying the controlled terminal located at some place remote from the controlling equipment. In case multiple equipment, possibly of different types, control same terminal there must be only one RegulatingControl at that terminal. The most specific subtype of RegulatingControl shall be used in case such equipment participate in the control, e.g. TapChangerControl for tap changers. For flow control load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment. - - :Terminal: The controls regulating this terminal. Default: None - :RegulatingCondEq: The equipment that participates in this regulating control scheme. Default: "list" - :mode: The regulating control mode presently available. This specification allows for determining the kind of regulation without need for obtaining the units from a schedule. Default: None - :RegulationSchedule: Schedule for this Regulating regulating control. Default: "list" - :discrete: The regulation is performed in a discrete mode. This applies to equipment with discrete controls, e.g. tap changers and shunt compensators. Default: False - :enabled: The flag tells if regulation is enabled. Default: False - :targetDeadband: This is a deadband used with discrete control to avoid excessive update of controls like tap changers and shunt compensator banks while regulating. The units of those appropriate for the mode. Default: 0.0 - :targetValue: The target value specified for case input. This value can be used for the target value without the use of schedules. The value has the units appropriate to the mode attribute. Default: 0.0 - :targetValueUnitMultiplier: Specify the multiplier for used for the targetValue. Default: None - ''' - - cgmesProfile = PowerSystemResource.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'Terminal': [cgmesProfile.EQ.value, ], - 'RegulatingCondEq': [cgmesProfile.EQ.value, ], - 'mode': [cgmesProfile.EQ.value, ], - 'RegulationSchedule': [cgmesProfile.EQ.value, ], - 'discrete': [cgmesProfile.SSH.value, ], - 'enabled': [cgmesProfile.SSH.value, ], - 'targetDeadband': [cgmesProfile.SSH.value, ], - 'targetValue': [cgmesProfile.SSH.value, ], - 'targetValueUnitMultiplier': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemResource: \n' + PowerSystemResource.__doc__ - - def __init__(self, Terminal = None, RegulatingCondEq = "list", mode = None, RegulationSchedule = "list", discrete = False, enabled = False, targetDeadband = 0.0, targetValue = 0.0, targetValueUnitMultiplier = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Terminal = Terminal - self.RegulatingCondEq = RegulatingCondEq - self.mode = mode - self.RegulationSchedule = RegulationSchedule - self.discrete = discrete - self.enabled = enabled - self.targetDeadband = targetDeadband - self.targetValue = targetValue - self.targetValueUnitMultiplier = targetValueUnitMultiplier - - def __str__(self): - str = 'class=RegulatingControl\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemResource import PowerSystemResource +from .CGMESProfile import Profile + + +class RegulatingControl(PowerSystemResource): + """ + Specifies a set of equipment that works together to control a power system quantity such as voltage or flow. Remote bus voltage control is possible by specifying the controlled terminal located at some place remote from the controlling equipment. In case multiple equipment, possibly of different types, control same terminal there must be only one RegulatingControl at that terminal. The most specific subtype of RegulatingControl shall be used in case such equipment participate in the control, e.g. TapChangerControl for tap changers. For flow control load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment. + + :RegulatingCondEq: The equipment that participates in this regulating control scheme. Default: "list" + :RegulationSchedule: Schedule for this Regulating regulating control. Default: "list" + :Terminal: The controls regulating this terminal. Default: None + :discrete: The regulation is performed in a discrete mode. This applies to equipment with discrete controls, e.g. tap changers and shunt compensators. Default: False + :enabled: The flag tells if regulation is enabled. Default: False + :mode: The regulating control mode presently available. This specification allows for determining the kind of regulation without need for obtaining the units from a schedule. Default: None + :targetDeadband: This is a deadband used with discrete control to avoid excessive update of controls like tap changers and shunt compensator banks while regulating. The units of those appropriate for the mode. Default: 0.0 + :targetValue: The target value specified for case input. This value can be used for the target value without the use of schedules. The value has the units appropriate to the mode attribute. Default: 0.0 + :targetValueUnitMultiplier: Specify the multiplier for used for the targetValue. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "RegulatingCondEq": [Profile.EQ.value, ], + "RegulationSchedule": [Profile.EQ.value, ], + "Terminal": [Profile.EQ.value, ], + "discrete": [Profile.SSH.value, ], + "enabled": [Profile.SSH.value, ], + "mode": [Profile.EQ.value, ], + "targetDeadband": [Profile.SSH.value, ], + "targetValue": [Profile.SSH.value, ], + "targetValueUnitMultiplier": [Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class PowerSystemResource:\n" + PowerSystemResource.__doc__ + + def __init__(self, RegulatingCondEq = "list", RegulationSchedule = "list", Terminal = None, discrete = False, enabled = False, mode = None, targetDeadband = 0.0, targetValue = 0.0, targetValueUnitMultiplier = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.RegulatingCondEq = RegulatingCondEq + self.RegulationSchedule = RegulationSchedule + self.Terminal = Terminal + self.discrete = discrete + self.enabled = enabled + self.mode = mode + self.targetDeadband = targetDeadband + self.targetValue = targetValue + self.targetValueUnitMultiplier = targetValueUnitMultiplier + + def __str__(self): + str = "class=RegulatingControl\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RegulatingControlModeKind.py b/cimpy/cgmes_v2_4_15/RegulatingControlModeKind.py index 9af4f1cd..1fcbdf97 100644 --- a/cimpy/cgmes_v2_4_15/RegulatingControlModeKind.py +++ b/cimpy/cgmes_v2_4_15/RegulatingControlModeKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class RegulatingControlModeKind(Base): - ''' - The kind of regulation model. For example regulating voltage, reactive power, active power, etc. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=RegulatingControlModeKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class RegulatingControlModeKind(Base): + """ + The kind of regulation model. For example regulating voltage, reactive power, active power, etc. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=RegulatingControlModeKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RegulationSchedule.py b/cimpy/cgmes_v2_4_15/RegulationSchedule.py index ab0d864b..d4ff58ea 100644 --- a/cimpy/cgmes_v2_4_15/RegulationSchedule.py +++ b/cimpy/cgmes_v2_4_15/RegulationSchedule.py @@ -1,31 +1,33 @@ -from .SeasonDayTypeSchedule import SeasonDayTypeSchedule - - -class RegulationSchedule(SeasonDayTypeSchedule): - ''' - A pre-established pattern over time for a controlled variable, e.g., busbar voltage. - - :RegulatingControl: Regulating controls that have this Schedule. Default: None - ''' - - cgmesProfile = SeasonDayTypeSchedule.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'RegulatingControl': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class SeasonDayTypeSchedule: \n' + SeasonDayTypeSchedule.__doc__ - - def __init__(self, RegulatingControl = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.RegulatingControl = RegulatingControl - - def __str__(self): - str = 'class=RegulationSchedule\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .SeasonDayTypeSchedule import SeasonDayTypeSchedule +from .CGMESProfile import Profile + + +class RegulationSchedule(SeasonDayTypeSchedule): + """ + A pre-established pattern over time for a controlled variable, e.g., busbar voltage. + + :RegulatingControl: Regulating controls that have this Schedule. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "RegulatingControl": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class SeasonDayTypeSchedule:\n" + SeasonDayTypeSchedule.__doc__ + + def __init__(self, RegulatingControl = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.RegulatingControl = RegulatingControl + + def __str__(self): + str = "class=RegulationSchedule\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RemoteInputSignal.py b/cimpy/cgmes_v2_4_15/RemoteInputSignal.py index 0cb79202..e0c35a81 100644 --- a/cimpy/cgmes_v2_4_15/RemoteInputSignal.py +++ b/cimpy/cgmes_v2_4_15/RemoteInputSignal.py @@ -1,58 +1,60 @@ -from .IdentifiedObject import IdentifiedObject - - -class RemoteInputSignal(IdentifiedObject): - ''' - Supports connection to a terminal associated with a remote bus from which an input signal of a specific type is coming. - - :Terminal: Remote terminal with which this input signal is associated. Default: None - :remoteSignalType: Type of input signal. Default: None - :PFVArControllerType1Dynamics: Power Factor or VAr controller Type I model using this remote input signal. Default: None - :UnderexcitationLimiterDynamics: Underexcitation limiter model using this remote input signal. Default: None - :WindTurbineType1or2Dynamics: Wind generator Type 1 or Type 2 model using this remote input signal. Default: None - :VoltageCompensatorDynamics: Voltage compensator model using this remote input signal. Default: None - :PowerSystemStabilizerDynamics: Power system stabilizer model using this remote input signal. Default: None - :DiscontinuousExcitationControlDynamics: Discontinuous excitation control model using this remote input signal. Default: None - :WindTurbineType3or4Dynamics: Remote input signal used by these wind turbine Type 3 or 4 models. Default: None - :WindPlantDynamics: The remote signal with which this power plant is associated. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'Terminal': [cgmesProfile.DY.value, ], - 'remoteSignalType': [cgmesProfile.DY.value, ], - 'PFVArControllerType1Dynamics': [cgmesProfile.DY.value, ], - 'UnderexcitationLimiterDynamics': [cgmesProfile.DY.value, ], - 'WindTurbineType1or2Dynamics': [cgmesProfile.DY.value, ], - 'VoltageCompensatorDynamics': [cgmesProfile.DY.value, ], - 'PowerSystemStabilizerDynamics': [cgmesProfile.DY.value, ], - 'DiscontinuousExcitationControlDynamics': [cgmesProfile.DY.value, ], - 'WindTurbineType3or4Dynamics': [cgmesProfile.DY.value, ], - 'WindPlantDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, Terminal = None, remoteSignalType = None, PFVArControllerType1Dynamics = None, UnderexcitationLimiterDynamics = None, WindTurbineType1or2Dynamics = None, VoltageCompensatorDynamics = None, PowerSystemStabilizerDynamics = None, DiscontinuousExcitationControlDynamics = None, WindTurbineType3or4Dynamics = None, WindPlantDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Terminal = Terminal - self.remoteSignalType = remoteSignalType - self.PFVArControllerType1Dynamics = PFVArControllerType1Dynamics - self.UnderexcitationLimiterDynamics = UnderexcitationLimiterDynamics - self.WindTurbineType1or2Dynamics = WindTurbineType1or2Dynamics - self.VoltageCompensatorDynamics = VoltageCompensatorDynamics - self.PowerSystemStabilizerDynamics = PowerSystemStabilizerDynamics - self.DiscontinuousExcitationControlDynamics = DiscontinuousExcitationControlDynamics - self.WindTurbineType3or4Dynamics = WindTurbineType3or4Dynamics - self.WindPlantDynamics = WindPlantDynamics - - def __str__(self): - str = 'class=RemoteInputSignal\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class RemoteInputSignal(IdentifiedObject): + """ + Supports connection to a terminal associated with a remote bus from which an input signal of a specific type is coming. + + :DiscontinuousExcitationControlDynamics: Discontinuous excitation control model using this remote input signal. Default: None + :PFVArControllerType1Dynamics: Power Factor or VAr controller Type I model using this remote input signal. Default: None + :PowerSystemStabilizerDynamics: Power system stabilizer model using this remote input signal. Default: None + :Terminal: Remote terminal with which this input signal is associated. Default: None + :UnderexcitationLimiterDynamics: Underexcitation limiter model using this remote input signal. Default: None + :VoltageCompensatorDynamics: Voltage compensator model using this remote input signal. Default: None + :WindPlantDynamics: The remote signal with which this power plant is associated. Default: None + :WindTurbineType1or2Dynamics: Wind generator Type 1 or Type 2 model using this remote input signal. Default: None + :WindTurbineType3or4Dynamics: Remote input signal used by these wind turbine Type 3 or 4 models. Default: None + :remoteSignalType: Type of input signal. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "DiscontinuousExcitationControlDynamics": [Profile.DY.value, ], + "PFVArControllerType1Dynamics": [Profile.DY.value, ], + "PowerSystemStabilizerDynamics": [Profile.DY.value, ], + "Terminal": [Profile.DY.value, ], + "UnderexcitationLimiterDynamics": [Profile.DY.value, ], + "VoltageCompensatorDynamics": [Profile.DY.value, ], + "WindPlantDynamics": [Profile.DY.value, ], + "WindTurbineType1or2Dynamics": [Profile.DY.value, ], + "WindTurbineType3or4Dynamics": [Profile.DY.value, ], + "remoteSignalType": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, DiscontinuousExcitationControlDynamics = None, PFVArControllerType1Dynamics = None, PowerSystemStabilizerDynamics = None, Terminal = None, UnderexcitationLimiterDynamics = None, VoltageCompensatorDynamics = None, WindPlantDynamics = None, WindTurbineType1or2Dynamics = None, WindTurbineType3or4Dynamics = None, remoteSignalType = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DiscontinuousExcitationControlDynamics = DiscontinuousExcitationControlDynamics + self.PFVArControllerType1Dynamics = PFVArControllerType1Dynamics + self.PowerSystemStabilizerDynamics = PowerSystemStabilizerDynamics + self.Terminal = Terminal + self.UnderexcitationLimiterDynamics = UnderexcitationLimiterDynamics + self.VoltageCompensatorDynamics = VoltageCompensatorDynamics + self.WindPlantDynamics = WindPlantDynamics + self.WindTurbineType1or2Dynamics = WindTurbineType1or2Dynamics + self.WindTurbineType3or4Dynamics = WindTurbineType3or4Dynamics + self.remoteSignalType = remoteSignalType + + def __str__(self): + str = "class=RemoteInputSignal\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RemoteSignalKind.py b/cimpy/cgmes_v2_4_15/RemoteSignalKind.py index 8e5d229c..bfd38bb7 100644 --- a/cimpy/cgmes_v2_4_15/RemoteSignalKind.py +++ b/cimpy/cgmes_v2_4_15/RemoteSignalKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class RemoteSignalKind(Base): - ''' - Type of input signal coming from remote bus. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=RemoteSignalKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class RemoteSignalKind(Base): + """ + Type of input signal coming from remote bus. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=RemoteSignalKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ReportingGroup.py b/cimpy/cgmes_v2_4_15/ReportingGroup.py index 732a1c71..23bf7d0c 100644 --- a/cimpy/cgmes_v2_4_15/ReportingGroup.py +++ b/cimpy/cgmes_v2_4_15/ReportingGroup.py @@ -1,34 +1,36 @@ -from .IdentifiedObject import IdentifiedObject - - -class ReportingGroup(IdentifiedObject): - ''' - A reporting group is used for various ad-hoc groupings used for reporting. - - :BusNameMarker: The reporting group to which this bus name marker belongs. Default: "list" - :TopologicalNode: The reporting group to which the topological node belongs. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.TP.value, ], - 'BusNameMarker': [cgmesProfile.EQ.value, ], - 'TopologicalNode': [cgmesProfile.TP.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, BusNameMarker = "list", TopologicalNode = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.BusNameMarker = BusNameMarker - self.TopologicalNode = TopologicalNode - - def __str__(self): - str = 'class=ReportingGroup\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class ReportingGroup(IdentifiedObject): + """ + A reporting group is used for various ad-hoc groupings used for reporting. + + :BusNameMarker: The reporting group to which this bus name marker belongs. Default: "list" + :TopologicalNode: The reporting group to which the topological node belongs. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.TP.value, ], + "BusNameMarker": [Profile.EQ.value, ], + "TopologicalNode": [Profile.TP.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, BusNameMarker = "list", TopologicalNode = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.BusNameMarker = BusNameMarker + self.TopologicalNode = TopologicalNode + + def __str__(self): + str = "class=ReportingGroup\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Resistance.py b/cimpy/cgmes_v2_4_15/Resistance.py index ca574d5e..67c5abfe 100644 --- a/cimpy/cgmes_v2_4_15/Resistance.py +++ b/cimpy/cgmes_v2_4_15/Resistance.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class Resistance(Base): - ''' - Resistance (real part of impedance). - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'value': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'unit': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'multiplier': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=Resistance\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Resistance(Base): + """ + Resistance (real part of impedance). + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "multiplier": [Profile.EQ.value, Profile.SSH.value, ], + "unit": [Profile.EQ.value, Profile.SSH.value, ], + "value": [Profile.EQ.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=Resistance\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ResistancePerLength.py b/cimpy/cgmes_v2_4_15/ResistancePerLength.py index 867e41dc..3b9b1c12 100644 --- a/cimpy/cgmes_v2_4_15/ResistancePerLength.py +++ b/cimpy/cgmes_v2_4_15/ResistancePerLength.py @@ -1,42 +1,43 @@ -from .Base import Base - - -class ResistancePerLength(Base): - ''' - Resistance (real part of impedance) per unit of length. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - :denominatorUnit: Default: None - :denominatorMultiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - 'denominatorUnit': [cgmesProfile.EQ.value, ], - 'denominatorMultiplier': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, denominatorUnit = None, denominatorMultiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - self.denominatorUnit = denominatorUnit - self.denominatorMultiplier = denominatorMultiplier - - def __str__(self): - str = 'class=ResistancePerLength\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ResistancePerLength(Base): + """ + Resistance (real part of impedance) per unit of length. + + :denominatorMultiplier: Default: None + :denominatorUnit: Default: None + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "denominatorMultiplier": [Profile.EQ.value, ], + "denominatorUnit": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, denominatorMultiplier = None, denominatorUnit = None, multiplier = None, unit = None, value = 0.0): + + self.denominatorMultiplier = denominatorMultiplier + self.denominatorUnit = denominatorUnit + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=ResistancePerLength\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RotatingMachine.py b/cimpy/cgmes_v2_4_15/RotatingMachine.py index 13c5eff1..2c383c7d 100644 --- a/cimpy/cgmes_v2_4_15/RotatingMachine.py +++ b/cimpy/cgmes_v2_4_15/RotatingMachine.py @@ -1,49 +1,51 @@ -from .RegulatingCondEq import RegulatingCondEq - - -class RotatingMachine(RegulatingCondEq): - ''' - A rotating machine which may be used as a generator or motor. - - :GeneratingUnit: A synchronous machine may operate as a generator and as such becomes a member of a generating unit. Default: None - :HydroPump: The synchronous machine drives the turbine which moves the water from a low elevation to a higher elevation. The direction of machine rotation for pumping may or may not be the same as for generating. Default: None - :ratedPowerFactor: Power factor (nameplate data). It is primarily used for short circuit data exchange according to IEC 60909. Default: 0.0 - :ratedS: Nameplate apparent power rating for the unit. The attribute shall have a positive value. Default: 0.0 - :ratedU: Rated voltage (nameplate data, Ur in IEC 60909-0). It is primarily used for short circuit data exchange according to IEC 60909. Default: 0.0 - :p: Active power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution. Default: 0.0 - :q: Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution. Default: 0.0 - ''' - - cgmesProfile = RegulatingCondEq.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.DY.value, ], - 'GeneratingUnit': [cgmesProfile.EQ.value, ], - 'HydroPump': [cgmesProfile.EQ.value, ], - 'ratedPowerFactor': [cgmesProfile.EQ.value, ], - 'ratedS': [cgmesProfile.EQ.value, ], - 'ratedU': [cgmesProfile.EQ.value, ], - 'p': [cgmesProfile.SSH.value, ], - 'q': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class RegulatingCondEq: \n' + RegulatingCondEq.__doc__ - - def __init__(self, GeneratingUnit = None, HydroPump = None, ratedPowerFactor = 0.0, ratedS = 0.0, ratedU = 0.0, p = 0.0, q = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.GeneratingUnit = GeneratingUnit - self.HydroPump = HydroPump - self.ratedPowerFactor = ratedPowerFactor - self.ratedS = ratedS - self.ratedU = ratedU - self.p = p - self.q = q - - def __str__(self): - str = 'class=RotatingMachine\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .RegulatingCondEq import RegulatingCondEq +from .CGMESProfile import Profile + + +class RotatingMachine(RegulatingCondEq): + """ + A rotating machine which may be used as a generator or motor. + + :GeneratingUnit: A synchronous machine may operate as a generator and as such becomes a member of a generating unit. Default: None + :HydroPump: The synchronous machine drives the turbine which moves the water from a low elevation to a higher elevation. The direction of machine rotation for pumping may or may not be the same as for generating. Default: None + :p: Active power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution. Default: 0.0 + :q: Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution. Default: 0.0 + :ratedPowerFactor: Power factor (nameplate data). It is primarily used for short circuit data exchange according to IEC 60909. Default: 0.0 + :ratedS: Nameplate apparent power rating for the unit. The attribute shall have a positive value. Default: 0.0 + :ratedU: Rated voltage (nameplate data, Ur in IEC 60909-0). It is primarily used for short circuit data exchange according to IEC 60909. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, Profile.SSH.value, ], + "GeneratingUnit": [Profile.EQ.value, ], + "HydroPump": [Profile.EQ.value, ], + "p": [Profile.SSH.value, ], + "q": [Profile.SSH.value, ], + "ratedPowerFactor": [Profile.EQ.value, ], + "ratedS": [Profile.EQ.value, ], + "ratedU": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class RegulatingCondEq:\n" + RegulatingCondEq.__doc__ + + def __init__(self, GeneratingUnit = None, HydroPump = None, p = 0.0, q = 0.0, ratedPowerFactor = 0.0, ratedS = 0.0, ratedU = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.GeneratingUnit = GeneratingUnit + self.HydroPump = HydroPump + self.p = p + self.q = q + self.ratedPowerFactor = ratedPowerFactor + self.ratedS = ratedS + self.ratedU = ratedU + + def __str__(self): + str = "class=RotatingMachine\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RotatingMachineDynamics.py b/cimpy/cgmes_v2_4_15/RotatingMachineDynamics.py index bdb81b86..67c65ebe 100644 --- a/cimpy/cgmes_v2_4_15/RotatingMachineDynamics.py +++ b/cimpy/cgmes_v2_4_15/RotatingMachineDynamics.py @@ -1,46 +1,48 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class RotatingMachineDynamics(DynamicsFunctionBlock): - ''' - Abstract parent class for all synchronous and asynchronous machine standard models. - - :damping: Damping torque coefficient (D). A proportionality constant that, when multiplied by the angular velocity of the rotor poles with respect to the magnetic field (frequency), results in the damping torque. This value is often zero when the sources of damping torques (generator damper windings, load damping effects, etc.) are modelled in detail. Typical Value = 0. Default: 0.0 - :inertia: Inertia constant of generator or motor and mechanical load (H) (>0). This is the specification for the stored energy in the rotating mass when operating at rated speed. For a generator, this includes the generator plus all other elements (turbine, exciter) on the same shaft and has units of MW*sec. For a motor, it includes the motor plus its mechanical load. Conventional units are per unit on the generator MVA base, usually expressed as MW*second/MVA or just second. This value is used in the accelerating power reference frame for operator training simulator solutions. Typical Value = 3. Default: 0 - :saturationFactor: Saturation factor at rated terminal voltage (S1) (> or =0). Not used by simplified model. Defined by defined by S(E1) in the SynchronousMachineSaturationParameters diagram. Typical Value = 0.02. Default: 0.0 - :saturationFactor120: Saturation factor at 120% of rated terminal voltage (S12) (> or =S1). Not used by the simplified model, defined by S(E2) in the SynchronousMachineSaturationParameters diagram. Typical Value = 0.12. Default: 0.0 - :statorLeakageReactance: Stator leakage reactance (Xl) (> or =0). Typical Value = 0.15. Default: 0.0 - :statorResistance: Stator (armature) resistance (Rs) (> or =0). Typical Value = 0.005. Default: 0.0 - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'damping': [cgmesProfile.DY.value, ], - 'inertia': [cgmesProfile.DY.value, ], - 'saturationFactor': [cgmesProfile.DY.value, ], - 'saturationFactor120': [cgmesProfile.DY.value, ], - 'statorLeakageReactance': [cgmesProfile.DY.value, ], - 'statorResistance': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, damping = 0.0, inertia = 0, saturationFactor = 0.0, saturationFactor120 = 0.0, statorLeakageReactance = 0.0, statorResistance = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.damping = damping - self.inertia = inertia - self.saturationFactor = saturationFactor - self.saturationFactor120 = saturationFactor120 - self.statorLeakageReactance = statorLeakageReactance - self.statorResistance = statorResistance - - def __str__(self): - str = 'class=RotatingMachineDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class RotatingMachineDynamics(DynamicsFunctionBlock): + """ + Abstract parent class for all synchronous and asynchronous machine standard models. + + :damping: Damping torque coefficient (D). A proportionality constant that, when multiplied by the angular velocity of the rotor poles with respect to the magnetic field (frequency), results in the damping torque. This value is often zero when the sources of damping torques (generator damper windings, load damping effects, etc.) are modelled in detail. Typical Value = 0. Default: 0.0 + :inertia: Inertia constant of generator or motor and mechanical load (H) (>0). This is the specification for the stored energy in the rotating mass when operating at rated speed. For a generator, this includes the generator plus all other elements (turbine, exciter) on the same shaft and has units of MW*sec. For a motor, it includes the motor plus its mechanical load. Conventional units are per unit on the generator MVA base, usually expressed as MW*second/MVA or just second. This value is used in the accelerating power reference frame for operator training simulator solutions. Typical Value = 3. Default: 0.0 + :saturationFactor: Saturation factor at rated terminal voltage (S1) (> or =0). Not used by simplified model. Defined by defined by S(E1) in the SynchronousMachineSaturationParameters diagram. Typical Value = 0.02. Default: 0.0 + :saturationFactor120: Saturation factor at 120% of rated terminal voltage (S12) (> or =S1). Not used by the simplified model, defined by S(E2) in the SynchronousMachineSaturationParameters diagram. Typical Value = 0.12. Default: 0.0 + :statorLeakageReactance: Stator leakage reactance (Xl) (> or =0). Typical Value = 0.15. Default: 0.0 + :statorResistance: Stator (armature) resistance (Rs) (> or =0). Typical Value = 0.005. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "damping": [Profile.DY.value, ], + "inertia": [Profile.DY.value, ], + "saturationFactor": [Profile.DY.value, ], + "saturationFactor120": [Profile.DY.value, ], + "statorLeakageReactance": [Profile.DY.value, ], + "statorResistance": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, damping = 0.0, inertia = 0.0, saturationFactor = 0.0, saturationFactor120 = 0.0, statorLeakageReactance = 0.0, statorResistance = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.damping = damping + self.inertia = inertia + self.saturationFactor = saturationFactor + self.saturationFactor120 = saturationFactor120 + self.statorLeakageReactance = statorLeakageReactance + self.statorResistance = statorResistance + + def __str__(self): + str = "class=RotatingMachineDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RotationSpeed.py b/cimpy/cgmes_v2_4_15/RotationSpeed.py index c3d29d5c..4fe9962c 100644 --- a/cimpy/cgmes_v2_4_15/RotationSpeed.py +++ b/cimpy/cgmes_v2_4_15/RotationSpeed.py @@ -1,42 +1,43 @@ -from .Base import Base - - -class RotationSpeed(Base): - ''' - Number of revolutions per second. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - :denominatorUnit: Default: None - :denominatorMultiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - 'denominatorUnit': [cgmesProfile.EQ.value, ], - 'denominatorMultiplier': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, denominatorUnit = None, denominatorMultiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - self.denominatorUnit = denominatorUnit - self.denominatorMultiplier = denominatorMultiplier - - def __str__(self): - str = 'class=RotationSpeed\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class RotationSpeed(Base): + """ + Number of revolutions per second. + + :denominatorMultiplier: Default: None + :denominatorUnit: Default: None + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "denominatorMultiplier": [Profile.EQ.value, ], + "denominatorUnit": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, denominatorMultiplier = None, denominatorUnit = None, multiplier = None, unit = None, value = 0.0): + + self.denominatorMultiplier = denominatorMultiplier + self.denominatorUnit = denominatorUnit + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=RotationSpeed\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/RotorKind.py b/cimpy/cgmes_v2_4_15/RotorKind.py index 9c92393d..a75e0cfd 100644 --- a/cimpy/cgmes_v2_4_15/RotorKind.py +++ b/cimpy/cgmes_v2_4_15/RotorKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class RotorKind(Base): - ''' - Type of rotor on physical machine. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=RotorKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class RotorKind(Base): + """ + Type of rotor on physical machine. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=RotorKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SVCControlMode.py b/cimpy/cgmes_v2_4_15/SVCControlMode.py index ffa8b5df..9381b169 100644 --- a/cimpy/cgmes_v2_4_15/SVCControlMode.py +++ b/cimpy/cgmes_v2_4_15/SVCControlMode.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class SVCControlMode(Base): - ''' - Static VAr Compensator control mode. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=SVCControlMode\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class SVCControlMode(Base): + """ + Static VAr Compensator control mode. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=SVCControlMode\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Season.py b/cimpy/cgmes_v2_4_15/Season.py index bb7ea332..e206ecf5 100644 --- a/cimpy/cgmes_v2_4_15/Season.py +++ b/cimpy/cgmes_v2_4_15/Season.py @@ -1,37 +1,39 @@ -from .IdentifiedObject import IdentifiedObject - - -class Season(IdentifiedObject): - ''' - A specified time period of the year. - - :endDate: Date season ends. Default: 0.0 - :startDate: Date season starts. Default: 0.0 - :SeasonDayTypeSchedules: Season for the Schedule. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'endDate': [cgmesProfile.EQ.value, ], - 'startDate': [cgmesProfile.EQ.value, ], - 'SeasonDayTypeSchedules': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, endDate = 0.0, startDate = 0.0, SeasonDayTypeSchedules = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.endDate = endDate - self.startDate = startDate - self.SeasonDayTypeSchedules = SeasonDayTypeSchedules - - def __str__(self): - str = 'class=Season\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class Season(IdentifiedObject): + """ + A specified time period of the year. + + :SeasonDayTypeSchedules: Season for the Schedule. Default: "list" + :endDate: Date season ends. Default: 0.0 + :startDate: Date season starts. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "SeasonDayTypeSchedules": [Profile.EQ.value, ], + "endDate": [Profile.EQ.value, ], + "startDate": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, SeasonDayTypeSchedules = "list", endDate = 0.0, startDate = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.SeasonDayTypeSchedules = SeasonDayTypeSchedules + self.endDate = endDate + self.startDate = startDate + + def __str__(self): + str = "class=Season\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SeasonDayTypeSchedule.py b/cimpy/cgmes_v2_4_15/SeasonDayTypeSchedule.py index 599e2c5a..0b987e08 100644 --- a/cimpy/cgmes_v2_4_15/SeasonDayTypeSchedule.py +++ b/cimpy/cgmes_v2_4_15/SeasonDayTypeSchedule.py @@ -1,34 +1,36 @@ -from .RegularIntervalSchedule import RegularIntervalSchedule - - -class SeasonDayTypeSchedule(RegularIntervalSchedule): - ''' - A time schedule covering a 24 hour period, with curve data for a specific type of season and day. - - :DayType: Schedules that use this DayType. Default: None - :Season: Schedules that use this Season. Default: None - ''' - - cgmesProfile = RegularIntervalSchedule.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'DayType': [cgmesProfile.EQ.value, ], - 'Season': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class RegularIntervalSchedule: \n' + RegularIntervalSchedule.__doc__ - - def __init__(self, DayType = None, Season = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.DayType = DayType - self.Season = Season - - def __str__(self): - str = 'class=SeasonDayTypeSchedule\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .RegularIntervalSchedule import RegularIntervalSchedule +from .CGMESProfile import Profile + + +class SeasonDayTypeSchedule(RegularIntervalSchedule): + """ + A time schedule covering a 24 hour period, with curve data for a specific type of season and day. + + :DayType: Schedules that use this DayType. Default: None + :Season: Schedules that use this Season. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "DayType": [Profile.EQ.value, ], + "Season": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class RegularIntervalSchedule:\n" + RegularIntervalSchedule.__doc__ + + def __init__(self, DayType = None, Season = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DayType = DayType + self.Season = Season + + def __str__(self): + str = "class=SeasonDayTypeSchedule\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Seconds.py b/cimpy/cgmes_v2_4_15/Seconds.py index 47306fb1..954b57a4 100644 --- a/cimpy/cgmes_v2_4_15/Seconds.py +++ b/cimpy/cgmes_v2_4_15/Seconds.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class Seconds(Base): - ''' - Time, in seconds. - - :value: Time, in seconds Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'value': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'unit': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'multiplier': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=Seconds\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Seconds(Base): + """ + Time, in seconds. + + :multiplier: Default: None + :unit: Default: None + :value: Time, in seconds Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, ], + "multiplier": [Profile.DY.value, Profile.EQ.value, ], + "unit": [Profile.DY.value, Profile.EQ.value, ], + "value": [Profile.DY.value, Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=Seconds\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SeriesCompensator.py b/cimpy/cgmes_v2_4_15/SeriesCompensator.py index 850e4faa..a27971fb 100644 --- a/cimpy/cgmes_v2_4_15/SeriesCompensator.py +++ b/cimpy/cgmes_v2_4_15/SeriesCompensator.py @@ -1,49 +1,51 @@ -from .ConductingEquipment import ConductingEquipment - - -class SeriesCompensator(ConductingEquipment): - ''' - A Series Compensator is a series capacitor or reactor or an AC transmission line without charging susceptance. It is a two terminal device. - - :r: Positive sequence resistance. Default: 0.0 - :x: Positive sequence reactance. Default: 0.0 - :varistorPresent: Describe if a metal oxide varistor (mov) for over voltage protection is configured at the series compensator. Default: False - :varistorRatedCurrent: The maximum current the varistor is designed to handle at specified duration. Default: 0.0 - :varistorVoltageThreshold: The dc voltage at which the varistor start conducting. Default: 0.0 - :r0: Zero sequence resistance. Default: 0.0 - :x0: Zero sequence reactance. Default: 0.0 - ''' - - cgmesProfile = ConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'r': [cgmesProfile.EQ.value, ], - 'x': [cgmesProfile.EQ.value, ], - 'varistorPresent': [cgmesProfile.EQ.value, ], - 'varistorRatedCurrent': [cgmesProfile.EQ.value, ], - 'varistorVoltageThreshold': [cgmesProfile.EQ.value, ], - 'r0': [cgmesProfile.EQ.value, ], - 'x0': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConductingEquipment: \n' + ConductingEquipment.__doc__ - - def __init__(self, r = 0.0, x = 0.0, varistorPresent = False, varistorRatedCurrent = 0.0, varistorVoltageThreshold = 0.0, r0 = 0.0, x0 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.r = r - self.x = x - self.varistorPresent = varistorPresent - self.varistorRatedCurrent = varistorRatedCurrent - self.varistorVoltageThreshold = varistorVoltageThreshold - self.r0 = r0 - self.x0 = x0 - - def __str__(self): - str = 'class=SeriesCompensator\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConductingEquipment import ConductingEquipment +from .CGMESProfile import Profile + + +class SeriesCompensator(ConductingEquipment): + """ + A Series Compensator is a series capacitor or reactor or an AC transmission line without charging susceptance. It is a two terminal device. + + :r: Positive sequence resistance. Default: 0.0 + :r0: Zero sequence resistance. Default: 0.0 + :varistorPresent: Describe if a metal oxide varistor (mov) for over voltage protection is configured at the series compensator. Default: False + :varistorRatedCurrent: The maximum current the varistor is designed to handle at specified duration. Default: 0.0 + :varistorVoltageThreshold: The dc voltage at which the varistor start conducting. Default: 0.0 + :x: Positive sequence reactance. Default: 0.0 + :x0: Zero sequence reactance. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "r": [Profile.EQ.value, ], + "r0": [Profile.EQ.value, ], + "varistorPresent": [Profile.EQ.value, ], + "varistorRatedCurrent": [Profile.EQ.value, ], + "varistorVoltageThreshold": [Profile.EQ.value, ], + "x": [Profile.EQ.value, ], + "x0": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConductingEquipment:\n" + ConductingEquipment.__doc__ + + def __init__(self, r = 0.0, r0 = 0.0, varistorPresent = False, varistorRatedCurrent = 0.0, varistorVoltageThreshold = 0.0, x = 0.0, x0 = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.r = r + self.r0 = r0 + self.varistorPresent = varistorPresent + self.varistorRatedCurrent = varistorRatedCurrent + self.varistorVoltageThreshold = varistorVoltageThreshold + self.x = x + self.x0 = x0 + + def __str__(self): + str = "class=SeriesCompensator\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SetPoint.py b/cimpy/cgmes_v2_4_15/SetPoint.py index 49eb78ed..d566089a 100644 --- a/cimpy/cgmes_v2_4_15/SetPoint.py +++ b/cimpy/cgmes_v2_4_15/SetPoint.py @@ -1,34 +1,36 @@ -from .AnalogControl import AnalogControl - - -class SetPoint(AnalogControl): - ''' - An analog control that issue a set point value. - - :normalValue: Normal value for Control.value e.g. used for percentage scaling. Default: 0.0 - :value: The value representing the actuator output. Default: 0.0 - ''' - - cgmesProfile = AnalogControl.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'normalValue': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class AnalogControl: \n' + AnalogControl.__doc__ - - def __init__(self, normalValue = 0.0, value = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.normalValue = normalValue - self.value = value - - def __str__(self): - str = 'class=SetPoint\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .AnalogControl import AnalogControl +from .CGMESProfile import Profile + + +class SetPoint(AnalogControl): + """ + An analog control that issue a set point value. + + :normalValue: Normal value for Control.value e.g. used for percentage scaling. Default: 0.0 + :value: The value representing the actuator output. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "normalValue": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class AnalogControl:\n" + AnalogControl.__doc__ + + def __init__(self, normalValue = 0.0, value = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.normalValue = normalValue + self.value = value + + def __str__(self): + str = "class=SetPoint\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ShortCircuitRotorKind.py b/cimpy/cgmes_v2_4_15/ShortCircuitRotorKind.py index d9b02045..322ee132 100644 --- a/cimpy/cgmes_v2_4_15/ShortCircuitRotorKind.py +++ b/cimpy/cgmes_v2_4_15/ShortCircuitRotorKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class ShortCircuitRotorKind(Base): - ''' - Type of rotor, used by short circuit applications. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=ShortCircuitRotorKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class ShortCircuitRotorKind(Base): + """ + Type of rotor, used by short circuit applications. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=ShortCircuitRotorKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ShuntCompensator.py b/cimpy/cgmes_v2_4_15/ShuntCompensator.py index 69b14909..aa4d636b 100644 --- a/cimpy/cgmes_v2_4_15/ShuntCompensator.py +++ b/cimpy/cgmes_v2_4_15/ShuntCompensator.py @@ -1,58 +1,60 @@ -from .RegulatingCondEq import RegulatingCondEq - - -class ShuntCompensator(RegulatingCondEq): - ''' - A shunt capacitor or reactor or switchable bank of shunt capacitors or reactors. A section of a shunt compensator is an individual capacitor or reactor. A negative value for reactivePerSection indicates that the compensator is a reactor. ShuntCompensator is a single terminal device. Ground is implied. - - :aVRDelay: Time delay required for the device to be connected or disconnected by automatic voltage regulation (AVR). Default: 0 - :grounded: Used for Yn and Zn connections. True if the neutral is solidly grounded. Default: False - :maximumSections: The maximum number of sections that may be switched in. Default: 0 - :nomU: The voltage at which the nominal reactive power may be calculated. This should normally be within 10% of the voltage at which the capacitor is connected to the network. Default: 0.0 - :normalSections: The normal number of sections switched in. Default: 0 - :switchOnCount: The switch on count since the capacitor count was last reset or initialized. Default: 0 - :switchOnDate: The date and time when the capacitor bank was last switched on. Default: '' - :voltageSensitivity: Voltage sensitivity required for the device to regulate the bus voltage, in voltage/reactive power. Default: 0.0 - :sections: Shunt compensator sections in use. Starting value for steady state solution. Non integer values are allowed to support continuous variables. The reasons for continuous value are to support study cases where no discrete shunt compensators has yet been designed, a solutions where a narrow voltage band force the sections to oscillate or accommodate for a continuous solution as input. Default: 0.0 - :SvShuntCompensatorSections: The state for the number of shunt compensator sections in service. Default: None - ''' - - cgmesProfile = RegulatingCondEq.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, ], - 'aVRDelay': [cgmesProfile.EQ.value, ], - 'grounded': [cgmesProfile.EQ.value, ], - 'maximumSections': [cgmesProfile.EQ.value, ], - 'nomU': [cgmesProfile.EQ.value, ], - 'normalSections': [cgmesProfile.EQ.value, ], - 'switchOnCount': [cgmesProfile.EQ.value, ], - 'switchOnDate': [cgmesProfile.EQ.value, ], - 'voltageSensitivity': [cgmesProfile.EQ.value, ], - 'sections': [cgmesProfile.SSH.value, ], - 'SvShuntCompensatorSections': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class RegulatingCondEq: \n' + RegulatingCondEq.__doc__ - - def __init__(self, aVRDelay = 0, grounded = False, maximumSections = 0, nomU = 0.0, normalSections = 0, switchOnCount = 0, switchOnDate = '', voltageSensitivity = 0.0, sections = 0.0, SvShuntCompensatorSections = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.aVRDelay = aVRDelay - self.grounded = grounded - self.maximumSections = maximumSections - self.nomU = nomU - self.normalSections = normalSections - self.switchOnCount = switchOnCount - self.switchOnDate = switchOnDate - self.voltageSensitivity = voltageSensitivity - self.sections = sections - self.SvShuntCompensatorSections = SvShuntCompensatorSections - - def __str__(self): - str = 'class=ShuntCompensator\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .RegulatingCondEq import RegulatingCondEq +from .CGMESProfile import Profile + + +class ShuntCompensator(RegulatingCondEq): + """ + A shunt capacitor or reactor or switchable bank of shunt capacitors or reactors. A section of a shunt compensator is an individual capacitor or reactor. A negative value for reactivePerSection indicates that the compensator is a reactor. ShuntCompensator is a single terminal device. Ground is implied. + + :SvShuntCompensatorSections: The state for the number of shunt compensator sections in service. Default: None + :aVRDelay: Time delay required for the device to be connected or disconnected by automatic voltage regulation (AVR). Default: 0.0 + :grounded: Used for Yn and Zn connections. True if the neutral is solidly grounded. Default: False + :maximumSections: The maximum number of sections that may be switched in. Default: 0 + :nomU: The voltage at which the nominal reactive power may be calculated. This should normally be within 10% of the voltage at which the capacitor is connected to the network. Default: 0.0 + :normalSections: The normal number of sections switched in. Default: 0 + :sections: Shunt compensator sections in use. Starting value for steady state solution. Non integer values are allowed to support continuous variables. The reasons for continuous value are to support study cases where no discrete shunt compensators has yet been designed, a solutions where a narrow voltage band force the sections to oscillate or accommodate for a continuous solution as input. Default: 0.0 + :switchOnCount: The switch on count since the capacitor count was last reset or initialized. Default: 0 + :switchOnDate: The date and time when the capacitor bank was last switched on. Default: '' + :voltageSensitivity: Voltage sensitivity required for the device to regulate the bus voltage, in voltage/reactive power. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "SvShuntCompensatorSections": [Profile.SV.value, ], + "aVRDelay": [Profile.EQ.value, ], + "grounded": [Profile.EQ.value, ], + "maximumSections": [Profile.EQ.value, ], + "nomU": [Profile.EQ.value, ], + "normalSections": [Profile.EQ.value, ], + "sections": [Profile.SSH.value, ], + "switchOnCount": [Profile.EQ.value, ], + "switchOnDate": [Profile.EQ.value, ], + "voltageSensitivity": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class RegulatingCondEq:\n" + RegulatingCondEq.__doc__ + + def __init__(self, SvShuntCompensatorSections = None, aVRDelay = 0.0, grounded = False, maximumSections = 0, nomU = 0.0, normalSections = 0, sections = 0.0, switchOnCount = 0, switchOnDate = '', voltageSensitivity = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.SvShuntCompensatorSections = SvShuntCompensatorSections + self.aVRDelay = aVRDelay + self.grounded = grounded + self.maximumSections = maximumSections + self.nomU = nomU + self.normalSections = normalSections + self.sections = sections + self.switchOnCount = switchOnCount + self.switchOnDate = switchOnDate + self.voltageSensitivity = voltageSensitivity + + def __str__(self): + str = "class=ShuntCompensator\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Simple_Float.py b/cimpy/cgmes_v2_4_15/Simple_Float.py index 3a583b86..36efc1ee 100644 --- a/cimpy/cgmes_v2_4_15/Simple_Float.py +++ b/cimpy/cgmes_v2_4_15/Simple_Float.py @@ -1,30 +1,31 @@ -from .Base import Base - - -class Simple_Float(Base): - ''' - A floating point number. The range is unspecified and not limited. - - :value: Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - 'value': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, ): - - self.value = value - - def __str__(self): - str = 'class=Simple_Float\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Simple_Float(Base): + """ + A floating point number. The range is unspecified and not limited. + + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DL.value, Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "value": [Profile.DL.value, Profile.DY.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, value = 0.0): + + self.value = value + + def __str__(self): + str = "class=Simple_Float\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SolarGeneratingUnit.py b/cimpy/cgmes_v2_4_15/SolarGeneratingUnit.py index ef51fead..9489f020 100644 --- a/cimpy/cgmes_v2_4_15/SolarGeneratingUnit.py +++ b/cimpy/cgmes_v2_4_15/SolarGeneratingUnit.py @@ -1,29 +1,31 @@ -from .GeneratingUnit import GeneratingUnit - - -class SolarGeneratingUnit(GeneratingUnit): - ''' - A solar thermal generating unit. - - ''' - - cgmesProfile = GeneratingUnit.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class GeneratingUnit: \n' + GeneratingUnit.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=SolarGeneratingUnit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .GeneratingUnit import GeneratingUnit +from .CGMESProfile import Profile + + +class SolarGeneratingUnit(GeneratingUnit): + """ + A solar thermal generating unit. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class GeneratingUnit:\n" + GeneratingUnit.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=SolarGeneratingUnit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Source.py b/cimpy/cgmes_v2_4_15/Source.py index 7a16742a..db562235 100644 --- a/cimpy/cgmes_v2_4_15/Source.py +++ b/cimpy/cgmes_v2_4_15/Source.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class Source(Base): - ''' - Source gives information related to the origin of a value. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=Source\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Source(Base): + """ + Source gives information related to the origin of a value. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=Source\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/StateVariablesVersion.py b/cimpy/cgmes_v2_4_15/StateVariablesVersion.py index bc6ec911..36b17603 100644 --- a/cimpy/cgmes_v2_4_15/StateVariablesVersion.py +++ b/cimpy/cgmes_v2_4_15/StateVariablesVersion.py @@ -1,57 +1,58 @@ -from .Base import Base - - -class StateVariablesVersion(Base): - ''' - Version details. - - :baseUML: Base UML provided by CIM model manager. Default: '' - :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' - :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' - :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' - :entsoeUML: UML provided by ENTSO-E. Default: '' - :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/StateVariables/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' - :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' - :namespaceRDF: RDF namespace. Default: '' - :namespaceUML: CIM UML namespace. Default: '' - :shortName: The short name of the profile used in profile documentation. Default: '' - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SV.value, ], - 'baseUML': [cgmesProfile.SV.value, ], - 'baseURI': [cgmesProfile.SV.value, ], - 'date': [cgmesProfile.SV.value, ], - 'differenceModelURI': [cgmesProfile.SV.value, ], - 'entsoeUML': [cgmesProfile.SV.value, ], - 'entsoeURI': [cgmesProfile.SV.value, ], - 'modelDescriptionURI': [cgmesProfile.SV.value, ], - 'namespaceRDF': [cgmesProfile.SV.value, ], - 'namespaceUML': [cgmesProfile.SV.value, ], - 'shortName': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - - - def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = '', ): - - self.baseUML = baseUML - self.baseURI = baseURI - self.date = date - self.differenceModelURI = differenceModelURI - self.entsoeUML = entsoeUML - self.entsoeURI = entsoeURI - self.modelDescriptionURI = modelDescriptionURI - self.namespaceRDF = namespaceRDF - self.namespaceUML = namespaceUML - self.shortName = shortName - - def __str__(self): - str = 'class=StateVariablesVersion\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class StateVariablesVersion(Base): + """ + Version details. + + :baseUML: Base UML provided by CIM model manager. Default: '' + :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' + :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' + :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' + :entsoeUML: UML provided by ENTSO-E. Default: '' + :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/StateVariables/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' + :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' + :namespaceRDF: RDF namespace. Default: '' + :namespaceUML: CIM UML namespace. Default: '' + :shortName: The short name of the profile used in profile documentation. Default: '' + """ + + possibleProfileList = { + "class": [Profile.SV.value, ], + "baseUML": [Profile.SV.value, ], + "baseURI": [Profile.SV.value, ], + "date": [Profile.SV.value, ], + "differenceModelURI": [Profile.SV.value, ], + "entsoeUML": [Profile.SV.value, ], + "entsoeURI": [Profile.SV.value, ], + "modelDescriptionURI": [Profile.SV.value, ], + "namespaceRDF": [Profile.SV.value, ], + "namespaceUML": [Profile.SV.value, ], + "shortName": [Profile.SV.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SV.value + + + def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = ''): + + self.baseUML = baseUML + self.baseURI = baseURI + self.date = date + self.differenceModelURI = differenceModelURI + self.entsoeUML = entsoeUML + self.entsoeURI = entsoeURI + self.modelDescriptionURI = modelDescriptionURI + self.namespaceRDF = namespaceRDF + self.namespaceUML = namespaceUML + self.shortName = shortName + + def __str__(self): + str = "class=StateVariablesVersion\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/StaticLoadModelKind.py b/cimpy/cgmes_v2_4_15/StaticLoadModelKind.py index 66cd340d..b2297284 100644 --- a/cimpy/cgmes_v2_4_15/StaticLoadModelKind.py +++ b/cimpy/cgmes_v2_4_15/StaticLoadModelKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class StaticLoadModelKind(Base): - ''' - Type of static load model. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=StaticLoadModelKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class StaticLoadModelKind(Base): + """ + Type of static load model. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=StaticLoadModelKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/StaticVarCompensator.py b/cimpy/cgmes_v2_4_15/StaticVarCompensator.py index d41aa7f6..a2cbcb49 100644 --- a/cimpy/cgmes_v2_4_15/StaticVarCompensator.py +++ b/cimpy/cgmes_v2_4_15/StaticVarCompensator.py @@ -1,46 +1,48 @@ -from .RegulatingCondEq import RegulatingCondEq - - -class StaticVarCompensator(RegulatingCondEq): - ''' - A facility for providing variable and controllable shunt reactive power. The SVC typically consists of a stepdown transformer, filter, thyristor-controlled reactor, and thyristor-switched capacitor arms. The SVC may operate in fixed MVar output mode or in voltage control mode. When in voltage control mode, the output of the SVC will be proportional to the deviation of voltage at the controlled bus from the voltage setpoint. The SVC characteristic slope defines the proportion. If the voltage at the controlled bus is equal to the voltage setpoint, the SVC MVar output is zero. - - :capacitiveRating: Maximum available capacitive reactance. Default: 0.0 - :inductiveRating: Maximum available inductive reactance. Default: 0.0 - :slope: The characteristics slope of an SVC defines how the reactive power output changes in proportion to the difference between the regulated bus voltage and the voltage setpoint. Default: 0.0 - :sVCControlMode: SVC control mode. Default: None - :voltageSetPoint: The reactive power output of the SVC is proportional to the difference between the voltage at the regulated bus and the voltage setpoint. When the regulated bus voltage is equal to the voltage setpoint, the reactive power output is zero. Default: 0.0 - :q: Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution. Default: 0.0 - ''' - - cgmesProfile = RegulatingCondEq.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'capacitiveRating': [cgmesProfile.EQ.value, ], - 'inductiveRating': [cgmesProfile.EQ.value, ], - 'slope': [cgmesProfile.EQ.value, ], - 'sVCControlMode': [cgmesProfile.EQ.value, ], - 'voltageSetPoint': [cgmesProfile.EQ.value, ], - 'q': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class RegulatingCondEq: \n' + RegulatingCondEq.__doc__ - - def __init__(self, capacitiveRating = 0.0, inductiveRating = 0.0, slope = 0.0, sVCControlMode = None, voltageSetPoint = 0.0, q = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.capacitiveRating = capacitiveRating - self.inductiveRating = inductiveRating - self.slope = slope - self.sVCControlMode = sVCControlMode - self.voltageSetPoint = voltageSetPoint - self.q = q - - def __str__(self): - str = 'class=StaticVarCompensator\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .RegulatingCondEq import RegulatingCondEq +from .CGMESProfile import Profile + + +class StaticVarCompensator(RegulatingCondEq): + """ + A facility for providing variable and controllable shunt reactive power. The SVC typically consists of a stepdown transformer, filter, thyristor-controlled reactor, and thyristor-switched capacitor arms. The SVC may operate in fixed MVar output mode or in voltage control mode. When in voltage control mode, the output of the SVC will be proportional to the deviation of voltage at the controlled bus from the voltage setpoint. The SVC characteristic slope defines the proportion. If the voltage at the controlled bus is equal to the voltage setpoint, the SVC MVar output is zero. + + :capacitiveRating: Maximum available capacitive reactance. Default: 0.0 + :inductiveRating: Maximum available inductive reactance. Default: 0.0 + :q: Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution. Default: 0.0 + :sVCControlMode: SVC control mode. Default: None + :slope: The characteristics slope of an SVC defines how the reactive power output changes in proportion to the difference between the regulated bus voltage and the voltage setpoint. Default: 0.0 + :voltageSetPoint: The reactive power output of the SVC is proportional to the difference between the voltage at the regulated bus and the voltage setpoint. When the regulated bus voltage is equal to the voltage setpoint, the reactive power output is zero. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "capacitiveRating": [Profile.EQ.value, ], + "inductiveRating": [Profile.EQ.value, ], + "q": [Profile.SSH.value, ], + "sVCControlMode": [Profile.EQ.value, ], + "slope": [Profile.EQ.value, ], + "voltageSetPoint": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class RegulatingCondEq:\n" + RegulatingCondEq.__doc__ + + def __init__(self, capacitiveRating = 0.0, inductiveRating = 0.0, q = 0.0, sVCControlMode = None, slope = 0.0, voltageSetPoint = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.capacitiveRating = capacitiveRating + self.inductiveRating = inductiveRating + self.q = q + self.sVCControlMode = sVCControlMode + self.slope = slope + self.voltageSetPoint = voltageSetPoint + + def __str__(self): + str = "class=StaticVarCompensator\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/StationSupply.py b/cimpy/cgmes_v2_4_15/StationSupply.py index 1953b51e..d045939b 100644 --- a/cimpy/cgmes_v2_4_15/StationSupply.py +++ b/cimpy/cgmes_v2_4_15/StationSupply.py @@ -1,29 +1,31 @@ -from .EnergyConsumer import EnergyConsumer - - -class StationSupply(EnergyConsumer): - ''' - Station supply with load derived from the station output. - - ''' - - cgmesProfile = EnergyConsumer.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EnergyConsumer: \n' + EnergyConsumer.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=StationSupply\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EnergyConsumer import EnergyConsumer +from .CGMESProfile import Profile + + +class StationSupply(EnergyConsumer): + """ + Station supply with load derived from the station output. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EnergyConsumer:\n" + EnergyConsumer.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=StationSupply\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SteadyStateHypothesisVersion.py b/cimpy/cgmes_v2_4_15/SteadyStateHypothesisVersion.py index 0692fd51..978a9339 100644 --- a/cimpy/cgmes_v2_4_15/SteadyStateHypothesisVersion.py +++ b/cimpy/cgmes_v2_4_15/SteadyStateHypothesisVersion.py @@ -1,57 +1,58 @@ -from .Base import Base - - -class SteadyStateHypothesisVersion(Base): - ''' - Version details. - - :baseUML: Base UML provided by CIM model manager. Default: '' - :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' - :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' - :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' - :entsoeUML: UML provided by ENTSO-E. Default: '' - :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/SteadyStateHypothesis/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' - :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' - :namespaceRDF: RDF namespace. Default: '' - :namespaceUML: CIM UML namespace. Default: '' - :shortName: The short name of the profile used in profile documentation. Default: '' - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SSH.value, ], - 'baseUML': [cgmesProfile.SSH.value, ], - 'baseURI': [cgmesProfile.SSH.value, ], - 'date': [cgmesProfile.SSH.value, ], - 'differenceModelURI': [cgmesProfile.SSH.value, ], - 'entsoeUML': [cgmesProfile.SSH.value, ], - 'entsoeURI': [cgmesProfile.SSH.value, ], - 'modelDescriptionURI': [cgmesProfile.SSH.value, ], - 'namespaceRDF': [cgmesProfile.SSH.value, ], - 'namespaceUML': [cgmesProfile.SSH.value, ], - 'shortName': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - - - def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = '', ): - - self.baseUML = baseUML - self.baseURI = baseURI - self.date = date - self.differenceModelURI = differenceModelURI - self.entsoeUML = entsoeUML - self.entsoeURI = entsoeURI - self.modelDescriptionURI = modelDescriptionURI - self.namespaceRDF = namespaceRDF - self.namespaceUML = namespaceUML - self.shortName = shortName - - def __str__(self): - str = 'class=SteadyStateHypothesisVersion\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class SteadyStateHypothesisVersion(Base): + """ + Version details. + + :baseUML: Base UML provided by CIM model manager. Default: '' + :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' + :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' + :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' + :entsoeUML: UML provided by ENTSO-E. Default: '' + :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/SteadyStateHypothesis/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' + :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' + :namespaceRDF: RDF namespace. Default: '' + :namespaceUML: CIM UML namespace. Default: '' + :shortName: The short name of the profile used in profile documentation. Default: '' + """ + + possibleProfileList = { + "class": [Profile.SSH.value, ], + "baseUML": [Profile.SSH.value, ], + "baseURI": [Profile.SSH.value, ], + "date": [Profile.SSH.value, ], + "differenceModelURI": [Profile.SSH.value, ], + "entsoeUML": [Profile.SSH.value, ], + "entsoeURI": [Profile.SSH.value, ], + "modelDescriptionURI": [Profile.SSH.value, ], + "namespaceRDF": [Profile.SSH.value, ], + "namespaceUML": [Profile.SSH.value, ], + "shortName": [Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SSH.value + + + def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = ''): + + self.baseUML = baseUML + self.baseURI = baseURI + self.date = date + self.differenceModelURI = differenceModelURI + self.entsoeUML = entsoeUML + self.entsoeURI = entsoeURI + self.modelDescriptionURI = modelDescriptionURI + self.namespaceRDF = namespaceRDF + self.namespaceUML = namespaceUML + self.shortName = shortName + + def __str__(self): + str = "class=SteadyStateHypothesisVersion\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/String.py b/cimpy/cgmes_v2_4_15/String.py deleted file mode 100644 index a00af050..00000000 --- a/cimpy/cgmes_v2_4_15/String.py +++ /dev/null @@ -1,28 +0,0 @@ -from cimpy.cgmes_v2_4_15.Base import Base - - -class String(Base): - ''' - A string consisting of a sequence of characters. The character encoding is UTF-8. The string length is unspecified and unlimited. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DI.value, cgmesProfile.DY.value, cgmesProfile.EQ.value, cgmesProfile.GL.value, cgmesProfile.SV.value, cgmesProfile.SSH.value, cgmesProfile.TP.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=String\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str diff --git a/cimpy/cgmes_v2_4_15/StringMeasurement.py b/cimpy/cgmes_v2_4_15/StringMeasurement.py index 0cd18710..4b775774 100644 --- a/cimpy/cgmes_v2_4_15/StringMeasurement.py +++ b/cimpy/cgmes_v2_4_15/StringMeasurement.py @@ -1,31 +1,33 @@ -from .Measurement import Measurement - - -class StringMeasurement(Measurement): - ''' - StringMeasurement represents a measurement with values of type string. - - :StringMeasurementValues: The values connected to this measurement. Default: "list" - ''' - - cgmesProfile = Measurement.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'StringMeasurementValues': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Measurement: \n' + Measurement.__doc__ - - def __init__(self, StringMeasurementValues = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.StringMeasurementValues = StringMeasurementValues - - def __str__(self): - str = 'class=StringMeasurement\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Measurement import Measurement +from .CGMESProfile import Profile + + +class StringMeasurement(Measurement): + """ + StringMeasurement represents a measurement with values of type string. + + :StringMeasurementValues: The values connected to this measurement. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "StringMeasurementValues": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Measurement:\n" + Measurement.__doc__ + + def __init__(self, StringMeasurementValues = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.StringMeasurementValues = StringMeasurementValues + + def __str__(self): + str = "class=StringMeasurement\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/StringMeasurementValue.py b/cimpy/cgmes_v2_4_15/StringMeasurementValue.py index 49f39f44..82a462e6 100644 --- a/cimpy/cgmes_v2_4_15/StringMeasurementValue.py +++ b/cimpy/cgmes_v2_4_15/StringMeasurementValue.py @@ -1,34 +1,36 @@ -from .MeasurementValue import MeasurementValue - - -class StringMeasurementValue(MeasurementValue): - ''' - StringMeasurementValue represents a measurement value of type string. - - :StringMeasurement: Measurement to which this value is connected. Default: None - :value: The value to supervise. Default: '' - ''' - - cgmesProfile = MeasurementValue.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'StringMeasurement': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class MeasurementValue: \n' + MeasurementValue.__doc__ - - def __init__(self, StringMeasurement = None, value = '', *args, **kw_args): - super().__init__(*args, **kw_args) - - self.StringMeasurement = StringMeasurement - self.value = value - - def __str__(self): - str = 'class=StringMeasurementValue\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .MeasurementValue import MeasurementValue +from .CGMESProfile import Profile + + +class StringMeasurementValue(MeasurementValue): + """ + StringMeasurementValue represents a measurement value of type string. + + :StringMeasurement: Measurement to which this value is connected. Default: None + :value: The value to supervise. Default: '' + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "StringMeasurement": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class MeasurementValue:\n" + MeasurementValue.__doc__ + + def __init__(self, StringMeasurement = None, value = '', *args, **kw_args): + super().__init__(*args, **kw_args) + + self.StringMeasurement = StringMeasurement + self.value = value + + def __str__(self): + str = "class=StringMeasurementValue\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SubGeographicalRegion.py b/cimpy/cgmes_v2_4_15/SubGeographicalRegion.py index a6168805..a46f271d 100644 --- a/cimpy/cgmes_v2_4_15/SubGeographicalRegion.py +++ b/cimpy/cgmes_v2_4_15/SubGeographicalRegion.py @@ -1,40 +1,42 @@ -from .IdentifiedObject import IdentifiedObject - - -class SubGeographicalRegion(IdentifiedObject): - ''' - A subset of a geographical region of a power system network model. - - :DCLines: Default: "list" - :Region: The geographical region to which this sub-geographical region is within. Default: None - :Lines: The lines within the sub-geographical region. Default: "list" - :Substations: The substations in this sub-geographical region. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - 'DCLines': [cgmesProfile.EQ.value, ], - 'Region': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - 'Lines': [cgmesProfile.EQ.value, cgmesProfile.EQ_BD.value, ], - 'Substations': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, DCLines = "list", Region = None, Lines = "list", Substations = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.DCLines = DCLines - self.Region = Region - self.Lines = Lines - self.Substations = Substations - - def __str__(self): - str = 'class=SubGeographicalRegion\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class SubGeographicalRegion(IdentifiedObject): + """ + A subset of a geographical region of a power system network model. + + :DCLines: Default: "list" + :Lines: The sub-geographical region of the line. Default: "list" + :Region: The geographical region to which this sub-geographical region is within. Default: None + :Substations: The substations in this sub-geographical region. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ_BD.value, Profile.EQ.value, ], + "DCLines": [Profile.EQ.value, ], + "Lines": [Profile.EQ_BD.value, Profile.EQ.value, ], + "Region": [Profile.EQ_BD.value, Profile.EQ.value, ], + "Substations": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, DCLines = "list", Lines = "list", Region = None, Substations = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DCLines = DCLines + self.Lines = Lines + self.Region = Region + self.Substations = Substations + + def __str__(self): + str = "class=SubGeographicalRegion\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SubLoadArea.py b/cimpy/cgmes_v2_4_15/SubLoadArea.py index 4f211e8a..74f90415 100644 --- a/cimpy/cgmes_v2_4_15/SubLoadArea.py +++ b/cimpy/cgmes_v2_4_15/SubLoadArea.py @@ -1,34 +1,36 @@ -from .EnergyArea import EnergyArea - - -class SubLoadArea(EnergyArea): - ''' - The class is the second level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling. - - :LoadArea: The LoadArea where the SubLoadArea belongs. Default: None - :LoadGroups: The Loadgroups in the SubLoadArea. Default: "list" - ''' - - cgmesProfile = EnergyArea.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'LoadArea': [cgmesProfile.EQ.value, ], - 'LoadGroups': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EnergyArea: \n' + EnergyArea.__doc__ - - def __init__(self, LoadArea = None, LoadGroups = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.LoadArea = LoadArea - self.LoadGroups = LoadGroups - - def __str__(self): - str = 'class=SubLoadArea\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EnergyArea import EnergyArea +from .CGMESProfile import Profile + + +class SubLoadArea(EnergyArea): + """ + The class is the second level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling. + + :LoadArea: The LoadArea where the SubLoadArea belongs. Default: None + :LoadGroups: The Loadgroups in the SubLoadArea. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "LoadArea": [Profile.EQ.value, ], + "LoadGroups": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EnergyArea:\n" + EnergyArea.__doc__ + + def __init__(self, LoadArea = None, LoadGroups = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.LoadArea = LoadArea + self.LoadGroups = LoadGroups + + def __str__(self): + str = "class=SubLoadArea\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Substation.py b/cimpy/cgmes_v2_4_15/Substation.py index 669b1c40..504ffd7b 100644 --- a/cimpy/cgmes_v2_4_15/Substation.py +++ b/cimpy/cgmes_v2_4_15/Substation.py @@ -1,37 +1,39 @@ -from .EquipmentContainer import EquipmentContainer - - -class Substation(EquipmentContainer): - ''' - A collection of equipment for purposes other than generation or utilization, through which electric energy in bulk is passed for the purposes of switching or modifying its characteristics. - - :DCConverterUnit: Default: "list" - :Region: The SubGeographicalRegion containing the substation. Default: None - :VoltageLevels: The voltage levels within this substation. Default: "list" - ''' - - cgmesProfile = EquipmentContainer.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'DCConverterUnit': [cgmesProfile.EQ.value, ], - 'Region': [cgmesProfile.EQ.value, ], - 'VoltageLevels': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EquipmentContainer: \n' + EquipmentContainer.__doc__ - - def __init__(self, DCConverterUnit = "list", Region = None, VoltageLevels = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.DCConverterUnit = DCConverterUnit - self.Region = Region - self.VoltageLevels = VoltageLevels - - def __str__(self): - str = 'class=Substation\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EquipmentContainer import EquipmentContainer +from .CGMESProfile import Profile + + +class Substation(EquipmentContainer): + """ + A collection of equipment for purposes other than generation or utilization, through which electric energy in bulk is passed for the purposes of switching or modifying its characteristics. + + :DCConverterUnit: Default: "list" + :Region: The SubGeographicalRegion containing the substation. Default: None + :VoltageLevels: The voltage levels within this substation. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "DCConverterUnit": [Profile.EQ.value, ], + "Region": [Profile.EQ.value, ], + "VoltageLevels": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EquipmentContainer:\n" + EquipmentContainer.__doc__ + + def __init__(self, DCConverterUnit = "list", Region = None, VoltageLevels = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.DCConverterUnit = DCConverterUnit + self.Region = Region + self.VoltageLevels = VoltageLevels + + def __str__(self): + str = "class=Substation\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Susceptance.py b/cimpy/cgmes_v2_4_15/Susceptance.py index c2eaa7c8..71849ca0 100644 --- a/cimpy/cgmes_v2_4_15/Susceptance.py +++ b/cimpy/cgmes_v2_4_15/Susceptance.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class Susceptance(Base): - ''' - Imaginary part of admittance. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=Susceptance\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Susceptance(Base): + """ + Imaginary part of admittance. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=Susceptance\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SvInjection.py b/cimpy/cgmes_v2_4_15/SvInjection.py index 02d51d20..ec5b01d8 100644 --- a/cimpy/cgmes_v2_4_15/SvInjection.py +++ b/cimpy/cgmes_v2_4_15/SvInjection.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class SvInjection(Base): - ''' - The SvInjection is reporting the calculated bus injection minus the sum of the terminal flows. The terminal flow is positive out from the bus (load sign convention) and bus injection has positive flow into the bus. SvInjection may have the remainder after state estimation or slack after power flow calculation. - - :pInjection: The active power injected into the bus in addition to injections from equipment terminals. Positive sign means injection into the TopologicalNode (bus). Default: 0.0 - :qInjection: The reactive power injected into the bus in addition to injections from equipment terminals. Positive sign means injection into the TopologicalNode (bus). Default: 0.0 - :TopologicalNode: The injection flows state variables associated with the topological node. Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SV.value, ], - 'pInjection': [cgmesProfile.SV.value, ], - 'qInjection': [cgmesProfile.SV.value, ], - 'TopologicalNode': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - - - def __init__(self, pInjection = 0.0, qInjection = 0.0, TopologicalNode = None, ): - - self.pInjection = pInjection - self.qInjection = qInjection - self.TopologicalNode = TopologicalNode - - def __str__(self): - str = 'class=SvInjection\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class SvInjection(Base): + """ + The SvInjection is reporting the calculated bus injection minus the sum of the terminal flows. The terminal flow is positive out from the bus (load sign convention) and bus injection has positive flow into the bus. SvInjection may have the remainder after state estimation or slack after power flow calculation. + + :TopologicalNode: The injection flows state variables associated with the topological node. Default: None + :pInjection: The active power injected into the bus in addition to injections from equipment terminals. Positive sign means injection into the TopologicalNode (bus). Default: 0.0 + :qInjection: The reactive power injected into the bus in addition to injections from equipment terminals. Positive sign means injection into the TopologicalNode (bus). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.SV.value, ], + "TopologicalNode": [Profile.SV.value, ], + "pInjection": [Profile.SV.value, ], + "qInjection": [Profile.SV.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SV.value + + + def __init__(self, TopologicalNode = None, pInjection = 0.0, qInjection = 0.0): + + self.TopologicalNode = TopologicalNode + self.pInjection = pInjection + self.qInjection = qInjection + + def __str__(self): + str = "class=SvInjection\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SvPowerFlow.py b/cimpy/cgmes_v2_4_15/SvPowerFlow.py index e05c11bf..757b6b66 100644 --- a/cimpy/cgmes_v2_4_15/SvPowerFlow.py +++ b/cimpy/cgmes_v2_4_15/SvPowerFlow.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class SvPowerFlow(Base): - ''' - State variable for power flow. Load convention is used for flow direction. This means flow out from the TopologicalNode into the equipment is positive. - - :Terminal: The terminal associated with the power flow state variable. Default: None - :p: The active power flow. Load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment. Default: 0.0 - :q: The reactive power flow. Load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment. Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SV.value, ], - 'Terminal': [cgmesProfile.SV.value, ], - 'p': [cgmesProfile.SV.value, ], - 'q': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - - - def __init__(self, Terminal = None, p = 0.0, q = 0.0, ): - - self.Terminal = Terminal - self.p = p - self.q = q - - def __str__(self): - str = 'class=SvPowerFlow\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class SvPowerFlow(Base): + """ + State variable for power flow. Load convention is used for flow direction. This means flow out from the TopologicalNode into the equipment is positive. + + :Terminal: The terminal associated with the power flow state variable. Default: None + :p: The active power flow. Load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment. Default: 0.0 + :q: The reactive power flow. Load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.SV.value, ], + "Terminal": [Profile.SV.value, ], + "p": [Profile.SV.value, ], + "q": [Profile.SV.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SV.value + + + def __init__(self, Terminal = None, p = 0.0, q = 0.0): + + self.Terminal = Terminal + self.p = p + self.q = q + + def __str__(self): + str = "class=SvPowerFlow\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SvShuntCompensatorSections.py b/cimpy/cgmes_v2_4_15/SvShuntCompensatorSections.py index c746a764..f83cd7a1 100644 --- a/cimpy/cgmes_v2_4_15/SvShuntCompensatorSections.py +++ b/cimpy/cgmes_v2_4_15/SvShuntCompensatorSections.py @@ -1,33 +1,34 @@ -from .Base import Base - - -class SvShuntCompensatorSections(Base): - ''' - State variable for the number of sections in service for a shunt compensator. - - :sections: The number of sections in service as a continous variable. To get integer value scale with ShuntCompensator.bPerSection. Default: 0.0 - :ShuntCompensator: The shunt compensator for which the state applies. Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SV.value, ], - 'sections': [cgmesProfile.SV.value, ], - 'ShuntCompensator': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - - - def __init__(self, sections = 0.0, ShuntCompensator = None, ): - - self.sections = sections - self.ShuntCompensator = ShuntCompensator - - def __str__(self): - str = 'class=SvShuntCompensatorSections\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class SvShuntCompensatorSections(Base): + """ + State variable for the number of sections in service for a shunt compensator. + + :ShuntCompensator: The shunt compensator for which the state applies. Default: None + :sections: The number of sections in service as a continous variable. To get integer value scale with ShuntCompensator.bPerSection. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.SV.value, ], + "ShuntCompensator": [Profile.SV.value, ], + "sections": [Profile.SV.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SV.value + + + def __init__(self, ShuntCompensator = None, sections = 0.0): + + self.ShuntCompensator = ShuntCompensator + self.sections = sections + + def __str__(self): + str = "class=SvShuntCompensatorSections\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SvStatus.py b/cimpy/cgmes_v2_4_15/SvStatus.py index a34c214f..6215dec5 100644 --- a/cimpy/cgmes_v2_4_15/SvStatus.py +++ b/cimpy/cgmes_v2_4_15/SvStatus.py @@ -1,33 +1,34 @@ -from .Base import Base - - -class SvStatus(Base): - ''' - State variable for status. - - :ConductingEquipment: The conducting equipment associated with the status state variable. Default: None - :inService: The in service status as a result of topology processing. Default: False - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SV.value, ], - 'ConductingEquipment': [cgmesProfile.SV.value, ], - 'inService': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ConductingEquipment = None, inService = False, ): - - self.ConductingEquipment = ConductingEquipment - self.inService = inService - - def __str__(self): - str = 'class=SvStatus\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class SvStatus(Base): + """ + State variable for status. + + :ConductingEquipment: The conducting equipment associated with the status state variable. Default: None + :inService: The in service status as a result of topology processing. Default: False + """ + + possibleProfileList = { + "class": [Profile.SV.value, ], + "ConductingEquipment": [Profile.SV.value, ], + "inService": [Profile.SV.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SV.value + + + def __init__(self, ConductingEquipment = None, inService = False): + + self.ConductingEquipment = ConductingEquipment + self.inService = inService + + def __str__(self): + str = "class=SvStatus\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SvTapStep.py b/cimpy/cgmes_v2_4_15/SvTapStep.py index b4b79ff0..ef8e712c 100644 --- a/cimpy/cgmes_v2_4_15/SvTapStep.py +++ b/cimpy/cgmes_v2_4_15/SvTapStep.py @@ -1,33 +1,34 @@ -from .Base import Base - - -class SvTapStep(Base): - ''' - State variable for transformer tap step. This class is to be used for taps of LTC (load tap changing) transformers, not fixed tap transformers. - - :position: The floating point tap position. This is not the tap ratio, but rather the tap step position as defined by the related tap changer model and normally is constrained to be within the range of minimum and maximum tap positions. Default: 0.0 - :TapChanger: The tap changer associated with the tap step state. Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SV.value, ], - 'position': [cgmesProfile.SV.value, ], - 'TapChanger': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - - - def __init__(self, position = 0.0, TapChanger = None, ): - - self.position = position - self.TapChanger = TapChanger - - def __str__(self): - str = 'class=SvTapStep\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class SvTapStep(Base): + """ + State variable for transformer tap step. This class is to be used for taps of LTC (load tap changing) transformers, not fixed tap transformers. + + :TapChanger: The tap changer associated with the tap step state. Default: None + :position: The floating point tap position. This is not the tap ratio, but rather the tap step position as defined by the related tap changer model and normally is constrained to be within the range of minimum and maximum tap positions. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.SV.value, ], + "TapChanger": [Profile.SV.value, ], + "position": [Profile.SV.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SV.value + + + def __init__(self, TapChanger = None, position = 0.0): + + self.TapChanger = TapChanger + self.position = position + + def __str__(self): + str = "class=SvTapStep\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SvVoltage.py b/cimpy/cgmes_v2_4_15/SvVoltage.py index 6a16d7f9..93a5203e 100644 --- a/cimpy/cgmes_v2_4_15/SvVoltage.py +++ b/cimpy/cgmes_v2_4_15/SvVoltage.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class SvVoltage(Base): - ''' - State variable for voltage. - - :angle: The voltage angle of the topological node complex voltage with respect to system reference. Default: 0.0 - :v: The voltage magnitude of the topological node. Default: 0.0 - :TopologicalNode: The state voltage associated with the topological node. Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SV.value, ], - 'angle': [cgmesProfile.SV.value, ], - 'v': [cgmesProfile.SV.value, ], - 'TopologicalNode': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - - - def __init__(self, angle = 0.0, v = 0.0, TopologicalNode = None, ): - - self.angle = angle - self.v = v - self.TopologicalNode = TopologicalNode - - def __str__(self): - str = 'class=SvVoltage\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class SvVoltage(Base): + """ + State variable for voltage. + + :TopologicalNode: The state voltage associated with the topological node. Default: None + :angle: The voltage angle of the topological node complex voltage with respect to system reference. Default: 0.0 + :v: The voltage magnitude of the topological node. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.SV.value, ], + "TopologicalNode": [Profile.SV.value, ], + "angle": [Profile.SV.value, ], + "v": [Profile.SV.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SV.value + + + def __init__(self, TopologicalNode = None, angle = 0.0, v = 0.0): + + self.TopologicalNode = TopologicalNode + self.angle = angle + self.v = v + + def __str__(self): + str = "class=SvVoltage\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Switch.py b/cimpy/cgmes_v2_4_15/Switch.py index 9e8f3fef..8e437f05 100644 --- a/cimpy/cgmes_v2_4_15/Switch.py +++ b/cimpy/cgmes_v2_4_15/Switch.py @@ -1,43 +1,45 @@ -from .ConductingEquipment import ConductingEquipment - - -class Switch(ConductingEquipment): - ''' - A generic device designed to close, or open, or both, one or more electric circuits. All switches are two terminal devices including grounding switches. - - :normalOpen: The attribute is used in cases when no Measurement for the status value is present. If the Switch has a status measurement the Discrete.normalValue is expected to match with the Switch.normalOpen. Default: False - :ratedCurrent: The maximum continuous current carrying capacity in amps governed by the device material and construction. Default: 0.0 - :retained: Branch is retained in a bus branch model. The flow through retained switches will normally be calculated in power flow. Default: False - :SwitchSchedules: A SwitchSchedule is associated with a Switch. Default: "list" - :open: The attribute tells if the switch is considered open when used as input to topology processing. Default: False - ''' - - cgmesProfile = ConductingEquipment.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'normalOpen': [cgmesProfile.EQ.value, ], - 'ratedCurrent': [cgmesProfile.EQ.value, ], - 'retained': [cgmesProfile.EQ.value, ], - 'SwitchSchedules': [cgmesProfile.EQ.value, ], - 'open': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ConductingEquipment: \n' + ConductingEquipment.__doc__ - - def __init__(self, normalOpen = False, ratedCurrent = 0.0, retained = False, SwitchSchedules = "list", open = False, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.normalOpen = normalOpen - self.ratedCurrent = ratedCurrent - self.retained = retained - self.SwitchSchedules = SwitchSchedules - self.open = open - - def __str__(self): - str = 'class=Switch\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ConductingEquipment import ConductingEquipment +from .CGMESProfile import Profile + + +class Switch(ConductingEquipment): + """ + A generic device designed to close, or open, or both, one or more electric circuits. All switches are two terminal devices including grounding switches. + + :SwitchSchedules: A SwitchSchedule is associated with a Switch. Default: "list" + :normalOpen: The attribute is used in cases when no Measurement for the status value is present. If the Switch has a status measurement the Discrete.normalValue is expected to match with the Switch.normalOpen. Default: False + :open: The attribute tells if the switch is considered open when used as input to topology processing. Default: False + :ratedCurrent: The maximum continuous current carrying capacity in amps governed by the device material and construction. Default: 0.0 + :retained: Branch is retained in a bus branch model. The flow through retained switches will normally be calculated in power flow. Default: False + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "SwitchSchedules": [Profile.EQ.value, ], + "normalOpen": [Profile.EQ.value, ], + "open": [Profile.SSH.value, ], + "ratedCurrent": [Profile.EQ.value, ], + "retained": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ConductingEquipment:\n" + ConductingEquipment.__doc__ + + def __init__(self, SwitchSchedules = "list", normalOpen = False, open = False, ratedCurrent = 0.0, retained = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.SwitchSchedules = SwitchSchedules + self.normalOpen = normalOpen + self.open = open + self.ratedCurrent = ratedCurrent + self.retained = retained + + def __str__(self): + str = "class=Switch\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SwitchSchedule.py b/cimpy/cgmes_v2_4_15/SwitchSchedule.py index 0ecfd7c6..de62d0f3 100644 --- a/cimpy/cgmes_v2_4_15/SwitchSchedule.py +++ b/cimpy/cgmes_v2_4_15/SwitchSchedule.py @@ -1,31 +1,33 @@ -from .SeasonDayTypeSchedule import SeasonDayTypeSchedule - - -class SwitchSchedule(SeasonDayTypeSchedule): - ''' - A schedule of switch positions. If RegularTimePoint.value1 is 0, the switch is open. If 1, the switch is closed. - - :Switch: A Switch can be associated with SwitchSchedules. Default: None - ''' - - cgmesProfile = SeasonDayTypeSchedule.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'Switch': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class SeasonDayTypeSchedule: \n' + SeasonDayTypeSchedule.__doc__ - - def __init__(self, Switch = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Switch = Switch - - def __str__(self): - str = 'class=SwitchSchedule\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .SeasonDayTypeSchedule import SeasonDayTypeSchedule +from .CGMESProfile import Profile + + +class SwitchSchedule(SeasonDayTypeSchedule): + """ + A schedule of switch positions. If RegularTimePoint.value1 is 0, the switch is open. If 1, the switch is closed. + + :Switch: A Switch can be associated with SwitchSchedules. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "Switch": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class SeasonDayTypeSchedule:\n" + SeasonDayTypeSchedule.__doc__ + + def __init__(self, Switch = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Switch = Switch + + def __str__(self): + str = "class=SwitchSchedule\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SynchronousMachine.py b/cimpy/cgmes_v2_4_15/SynchronousMachine.py index 476e0f1a..598951c8 100644 --- a/cimpy/cgmes_v2_4_15/SynchronousMachine.py +++ b/cimpy/cgmes_v2_4_15/SynchronousMachine.py @@ -1,97 +1,99 @@ -from .RotatingMachine import RotatingMachine - - -class SynchronousMachine(RotatingMachine): - ''' - An electromechanical device that operates with shaft rotating synchronously with the network. It is a single machine operating either as a generator or synchronous condenser or pump. - - :InitialReactiveCapabilityCurve: Synchronous machines using this curve as default. Default: None - :maxQ: Maximum reactive power limit. This is the maximum (nameplate) limit for the unit. Default: 0.0 - :minQ: Minimum reactive power limit for the unit. Default: 0.0 - :qPercent: Percent of the coordinated reactive control that comes from this machine. Default: 0.0 - :type: Modes that this synchronous machine can operate in. Default: None - :earthing: Indicates whether or not the generator is earthed. Used for short circuit data exchange according to IEC 60909 Default: False - :earthingStarPointR: Generator star point earthing resistance (Re). Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :earthingStarPointX: Generator star point earthing reactance (Xe). Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :ikk: Steady-state short-circuit current (in A for the profile) of generator with compound excitation during 3-phase short circuit. - Ikk=0: Generator with no compound excitation. - Ikk?0: Generator with compound excitation. Ikk is used to calculate the minimum steady-state short-circuit current for generators with compound excitation (Section 4.6.1.2 in the IEC 60909-0) Used only for single fed short circuit on a generator. (Section 4.3.4.2. in the IEC 60909-0) Default: 0.0 - :mu: Factor to calculate the breaking current (Section 4.5.2.1 in the IEC 60909-0). Used only for single fed short circuit on a generator (Section 4.3.4.2. in the IEC 60909-0). Default: 0.0 - :r0: Zero sequence resistance of the synchronous machine. Default: 0.0 - :r2: Negative sequence resistance. Default: 0.0 - :satDirectSubtransX: Direct-axis subtransient reactance saturated, also known as Xd`sat. Default: 0.0 - :satDirectSyncX: Direct-axes saturated synchronous reactance (xdsat); reciprocal of short-circuit ration. Used for short circuit data exchange, only for single fed short circuit on a generator. (Section 4.3.4.2. in the IEC 60909-0). Default: 0.0 - :satDirectTransX: Saturated Direct-axis transient reactance. The attribute is primarily used for short circuit calculations according to ANSI. Default: 0.0 - :shortCircuitRotorType: Type of rotor, used by short circuit applications, only for single fed short circuit according to IEC 60909. Default: None - :voltageRegulationRange: Range of generator voltage regulation (PG in the IEC 60909-0) used for calculation of the impedance correction factor KG defined in IEC 60909-0 This attribute is used to describe the operating voltage of the generating unit. Default: 0.0 - :r: Equivalent resistance (RG) of generator. RG is considered for the calculation of all currents, except for the calculation of the peak current ip. Used for short circuit data exchange according to IEC 60909 Default: 0.0 - :x0: Zero sequence reactance of the synchronous machine. Default: 0.0 - :x2: Negative sequence reactance. Default: 0.0 - :operatingMode: Current mode of operation. Default: None - :referencePriority: Priority of unit for use as powerflow voltage phase angle reference bus selection. 0 = don t care (default) 1 = highest priority. 2 is less than 1 and so on. Default: 0 - :SynchronousMachineDynamics: Synchronous machine dynamics model used to describe dynamic behavior of this synchronous machine. Default: None - ''' - - cgmesProfile = RotatingMachine.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.DY.value, ], - 'InitialReactiveCapabilityCurve': [cgmesProfile.EQ.value, ], - 'maxQ': [cgmesProfile.EQ.value, ], - 'minQ': [cgmesProfile.EQ.value, ], - 'qPercent': [cgmesProfile.EQ.value, ], - 'type': [cgmesProfile.EQ.value, ], - 'earthing': [cgmesProfile.EQ.value, ], - 'earthingStarPointR': [cgmesProfile.EQ.value, ], - 'earthingStarPointX': [cgmesProfile.EQ.value, ], - 'ikk': [cgmesProfile.EQ.value, ], - 'mu': [cgmesProfile.EQ.value, ], - 'r0': [cgmesProfile.EQ.value, ], - 'r2': [cgmesProfile.EQ.value, ], - 'satDirectSubtransX': [cgmesProfile.EQ.value, ], - 'satDirectSyncX': [cgmesProfile.EQ.value, ], - 'satDirectTransX': [cgmesProfile.EQ.value, ], - 'shortCircuitRotorType': [cgmesProfile.EQ.value, ], - 'voltageRegulationRange': [cgmesProfile.EQ.value, ], - 'r': [cgmesProfile.EQ.value, ], - 'x0': [cgmesProfile.EQ.value, ], - 'x2': [cgmesProfile.EQ.value, ], - 'operatingMode': [cgmesProfile.SSH.value, ], - 'referencePriority': [cgmesProfile.SSH.value, ], - 'SynchronousMachineDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class RotatingMachine: \n' + RotatingMachine.__doc__ - - def __init__(self, InitialReactiveCapabilityCurve = None, maxQ = 0.0, minQ = 0.0, qPercent = 0.0, type = None, earthing = False, earthingStarPointR = 0.0, earthingStarPointX = 0.0, ikk = 0.0, mu = 0.0, r0 = 0.0, r2 = 0.0, satDirectSubtransX = 0.0, satDirectSyncX = 0.0, satDirectTransX = 0.0, shortCircuitRotorType = None, voltageRegulationRange = 0.0, r = 0.0, x0 = 0.0, x2 = 0.0, operatingMode = None, referencePriority = 0, SynchronousMachineDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.InitialReactiveCapabilityCurve = InitialReactiveCapabilityCurve - self.maxQ = maxQ - self.minQ = minQ - self.qPercent = qPercent - self.type = type - self.earthing = earthing - self.earthingStarPointR = earthingStarPointR - self.earthingStarPointX = earthingStarPointX - self.ikk = ikk - self.mu = mu - self.r0 = r0 - self.r2 = r2 - self.satDirectSubtransX = satDirectSubtransX - self.satDirectSyncX = satDirectSyncX - self.satDirectTransX = satDirectTransX - self.shortCircuitRotorType = shortCircuitRotorType - self.voltageRegulationRange = voltageRegulationRange - self.r = r - self.x0 = x0 - self.x2 = x2 - self.operatingMode = operatingMode - self.referencePriority = referencePriority - self.SynchronousMachineDynamics = SynchronousMachineDynamics - - def __str__(self): - str = 'class=SynchronousMachine\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .RotatingMachine import RotatingMachine +from .CGMESProfile import Profile + + +class SynchronousMachine(RotatingMachine): + """ + An electromechanical device that operates with shaft rotating synchronously with the network. It is a single machine operating either as a generator or synchronous condenser or pump. + + :InitialReactiveCapabilityCurve: Synchronous machines using this curve as default. Default: None + :SynchronousMachineDynamics: Synchronous machine dynamics model used to describe dynamic behavior of this synchronous machine. Default: None + :earthing: Indicates whether or not the generator is earthed. Used for short circuit data exchange according to IEC 60909 Default: False + :earthingStarPointR: Generator star point earthing resistance (Re). Used for short circuit data exchange according to IEC 60909 Default: 0.0 + :earthingStarPointX: Generator star point earthing reactance (Xe). Used for short circuit data exchange according to IEC 60909 Default: 0.0 + :ikk: Steady-state short-circuit current (in A for the profile) of generator with compound excitation during 3-phase short circuit. - Ikk=0: Generator with no compound excitation. - Ikk?0: Generator with compound excitation. Ikk is used to calculate the minimum steady-state short-circuit current for generators with compound excitation (Section 4.6.1.2 in the IEC 60909-0) Used only for single fed short circuit on a generator. (Section 4.3.4.2. in the IEC 60909-0) Default: 0.0 + :maxQ: Maximum reactive power limit. This is the maximum (nameplate) limit for the unit. Default: 0.0 + :minQ: Minimum reactive power limit for the unit. Default: 0.0 + :mu: Factor to calculate the breaking current (Section 4.5.2.1 in the IEC 60909-0). Used only for single fed short circuit on a generator (Section 4.3.4.2. in the IEC 60909-0). Default: 0.0 + :operatingMode: Current mode of operation. Default: None + :qPercent: Percent of the coordinated reactive control that comes from this machine. Default: 0.0 + :r: Equivalent resistance (RG) of generator. RG is considered for the calculation of all currents, except for the calculation of the peak current ip. Used for short circuit data exchange according to IEC 60909 Default: 0.0 + :r0: Zero sequence resistance of the synchronous machine. Default: 0.0 + :r2: Negative sequence resistance. Default: 0.0 + :referencePriority: Priority of unit for use as powerflow voltage phase angle reference bus selection. 0 = don t care (default) 1 = highest priority. 2 is less than 1 and so on. Default: 0 + :satDirectSubtransX: Direct-axis subtransient reactance saturated, also known as Xd`sat. Default: 0.0 + :satDirectSyncX: Direct-axes saturated synchronous reactance (xdsat); reciprocal of short-circuit ration. Used for short circuit data exchange, only for single fed short circuit on a generator. (Section 4.3.4.2. in the IEC 60909-0). Default: 0.0 + :satDirectTransX: Saturated Direct-axis transient reactance. The attribute is primarily used for short circuit calculations according to ANSI. Default: 0.0 + :shortCircuitRotorType: Type of rotor, used by short circuit applications, only for single fed short circuit according to IEC 60909. Default: None + :type: Modes that this synchronous machine can operate in. Default: None + :voltageRegulationRange: Range of generator voltage regulation (PG in the IEC 60909-0) used for calculation of the impedance correction factor KG defined in IEC 60909-0 This attribute is used to describe the operating voltage of the generating unit. Default: 0.0 + :x0: Zero sequence reactance of the synchronous machine. Default: 0.0 + :x2: Negative sequence reactance. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, Profile.SSH.value, ], + "InitialReactiveCapabilityCurve": [Profile.EQ.value, ], + "SynchronousMachineDynamics": [Profile.DY.value, ], + "earthing": [Profile.EQ.value, ], + "earthingStarPointR": [Profile.EQ.value, ], + "earthingStarPointX": [Profile.EQ.value, ], + "ikk": [Profile.EQ.value, ], + "maxQ": [Profile.EQ.value, ], + "minQ": [Profile.EQ.value, ], + "mu": [Profile.EQ.value, ], + "operatingMode": [Profile.SSH.value, ], + "qPercent": [Profile.EQ.value, ], + "r": [Profile.EQ.value, ], + "r0": [Profile.EQ.value, ], + "r2": [Profile.EQ.value, ], + "referencePriority": [Profile.SSH.value, ], + "satDirectSubtransX": [Profile.EQ.value, ], + "satDirectSyncX": [Profile.EQ.value, ], + "satDirectTransX": [Profile.EQ.value, ], + "shortCircuitRotorType": [Profile.EQ.value, ], + "type": [Profile.EQ.value, ], + "voltageRegulationRange": [Profile.EQ.value, ], + "x0": [Profile.EQ.value, ], + "x2": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class RotatingMachine:\n" + RotatingMachine.__doc__ + + def __init__(self, InitialReactiveCapabilityCurve = None, SynchronousMachineDynamics = None, earthing = False, earthingStarPointR = 0.0, earthingStarPointX = 0.0, ikk = 0.0, maxQ = 0.0, minQ = 0.0, mu = 0.0, operatingMode = None, qPercent = 0.0, r = 0.0, r0 = 0.0, r2 = 0.0, referencePriority = 0, satDirectSubtransX = 0.0, satDirectSyncX = 0.0, satDirectTransX = 0.0, shortCircuitRotorType = None, type = None, voltageRegulationRange = 0.0, x0 = 0.0, x2 = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.InitialReactiveCapabilityCurve = InitialReactiveCapabilityCurve + self.SynchronousMachineDynamics = SynchronousMachineDynamics + self.earthing = earthing + self.earthingStarPointR = earthingStarPointR + self.earthingStarPointX = earthingStarPointX + self.ikk = ikk + self.maxQ = maxQ + self.minQ = minQ + self.mu = mu + self.operatingMode = operatingMode + self.qPercent = qPercent + self.r = r + self.r0 = r0 + self.r2 = r2 + self.referencePriority = referencePriority + self.satDirectSubtransX = satDirectSubtransX + self.satDirectSyncX = satDirectSyncX + self.satDirectTransX = satDirectTransX + self.shortCircuitRotorType = shortCircuitRotorType + self.type = type + self.voltageRegulationRange = voltageRegulationRange + self.x0 = x0 + self.x2 = x2 + + def __str__(self): + str = "class=SynchronousMachine\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SynchronousMachineDetailed.py b/cimpy/cgmes_v2_4_15/SynchronousMachineDetailed.py index 9e86793a..c5c0b7be 100644 --- a/cimpy/cgmes_v2_4_15/SynchronousMachineDetailed.py +++ b/cimpy/cgmes_v2_4_15/SynchronousMachineDetailed.py @@ -1,43 +1,45 @@ -from .SynchronousMachineDynamics import SynchronousMachineDynamics - - -class SynchronousMachineDetailed(SynchronousMachineDynamics): - ''' - All synchronous machine detailed types use a subset of the same data parameters and input/output variables. The several variations differ in the following ways: It is not necessary for each simulation tool to have separate models for each of the model types. The same model can often be used for several types by alternative logic within the model. Also, differences in saturation representation may not result in significant model performance differences so model substitutions are often acceptable. - - :saturationFactorQAxis: Q-axis saturation factor at rated terminal voltage (S1q) (>= 0). Typical Value = 0.02. Default: 0.0 - :saturationFactor120QAxis: Q-axis saturation factor at 120% of rated terminal voltage (S12q) (>=S1q). Typical Value = 0.12. Default: 0.0 - :efdBaseRatio: Ratio of Efd bases of exciter and generator models. Typical Value = 1. Default: 0.0 - :ifdBaseType: Excitation base system mode. Typical Value = ifag. Default: None - :ifdBaseValue: Ifd base current if .ifdBaseType = other. Not needed if .ifdBaseType not = other. Unit = A. Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = SynchronousMachineDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'saturationFactorQAxis': [cgmesProfile.DY.value, ], - 'saturationFactor120QAxis': [cgmesProfile.DY.value, ], - 'efdBaseRatio': [cgmesProfile.DY.value, ], - 'ifdBaseType': [cgmesProfile.DY.value, ], - 'ifdBaseValue': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class SynchronousMachineDynamics: \n' + SynchronousMachineDynamics.__doc__ - - def __init__(self, saturationFactorQAxis = 0.0, saturationFactor120QAxis = 0.0, efdBaseRatio = 0.0, ifdBaseType = None, ifdBaseValue = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.saturationFactorQAxis = saturationFactorQAxis - self.saturationFactor120QAxis = saturationFactor120QAxis - self.efdBaseRatio = efdBaseRatio - self.ifdBaseType = ifdBaseType - self.ifdBaseValue = ifdBaseValue - - def __str__(self): - str = 'class=SynchronousMachineDetailed\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .SynchronousMachineDynamics import SynchronousMachineDynamics +from .CGMESProfile import Profile + + +class SynchronousMachineDetailed(SynchronousMachineDynamics): + """ + All synchronous machine detailed types use a subset of the same data parameters and input/output variables. The several variations differ in the following ways: It is not necessary for each simulation tool to have separate models for each of the model types. The same model can often be used for several types by alternative logic within the model. Also, differences in saturation representation may not result in significant model performance differences so model substitutions are often acceptable. + + :efdBaseRatio: Ratio of Efd bases of exciter and generator models. Typical Value = 1. Default: 0.0 + :ifdBaseType: Excitation base system mode. Typical Value = ifag. Default: None + :ifdBaseValue: Ifd base current if .ifdBaseType = other. Not needed if .ifdBaseType not = other. Unit = A. Typical Value = 0. Default: 0.0 + :saturationFactor120QAxis: Q-axis saturation factor at 120% of rated terminal voltage (S12q) (>=S1q). Typical Value = 0.12. Default: 0.0 + :saturationFactorQAxis: Q-axis saturation factor at rated terminal voltage (S1q) (>= 0). Typical Value = 0.02. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "efdBaseRatio": [Profile.DY.value, ], + "ifdBaseType": [Profile.DY.value, ], + "ifdBaseValue": [Profile.DY.value, ], + "saturationFactor120QAxis": [Profile.DY.value, ], + "saturationFactorQAxis": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class SynchronousMachineDynamics:\n" + SynchronousMachineDynamics.__doc__ + + def __init__(self, efdBaseRatio = 0.0, ifdBaseType = None, ifdBaseValue = 0.0, saturationFactor120QAxis = 0.0, saturationFactorQAxis = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.efdBaseRatio = efdBaseRatio + self.ifdBaseType = ifdBaseType + self.ifdBaseValue = ifdBaseValue + self.saturationFactor120QAxis = saturationFactor120QAxis + self.saturationFactorQAxis = saturationFactorQAxis + + def __str__(self): + str = "class=SynchronousMachineDetailed\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SynchronousMachineDynamics.py b/cimpy/cgmes_v2_4_15/SynchronousMachineDynamics.py index fe6d24fa..bd5ed7f4 100644 --- a/cimpy/cgmes_v2_4_15/SynchronousMachineDynamics.py +++ b/cimpy/cgmes_v2_4_15/SynchronousMachineDynamics.py @@ -1,43 +1,45 @@ -from .RotatingMachineDynamics import RotatingMachineDynamics - - -class SynchronousMachineDynamics(RotatingMachineDynamics): - ''' - Synchronous machine whose behaviour is described by reference to a standard model expressed in one of the following forms: - - :SynchronousMachine: Synchronous machine to which synchronous machine dynamics model applies. Default: None - :TurbineGovernorDynamics: Synchronous machine model with which this turbine-governor model is associated. Default: "list" - :ExcitationSystemDynamics: Excitation system model associated with this synchronous machine model. Default: None - :MechanicalLoadDynamics: Mechanical load model associated with this synchronous machine model. Default: None - :GenICompensationForGenJ: Compensation of voltage compensator`s generator for current flow out of this generator. Default: "list" - ''' - - cgmesProfile = RotatingMachineDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'SynchronousMachine': [cgmesProfile.DY.value, ], - 'TurbineGovernorDynamics': [cgmesProfile.DY.value, ], - 'ExcitationSystemDynamics': [cgmesProfile.DY.value, ], - 'MechanicalLoadDynamics': [cgmesProfile.DY.value, ], - 'GenICompensationForGenJ': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class RotatingMachineDynamics: \n' + RotatingMachineDynamics.__doc__ - - def __init__(self, SynchronousMachine = None, TurbineGovernorDynamics = "list", ExcitationSystemDynamics = None, MechanicalLoadDynamics = None, GenICompensationForGenJ = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.SynchronousMachine = SynchronousMachine - self.TurbineGovernorDynamics = TurbineGovernorDynamics - self.ExcitationSystemDynamics = ExcitationSystemDynamics - self.MechanicalLoadDynamics = MechanicalLoadDynamics - self.GenICompensationForGenJ = GenICompensationForGenJ - - def __str__(self): - str = 'class=SynchronousMachineDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .RotatingMachineDynamics import RotatingMachineDynamics +from .CGMESProfile import Profile + + +class SynchronousMachineDynamics(RotatingMachineDynamics): + """ + Synchronous machine whose behaviour is described by reference to a standard model expressed in one of the following forms: + + :ExcitationSystemDynamics: Excitation system model associated with this synchronous machine model. Default: None + :GenICompensationForGenJ: Compensation of voltage compensator`s generator for current flow out of this generator. Default: "list" + :MechanicalLoadDynamics: Mechanical load model associated with this synchronous machine model. Default: None + :SynchronousMachine: Synchronous machine to which synchronous machine dynamics model applies. Default: None + :TurbineGovernorDynamics: Synchronous machine model with which this turbine-governor model is associated. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ExcitationSystemDynamics": [Profile.DY.value, ], + "GenICompensationForGenJ": [Profile.DY.value, ], + "MechanicalLoadDynamics": [Profile.DY.value, ], + "SynchronousMachine": [Profile.DY.value, ], + "TurbineGovernorDynamics": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class RotatingMachineDynamics:\n" + RotatingMachineDynamics.__doc__ + + def __init__(self, ExcitationSystemDynamics = None, GenICompensationForGenJ = "list", MechanicalLoadDynamics = None, SynchronousMachine = None, TurbineGovernorDynamics = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ExcitationSystemDynamics = ExcitationSystemDynamics + self.GenICompensationForGenJ = GenICompensationForGenJ + self.MechanicalLoadDynamics = MechanicalLoadDynamics + self.SynchronousMachine = SynchronousMachine + self.TurbineGovernorDynamics = TurbineGovernorDynamics + + def __str__(self): + str = "class=SynchronousMachineDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SynchronousMachineEquivalentCircuit.py b/cimpy/cgmes_v2_4_15/SynchronousMachineEquivalentCircuit.py index e3168da6..48b5f5eb 100644 --- a/cimpy/cgmes_v2_4_15/SynchronousMachineEquivalentCircuit.py +++ b/cimpy/cgmes_v2_4_15/SynchronousMachineEquivalentCircuit.py @@ -1,61 +1,63 @@ -from .SynchronousMachineDetailed import SynchronousMachineDetailed - - -class SynchronousMachineEquivalentCircuit(SynchronousMachineDetailed): - ''' - The electrical equations for all variations of the synchronous models are based on the SynchronousEquivalentCircuit diagram for the direct and quadrature axes. = + = + * / ( + ) = + * * / ( * + * + * ) = + = + * / (+ ) = + ** / ( * + * + * ) = ( + ) / ( * ) = ( * + * + * ) / ( * * ( + ) = ( + ) / ( * ) = ( * + * + * )/ ( * * ( + ) Same equations using CIM attributes from SynchronousMachineTimeConstantReactance class on left of = sign and SynchronousMachineEquivalentCircuit class on right (except as noted): xDirectSync = xad + RotatingMachineDynamics.statorLeakageReactance xDirectTrans = RotatingMachineDynamics.statorLeakageReactance + xad * xfd / (xad + xfd) xDirectSubtrans = RotatingMachineDynamics.statorLeakageReactance + xad * xfd * x1d / (xad * xfd + xad * x1d + xfd * x1d) xQuadSync = xaq + RotatingMachineDynamics.statorLeakageReactance xQuadTrans = RotatingMachineDynamics.statorLeakageReactance + xaq * x1q / (xaq+ x1q) xQuadSubtrans = RotatingMachineDynamics.statorLeakageReactance + xaq * x1q* x2q / (xaq * x1q + xaq * x2q + x1q * x2q) tpdo = (xad + xfd) / (2*pi*nominal frequency * rfd) tppdo = (xad * xfd + xad * x1d + xfd * x1d) / (2*pi*nominal frequency * r1d * (xad + xfd) tpqo = (xaq + x1q) / (2*pi*nominal frequency * r1q) tppqo = (xaq * x1q + xaq * x2q + x1q * x2q)/ (2*pi*nominal frequency * r2q * (xaq + x1q). Are only valid for a simplified model where "Canay" reactance is zero. - - :xad: D-axis mutual reactance. Default: 0.0 - :rfd: Field winding resistance. Default: 0.0 - :xfd: Field winding leakage reactance. Default: 0.0 - :r1d: D-axis damper 1 winding resistance. Default: 0.0 - :x1d: D-axis damper 1 winding leakage reactance. Default: 0.0 - :xf1d: Differential mutual (`Canay`) reactance. Default: 0.0 - :xaq: Q-axis mutual reactance. Default: 0.0 - :r1q: Q-axis damper 1 winding resistance. Default: 0.0 - :x1q: Q-axis damper 1 winding leakage reactance. Default: 0.0 - :r2q: Q-axis damper 2 winding resistance. Default: 0.0 - :x2q: Q-axis damper 2 winding leakage reactance. Default: 0.0 - ''' - - cgmesProfile = SynchronousMachineDetailed.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'xad': [cgmesProfile.DY.value, ], - 'rfd': [cgmesProfile.DY.value, ], - 'xfd': [cgmesProfile.DY.value, ], - 'r1d': [cgmesProfile.DY.value, ], - 'x1d': [cgmesProfile.DY.value, ], - 'xf1d': [cgmesProfile.DY.value, ], - 'xaq': [cgmesProfile.DY.value, ], - 'r1q': [cgmesProfile.DY.value, ], - 'x1q': [cgmesProfile.DY.value, ], - 'r2q': [cgmesProfile.DY.value, ], - 'x2q': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class SynchronousMachineDetailed: \n' + SynchronousMachineDetailed.__doc__ - - def __init__(self, xad = 0.0, rfd = 0.0, xfd = 0.0, r1d = 0.0, x1d = 0.0, xf1d = 0.0, xaq = 0.0, r1q = 0.0, x1q = 0.0, r2q = 0.0, x2q = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.xad = xad - self.rfd = rfd - self.xfd = xfd - self.r1d = r1d - self.x1d = x1d - self.xf1d = xf1d - self.xaq = xaq - self.r1q = r1q - self.x1q = x1q - self.r2q = r2q - self.x2q = x2q - - def __str__(self): - str = 'class=SynchronousMachineEquivalentCircuit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .SynchronousMachineDetailed import SynchronousMachineDetailed +from .CGMESProfile import Profile + + +class SynchronousMachineEquivalentCircuit(SynchronousMachineDetailed): + """ + The electrical equations for all variations of the synchronous models are based on the SynchronousEquivalentCircuit diagram for the direct and quadrature axes. = + = + * / ( + ) = + * * / ( * + * + * ) = + = + * / (+ ) = + ** / ( * + * + * ) = ( + ) / ( * ) = ( * + * + * ) / ( * * ( + ) = ( + ) / ( * ) = ( * + * + * )/ ( * * ( + ) Same equations using CIM attributes from SynchronousMachineTimeConstantReactance class on left of = sign and SynchronousMachineEquivalentCircuit class on right (except as noted): xDirectSync = xad + RotatingMachineDynamics.statorLeakageReactance xDirectTrans = RotatingMachineDynamics.statorLeakageReactance + xad * xfd / (xad + xfd) xDirectSubtrans = RotatingMachineDynamics.statorLeakageReactance + xad * xfd * x1d / (xad * xfd + xad * x1d + xfd * x1d) xQuadSync = xaq + RotatingMachineDynamics.statorLeakageReactance xQuadTrans = RotatingMachineDynamics.statorLeakageReactance + xaq * x1q / (xaq+ x1q) xQuadSubtrans = RotatingMachineDynamics.statorLeakageReactance + xaq * x1q* x2q / (xaq * x1q + xaq * x2q + x1q * x2q) tpdo = (xad + xfd) / (2*pi*nominal frequency * rfd) tppdo = (xad * xfd + xad * x1d + xfd * x1d) / (2*pi*nominal frequency * r1d * (xad + xfd) tpqo = (xaq + x1q) / (2*pi*nominal frequency * r1q) tppqo = (xaq * x1q + xaq * x2q + x1q * x2q)/ (2*pi*nominal frequency * r2q * (xaq + x1q). Are only valid for a simplified model where "Canay" reactance is zero. + + :r1d: D-axis damper 1 winding resistance. Default: 0.0 + :r1q: Q-axis damper 1 winding resistance. Default: 0.0 + :r2q: Q-axis damper 2 winding resistance. Default: 0.0 + :rfd: Field winding resistance. Default: 0.0 + :x1d: D-axis damper 1 winding leakage reactance. Default: 0.0 + :x1q: Q-axis damper 1 winding leakage reactance. Default: 0.0 + :x2q: Q-axis damper 2 winding leakage reactance. Default: 0.0 + :xad: D-axis mutual reactance. Default: 0.0 + :xaq: Q-axis mutual reactance. Default: 0.0 + :xf1d: Differential mutual (`Canay`) reactance. Default: 0.0 + :xfd: Field winding leakage reactance. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "r1d": [Profile.DY.value, ], + "r1q": [Profile.DY.value, ], + "r2q": [Profile.DY.value, ], + "rfd": [Profile.DY.value, ], + "x1d": [Profile.DY.value, ], + "x1q": [Profile.DY.value, ], + "x2q": [Profile.DY.value, ], + "xad": [Profile.DY.value, ], + "xaq": [Profile.DY.value, ], + "xf1d": [Profile.DY.value, ], + "xfd": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class SynchronousMachineDetailed:\n" + SynchronousMachineDetailed.__doc__ + + def __init__(self, r1d = 0.0, r1q = 0.0, r2q = 0.0, rfd = 0.0, x1d = 0.0, x1q = 0.0, x2q = 0.0, xad = 0.0, xaq = 0.0, xf1d = 0.0, xfd = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.r1d = r1d + self.r1q = r1q + self.r2q = r2q + self.rfd = rfd + self.x1d = x1d + self.x1q = x1q + self.x2q = x2q + self.xad = xad + self.xaq = xaq + self.xf1d = xf1d + self.xfd = xfd + + def __str__(self): + str = "class=SynchronousMachineEquivalentCircuit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SynchronousMachineKind.py b/cimpy/cgmes_v2_4_15/SynchronousMachineKind.py index bb3b09c0..fbd40799 100644 --- a/cimpy/cgmes_v2_4_15/SynchronousMachineKind.py +++ b/cimpy/cgmes_v2_4_15/SynchronousMachineKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class SynchronousMachineKind(Base): - ''' - Synchronous machine type. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=SynchronousMachineKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class SynchronousMachineKind(Base): + """ + Synchronous machine type. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=SynchronousMachineKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SynchronousMachineModelKind.py b/cimpy/cgmes_v2_4_15/SynchronousMachineModelKind.py index ad033564..46f226d4 100644 --- a/cimpy/cgmes_v2_4_15/SynchronousMachineModelKind.py +++ b/cimpy/cgmes_v2_4_15/SynchronousMachineModelKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class SynchronousMachineModelKind(Base): - ''' - Type of synchronous machine model used in Dynamic simulation applications. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=SynchronousMachineModelKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class SynchronousMachineModelKind(Base): + """ + Type of synchronous machine model used in Dynamic simulation applications. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=SynchronousMachineModelKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SynchronousMachineOperatingMode.py b/cimpy/cgmes_v2_4_15/SynchronousMachineOperatingMode.py index bf125a97..0a2000b0 100644 --- a/cimpy/cgmes_v2_4_15/SynchronousMachineOperatingMode.py +++ b/cimpy/cgmes_v2_4_15/SynchronousMachineOperatingMode.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class SynchronousMachineOperatingMode(Base): - ''' - Synchronous machine operating mode. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=SynchronousMachineOperatingMode\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class SynchronousMachineOperatingMode(Base): + """ + Synchronous machine operating mode. + + """ + + possibleProfileList = { + "class": [Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SSH.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=SynchronousMachineOperatingMode\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SynchronousMachineSimplified.py b/cimpy/cgmes_v2_4_15/SynchronousMachineSimplified.py index c83de9b0..22723090 100644 --- a/cimpy/cgmes_v2_4_15/SynchronousMachineSimplified.py +++ b/cimpy/cgmes_v2_4_15/SynchronousMachineSimplified.py @@ -1,29 +1,31 @@ -from .SynchronousMachineDynamics import SynchronousMachineDynamics - - -class SynchronousMachineSimplified(SynchronousMachineDynamics): - ''' - The simplified model represents a synchronous generator as a constant internal voltage behind an impedance ( + ) as shown in the Simplified diagram. Since internal voltage is held constant, there is no input and any excitation system model will be ignored. There is also no output. This model should not be used for representing a real generator except, perhaps, small generators whose response is insignificant. The parameters used for the Simplified model include: - - ''' - - cgmesProfile = SynchronousMachineDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class SynchronousMachineDynamics: \n' + SynchronousMachineDynamics.__doc__ - - def __init__(self, *args, **kw_args): - super().__init__(*args, **kw_args) - - pass - - def __str__(self): - str = 'class=SynchronousMachineSimplified\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .SynchronousMachineDynamics import SynchronousMachineDynamics +from .CGMESProfile import Profile + + +class SynchronousMachineSimplified(SynchronousMachineDynamics): + """ + The simplified model represents a synchronous generator as a constant internal voltage behind an impedance ( + ) as shown in the Simplified diagram. Since internal voltage is held constant, there is no input and any excitation system model will be ignored. There is also no output. This model should not be used for representing a real generator except, perhaps, small generators whose response is insignificant. The parameters used for the Simplified model include: + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class SynchronousMachineDynamics:\n" + SynchronousMachineDynamics.__doc__ + + def __init__(self, *args, **kw_args): + super().__init__(*args, **kw_args) + + pass + + def __str__(self): + str = "class=SynchronousMachineSimplified\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SynchronousMachineTimeConstantReactance.py b/cimpy/cgmes_v2_4_15/SynchronousMachineTimeConstantReactance.py index ef592f50..fb67a6ee 100644 --- a/cimpy/cgmes_v2_4_15/SynchronousMachineTimeConstantReactance.py +++ b/cimpy/cgmes_v2_4_15/SynchronousMachineTimeConstantReactance.py @@ -1,70 +1,72 @@ -from .SynchronousMachineDetailed import SynchronousMachineDetailed - - -class SynchronousMachineTimeConstantReactance(SynchronousMachineDetailed): - ''' - Synchronous machine detailed modelling types are defined by the combination of the attributes SynchronousMachineTimeConstantReactance.modelType and SynchronousMachineTimeConstantReactance.rotorType. The parameters used for models expressed in time constant reactance form include: - - :rotorType: Type of rotor on physical machine. Default: None - :modelType: Type of synchronous machine model used in Dynamic simulation applications. Default: None - :ks: Saturation loading correction factor (Ks) (>= 0). Used only by Type J model. Typical Value = 0. Default: 0.0 - :xDirectSync: Direct-axis synchronous reactance (Xd) (>= X`d). The quotient of a sustained value of that AC component of armature voltage that is produced by the total direct-axis flux due to direct-axis armature current and the value of the AC component of this current, the machine running at rated speed. Typical Value = 1.8. Default: 0.0 - :xDirectTrans: Direct-axis transient reactance (unsaturated) (X`d) (> =X``d). Typical Value = 0.5. Default: 0.0 - :xDirectSubtrans: Direct-axis subtransient reactance (unsaturated) (X``d) (> Xl). Typical Value = 0.2. Default: 0.0 - :xQuadSync: Quadrature-axis synchronous reactance (Xq) (> =X`q). The ratio of the component of reactive armature voltage, due to the quadrature-axis component of armature current, to this component of current, under steady state conditions and at rated frequency. Typical Value = 1.6. Default: 0.0 - :xQuadTrans: Quadrature-axis transient reactance (X`q) (> =X``q). Typical Value = 0.3. Default: 0.0 - :xQuadSubtrans: Quadrature-axis subtransient reactance (X``q) (> Xl). Typical Value = 0.2. Default: 0.0 - :tpdo: Direct-axis transient rotor time constant (T`do) (> T``do). Typical Value = 5. Default: 0 - :tppdo: Direct-axis subtransient rotor time constant (T``do) (> 0). Typical Value = 0.03. Default: 0 - :tpqo: Quadrature-axis transient rotor time constant (T`qo) (> T``qo). Typical Value = 0.5. Default: 0 - :tppqo: Quadrature-axis subtransient rotor time constant (T``qo) (> 0). Typical Value = 0.03. Default: 0 - :tc: Damping time constant for `Canay` reactance. Typical Value = 0. Default: 0 - ''' - - cgmesProfile = SynchronousMachineDetailed.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'rotorType': [cgmesProfile.DY.value, ], - 'modelType': [cgmesProfile.DY.value, ], - 'ks': [cgmesProfile.DY.value, ], - 'xDirectSync': [cgmesProfile.DY.value, ], - 'xDirectTrans': [cgmesProfile.DY.value, ], - 'xDirectSubtrans': [cgmesProfile.DY.value, ], - 'xQuadSync': [cgmesProfile.DY.value, ], - 'xQuadTrans': [cgmesProfile.DY.value, ], - 'xQuadSubtrans': [cgmesProfile.DY.value, ], - 'tpdo': [cgmesProfile.DY.value, ], - 'tppdo': [cgmesProfile.DY.value, ], - 'tpqo': [cgmesProfile.DY.value, ], - 'tppqo': [cgmesProfile.DY.value, ], - 'tc': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class SynchronousMachineDetailed: \n' + SynchronousMachineDetailed.__doc__ - - def __init__(self, rotorType = None, modelType = None, ks = 0.0, xDirectSync = 0.0, xDirectTrans = 0.0, xDirectSubtrans = 0.0, xQuadSync = 0.0, xQuadTrans = 0.0, xQuadSubtrans = 0.0, tpdo = 0, tppdo = 0, tpqo = 0, tppqo = 0, tc = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.rotorType = rotorType - self.modelType = modelType - self.ks = ks - self.xDirectSync = xDirectSync - self.xDirectTrans = xDirectTrans - self.xDirectSubtrans = xDirectSubtrans - self.xQuadSync = xQuadSync - self.xQuadTrans = xQuadTrans - self.xQuadSubtrans = xQuadSubtrans - self.tpdo = tpdo - self.tppdo = tppdo - self.tpqo = tpqo - self.tppqo = tppqo - self.tc = tc - - def __str__(self): - str = 'class=SynchronousMachineTimeConstantReactance\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .SynchronousMachineDetailed import SynchronousMachineDetailed +from .CGMESProfile import Profile + + +class SynchronousMachineTimeConstantReactance(SynchronousMachineDetailed): + """ + Synchronous machine detailed modelling types are defined by the combination of the attributes SynchronousMachineTimeConstantReactance.modelType and SynchronousMachineTimeConstantReactance.rotorType. The parameters used for models expressed in time constant reactance form include: + + :ks: Saturation loading correction factor (Ks) (>= 0). Used only by Type J model. Typical Value = 0. Default: 0.0 + :modelType: Type of synchronous machine model used in Dynamic simulation applications. Default: None + :rotorType: Type of rotor on physical machine. Default: None + :tc: Damping time constant for `Canay` reactance. Typical Value = 0. Default: 0.0 + :tpdo: Direct-axis transient rotor time constant (T`do) (> T``do). Typical Value = 5. Default: 0.0 + :tppdo: Direct-axis subtransient rotor time constant (T``do) (> 0). Typical Value = 0.03. Default: 0.0 + :tppqo: Quadrature-axis subtransient rotor time constant (T``qo) (> 0). Typical Value = 0.03. Default: 0.0 + :tpqo: Quadrature-axis transient rotor time constant (T`qo) (> T``qo). Typical Value = 0.5. Default: 0.0 + :xDirectSubtrans: Direct-axis subtransient reactance (unsaturated) (X``d) (> Xl). Typical Value = 0.2. Default: 0.0 + :xDirectSync: Direct-axis synchronous reactance (Xd) (>= X`d). The quotient of a sustained value of that AC component of armature voltage that is produced by the total direct-axis flux due to direct-axis armature current and the value of the AC component of this current, the machine running at rated speed. Typical Value = 1.8. Default: 0.0 + :xDirectTrans: Direct-axis transient reactance (unsaturated) (X`d) (> =X``d). Typical Value = 0.5. Default: 0.0 + :xQuadSubtrans: Quadrature-axis subtransient reactance (X``q) (> Xl). Typical Value = 0.2. Default: 0.0 + :xQuadSync: Quadrature-axis synchronous reactance (Xq) (> =X`q). The ratio of the component of reactive armature voltage, due to the quadrature-axis component of armature current, to this component of current, under steady state conditions and at rated frequency. Typical Value = 1.6. Default: 0.0 + :xQuadTrans: Quadrature-axis transient reactance (X`q) (> =X``q). Typical Value = 0.3. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ks": [Profile.DY.value, ], + "modelType": [Profile.DY.value, ], + "rotorType": [Profile.DY.value, ], + "tc": [Profile.DY.value, ], + "tpdo": [Profile.DY.value, ], + "tppdo": [Profile.DY.value, ], + "tppqo": [Profile.DY.value, ], + "tpqo": [Profile.DY.value, ], + "xDirectSubtrans": [Profile.DY.value, ], + "xDirectSync": [Profile.DY.value, ], + "xDirectTrans": [Profile.DY.value, ], + "xQuadSubtrans": [Profile.DY.value, ], + "xQuadSync": [Profile.DY.value, ], + "xQuadTrans": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class SynchronousMachineDetailed:\n" + SynchronousMachineDetailed.__doc__ + + def __init__(self, ks = 0.0, modelType = None, rotorType = None, tc = 0.0, tpdo = 0.0, tppdo = 0.0, tppqo = 0.0, tpqo = 0.0, xDirectSubtrans = 0.0, xDirectSync = 0.0, xDirectTrans = 0.0, xQuadSubtrans = 0.0, xQuadSync = 0.0, xQuadTrans = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ks = ks + self.modelType = modelType + self.rotorType = rotorType + self.tc = tc + self.tpdo = tpdo + self.tppdo = tppdo + self.tppqo = tppqo + self.tpqo = tpqo + self.xDirectSubtrans = xDirectSubtrans + self.xDirectSync = xDirectSync + self.xDirectTrans = xDirectTrans + self.xQuadSubtrans = xQuadSubtrans + self.xQuadSync = xQuadSync + self.xQuadTrans = xQuadTrans + + def __str__(self): + str = "class=SynchronousMachineTimeConstantReactance\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/SynchronousMachineUserDefined.py b/cimpy/cgmes_v2_4_15/SynchronousMachineUserDefined.py index 362af11b..2210ed62 100644 --- a/cimpy/cgmes_v2_4_15/SynchronousMachineUserDefined.py +++ b/cimpy/cgmes_v2_4_15/SynchronousMachineUserDefined.py @@ -1,34 +1,36 @@ -from .SynchronousMachineDynamics import SynchronousMachineDynamics - - -class SynchronousMachineUserDefined(SynchronousMachineDynamics): - ''' - Synchronous machine whose dynamic behaviour is described by a user-defined model. - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = SynchronousMachineDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class SynchronousMachineDynamics: \n' + SynchronousMachineDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=SynchronousMachineUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .SynchronousMachineDynamics import SynchronousMachineDynamics +from .CGMESProfile import Profile + + +class SynchronousMachineUserDefined(SynchronousMachineDynamics): + """ + Synchronous machine whose dynamic behaviour is described by a user-defined model. + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class SynchronousMachineDynamics:\n" + SynchronousMachineDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=SynchronousMachineUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TapChanger.py b/cimpy/cgmes_v2_4_15/TapChanger.py index 8baec9c0..24e9b2c5 100644 --- a/cimpy/cgmes_v2_4_15/TapChanger.py +++ b/cimpy/cgmes_v2_4_15/TapChanger.py @@ -1,61 +1,63 @@ -from .PowerSystemResource import PowerSystemResource - - -class TapChanger(PowerSystemResource): - ''' - Mechanism for changing transformer winding tap positions. - - :highStep: Highest possible tap step position, advance from neutral. The attribute shall be greater than lowStep. Default: 0 - :lowStep: Lowest possible tap step position, retard from neutral Default: 0 - :ltcFlag: Specifies whether or not a TapChanger has load tap changing capabilities. Default: False - :neutralStep: The neutral tap step position for this winding. The attribute shall be equal or greater than lowStep and equal or less than highStep. Default: 0 - :neutralU: Voltage at which the winding operates at the neutral tap setting. Default: 0.0 - :normalStep: The tap step position used in `normal` network operation for this winding. For a `Fixed` tap changer indicates the current physical tap setting. The attribute shall be equal or greater than lowStep and equal or less than highStep. Default: 0 - :TapChangerControl: The tap changers that participates in this regulating tap control scheme. Default: None - :TapSchedules: A TapSchedule is associated with a TapChanger. Default: "list" - :controlEnabled: Specifies the regulation status of the equipment. True is regulating, false is not regulating. Default: False - :step: Tap changer position. Starting step for a steady state solution. Non integer values are allowed to support continuous tap variables. The reasons for continuous value are to support study cases where no discrete tap changers has yet been designed, a solutions where a narrow voltage band force the tap step to oscillate or accommodate for a continuous solution as input. The attribute shall be equal or greater than lowStep and equal or less than highStep. Default: 0.0 - :SvTapStep: The tap step state associated with the tap changer. Default: None - ''' - - cgmesProfile = PowerSystemResource.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, ], - 'highStep': [cgmesProfile.EQ.value, ], - 'lowStep': [cgmesProfile.EQ.value, ], - 'ltcFlag': [cgmesProfile.EQ.value, ], - 'neutralStep': [cgmesProfile.EQ.value, ], - 'neutralU': [cgmesProfile.EQ.value, ], - 'normalStep': [cgmesProfile.EQ.value, ], - 'TapChangerControl': [cgmesProfile.EQ.value, ], - 'TapSchedules': [cgmesProfile.EQ.value, ], - 'controlEnabled': [cgmesProfile.SSH.value, ], - 'step': [cgmesProfile.SSH.value, ], - 'SvTapStep': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class PowerSystemResource: \n' + PowerSystemResource.__doc__ - - def __init__(self, highStep = 0, lowStep = 0, ltcFlag = False, neutralStep = 0, neutralU = 0.0, normalStep = 0, TapChangerControl = None, TapSchedules = "list", controlEnabled = False, step = 0.0, SvTapStep = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.highStep = highStep - self.lowStep = lowStep - self.ltcFlag = ltcFlag - self.neutralStep = neutralStep - self.neutralU = neutralU - self.normalStep = normalStep - self.TapChangerControl = TapChangerControl - self.TapSchedules = TapSchedules - self.controlEnabled = controlEnabled - self.step = step - self.SvTapStep = SvTapStep - - def __str__(self): - str = 'class=TapChanger\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .PowerSystemResource import PowerSystemResource +from .CGMESProfile import Profile + + +class TapChanger(PowerSystemResource): + """ + Mechanism for changing transformer winding tap positions. + + :SvTapStep: The tap step state associated with the tap changer. Default: None + :TapChangerControl: The tap changers that participates in this regulating tap control scheme. Default: None + :TapSchedules: A TapSchedule is associated with a TapChanger. Default: "list" + :controlEnabled: Specifies the regulation status of the equipment. True is regulating, false is not regulating. Default: False + :highStep: Highest possible tap step position, advance from neutral. The attribute shall be greater than lowStep. Default: 0 + :lowStep: Lowest possible tap step position, retard from neutral Default: 0 + :ltcFlag: Specifies whether or not a TapChanger has load tap changing capabilities. Default: False + :neutralStep: The neutral tap step position for this winding. The attribute shall be equal or greater than lowStep and equal or less than highStep. Default: 0 + :neutralU: Voltage at which the winding operates at the neutral tap setting. Default: 0.0 + :normalStep: The tap step position used in `normal` network operation for this winding. For a `Fixed` tap changer indicates the current physical tap setting. The attribute shall be equal or greater than lowStep and equal or less than highStep. Default: 0 + :step: Tap changer position. Starting step for a steady state solution. Non integer values are allowed to support continuous tap variables. The reasons for continuous value are to support study cases where no discrete tap changers has yet been designed, a solutions where a narrow voltage band force the tap step to oscillate or accommodate for a continuous solution as input. The attribute shall be equal or greater than lowStep and equal or less than highStep. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "SvTapStep": [Profile.SV.value, ], + "TapChangerControl": [Profile.EQ.value, ], + "TapSchedules": [Profile.EQ.value, ], + "controlEnabled": [Profile.SSH.value, ], + "highStep": [Profile.EQ.value, ], + "lowStep": [Profile.EQ.value, ], + "ltcFlag": [Profile.EQ.value, ], + "neutralStep": [Profile.EQ.value, ], + "neutralU": [Profile.EQ.value, ], + "normalStep": [Profile.EQ.value, ], + "step": [Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class PowerSystemResource:\n" + PowerSystemResource.__doc__ + + def __init__(self, SvTapStep = None, TapChangerControl = None, TapSchedules = "list", controlEnabled = False, highStep = 0, lowStep = 0, ltcFlag = False, neutralStep = 0, neutralU = 0.0, normalStep = 0, step = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.SvTapStep = SvTapStep + self.TapChangerControl = TapChangerControl + self.TapSchedules = TapSchedules + self.controlEnabled = controlEnabled + self.highStep = highStep + self.lowStep = lowStep + self.ltcFlag = ltcFlag + self.neutralStep = neutralStep + self.neutralU = neutralU + self.normalStep = normalStep + self.step = step + + def __str__(self): + str = "class=TapChanger\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TapChangerControl.py b/cimpy/cgmes_v2_4_15/TapChangerControl.py index de69d595..5f08c733 100644 --- a/cimpy/cgmes_v2_4_15/TapChangerControl.py +++ b/cimpy/cgmes_v2_4_15/TapChangerControl.py @@ -1,31 +1,33 @@ -from .RegulatingControl import RegulatingControl - - -class TapChangerControl(RegulatingControl): - ''' - Describes behavior specific to tap changers, e.g. how the voltage at the end of a line varies with the load level and compensation of the voltage drop by tap adjustment. - - :TapChanger: The regulating control scheme in which this tap changer participates. Default: "list" - ''' - - cgmesProfile = RegulatingControl.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'TapChanger': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class RegulatingControl: \n' + RegulatingControl.__doc__ - - def __init__(self, TapChanger = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.TapChanger = TapChanger - - def __str__(self): - str = 'class=TapChangerControl\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .RegulatingControl import RegulatingControl +from .CGMESProfile import Profile + + +class TapChangerControl(RegulatingControl): + """ + Describes behavior specific to tap changers, e.g. how the voltage at the end of a line varies with the load level and compensation of the voltage drop by tap adjustment. + + :TapChanger: The regulating control scheme in which this tap changer participates. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "TapChanger": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class RegulatingControl:\n" + RegulatingControl.__doc__ + + def __init__(self, TapChanger = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.TapChanger = TapChanger + + def __str__(self): + str = "class=TapChangerControl\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TapChangerTablePoint.py b/cimpy/cgmes_v2_4_15/TapChangerTablePoint.py index e1fbc340..051be86f 100644 --- a/cimpy/cgmes_v2_4_15/TapChangerTablePoint.py +++ b/cimpy/cgmes_v2_4_15/TapChangerTablePoint.py @@ -1,45 +1,46 @@ -from .Base import Base - - -class TapChangerTablePoint(Base): - ''' - - - :b: The magnetizing branch susceptance deviation in percent of nominal value. The actual susceptance is calculated as follows: calculated magnetizing susceptance = b(nominal) * (1 + b(from this class)/100). The b(nominal) is defined as the static magnetizing susceptance on the associated power transformer end or ends. This model assumes the star impedance (pi model) form. Default: 0.0 - :g: The magnetizing branch conductance deviation in percent of nominal value. The actual conductance is calculated as follows: calculated magnetizing conductance = g(nominal) * (1 + g(from this class)/100). The g(nominal) is defined as the static magnetizing conductance on the associated power transformer end or ends. This model assumes the star impedance (pi model) form. Default: 0.0 - :r: The resistance deviation in percent of nominal value. The actual reactance is calculated as follows: calculated resistance = r(nominal) * (1 + r(from this class)/100). The r(nominal) is defined as the static resistance on the associated power transformer end or ends. This model assumes the star impedance (pi model) form. Default: 0.0 - :ratio: The voltage ratio in per unit. Hence this is a value close to one. Default: 0.0 - :step: The tap step. Default: 0 - :x: The series reactance deviation in percent of nominal value. The actual reactance is calculated as follows: calculated reactance = x(nominal) * (1 + x(from this class)/100). The x(nominal) is defined as the static series reactance on the associated power transformer end or ends. This model assumes the star impedance (pi model) form. Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'b': [cgmesProfile.EQ.value, ], - 'g': [cgmesProfile.EQ.value, ], - 'r': [cgmesProfile.EQ.value, ], - 'ratio': [cgmesProfile.EQ.value, ], - 'step': [cgmesProfile.EQ.value, ], - 'x': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, b = 0.0, g = 0.0, r = 0.0, ratio = 0.0, step = 0, x = 0.0, ): - - self.b = b - self.g = g - self.r = r - self.ratio = ratio - self.step = step - self.x = x - - def __str__(self): - str = 'class=TapChangerTablePoint\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class TapChangerTablePoint(Base): + """ + + + :b: The magnetizing branch susceptance deviation in percent of nominal value. The actual susceptance is calculated as follows: calculated magnetizing susceptance = b(nominal) * (1 + b(from this class)/100). The b(nominal) is defined as the static magnetizing susceptance on the associated power transformer end or ends. This model assumes the star impedance (pi model) form. Default: 0.0 + :g: The magnetizing branch conductance deviation in percent of nominal value. The actual conductance is calculated as follows: calculated magnetizing conductance = g(nominal) * (1 + g(from this class)/100). The g(nominal) is defined as the static magnetizing conductance on the associated power transformer end or ends. This model assumes the star impedance (pi model) form. Default: 0.0 + :r: The resistance deviation in percent of nominal value. The actual reactance is calculated as follows: calculated resistance = r(nominal) * (1 + r(from this class)/100). The r(nominal) is defined as the static resistance on the associated power transformer end or ends. This model assumes the star impedance (pi model) form. Default: 0.0 + :ratio: The voltage ratio in per unit. Hence this is a value close to one. Default: 0.0 + :step: The tap step. Default: 0 + :x: The series reactance deviation in percent of nominal value. The actual reactance is calculated as follows: calculated reactance = x(nominal) * (1 + x(from this class)/100). The x(nominal) is defined as the static series reactance on the associated power transformer end or ends. This model assumes the star impedance (pi model) form. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "b": [Profile.EQ.value, ], + "g": [Profile.EQ.value, ], + "r": [Profile.EQ.value, ], + "ratio": [Profile.EQ.value, ], + "step": [Profile.EQ.value, ], + "x": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, b = 0.0, g = 0.0, r = 0.0, ratio = 0.0, step = 0, x = 0.0): + + self.b = b + self.g = g + self.r = r + self.ratio = ratio + self.step = step + self.x = x + + def __str__(self): + str = "class=TapChangerTablePoint\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TapSchedule.py b/cimpy/cgmes_v2_4_15/TapSchedule.py index ec29f48a..135b1da1 100644 --- a/cimpy/cgmes_v2_4_15/TapSchedule.py +++ b/cimpy/cgmes_v2_4_15/TapSchedule.py @@ -1,31 +1,33 @@ -from .SeasonDayTypeSchedule import SeasonDayTypeSchedule - - -class TapSchedule(SeasonDayTypeSchedule): - ''' - A pre-established pattern over time for a tap step. - - :TapChanger: A TapChanger can have TapSchedules. Default: None - ''' - - cgmesProfile = SeasonDayTypeSchedule.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'TapChanger': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class SeasonDayTypeSchedule: \n' + SeasonDayTypeSchedule.__doc__ - - def __init__(self, TapChanger = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.TapChanger = TapChanger - - def __str__(self): - str = 'class=TapSchedule\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .SeasonDayTypeSchedule import SeasonDayTypeSchedule +from .CGMESProfile import Profile + + +class TapSchedule(SeasonDayTypeSchedule): + """ + A pre-established pattern over time for a tap step. + + :TapChanger: A TapChanger can have TapSchedules. Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "TapChanger": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class SeasonDayTypeSchedule:\n" + SeasonDayTypeSchedule.__doc__ + + def __init__(self, TapChanger = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.TapChanger = TapChanger + + def __str__(self): + str = "class=TapSchedule\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Temperature.py b/cimpy/cgmes_v2_4_15/Temperature.py index 4fa91445..58bdbcaa 100644 --- a/cimpy/cgmes_v2_4_15/Temperature.py +++ b/cimpy/cgmes_v2_4_15/Temperature.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class Temperature(Base): - ''' - Value of temperature in degrees Celsius. - - :multiplier: Default: None - :unit: Default: None - :value: Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'multiplier': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'unit': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - 'value': [cgmesProfile.EQ.value, cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, multiplier = None, unit = None, value = 0.0, ): - - self.multiplier = multiplier - self.unit = unit - self.value = value - - def __str__(self): - str = 'class=Temperature\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Temperature(Base): + """ + Value of temperature in degrees Celsius. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ.value, ], + "multiplier": [Profile.DY.value, Profile.EQ.value, ], + "unit": [Profile.DY.value, Profile.EQ.value, ], + "value": [Profile.DY.value, Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=Temperature\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Terminal.py b/cimpy/cgmes_v2_4_15/Terminal.py index def7a98d..55771534 100644 --- a/cimpy/cgmes_v2_4_15/Terminal.py +++ b/cimpy/cgmes_v2_4_15/Terminal.py @@ -1,64 +1,66 @@ -from .ACDCTerminal import ACDCTerminal - - -class Terminal(ACDCTerminal): - ''' - An AC electrical connection point to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes. - - :ConverterDCSides: Point of common coupling terminal for this converter DC side. It is typically the terminal on the power transformer (or switch) closest to the AC network. The power flow measurement must be the sum of all flows into the transformer. Default: "list" - :ConductingEquipment: The conducting equipment of the terminal. Conducting equipment have terminals that may be connected to other conducting equipment terminals via connectivity nodes or topological nodes. Default: None - :phases: Represents the normal network phasing condition. If the attribute is missing three phases (ABC or ABCN) shall be assumed. Default: None - :RegulatingControl: The terminal associated with this regulating control. The terminal is associated instead of a node, since the terminal could connect into either a topological node (bus in bus-branch model) or a connectivity node (detailed switch model). Sometimes it is useful to model regulation at a terminal of a bus bar object since the bus bar can be present in both a bus-branch model or a model with switch detail. Default: None - :TieFlow: The control area tie flows to which this terminal associates. Default: "list" - :TransformerEnd: All transformer ends connected at this terminal. Default: "list" - :ConnectivityNode: Terminals interconnected with zero impedance at a this connectivity node. Default: None - :HasFirstMutualCoupling: Mutual couplings associated with the branch as the first branch. Default: "list" - :HasSecondMutualCoupling: Mutual couplings with the branch associated as the first branch. Default: "list" - :SvPowerFlow: The power flow state variable associated with the terminal. Default: None - :RemoteInputSignal: Input signal coming from this terminal. Default: "list" - :TopologicalNode: The terminals associated with the topological node. This can be used as an alternative to the connectivity node path to terminal, thus making it unneccesary to model connectivity nodes in some cases. Note that if connectivity nodes are in the model, this association would probably not be used as an input specification. Default: None - ''' - - cgmesProfile = ACDCTerminal.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, cgmesProfile.TP.value, cgmesProfile.EQ_BD.value, ], - 'ConverterDCSides': [cgmesProfile.EQ.value, ], - 'ConductingEquipment': [cgmesProfile.EQ.value, cgmesProfile.DY.value, cgmesProfile.EQ_BD.value, ], - 'phases': [cgmesProfile.EQ.value, ], - 'RegulatingControl': [cgmesProfile.EQ.value, ], - 'TieFlow': [cgmesProfile.EQ.value, ], - 'TransformerEnd': [cgmesProfile.EQ.value, ], - 'ConnectivityNode': [cgmesProfile.EQ.value, ], - 'HasFirstMutualCoupling': [cgmesProfile.EQ.value, ], - 'HasSecondMutualCoupling': [cgmesProfile.EQ.value, ], - 'SvPowerFlow': [cgmesProfile.SV.value, ], - 'RemoteInputSignal': [cgmesProfile.DY.value, ], - 'TopologicalNode': [cgmesProfile.TP.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ACDCTerminal: \n' + ACDCTerminal.__doc__ - - def __init__(self, ConverterDCSides = "list", ConductingEquipment = None, phases = None, RegulatingControl = None, TieFlow = "list", TransformerEnd = "list", ConnectivityNode = None, HasFirstMutualCoupling = "list", HasSecondMutualCoupling = "list", SvPowerFlow = None, RemoteInputSignal = "list", TopologicalNode = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ConverterDCSides = ConverterDCSides - self.ConductingEquipment = ConductingEquipment - self.phases = phases - self.RegulatingControl = RegulatingControl - self.TieFlow = TieFlow - self.TransformerEnd = TransformerEnd - self.ConnectivityNode = ConnectivityNode - self.HasFirstMutualCoupling = HasFirstMutualCoupling - self.HasSecondMutualCoupling = HasSecondMutualCoupling - self.SvPowerFlow = SvPowerFlow - self.RemoteInputSignal = RemoteInputSignal - self.TopologicalNode = TopologicalNode - - def __str__(self): - str = 'class=Terminal\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ACDCTerminal import ACDCTerminal +from .CGMESProfile import Profile + + +class Terminal(ACDCTerminal): + """ + An AC electrical connection point to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes. + + :ConductingEquipment: The conducting equipment of the terminal. Conducting equipment have terminals that may be connected to other conducting equipment terminals via connectivity nodes or topological nodes. Default: None + :ConnectivityNode: Terminals interconnected with zero impedance at a this connectivity node. Default: None + :ConverterDCSides: Point of common coupling terminal for this converter DC side. It is typically the terminal on the power transformer (or switch) closest to the AC network. The power flow measurement must be the sum of all flows into the transformer. Default: "list" + :HasFirstMutualCoupling: Mutual couplings associated with the branch as the first branch. Default: "list" + :HasSecondMutualCoupling: Mutual couplings with the branch associated as the first branch. Default: "list" + :RegulatingControl: The terminal associated with this regulating control. The terminal is associated instead of a node, since the terminal could connect into either a topological node (bus in bus-branch model) or a connectivity node (detailed switch model). Sometimes it is useful to model regulation at a terminal of a bus bar object since the bus bar can be present in both a bus-branch model or a model with switch detail. Default: None + :RemoteInputSignal: Input signal coming from this terminal. Default: "list" + :SvPowerFlow: The power flow state variable associated with the terminal. Default: None + :TieFlow: The control area tie flows to which this terminal associates. Default: "list" + :TopologicalNode: The terminals associated with the topological node. This can be used as an alternative to the connectivity node path to terminal, thus making it unneccesary to model connectivity nodes in some cases. Note that if connectivity nodes are in the model, this association would probably not be used as an input specification. Default: None + :TransformerEnd: All transformer ends connected at this terminal. Default: "list" + :phases: Represents the normal network phasing condition. If the attribute is missing three phases (ABC or ABCN) shall be assumed. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, Profile.TP.value, ], + "ConductingEquipment": [Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, ], + "ConnectivityNode": [Profile.EQ.value, ], + "ConverterDCSides": [Profile.EQ.value, ], + "HasFirstMutualCoupling": [Profile.EQ.value, ], + "HasSecondMutualCoupling": [Profile.EQ.value, ], + "RegulatingControl": [Profile.EQ.value, ], + "RemoteInputSignal": [Profile.DY.value, ], + "SvPowerFlow": [Profile.SV.value, ], + "TieFlow": [Profile.EQ.value, ], + "TopologicalNode": [Profile.TP.value, ], + "TransformerEnd": [Profile.EQ.value, ], + "phases": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ACDCTerminal:\n" + ACDCTerminal.__doc__ + + def __init__(self, ConductingEquipment = None, ConnectivityNode = None, ConverterDCSides = "list", HasFirstMutualCoupling = "list", HasSecondMutualCoupling = "list", RegulatingControl = None, RemoteInputSignal = "list", SvPowerFlow = None, TieFlow = "list", TopologicalNode = None, TransformerEnd = "list", phases = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ConductingEquipment = ConductingEquipment + self.ConnectivityNode = ConnectivityNode + self.ConverterDCSides = ConverterDCSides + self.HasFirstMutualCoupling = HasFirstMutualCoupling + self.HasSecondMutualCoupling = HasSecondMutualCoupling + self.RegulatingControl = RegulatingControl + self.RemoteInputSignal = RemoteInputSignal + self.SvPowerFlow = SvPowerFlow + self.TieFlow = TieFlow + self.TopologicalNode = TopologicalNode + self.TransformerEnd = TransformerEnd + self.phases = phases + + def __str__(self): + str = "class=Terminal\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TextDiagramObject.py b/cimpy/cgmes_v2_4_15/TextDiagramObject.py index af268ac1..36f90abf 100644 --- a/cimpy/cgmes_v2_4_15/TextDiagramObject.py +++ b/cimpy/cgmes_v2_4_15/TextDiagramObject.py @@ -1,31 +1,33 @@ -from .DiagramObject import DiagramObject - - -class TextDiagramObject(DiagramObject): - ''' - A diagram object for placing free-text or text derived from an associated domain object. - - :text: The text that is displayed by this text diagram object. Default: '' - ''' - - cgmesProfile = DiagramObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, ], - 'text': [cgmesProfile.DL.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DiagramObject: \n' + DiagramObject.__doc__ - - def __init__(self, text = '', *args, **kw_args): - super().__init__(*args, **kw_args) - - self.text = text - - def __str__(self): - str = 'class=TextDiagramObject\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DiagramObject import DiagramObject +from .CGMESProfile import Profile + + +class TextDiagramObject(DiagramObject): + """ + A diagram object for placing free-text or text derived from an associated domain object. + + :text: The text that is displayed by this text diagram object. Default: '' + """ + + possibleProfileList = { + "class": [Profile.DL.value, ], + "text": [Profile.DL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DL.value + + __doc__ += "\nDocumentation of parent class DiagramObject:\n" + DiagramObject.__doc__ + + def __init__(self, text = '', *args, **kw_args): + super().__init__(*args, **kw_args) + + self.text = text + + def __str__(self): + str = "class=TextDiagramObject\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ThermalGeneratingUnit.py b/cimpy/cgmes_v2_4_15/ThermalGeneratingUnit.py index 0b35ee9f..6b92f93f 100644 --- a/cimpy/cgmes_v2_4_15/ThermalGeneratingUnit.py +++ b/cimpy/cgmes_v2_4_15/ThermalGeneratingUnit.py @@ -1,31 +1,33 @@ -from .GeneratingUnit import GeneratingUnit - - -class ThermalGeneratingUnit(GeneratingUnit): - ''' - A generating unit whose prime mover could be a steam turbine, combustion turbine, or diesel engine. - - :FossilFuels: A thermal generating unit may have one or more fossil fuels. Default: "list" - ''' - - cgmesProfile = GeneratingUnit.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'FossilFuels': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class GeneratingUnit: \n' + GeneratingUnit.__doc__ - - def __init__(self, FossilFuels = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.FossilFuels = FossilFuels - - def __str__(self): - str = 'class=ThermalGeneratingUnit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .GeneratingUnit import GeneratingUnit +from .CGMESProfile import Profile + + +class ThermalGeneratingUnit(GeneratingUnit): + """ + A generating unit whose prime mover could be a steam turbine, combustion turbine, or diesel engine. + + :FossilFuels: A thermal generating unit may have one or more fossil fuels. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "FossilFuels": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class GeneratingUnit:\n" + GeneratingUnit.__doc__ + + def __init__(self, FossilFuels = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.FossilFuels = FossilFuels + + def __str__(self): + str = "class=ThermalGeneratingUnit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TieFlow.py b/cimpy/cgmes_v2_4_15/TieFlow.py index 35669913..c7c793e0 100644 --- a/cimpy/cgmes_v2_4_15/TieFlow.py +++ b/cimpy/cgmes_v2_4_15/TieFlow.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class TieFlow(Base): - ''' - A flow specification in terms of location and direction for a control area. - - :Terminal: The terminal to which this tie flow belongs. Default: None - :ControlArea: The control area of the tie flows. Default: None - :positiveFlowIn: True if the flow into the terminal (load convention) is also flow into the control area. For example, this attribute should be true if using the tie line terminal further away from the control area. For example to represent a tie to a shunt component (like a load or generator) in another area, this is the near end of a branch and this attribute would be specified as false. Default: False - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'Terminal': [cgmesProfile.EQ.value, ], - 'ControlArea': [cgmesProfile.EQ.value, ], - 'positiveFlowIn': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, Terminal = None, ControlArea = None, positiveFlowIn = False, ): - - self.Terminal = Terminal - self.ControlArea = ControlArea - self.positiveFlowIn = positiveFlowIn - - def __str__(self): - str = 'class=TieFlow\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class TieFlow(Base): + """ + A flow specification in terms of location and direction for a control area. + + :ControlArea: The control area of the tie flows. Default: None + :Terminal: The terminal to which this tie flow belongs. Default: None + :positiveFlowIn: True if the flow into the terminal (load convention) is also flow into the control area. For example, this attribute should be true if using the tie line terminal further away from the control area. For example to represent a tie to a shunt component (like a load or generator) in another area, this is the near end of a branch and this attribute would be specified as false. Default: False + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "ControlArea": [Profile.EQ.value, ], + "Terminal": [Profile.EQ.value, ], + "positiveFlowIn": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, ControlArea = None, Terminal = None, positiveFlowIn = False): + + self.ControlArea = ControlArea + self.Terminal = Terminal + self.positiveFlowIn = positiveFlowIn + + def __str__(self): + str = "class=TieFlow\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TopologicalIsland.py b/cimpy/cgmes_v2_4_15/TopologicalIsland.py index d79ceb67..20d3040a 100644 --- a/cimpy/cgmes_v2_4_15/TopologicalIsland.py +++ b/cimpy/cgmes_v2_4_15/TopologicalIsland.py @@ -1,34 +1,36 @@ -from .IdentifiedObject import IdentifiedObject - - -class TopologicalIsland(IdentifiedObject): - ''' - An electrically connected subset of the network. Topological islands can change as the current network state changes: e.g. due to - disconnect switches or breakers change state in a SCADA/EMS - manual creation, change or deletion of topological nodes in a planning tool. - - :AngleRefTopologicalNode: The angle reference for the island. Normally there is one TopologicalNode that is selected as the angle reference for each island. Other reference schemes exist, so the association is typically optional. Default: None - :TopologicalNodes: A topological node belongs to a topological island. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SV.value, ], - 'AngleRefTopologicalNode': [cgmesProfile.SV.value, ], - 'TopologicalNodes': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, AngleRefTopologicalNode = None, TopologicalNodes = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.AngleRefTopologicalNode = AngleRefTopologicalNode - self.TopologicalNodes = TopologicalNodes - - def __str__(self): - str = 'class=TopologicalIsland\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class TopologicalIsland(IdentifiedObject): + """ + An electrically connected subset of the network. Topological islands can change as the current network state changes: e.g. due to - disconnect switches or breakers change state in a SCADA/EMS - manual creation, change or deletion of topological nodes in a planning tool. + + :AngleRefTopologicalNode: The angle reference for the island. Normally there is one TopologicalNode that is selected as the angle reference for each island. Other reference schemes exist, so the association is typically optional. Default: None + :TopologicalNodes: A topological node belongs to a topological island. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.SV.value, ], + "AngleRefTopologicalNode": [Profile.SV.value, ], + "TopologicalNodes": [Profile.SV.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SV.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, AngleRefTopologicalNode = None, TopologicalNodes = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.AngleRefTopologicalNode = AngleRefTopologicalNode + self.TopologicalNodes = TopologicalNodes + + def __str__(self): + str = "class=TopologicalIsland\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TopologicalNode.py b/cimpy/cgmes_v2_4_15/TopologicalNode.py index d9e0373b..beb21e73 100644 --- a/cimpy/cgmes_v2_4_15/TopologicalNode.py +++ b/cimpy/cgmes_v2_4_15/TopologicalNode.py @@ -1,76 +1,78 @@ -from .IdentifiedObject import IdentifiedObject - - -class TopologicalNode(IdentifiedObject): - ''' - For a detailed substation model a topological node is a set of connectivity nodes that, in the current network state, are connected together through any type of closed switches, including jumpers. Topological nodes change as the current network state changes (i.e., switches, breakers, etc. change state). For a planning model, switch statuses are not used to form topological nodes. Instead they are manually created or deleted in a model builder tool. Topological nodes maintained this way are also called "busses". - - :SvInjection: The topological node associated with the flow injection state variable. Default: None - :SvVoltage: The topological node associated with the voltage state. Default: None - :AngleRefTopologicalIsland: The island for which the node is an angle reference. Normally there is one angle reference node for each island. Default: None - :TopologicalIsland: A topological node belongs to a topological island. Default: None - :BaseVoltage: The base voltage of the topologocial node. Default: None - :ConnectivityNodes: The topological node to which this connectivity node is assigned. May depend on the current state of switches in the network. Default: "list" - :ConnectivityNodeContainer: The connectivity node container to which the toplogical node belongs. Default: None - :ReportingGroup: The topological nodes that belong to the reporting group. Default: None - :Terminal: The topological node associated with the terminal. This can be used as an alternative to the connectivity node path to topological node, thus making it unneccesary to model connectivity nodes in some cases. Note that the if connectivity nodes are in the model, this association would probably not be used as an input specification. Default: "list" - :boundaryPoint: Identifies if a node is a BoundaryPoint. If boundaryPoint=true the ConnectivityNode or the TopologicalNode represents a BoundaryPoint. Default: False - :fromEndIsoCode: The attribute is used for an exchange of the ISO code of the region to which the `From` side of the Boundary point belongs to or it is connected to. The ISO code is two characters country code as defined by ISO 3166 (). The length of the string is 2 characters maximum. The attribute is a required for the Boundary Model Authority Set where this attribute is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' - :fromEndName: The attribute is used for an exchange of a human readable name with length of the string 32 characters maximum. The attribute covers two cases: The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' - :fromEndNameTso: The attribute is used for an exchange of the name of the TSO to which the `From` side of the Boundary point belongs to or it is connected to. The length of the string is 32 characters maximum. The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' - :toEndIsoCode: The attribute is used for an exchange of the ISO code of the region to which the `To` side of the Boundary point belongs to or it is connected to. The ISO code is two characters country code as defined by ISO 3166 (). The length of the string is 2 characters maximum. The attribute is a required for the Boundary Model Authority Set where this attribute is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' - :toEndName: The attribute is used for an exchange of a human readable name with length of the string 32 characters maximum. The attribute covers two cases: The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' - :toEndNameTso: The attribute is used for an exchange of the name of the TSO to which the `To` side of the Boundary point belongs to or it is connected to. The length of the string is 32 characters maximum. The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SV.value, cgmesProfile.TP.value, cgmesProfile.TP_BD.value, ], - 'SvInjection': [cgmesProfile.SV.value, ], - 'SvVoltage': [cgmesProfile.SV.value, ], - 'AngleRefTopologicalIsland': [cgmesProfile.SV.value, ], - 'TopologicalIsland': [cgmesProfile.SV.value, ], - 'BaseVoltage': [cgmesProfile.TP.value, cgmesProfile.TP_BD.value, ], - 'ConnectivityNodes': [cgmesProfile.TP.value, cgmesProfile.TP_BD.value, ], - 'ConnectivityNodeContainer': [cgmesProfile.TP.value, cgmesProfile.TP_BD.value, ], - 'ReportingGroup': [cgmesProfile.TP.value, ], - 'Terminal': [cgmesProfile.TP.value, ], - 'boundaryPoint': [cgmesProfile.TP_BD.value, ], - 'fromEndIsoCode': [cgmesProfile.TP_BD.value, ], - 'fromEndName': [cgmesProfile.TP_BD.value, ], - 'fromEndNameTso': [cgmesProfile.TP_BD.value, ], - 'toEndIsoCode': [cgmesProfile.TP_BD.value, ], - 'toEndName': [cgmesProfile.TP_BD.value, ], - 'toEndNameTso': [cgmesProfile.TP_BD.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, SvInjection = None, SvVoltage = None, AngleRefTopologicalIsland = None, TopologicalIsland = None, BaseVoltage = None, ConnectivityNodes = "list", ConnectivityNodeContainer = None, ReportingGroup = None, Terminal = "list", boundaryPoint = False, fromEndIsoCode = '', fromEndName = '', fromEndNameTso = '', toEndIsoCode = '', toEndName = '', toEndNameTso = '', *args, **kw_args): - super().__init__(*args, **kw_args) - - self.SvInjection = SvInjection - self.SvVoltage = SvVoltage - self.AngleRefTopologicalIsland = AngleRefTopologicalIsland - self.TopologicalIsland = TopologicalIsland - self.BaseVoltage = BaseVoltage - self.ConnectivityNodes = ConnectivityNodes - self.ConnectivityNodeContainer = ConnectivityNodeContainer - self.ReportingGroup = ReportingGroup - self.Terminal = Terminal - self.boundaryPoint = boundaryPoint - self.fromEndIsoCode = fromEndIsoCode - self.fromEndName = fromEndName - self.fromEndNameTso = fromEndNameTso - self.toEndIsoCode = toEndIsoCode - self.toEndName = toEndName - self.toEndNameTso = toEndNameTso - - def __str__(self): - str = 'class=TopologicalNode\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class TopologicalNode(IdentifiedObject): + """ + For a detailed substation model a topological node is a set of connectivity nodes that, in the current network state, are connected together through any type of closed switches, including jumpers. Topological nodes change as the current network state changes (i.e., switches, breakers, etc. change state). For a planning model, switch statuses are not used to form topological nodes. Instead they are manually created or deleted in a model builder tool. Topological nodes maintained this way are also called "busses". + + :AngleRefTopologicalIsland: The island for which the node is an angle reference. Normally there is one angle reference node for each island. Default: None + :BaseVoltage: The base voltage of the topologocial node. Default: None + :ConnectivityNodeContainer: The connectivity node container to which the toplogical node belongs. Default: None + :ConnectivityNodes: The connectivity nodes combine together to form this topological node. May depend on the current state of switches in the network. Default: "list" + :ReportingGroup: The topological nodes that belong to the reporting group. Default: None + :SvInjection: The topological node associated with the flow injection state variable. Default: None + :SvVoltage: The topological node associated with the voltage state. Default: None + :Terminal: The topological node associated with the terminal. This can be used as an alternative to the connectivity node path to topological node, thus making it unneccesary to model connectivity nodes in some cases. Note that the if connectivity nodes are in the model, this association would probably not be used as an input specification. Default: "list" + :TopologicalIsland: A topological node belongs to a topological island. Default: None + :boundaryPoint: Identifies if a node is a BoundaryPoint. If boundaryPoint=true the ConnectivityNode or the TopologicalNode represents a BoundaryPoint. Default: False + :fromEndIsoCode: The attribute is used for an exchange of the ISO code of the region to which the `From` side of the Boundary point belongs to or it is connected to. The ISO code is two characters country code as defined by ISO 3166 (). The length of the string is 2 characters maximum. The attribute is a required for the Boundary Model Authority Set where this attribute is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' + :fromEndName: The attribute is used for an exchange of a human readable name with length of the string 32 characters maximum. The attribute covers two cases: The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' + :fromEndNameTso: The attribute is used for an exchange of the name of the TSO to which the `From` side of the Boundary point belongs to or it is connected to. The length of the string is 32 characters maximum. The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' + :toEndIsoCode: The attribute is used for an exchange of the ISO code of the region to which the `To` side of the Boundary point belongs to or it is connected to. The ISO code is two characters country code as defined by ISO 3166 (). The length of the string is 2 characters maximum. The attribute is a required for the Boundary Model Authority Set where this attribute is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' + :toEndName: The attribute is used for an exchange of a human readable name with length of the string 32 characters maximum. The attribute covers two cases: The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' + :toEndNameTso: The attribute is used for an exchange of the name of the TSO to which the `To` side of the Boundary point belongs to or it is connected to. The length of the string is 32 characters maximum. The attribute is required for the Boundary Model Authority Set where it is used only for the TopologicalNode in the Boundary Topology profile and ConnectivityNode in the Boundary Equipment profile. Default: '' + """ + + possibleProfileList = { + "class": [Profile.SV.value, Profile.TP_BD.value, Profile.TP.value, ], + "AngleRefTopologicalIsland": [Profile.SV.value, ], + "BaseVoltage": [Profile.TP_BD.value, Profile.TP.value, ], + "ConnectivityNodeContainer": [Profile.TP_BD.value, Profile.TP.value, ], + "ConnectivityNodes": [Profile.TP_BD.value, Profile.TP.value, ], + "ReportingGroup": [Profile.TP.value, ], + "SvInjection": [Profile.SV.value, ], + "SvVoltage": [Profile.SV.value, ], + "Terminal": [Profile.TP.value, ], + "TopologicalIsland": [Profile.SV.value, ], + "boundaryPoint": [Profile.TP_BD.value, ], + "fromEndIsoCode": [Profile.TP_BD.value, ], + "fromEndName": [Profile.TP_BD.value, ], + "fromEndNameTso": [Profile.TP_BD.value, ], + "toEndIsoCode": [Profile.TP_BD.value, ], + "toEndName": [Profile.TP_BD.value, ], + "toEndNameTso": [Profile.TP_BD.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.TP.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, AngleRefTopologicalIsland = None, BaseVoltage = None, ConnectivityNodeContainer = None, ConnectivityNodes = "list", ReportingGroup = None, SvInjection = None, SvVoltage = None, Terminal = "list", TopologicalIsland = None, boundaryPoint = False, fromEndIsoCode = '', fromEndName = '', fromEndNameTso = '', toEndIsoCode = '', toEndName = '', toEndNameTso = '', *args, **kw_args): + super().__init__(*args, **kw_args) + + self.AngleRefTopologicalIsland = AngleRefTopologicalIsland + self.BaseVoltage = BaseVoltage + self.ConnectivityNodeContainer = ConnectivityNodeContainer + self.ConnectivityNodes = ConnectivityNodes + self.ReportingGroup = ReportingGroup + self.SvInjection = SvInjection + self.SvVoltage = SvVoltage + self.Terminal = Terminal + self.TopologicalIsland = TopologicalIsland + self.boundaryPoint = boundaryPoint + self.fromEndIsoCode = fromEndIsoCode + self.fromEndName = fromEndName + self.fromEndNameTso = fromEndNameTso + self.toEndIsoCode = toEndIsoCode + self.toEndName = toEndName + self.toEndNameTso = toEndNameTso + + def __str__(self): + str = "class=TopologicalNode\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TopologyBoundaryVersion.py b/cimpy/cgmes_v2_4_15/TopologyBoundaryVersion.py index 5e3641f5..0860cc34 100644 --- a/cimpy/cgmes_v2_4_15/TopologyBoundaryVersion.py +++ b/cimpy/cgmes_v2_4_15/TopologyBoundaryVersion.py @@ -1,57 +1,58 @@ -from .Base import Base - - -class TopologyBoundaryVersion(Base): - ''' - Version details. - - :baseUML: Base UML provided by CIM model manager. Default: '' - :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' - :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' - :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' - :entsoeUML: UML provided by ENTSO-E. Default: '' - :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/TopologyBoundary/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' - :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' - :namespaceRDF: RDF namespace. Default: '' - :namespaceUML: CIM UML namespace. Default: '' - :shortName: The short name of the profile used in profile documentation. Default: '' - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.TP_BD.value, ], - 'baseUML': [cgmesProfile.TP_BD.value, ], - 'baseURI': [cgmesProfile.TP_BD.value, ], - 'date': [cgmesProfile.TP_BD.value, ], - 'differenceModelURI': [cgmesProfile.TP_BD.value, ], - 'entsoeUML': [cgmesProfile.TP_BD.value, ], - 'entsoeURI': [cgmesProfile.TP_BD.value, ], - 'modelDescriptionURI': [cgmesProfile.TP_BD.value, ], - 'namespaceRDF': [cgmesProfile.TP_BD.value, ], - 'namespaceUML': [cgmesProfile.TP_BD.value, ], - 'shortName': [cgmesProfile.TP_BD.value, ], - } - - serializationProfile = {} - - - - def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = '', ): - - self.baseUML = baseUML - self.baseURI = baseURI - self.date = date - self.differenceModelURI = differenceModelURI - self.entsoeUML = entsoeUML - self.entsoeURI = entsoeURI - self.modelDescriptionURI = modelDescriptionURI - self.namespaceRDF = namespaceRDF - self.namespaceUML = namespaceUML - self.shortName = shortName - - def __str__(self): - str = 'class=TopologyBoundaryVersion\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class TopologyBoundaryVersion(Base): + """ + Version details. + + :baseUML: Base UML provided by CIM model manager. Default: '' + :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' + :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' + :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' + :entsoeUML: UML provided by ENTSO-E. Default: '' + :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/TopologyBoundary/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' + :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' + :namespaceRDF: RDF namespace. Default: '' + :namespaceUML: CIM UML namespace. Default: '' + :shortName: The short name of the profile used in profile documentation. Default: '' + """ + + possibleProfileList = { + "class": [Profile.TP_BD.value, ], + "baseUML": [Profile.TP_BD.value, ], + "baseURI": [Profile.TP_BD.value, ], + "date": [Profile.TP_BD.value, ], + "differenceModelURI": [Profile.TP_BD.value, ], + "entsoeUML": [Profile.TP_BD.value, ], + "entsoeURI": [Profile.TP_BD.value, ], + "modelDescriptionURI": [Profile.TP_BD.value, ], + "namespaceRDF": [Profile.TP_BD.value, ], + "namespaceUML": [Profile.TP_BD.value, ], + "shortName": [Profile.TP_BD.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.TP_BD.value + + + def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = ''): + + self.baseUML = baseUML + self.baseURI = baseURI + self.date = date + self.differenceModelURI = differenceModelURI + self.entsoeUML = entsoeUML + self.entsoeURI = entsoeURI + self.modelDescriptionURI = modelDescriptionURI + self.namespaceRDF = namespaceRDF + self.namespaceUML = namespaceUML + self.shortName = shortName + + def __str__(self): + str = "class=TopologyBoundaryVersion\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TopologyVersion.py b/cimpy/cgmes_v2_4_15/TopologyVersion.py index e14a4cb5..e2e5b7ac 100644 --- a/cimpy/cgmes_v2_4_15/TopologyVersion.py +++ b/cimpy/cgmes_v2_4_15/TopologyVersion.py @@ -1,57 +1,58 @@ -from .Base import Base - - -class TopologyVersion(Base): - ''' - Version details. - - :baseUML: Base UML provided by CIM model manager. Default: '' - :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' - :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' - :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' - :entsoeUML: UML provided by ENTSO-E. Default: '' - :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/Topology/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' - :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' - :namespaceRDF: RDF namespace. Default: '' - :namespaceUML: CIM UML namespace. Default: '' - :shortName: The short name of the profile used in profile documentation. Default: '' - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.TP.value, ], - 'baseUML': [cgmesProfile.TP.value, ], - 'baseURI': [cgmesProfile.TP.value, ], - 'date': [cgmesProfile.TP.value, ], - 'differenceModelURI': [cgmesProfile.TP.value, ], - 'entsoeUML': [cgmesProfile.TP.value, ], - 'entsoeURI': [cgmesProfile.TP.value, ], - 'modelDescriptionURI': [cgmesProfile.TP.value, ], - 'namespaceRDF': [cgmesProfile.TP.value, ], - 'namespaceUML': [cgmesProfile.TP.value, ], - 'shortName': [cgmesProfile.TP.value, ], - } - - serializationProfile = {} - - - - def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = '', ): - - self.baseUML = baseUML - self.baseURI = baseURI - self.date = date - self.differenceModelURI = differenceModelURI - self.entsoeUML = entsoeUML - self.entsoeURI = entsoeURI - self.modelDescriptionURI = modelDescriptionURI - self.namespaceRDF = namespaceRDF - self.namespaceUML = namespaceUML - self.shortName = shortName - - def __str__(self): - str = 'class=TopologyVersion\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class TopologyVersion(Base): + """ + Version details. + + :baseUML: Base UML provided by CIM model manager. Default: '' + :baseURI: Profile URI used in the Model Exchange header and defined in IEC standards. It uniquely identifies the Profile and its version. It is given for information only and to identify the closest IEC profile to which this CGMES profile is based on. Default: '' + :date: Profile creation date Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05. Default: '' + :differenceModelURI: Difference model URI defined by IEC 61970-552. Default: '' + :entsoeUML: UML provided by ENTSO-E. Default: '' + :entsoeURI: Profile URI defined by ENTSO-E and used in the Model Exchange header. It uniquely identifies the Profile and its version. The last two elements in the URI (http://entsoe.eu/CIM/Topology/yy/zzz) indicate major and minor versions where: - yy - indicates a major version; - zzz - indicates a minor version. Default: '' + :modelDescriptionURI: Model Description URI defined by IEC 61970-552. Default: '' + :namespaceRDF: RDF namespace. Default: '' + :namespaceUML: CIM UML namespace. Default: '' + :shortName: The short name of the profile used in profile documentation. Default: '' + """ + + possibleProfileList = { + "class": [Profile.TP.value, ], + "baseUML": [Profile.TP.value, ], + "baseURI": [Profile.TP.value, ], + "date": [Profile.TP.value, ], + "differenceModelURI": [Profile.TP.value, ], + "entsoeUML": [Profile.TP.value, ], + "entsoeURI": [Profile.TP.value, ], + "modelDescriptionURI": [Profile.TP.value, ], + "namespaceRDF": [Profile.TP.value, ], + "namespaceUML": [Profile.TP.value, ], + "shortName": [Profile.TP.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.TP.value + + + def __init__(self, baseUML = '', baseURI = '', date = '', differenceModelURI = '', entsoeUML = '', entsoeURI = '', modelDescriptionURI = '', namespaceRDF = '', namespaceUML = '', shortName = ''): + + self.baseUML = baseUML + self.baseURI = baseURI + self.date = date + self.differenceModelURI = differenceModelURI + self.entsoeUML = entsoeUML + self.entsoeURI = entsoeURI + self.modelDescriptionURI = modelDescriptionURI + self.namespaceRDF = namespaceRDF + self.namespaceUML = namespaceUML + self.shortName = shortName + + def __str__(self): + str = "class=TopologyVersion\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TransformerControlMode.py b/cimpy/cgmes_v2_4_15/TransformerControlMode.py index 35c72f87..a7be7849 100644 --- a/cimpy/cgmes_v2_4_15/TransformerControlMode.py +++ b/cimpy/cgmes_v2_4_15/TransformerControlMode.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class TransformerControlMode(Base): - ''' - Control modes for a transformer. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=TransformerControlMode\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class TransformerControlMode(Base): + """ + Control modes for a transformer. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=TransformerControlMode\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TransformerEnd.py b/cimpy/cgmes_v2_4_15/TransformerEnd.py index 1e8942f0..ffca957d 100644 --- a/cimpy/cgmes_v2_4_15/TransformerEnd.py +++ b/cimpy/cgmes_v2_4_15/TransformerEnd.py @@ -1,52 +1,54 @@ -from .IdentifiedObject import IdentifiedObject - - -class TransformerEnd(IdentifiedObject): - ''' - A conducting connection point of a power transformer. It corresponds to a physical transformer winding terminal. In earlier CIM versions, the TransformerWinding class served a similar purpose, but this class is more flexible because it associates to terminal but is not a specialization of ConductingEquipment. - - :BaseVoltage: Base voltage of the transformer end. This is essential for PU calculation. Default: None - :Terminal: Terminal of the power transformer to which this transformer end belongs. Default: None - :PhaseTapChanger: Transformer end to which this phase tap changer belongs. Default: None - :RatioTapChanger: Transformer end to which this ratio tap changer belongs. Default: None - :endNumber: Number for this transformer end, corresponding to the end`s order in the power transformer vector group or phase angle clock number. Highest voltage winding should be 1. Each end within a power transformer should have a unique subsequent end number. Note the transformer end number need not match the terminal sequence number. Default: 0 - :rground: (for Yn and Zn connections) Resistance part of neutral impedance where `grounded` is true. Default: 0.0 - :grounded: (for Yn and Zn connections) True if the neutral is solidly grounded. Default: False - :xground: (for Yn and Zn connections) Reactive part of neutral impedance where `grounded` is true. Default: 0.0 - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'BaseVoltage': [cgmesProfile.EQ.value, ], - 'Terminal': [cgmesProfile.EQ.value, ], - 'PhaseTapChanger': [cgmesProfile.EQ.value, ], - 'RatioTapChanger': [cgmesProfile.EQ.value, ], - 'endNumber': [cgmesProfile.EQ.value, ], - 'rground': [cgmesProfile.EQ.value, ], - 'grounded': [cgmesProfile.EQ.value, ], - 'xground': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, BaseVoltage = None, Terminal = None, PhaseTapChanger = None, RatioTapChanger = None, endNumber = 0, rground = 0.0, grounded = False, xground = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.BaseVoltage = BaseVoltage - self.Terminal = Terminal - self.PhaseTapChanger = PhaseTapChanger - self.RatioTapChanger = RatioTapChanger - self.endNumber = endNumber - self.rground = rground - self.grounded = grounded - self.xground = xground - - def __str__(self): - str = 'class=TransformerEnd\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class TransformerEnd(IdentifiedObject): + """ + A conducting connection point of a power transformer. It corresponds to a physical transformer winding terminal. In earlier CIM versions, the TransformerWinding class served a similar purpose, but this class is more flexible because it associates to terminal but is not a specialization of ConductingEquipment. + + :BaseVoltage: Base voltage of the transformer end. This is essential for PU calculation. Default: None + :PhaseTapChanger: Transformer end to which this phase tap changer belongs. Default: None + :RatioTapChanger: Transformer end to which this ratio tap changer belongs. Default: None + :Terminal: Terminal of the power transformer to which this transformer end belongs. Default: None + :endNumber: Number for this transformer end, corresponding to the end`s order in the power transformer vector group or phase angle clock number. Highest voltage winding should be 1. Each end within a power transformer should have a unique subsequent end number. Note the transformer end number need not match the terminal sequence number. Default: 0 + :grounded: (for Yn and Zn connections) True if the neutral is solidly grounded. Default: False + :rground: (for Yn and Zn connections) Resistance part of neutral impedance where `grounded` is true. Default: 0.0 + :xground: (for Yn and Zn connections) Reactive part of neutral impedance where `grounded` is true. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "BaseVoltage": [Profile.EQ.value, ], + "PhaseTapChanger": [Profile.EQ.value, ], + "RatioTapChanger": [Profile.EQ.value, ], + "Terminal": [Profile.EQ.value, ], + "endNumber": [Profile.EQ.value, ], + "grounded": [Profile.EQ.value, ], + "rground": [Profile.EQ.value, ], + "xground": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, BaseVoltage = None, PhaseTapChanger = None, RatioTapChanger = None, Terminal = None, endNumber = 0, grounded = False, rground = 0.0, xground = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.BaseVoltage = BaseVoltage + self.PhaseTapChanger = PhaseTapChanger + self.RatioTapChanger = RatioTapChanger + self.Terminal = Terminal + self.endNumber = endNumber + self.grounded = grounded + self.rground = rground + self.xground = xground + + def __str__(self): + str = "class=TransformerEnd\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TurbLCFB1.py b/cimpy/cgmes_v2_4_15/TurbLCFB1.py index 9b5ace07..a0a03697 100644 --- a/cimpy/cgmes_v2_4_15/TurbLCFB1.py +++ b/cimpy/cgmes_v2_4_15/TurbLCFB1.py @@ -1,64 +1,66 @@ -from .TurbineLoadControllerDynamics import TurbineLoadControllerDynamics - - -class TurbLCFB1(TurbineLoadControllerDynamics): - ''' - Turbine Load Controller model developed in the WECC. This model represents a supervisory turbine load controller that acts to maintain turbine power at a set value by continuous adjustment of the turbine governor speed-load reference. This model is intended to represent slow reset 'outer loop' controllers managing the action of the turbine governor. - - :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 - :speedReferenceGovernor: Type of turbine governor reference (Type). true = speed reference governor false = load reference governor. Typical Value = true. Default: False - :db: Controller dead band (db). Typical Value = 0. Default: 0.0 - :emax: Maximum control error (Emax) (note 4). Typical Value = 0.02. Default: 0.0 - :fb: Frequency bias gain (Fb). Typical Value = 0. Default: 0.0 - :kp: Proportional gain (Kp). Typical Value = 0. Default: 0.0 - :ki: Integral gain (Ki). Typical Value = 0. Default: 0.0 - :fbf: Frequency bias flag (Fbf). true = enable frequency bias false = disable frequency bias. Typical Value = false. Default: False - :pbf: Power controller flag (Pbf). true = enable load controller false = disable load controller. Typical Value = false. Default: False - :tpelec: Power transducer time constant (Tpelec). Typical Value = 0. Default: 0 - :irmax: Maximum turbine speed/load reference bias (Irmax) (note 3). Typical Value = 0. Default: 0.0 - :pmwset: Power controller setpoint (Pmwset) (note 1). Unit = MW. Typical Value = 0. Default: 0.0 - ''' - - cgmesProfile = TurbineLoadControllerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'mwbase': [cgmesProfile.DY.value, ], - 'speedReferenceGovernor': [cgmesProfile.DY.value, ], - 'db': [cgmesProfile.DY.value, ], - 'emax': [cgmesProfile.DY.value, ], - 'fb': [cgmesProfile.DY.value, ], - 'kp': [cgmesProfile.DY.value, ], - 'ki': [cgmesProfile.DY.value, ], - 'fbf': [cgmesProfile.DY.value, ], - 'pbf': [cgmesProfile.DY.value, ], - 'tpelec': [cgmesProfile.DY.value, ], - 'irmax': [cgmesProfile.DY.value, ], - 'pmwset': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineLoadControllerDynamics: \n' + TurbineLoadControllerDynamics.__doc__ - - def __init__(self, mwbase = 0.0, speedReferenceGovernor = False, db = 0.0, emax = 0.0, fb = 0.0, kp = 0.0, ki = 0.0, fbf = False, pbf = False, tpelec = 0, irmax = 0.0, pmwset = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.mwbase = mwbase - self.speedReferenceGovernor = speedReferenceGovernor - self.db = db - self.emax = emax - self.fb = fb - self.kp = kp - self.ki = ki - self.fbf = fbf - self.pbf = pbf - self.tpelec = tpelec - self.irmax = irmax - self.pmwset = pmwset - - def __str__(self): - str = 'class=TurbLCFB1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineLoadControllerDynamics import TurbineLoadControllerDynamics +from .CGMESProfile import Profile + + +class TurbLCFB1(TurbineLoadControllerDynamics): + """ + Turbine Load Controller model developed in the WECC. This model represents a supervisory turbine load controller that acts to maintain turbine power at a set value by continuous adjustment of the turbine governor speed-load reference. This model is intended to represent slow reset 'outer loop' controllers managing the action of the turbine governor. + + :db: Controller dead band (db). Typical Value = 0. Default: 0.0 + :emax: Maximum control error (Emax) (note 4). Typical Value = 0.02. Default: 0.0 + :fb: Frequency bias gain (Fb). Typical Value = 0. Default: 0.0 + :fbf: Frequency bias flag (Fbf). true = enable frequency bias false = disable frequency bias. Typical Value = false. Default: False + :irmax: Maximum turbine speed/load reference bias (Irmax) (note 3). Typical Value = 0. Default: 0.0 + :ki: Integral gain (Ki). Typical Value = 0. Default: 0.0 + :kp: Proportional gain (Kp). Typical Value = 0. Default: 0.0 + :mwbase: Base for power values (MWbase) (>0). Unit = MW. Default: 0.0 + :pbf: Power controller flag (Pbf). true = enable load controller false = disable load controller. Typical Value = false. Default: False + :pmwset: Power controller setpoint (Pmwset) (note 1). Unit = MW. Typical Value = 0. Default: 0.0 + :speedReferenceGovernor: Type of turbine governor reference (Type). true = speed reference governor false = load reference governor. Typical Value = true. Default: False + :tpelec: Power transducer time constant (Tpelec). Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "db": [Profile.DY.value, ], + "emax": [Profile.DY.value, ], + "fb": [Profile.DY.value, ], + "fbf": [Profile.DY.value, ], + "irmax": [Profile.DY.value, ], + "ki": [Profile.DY.value, ], + "kp": [Profile.DY.value, ], + "mwbase": [Profile.DY.value, ], + "pbf": [Profile.DY.value, ], + "pmwset": [Profile.DY.value, ], + "speedReferenceGovernor": [Profile.DY.value, ], + "tpelec": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineLoadControllerDynamics:\n" + TurbineLoadControllerDynamics.__doc__ + + def __init__(self, db = 0.0, emax = 0.0, fb = 0.0, fbf = False, irmax = 0.0, ki = 0.0, kp = 0.0, mwbase = 0.0, pbf = False, pmwset = 0.0, speedReferenceGovernor = False, tpelec = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.db = db + self.emax = emax + self.fb = fb + self.fbf = fbf + self.irmax = irmax + self.ki = ki + self.kp = kp + self.mwbase = mwbase + self.pbf = pbf + self.pmwset = pmwset + self.speedReferenceGovernor = speedReferenceGovernor + self.tpelec = tpelec + + def __str__(self): + str = "class=TurbLCFB1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TurbineGovernorDynamics.py b/cimpy/cgmes_v2_4_15/TurbineGovernorDynamics.py index e128aa67..c3186db2 100644 --- a/cimpy/cgmes_v2_4_15/TurbineGovernorDynamics.py +++ b/cimpy/cgmes_v2_4_15/TurbineGovernorDynamics.py @@ -1,37 +1,39 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class TurbineGovernorDynamics(DynamicsFunctionBlock): - ''' - Turbine-governor function block whose behavior is described by reference to a standard model - - :SynchronousMachineDynamics: Turbine-governor model associated with this synchronous machine model. Default: "list" - :AsynchronousMachineDynamics: Asynchronous machine model with which this turbine-governor model is associated. Default: None - :TurbineLoadControllerDynamics: Turbine load controller providing input to this turbine-governor. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'SynchronousMachineDynamics': [cgmesProfile.DY.value, ], - 'AsynchronousMachineDynamics': [cgmesProfile.DY.value, ], - 'TurbineLoadControllerDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, SynchronousMachineDynamics = "list", AsynchronousMachineDynamics = None, TurbineLoadControllerDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.SynchronousMachineDynamics = SynchronousMachineDynamics - self.AsynchronousMachineDynamics = AsynchronousMachineDynamics - self.TurbineLoadControllerDynamics = TurbineLoadControllerDynamics - - def __str__(self): - str = 'class=TurbineGovernorDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class TurbineGovernorDynamics(DynamicsFunctionBlock): + """ + Turbine-governor function block whose behavior is described by reference to a standard model + + :AsynchronousMachineDynamics: Asynchronous machine model with which this turbine-governor model is associated. Default: None + :SynchronousMachineDynamics: Turbine-governor model associated with this synchronous machine model. Default: "list" + :TurbineLoadControllerDynamics: Turbine load controller providing input to this turbine-governor. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "AsynchronousMachineDynamics": [Profile.DY.value, ], + "SynchronousMachineDynamics": [Profile.DY.value, ], + "TurbineLoadControllerDynamics": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, AsynchronousMachineDynamics = None, SynchronousMachineDynamics = "list", TurbineLoadControllerDynamics = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.AsynchronousMachineDynamics = AsynchronousMachineDynamics + self.SynchronousMachineDynamics = SynchronousMachineDynamics + self.TurbineLoadControllerDynamics = TurbineLoadControllerDynamics + + def __str__(self): + str = "class=TurbineGovernorDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TurbineGovernorUserDefined.py b/cimpy/cgmes_v2_4_15/TurbineGovernorUserDefined.py index 14dd9d06..339b9c3b 100644 --- a/cimpy/cgmes_v2_4_15/TurbineGovernorUserDefined.py +++ b/cimpy/cgmes_v2_4_15/TurbineGovernorUserDefined.py @@ -1,34 +1,36 @@ -from .TurbineGovernorDynamics import TurbineGovernorDynamics - - -class TurbineGovernorUserDefined(TurbineGovernorDynamics): - ''' - Turbine-governor function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = TurbineGovernorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineGovernorDynamics: \n' + TurbineGovernorDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=TurbineGovernorUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineGovernorDynamics import TurbineGovernorDynamics +from .CGMESProfile import Profile + + +class TurbineGovernorUserDefined(TurbineGovernorDynamics): + """ + Turbine-governor function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineGovernorDynamics:\n" + TurbineGovernorDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=TurbineGovernorUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TurbineLoadControllerDynamics.py b/cimpy/cgmes_v2_4_15/TurbineLoadControllerDynamics.py index 7401aae2..eab26930 100644 --- a/cimpy/cgmes_v2_4_15/TurbineLoadControllerDynamics.py +++ b/cimpy/cgmes_v2_4_15/TurbineLoadControllerDynamics.py @@ -1,31 +1,33 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class TurbineLoadControllerDynamics(DynamicsFunctionBlock): - ''' - Turbine load controller function block whose behavior is described by reference to a standard model - - :TurbineGovernorDynamics: Turbine-governor controlled by this turbine load controller. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'TurbineGovernorDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, TurbineGovernorDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.TurbineGovernorDynamics = TurbineGovernorDynamics - - def __str__(self): - str = 'class=TurbineLoadControllerDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class TurbineLoadControllerDynamics(DynamicsFunctionBlock): + """ + Turbine load controller function block whose behavior is described by reference to a standard model + + :TurbineGovernorDynamics: Turbine-governor controlled by this turbine load controller. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "TurbineGovernorDynamics": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, TurbineGovernorDynamics = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.TurbineGovernorDynamics = TurbineGovernorDynamics + + def __str__(self): + str = "class=TurbineLoadControllerDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/TurbineLoadControllerUserDefined.py b/cimpy/cgmes_v2_4_15/TurbineLoadControllerUserDefined.py index 84946b5a..0274333c 100644 --- a/cimpy/cgmes_v2_4_15/TurbineLoadControllerUserDefined.py +++ b/cimpy/cgmes_v2_4_15/TurbineLoadControllerUserDefined.py @@ -1,34 +1,36 @@ -from .TurbineLoadControllerDynamics import TurbineLoadControllerDynamics - - -class TurbineLoadControllerUserDefined(TurbineLoadControllerDynamics): - ''' - Turbine load controller function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = TurbineLoadControllerDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class TurbineLoadControllerDynamics: \n' + TurbineLoadControllerDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=TurbineLoadControllerUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .TurbineLoadControllerDynamics import TurbineLoadControllerDynamics +from .CGMESProfile import Profile + + +class TurbineLoadControllerUserDefined(TurbineLoadControllerDynamics): + """ + Turbine load controller function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class TurbineLoadControllerDynamics:\n" + TurbineLoadControllerDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=TurbineLoadControllerUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/UnderexcLim2Simplified.py b/cimpy/cgmes_v2_4_15/UnderexcLim2Simplified.py index ae1b368b..f3d96e5c 100644 --- a/cimpy/cgmes_v2_4_15/UnderexcLim2Simplified.py +++ b/cimpy/cgmes_v2_4_15/UnderexcLim2Simplified.py @@ -1,49 +1,51 @@ -from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics - - -class UnderexcLim2Simplified(UnderexcitationLimiterDynamics): - ''' - This model can be derived from UnderexcLimIEEE2. The limit characteristic (look -up table) is a single straight-line, the same as UnderexcLimIEEE2 (see Figure 10.4 (p 32), IEEE 421.5-2005 Section 10.2). - - :q0: Segment Q initial point (Q0). Typical Value = -0.31. Default: 0.0 - :q1: Segment Q end point (Q1). Typical Value = -0.1. Default: 0.0 - :p0: Segment P initial point (P0). Typical Value = 0. Default: 0.0 - :p1: Segment P end point (P1). Typical Value = 1. Default: 0.0 - :kui: Gain Under excitation limiter (Kui). Typical Value = 0.1. Default: 0.0 - :vuimin: Minimum error signal (V). Typical Value = 0. Default: 0.0 - :vuimax: Maximum error signal (V). Typical Value = 1. Default: 0.0 - ''' - - cgmesProfile = UnderexcitationLimiterDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'q0': [cgmesProfile.DY.value, ], - 'q1': [cgmesProfile.DY.value, ], - 'p0': [cgmesProfile.DY.value, ], - 'p1': [cgmesProfile.DY.value, ], - 'kui': [cgmesProfile.DY.value, ], - 'vuimin': [cgmesProfile.DY.value, ], - 'vuimax': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class UnderexcitationLimiterDynamics: \n' + UnderexcitationLimiterDynamics.__doc__ - - def __init__(self, q0 = 0.0, q1 = 0.0, p0 = 0.0, p1 = 0.0, kui = 0.0, vuimin = 0.0, vuimax = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.q0 = q0 - self.q1 = q1 - self.p0 = p0 - self.p1 = p1 - self.kui = kui - self.vuimin = vuimin - self.vuimax = vuimax - - def __str__(self): - str = 'class=UnderexcLim2Simplified\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics +from .CGMESProfile import Profile + + +class UnderexcLim2Simplified(UnderexcitationLimiterDynamics): + """ + This model can be derived from UnderexcLimIEEE2. The limit characteristic (look -up table) is a single straight-line, the same as UnderexcLimIEEE2 (see Figure 10.4 (p 32), IEEE 421.5-2005 Section 10.2). + + :kui: Gain Under excitation limiter (Kui). Typical Value = 0.1. Default: 0.0 + :p0: Segment P initial point (P0). Typical Value = 0. Default: 0.0 + :p1: Segment P end point (P1). Typical Value = 1. Default: 0.0 + :q0: Segment Q initial point (Q0). Typical Value = -0.31. Default: 0.0 + :q1: Segment Q end point (Q1). Typical Value = -0.1. Default: 0.0 + :vuimax: Maximum error signal (V). Typical Value = 1. Default: 0.0 + :vuimin: Minimum error signal (V). Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "kui": [Profile.DY.value, ], + "p0": [Profile.DY.value, ], + "p1": [Profile.DY.value, ], + "q0": [Profile.DY.value, ], + "q1": [Profile.DY.value, ], + "vuimax": [Profile.DY.value, ], + "vuimin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class UnderexcitationLimiterDynamics:\n" + UnderexcitationLimiterDynamics.__doc__ + + def __init__(self, kui = 0.0, p0 = 0.0, p1 = 0.0, q0 = 0.0, q1 = 0.0, vuimax = 0.0, vuimin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.kui = kui + self.p0 = p0 + self.p1 = p1 + self.q0 = q0 + self.q1 = q1 + self.vuimax = vuimax + self.vuimin = vuimin + + def __str__(self): + str = "class=UnderexcLim2Simplified\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/UnderexcLimIEEE1.py b/cimpy/cgmes_v2_4_15/UnderexcLimIEEE1.py index de0e005a..98245a70 100644 --- a/cimpy/cgmes_v2_4_15/UnderexcLimIEEE1.py +++ b/cimpy/cgmes_v2_4_15/UnderexcLimIEEE1.py @@ -1,73 +1,75 @@ -from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics - - -class UnderexcLimIEEE1(UnderexcitationLimiterDynamics): - ''' - The class represents the Type UEL1 model which has a circular limit boundary when plotted in terms of machine reactive power vs. real power output. Reference: IEEE UEL1 421.5-2005 Section 10.1. - - :kur: UEL radius setting (K). Typical Value = 1.95. Default: 0.0 - :kuc: UEL center setting (K). Typical Value = 1.38. Default: 0.0 - :kuf: UEL excitation system stabilizer gain (K). Typical Value = 3.3. Default: 0.0 - :vurmax: UEL maximum limit for radius phasor magnitude (V). Typical Value = 5.8. Default: 0.0 - :vucmax: UEL maximum limit for operating point phasor magnitude (V). Typical Value = 5.8. Default: 0.0 - :kui: UEL integral gain (K). Typical Value = 0. Default: 0.0 - :kul: UEL proportional gain (K). Typical Value = 100. Default: 0.0 - :vuimax: UEL integrator output maximum limit (V). Default: 0.0 - :vuimin: UEL integrator output minimum limit (V). Default: 0.0 - :tu1: UEL lead time constant (T). Typical Value = 0. Default: 0 - :tu2: UEL lag time constant (T). Typical Value = 0.05. Default: 0 - :tu3: UEL lead time constant (T). Typical Value = 0. Default: 0 - :tu4: UEL lag time constant (T). Typical Value = 0. Default: 0 - :vulmax: UEL output maximum limit (V). Typical Value = 18. Default: 0.0 - :vulmin: UEL output minimum limit (V). Typical Value = -18. Default: 0.0 - ''' - - cgmesProfile = UnderexcitationLimiterDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kur': [cgmesProfile.DY.value, ], - 'kuc': [cgmesProfile.DY.value, ], - 'kuf': [cgmesProfile.DY.value, ], - 'vurmax': [cgmesProfile.DY.value, ], - 'vucmax': [cgmesProfile.DY.value, ], - 'kui': [cgmesProfile.DY.value, ], - 'kul': [cgmesProfile.DY.value, ], - 'vuimax': [cgmesProfile.DY.value, ], - 'vuimin': [cgmesProfile.DY.value, ], - 'tu1': [cgmesProfile.DY.value, ], - 'tu2': [cgmesProfile.DY.value, ], - 'tu3': [cgmesProfile.DY.value, ], - 'tu4': [cgmesProfile.DY.value, ], - 'vulmax': [cgmesProfile.DY.value, ], - 'vulmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class UnderexcitationLimiterDynamics: \n' + UnderexcitationLimiterDynamics.__doc__ - - def __init__(self, kur = 0.0, kuc = 0.0, kuf = 0.0, vurmax = 0.0, vucmax = 0.0, kui = 0.0, kul = 0.0, vuimax = 0.0, vuimin = 0.0, tu1 = 0, tu2 = 0, tu3 = 0, tu4 = 0, vulmax = 0.0, vulmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kur = kur - self.kuc = kuc - self.kuf = kuf - self.vurmax = vurmax - self.vucmax = vucmax - self.kui = kui - self.kul = kul - self.vuimax = vuimax - self.vuimin = vuimin - self.tu1 = tu1 - self.tu2 = tu2 - self.tu3 = tu3 - self.tu4 = tu4 - self.vulmax = vulmax - self.vulmin = vulmin - - def __str__(self): - str = 'class=UnderexcLimIEEE1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics +from .CGMESProfile import Profile + + +class UnderexcLimIEEE1(UnderexcitationLimiterDynamics): + """ + The class represents the Type UEL1 model which has a circular limit boundary when plotted in terms of machine reactive power vs. real power output. Reference: IEEE UEL1 421.5-2005 Section 10.1. + + :kuc: UEL center setting (K). Typical Value = 1.38. Default: 0.0 + :kuf: UEL excitation system stabilizer gain (K). Typical Value = 3.3. Default: 0.0 + :kui: UEL integral gain (K). Typical Value = 0. Default: 0.0 + :kul: UEL proportional gain (K). Typical Value = 100. Default: 0.0 + :kur: UEL radius setting (K). Typical Value = 1.95. Default: 0.0 + :tu1: UEL lead time constant (T). Typical Value = 0. Default: 0.0 + :tu2: UEL lag time constant (T). Typical Value = 0.05. Default: 0.0 + :tu3: UEL lead time constant (T). Typical Value = 0. Default: 0.0 + :tu4: UEL lag time constant (T). Typical Value = 0. Default: 0.0 + :vucmax: UEL maximum limit for operating point phasor magnitude (V). Typical Value = 5.8. Default: 0.0 + :vuimax: UEL integrator output maximum limit (V). Default: 0.0 + :vuimin: UEL integrator output minimum limit (V). Default: 0.0 + :vulmax: UEL output maximum limit (V). Typical Value = 18. Default: 0.0 + :vulmin: UEL output minimum limit (V). Typical Value = -18. Default: 0.0 + :vurmax: UEL maximum limit for radius phasor magnitude (V). Typical Value = 5.8. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "kuc": [Profile.DY.value, ], + "kuf": [Profile.DY.value, ], + "kui": [Profile.DY.value, ], + "kul": [Profile.DY.value, ], + "kur": [Profile.DY.value, ], + "tu1": [Profile.DY.value, ], + "tu2": [Profile.DY.value, ], + "tu3": [Profile.DY.value, ], + "tu4": [Profile.DY.value, ], + "vucmax": [Profile.DY.value, ], + "vuimax": [Profile.DY.value, ], + "vuimin": [Profile.DY.value, ], + "vulmax": [Profile.DY.value, ], + "vulmin": [Profile.DY.value, ], + "vurmax": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class UnderexcitationLimiterDynamics:\n" + UnderexcitationLimiterDynamics.__doc__ + + def __init__(self, kuc = 0.0, kuf = 0.0, kui = 0.0, kul = 0.0, kur = 0.0, tu1 = 0.0, tu2 = 0.0, tu3 = 0.0, tu4 = 0.0, vucmax = 0.0, vuimax = 0.0, vuimin = 0.0, vulmax = 0.0, vulmin = 0.0, vurmax = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.kuc = kuc + self.kuf = kuf + self.kui = kui + self.kul = kul + self.kur = kur + self.tu1 = tu1 + self.tu2 = tu2 + self.tu3 = tu3 + self.tu4 = tu4 + self.vucmax = vucmax + self.vuimax = vuimax + self.vuimin = vuimin + self.vulmax = vulmax + self.vulmin = vulmin + self.vurmax = vurmax + + def __str__(self): + str = "class=UnderexcLimIEEE1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/UnderexcLimIEEE2.py b/cimpy/cgmes_v2_4_15/UnderexcLimIEEE2.py index 15d0db60..c98b85ee 100644 --- a/cimpy/cgmes_v2_4_15/UnderexcLimIEEE2.py +++ b/cimpy/cgmes_v2_4_15/UnderexcLimIEEE2.py @@ -1,148 +1,150 @@ -from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics - - -class UnderexcLimIEEE2(UnderexcitationLimiterDynamics): - ''' - The class represents the Type UEL2 which has either a straight-line or multi-segment characteristic when plotted in terms of machine reactive power output vs. real power output. Reference: IEEE UEL2 421.5-2005 Section 10.2. (Limit characteristic lookup table shown in Figure 10.4 (p 32) of the standard). - - :tuv: Voltage filter time constant (T). Typical Value = 5. Default: 0 - :tup: Real power filter time constant (T). Typical Value = 5. Default: 0 - :tuq: Reactive power filter time constant (T). Typical Value = 0. Default: 0 - :kui: UEL integral gain (K). Typical Value = 0.5. Default: 0.0 - :kul: UEL proportional gain (K). Typical Value = 0.8. Default: 0.0 - :vuimax: UEL integrator output maximum limit (V). Typical Value = 0.25. Default: 0.0 - :vuimin: UEL integrator output minimum limit (V). Typical Value = 0. Default: 0.0 - :kuf: UEL excitation system stabilizer gain (K). Typical Value = 0. Default: 0.0 - :kfb: Gain associated with optional integrator feedback input signal to UEL (K). Typical Value = 0. Default: 0.0 - :tul: Time constant associated with optional integrator feedback input signal to UEL (T). Typical Value = 0. Default: 0 - :tu1: UEL lead time constant (T). Typical Value = 0. Default: 0 - :tu2: UEL lag time constant (T). Typical Value = 0. Default: 0 - :tu3: UEL lead time constant (T). Typical Value = 0. Default: 0 - :tu4: UEL lag time constant (T). Typical Value = 0. Default: 0 - :vulmax: UEL output maximum limit (V). Typical Value = 0.25. Default: 0.0 - :vulmin: UEL output minimum limit (V). Typical Value = 0. Default: 0.0 - :p0: Real power values for endpoints (P). Typical Value = 0. Default: 0.0 - :q0: Reactive power values for endpoints (Q). Typical Value = -0.31. Default: 0.0 - :p1: Real power values for endpoints (P). Typical Value = 0.3. Default: 0.0 - :q1: Reactive power values for endpoints (Q). Typical Value = -0.31. Default: 0.0 - :p2: Real power values for endpoints (P). Typical Value = 0.6. Default: 0.0 - :q2: Reactive power values for endpoints (Q). Typical Value = -0.28. Default: 0.0 - :p3: Real power values for endpoints (P). Typical Value = 0.9. Default: 0.0 - :q3: Reactive power values for endpoints (Q). Typical Value = -0.21. Default: 0.0 - :p4: Real power values for endpoints (P). Typical Value = 1.02. Default: 0.0 - :q4: Reactive power values for endpoints (Q). Typical Value = 0. Default: 0.0 - :p5: Real power values for endpoints (P). Default: 0.0 - :q5: Reactive power values for endpoints (Q). Default: 0.0 - :p6: Real power values for endpoints (P). Default: 0.0 - :q6: Reactive power values for endpoints (Q). Default: 0.0 - :p7: Real power values for endpoints (P). Default: 0.0 - :q7: Reactive power values for endpoints (Q). Default: 0.0 - :p8: Real power values for endpoints (P). Default: 0.0 - :q8: Reactive power values for endpoints (Q). Default: 0.0 - :p9: Real power values for endpoints (P). Default: 0.0 - :q9: Reactive power values for endpoints (Q). Default: 0.0 - :p10: Real power values for endpoints (P). Default: 0.0 - :q10: Reactive power values for endpoints (Q). Default: 0.0 - :k1: UEL terminal voltage exponent applied to real power input to UEL limit look-up table (k1). Typical Value = 2. Default: 0.0 - :k2: UEL terminal voltage exponent applied to reactive power output from UEL limit look-up table (k2). Typical Value = 2. Default: 0.0 - ''' - - cgmesProfile = UnderexcitationLimiterDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tuv': [cgmesProfile.DY.value, ], - 'tup': [cgmesProfile.DY.value, ], - 'tuq': [cgmesProfile.DY.value, ], - 'kui': [cgmesProfile.DY.value, ], - 'kul': [cgmesProfile.DY.value, ], - 'vuimax': [cgmesProfile.DY.value, ], - 'vuimin': [cgmesProfile.DY.value, ], - 'kuf': [cgmesProfile.DY.value, ], - 'kfb': [cgmesProfile.DY.value, ], - 'tul': [cgmesProfile.DY.value, ], - 'tu1': [cgmesProfile.DY.value, ], - 'tu2': [cgmesProfile.DY.value, ], - 'tu3': [cgmesProfile.DY.value, ], - 'tu4': [cgmesProfile.DY.value, ], - 'vulmax': [cgmesProfile.DY.value, ], - 'vulmin': [cgmesProfile.DY.value, ], - 'p0': [cgmesProfile.DY.value, ], - 'q0': [cgmesProfile.DY.value, ], - 'p1': [cgmesProfile.DY.value, ], - 'q1': [cgmesProfile.DY.value, ], - 'p2': [cgmesProfile.DY.value, ], - 'q2': [cgmesProfile.DY.value, ], - 'p3': [cgmesProfile.DY.value, ], - 'q3': [cgmesProfile.DY.value, ], - 'p4': [cgmesProfile.DY.value, ], - 'q4': [cgmesProfile.DY.value, ], - 'p5': [cgmesProfile.DY.value, ], - 'q5': [cgmesProfile.DY.value, ], - 'p6': [cgmesProfile.DY.value, ], - 'q6': [cgmesProfile.DY.value, ], - 'p7': [cgmesProfile.DY.value, ], - 'q7': [cgmesProfile.DY.value, ], - 'p8': [cgmesProfile.DY.value, ], - 'q8': [cgmesProfile.DY.value, ], - 'p9': [cgmesProfile.DY.value, ], - 'q9': [cgmesProfile.DY.value, ], - 'p10': [cgmesProfile.DY.value, ], - 'q10': [cgmesProfile.DY.value, ], - 'k1': [cgmesProfile.DY.value, ], - 'k2': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class UnderexcitationLimiterDynamics: \n' + UnderexcitationLimiterDynamics.__doc__ - - def __init__(self, tuv = 0, tup = 0, tuq = 0, kui = 0.0, kul = 0.0, vuimax = 0.0, vuimin = 0.0, kuf = 0.0, kfb = 0.0, tul = 0, tu1 = 0, tu2 = 0, tu3 = 0, tu4 = 0, vulmax = 0.0, vulmin = 0.0, p0 = 0.0, q0 = 0.0, p1 = 0.0, q1 = 0.0, p2 = 0.0, q2 = 0.0, p3 = 0.0, q3 = 0.0, p4 = 0.0, q4 = 0.0, p5 = 0.0, q5 = 0.0, p6 = 0.0, q6 = 0.0, p7 = 0.0, q7 = 0.0, p8 = 0.0, q8 = 0.0, p9 = 0.0, q9 = 0.0, p10 = 0.0, q10 = 0.0, k1 = 0.0, k2 = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tuv = tuv - self.tup = tup - self.tuq = tuq - self.kui = kui - self.kul = kul - self.vuimax = vuimax - self.vuimin = vuimin - self.kuf = kuf - self.kfb = kfb - self.tul = tul - self.tu1 = tu1 - self.tu2 = tu2 - self.tu3 = tu3 - self.tu4 = tu4 - self.vulmax = vulmax - self.vulmin = vulmin - self.p0 = p0 - self.q0 = q0 - self.p1 = p1 - self.q1 = q1 - self.p2 = p2 - self.q2 = q2 - self.p3 = p3 - self.q3 = q3 - self.p4 = p4 - self.q4 = q4 - self.p5 = p5 - self.q5 = q5 - self.p6 = p6 - self.q6 = q6 - self.p7 = p7 - self.q7 = q7 - self.p8 = p8 - self.q8 = q8 - self.p9 = p9 - self.q9 = q9 - self.p10 = p10 - self.q10 = q10 - self.k1 = k1 - self.k2 = k2 - - def __str__(self): - str = 'class=UnderexcLimIEEE2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics +from .CGMESProfile import Profile + + +class UnderexcLimIEEE2(UnderexcitationLimiterDynamics): + """ + The class represents the Type UEL2 which has either a straight-line or multi-segment characteristic when plotted in terms of machine reactive power output vs. real power output. Reference: IEEE UEL2 421.5-2005 Section 10.2. (Limit characteristic lookup table shown in Figure 10.4 (p 32) of the standard). + + :k1: UEL terminal voltage exponent applied to real power input to UEL limit look-up table (k1). Typical Value = 2. Default: 0.0 + :k2: UEL terminal voltage exponent applied to reactive power output from UEL limit look-up table (k2). Typical Value = 2. Default: 0.0 + :kfb: Gain associated with optional integrator feedback input signal to UEL (K). Typical Value = 0. Default: 0.0 + :kuf: UEL excitation system stabilizer gain (K). Typical Value = 0. Default: 0.0 + :kui: UEL integral gain (K). Typical Value = 0.5. Default: 0.0 + :kul: UEL proportional gain (K). Typical Value = 0.8. Default: 0.0 + :p0: Real power values for endpoints (P). Typical Value = 0. Default: 0.0 + :p1: Real power values for endpoints (P). Typical Value = 0.3. Default: 0.0 + :p10: Real power values for endpoints (P). Default: 0.0 + :p2: Real power values for endpoints (P). Typical Value = 0.6. Default: 0.0 + :p3: Real power values for endpoints (P). Typical Value = 0.9. Default: 0.0 + :p4: Real power values for endpoints (P). Typical Value = 1.02. Default: 0.0 + :p5: Real power values for endpoints (P). Default: 0.0 + :p6: Real power values for endpoints (P). Default: 0.0 + :p7: Real power values for endpoints (P). Default: 0.0 + :p8: Real power values for endpoints (P). Default: 0.0 + :p9: Real power values for endpoints (P). Default: 0.0 + :q0: Reactive power values for endpoints (Q). Typical Value = -0.31. Default: 0.0 + :q1: Reactive power values for endpoints (Q). Typical Value = -0.31. Default: 0.0 + :q10: Reactive power values for endpoints (Q). Default: 0.0 + :q2: Reactive power values for endpoints (Q). Typical Value = -0.28. Default: 0.0 + :q3: Reactive power values for endpoints (Q). Typical Value = -0.21. Default: 0.0 + :q4: Reactive power values for endpoints (Q). Typical Value = 0. Default: 0.0 + :q5: Reactive power values for endpoints (Q). Default: 0.0 + :q6: Reactive power values for endpoints (Q). Default: 0.0 + :q7: Reactive power values for endpoints (Q). Default: 0.0 + :q8: Reactive power values for endpoints (Q). Default: 0.0 + :q9: Reactive power values for endpoints (Q). Default: 0.0 + :tu1: UEL lead time constant (T). Typical Value = 0. Default: 0.0 + :tu2: UEL lag time constant (T). Typical Value = 0. Default: 0.0 + :tu3: UEL lead time constant (T). Typical Value = 0. Default: 0.0 + :tu4: UEL lag time constant (T). Typical Value = 0. Default: 0.0 + :tul: Time constant associated with optional integrator feedback input signal to UEL (T). Typical Value = 0. Default: 0.0 + :tup: Real power filter time constant (T). Typical Value = 5. Default: 0.0 + :tuq: Reactive power filter time constant (T). Typical Value = 0. Default: 0.0 + :tuv: Voltage filter time constant (T). Typical Value = 5. Default: 0.0 + :vuimax: UEL integrator output maximum limit (V). Typical Value = 0.25. Default: 0.0 + :vuimin: UEL integrator output minimum limit (V). Typical Value = 0. Default: 0.0 + :vulmax: UEL output maximum limit (V). Typical Value = 0.25. Default: 0.0 + :vulmin: UEL output minimum limit (V). Typical Value = 0. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "k1": [Profile.DY.value, ], + "k2": [Profile.DY.value, ], + "kfb": [Profile.DY.value, ], + "kuf": [Profile.DY.value, ], + "kui": [Profile.DY.value, ], + "kul": [Profile.DY.value, ], + "p0": [Profile.DY.value, ], + "p1": [Profile.DY.value, ], + "p10": [Profile.DY.value, ], + "p2": [Profile.DY.value, ], + "p3": [Profile.DY.value, ], + "p4": [Profile.DY.value, ], + "p5": [Profile.DY.value, ], + "p6": [Profile.DY.value, ], + "p7": [Profile.DY.value, ], + "p8": [Profile.DY.value, ], + "p9": [Profile.DY.value, ], + "q0": [Profile.DY.value, ], + "q1": [Profile.DY.value, ], + "q10": [Profile.DY.value, ], + "q2": [Profile.DY.value, ], + "q3": [Profile.DY.value, ], + "q4": [Profile.DY.value, ], + "q5": [Profile.DY.value, ], + "q6": [Profile.DY.value, ], + "q7": [Profile.DY.value, ], + "q8": [Profile.DY.value, ], + "q9": [Profile.DY.value, ], + "tu1": [Profile.DY.value, ], + "tu2": [Profile.DY.value, ], + "tu3": [Profile.DY.value, ], + "tu4": [Profile.DY.value, ], + "tul": [Profile.DY.value, ], + "tup": [Profile.DY.value, ], + "tuq": [Profile.DY.value, ], + "tuv": [Profile.DY.value, ], + "vuimax": [Profile.DY.value, ], + "vuimin": [Profile.DY.value, ], + "vulmax": [Profile.DY.value, ], + "vulmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class UnderexcitationLimiterDynamics:\n" + UnderexcitationLimiterDynamics.__doc__ + + def __init__(self, k1 = 0.0, k2 = 0.0, kfb = 0.0, kuf = 0.0, kui = 0.0, kul = 0.0, p0 = 0.0, p1 = 0.0, p10 = 0.0, p2 = 0.0, p3 = 0.0, p4 = 0.0, p5 = 0.0, p6 = 0.0, p7 = 0.0, p8 = 0.0, p9 = 0.0, q0 = 0.0, q1 = 0.0, q10 = 0.0, q2 = 0.0, q3 = 0.0, q4 = 0.0, q5 = 0.0, q6 = 0.0, q7 = 0.0, q8 = 0.0, q9 = 0.0, tu1 = 0.0, tu2 = 0.0, tu3 = 0.0, tu4 = 0.0, tul = 0.0, tup = 0.0, tuq = 0.0, tuv = 0.0, vuimax = 0.0, vuimin = 0.0, vulmax = 0.0, vulmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.k1 = k1 + self.k2 = k2 + self.kfb = kfb + self.kuf = kuf + self.kui = kui + self.kul = kul + self.p0 = p0 + self.p1 = p1 + self.p10 = p10 + self.p2 = p2 + self.p3 = p3 + self.p4 = p4 + self.p5 = p5 + self.p6 = p6 + self.p7 = p7 + self.p8 = p8 + self.p9 = p9 + self.q0 = q0 + self.q1 = q1 + self.q10 = q10 + self.q2 = q2 + self.q3 = q3 + self.q4 = q4 + self.q5 = q5 + self.q6 = q6 + self.q7 = q7 + self.q8 = q8 + self.q9 = q9 + self.tu1 = tu1 + self.tu2 = tu2 + self.tu3 = tu3 + self.tu4 = tu4 + self.tul = tul + self.tup = tup + self.tuq = tuq + self.tuv = tuv + self.vuimax = vuimax + self.vuimin = vuimin + self.vulmax = vulmax + self.vulmin = vulmin + + def __str__(self): + str = "class=UnderexcLimIEEE2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/UnderexcLimX1.py b/cimpy/cgmes_v2_4_15/UnderexcLimX1.py index 78183f04..7694cc5e 100644 --- a/cimpy/cgmes_v2_4_15/UnderexcLimX1.py +++ b/cimpy/cgmes_v2_4_15/UnderexcLimX1.py @@ -1,46 +1,48 @@ -from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics - - -class UnderexcLimX1(UnderexcitationLimiterDynamics): - ''' - - - :kf2: Differential gain (Kf2). Default: 0.0 - :tf2: Differential time constant (Tf2) (>0). Default: 0 - :km: Minimum excitation limit gain (Km). Default: 0.0 - :tm: Minimum excitation limit time constant (Tm). Default: 0 - :melmax: Minimum excitation limit value (MELMAX). Default: 0.0 - :k: Minimum excitation limit slope (K) (>0). Default: 0.0 - ''' - - cgmesProfile = UnderexcitationLimiterDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kf2': [cgmesProfile.DY.value, ], - 'tf2': [cgmesProfile.DY.value, ], - 'km': [cgmesProfile.DY.value, ], - 'tm': [cgmesProfile.DY.value, ], - 'melmax': [cgmesProfile.DY.value, ], - 'k': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class UnderexcitationLimiterDynamics: \n' + UnderexcitationLimiterDynamics.__doc__ - - def __init__(self, kf2 = 0.0, tf2 = 0, km = 0.0, tm = 0, melmax = 0.0, k = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kf2 = kf2 - self.tf2 = tf2 - self.km = km - self.tm = tm - self.melmax = melmax - self.k = k - - def __str__(self): - str = 'class=UnderexcLimX1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics +from .CGMESProfile import Profile + + +class UnderexcLimX1(UnderexcitationLimiterDynamics): + """ + + + :k: Minimum excitation limit slope (K) (>0). Default: 0.0 + :kf2: Differential gain (Kf2). Default: 0.0 + :km: Minimum excitation limit gain (Km). Default: 0.0 + :melmax: Minimum excitation limit value (MELMAX). Default: 0.0 + :tf2: Differential time constant (Tf2) (>0). Default: 0.0 + :tm: Minimum excitation limit time constant (Tm). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "k": [Profile.DY.value, ], + "kf2": [Profile.DY.value, ], + "km": [Profile.DY.value, ], + "melmax": [Profile.DY.value, ], + "tf2": [Profile.DY.value, ], + "tm": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class UnderexcitationLimiterDynamics:\n" + UnderexcitationLimiterDynamics.__doc__ + + def __init__(self, k = 0.0, kf2 = 0.0, km = 0.0, melmax = 0.0, tf2 = 0.0, tm = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.k = k + self.kf2 = kf2 + self.km = km + self.melmax = melmax + self.tf2 = tf2 + self.tm = tm + + def __str__(self): + str = "class=UnderexcLimX1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/UnderexcLimX2.py b/cimpy/cgmes_v2_4_15/UnderexcLimX2.py index 87008391..aa89a984 100644 --- a/cimpy/cgmes_v2_4_15/UnderexcLimX2.py +++ b/cimpy/cgmes_v2_4_15/UnderexcLimX2.py @@ -1,49 +1,51 @@ -from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics - - -class UnderexcLimX2(UnderexcitationLimiterDynamics): - ''' - - - :kf2: Differential gain (Kf2). Default: 0.0 - :tf2: Differential time constant (Tf2) (>0). Default: 0 - :km: Minimum excitation limit gain (Km). Default: 0.0 - :tm: Minimum excitation limit time constant (Tm). Default: 0 - :melmax: Minimum excitation limit value (MELMAX). Default: 0.0 - :qo: Excitation center setting (Qo). Default: 0.0 - :r: Excitation radius (R). Default: 0.0 - ''' - - cgmesProfile = UnderexcitationLimiterDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kf2': [cgmesProfile.DY.value, ], - 'tf2': [cgmesProfile.DY.value, ], - 'km': [cgmesProfile.DY.value, ], - 'tm': [cgmesProfile.DY.value, ], - 'melmax': [cgmesProfile.DY.value, ], - 'qo': [cgmesProfile.DY.value, ], - 'r': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class UnderexcitationLimiterDynamics: \n' + UnderexcitationLimiterDynamics.__doc__ - - def __init__(self, kf2 = 0.0, tf2 = 0, km = 0.0, tm = 0, melmax = 0.0, qo = 0.0, r = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kf2 = kf2 - self.tf2 = tf2 - self.km = km - self.tm = tm - self.melmax = melmax - self.qo = qo - self.r = r - - def __str__(self): - str = 'class=UnderexcLimX2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics +from .CGMESProfile import Profile + + +class UnderexcLimX2(UnderexcitationLimiterDynamics): + """ + + + :kf2: Differential gain (Kf2). Default: 0.0 + :km: Minimum excitation limit gain (Km). Default: 0.0 + :melmax: Minimum excitation limit value (MELMAX). Default: 0.0 + :qo: Excitation center setting (Qo). Default: 0.0 + :r: Excitation radius (R). Default: 0.0 + :tf2: Differential time constant (Tf2) (>0). Default: 0.0 + :tm: Minimum excitation limit time constant (Tm). Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "kf2": [Profile.DY.value, ], + "km": [Profile.DY.value, ], + "melmax": [Profile.DY.value, ], + "qo": [Profile.DY.value, ], + "r": [Profile.DY.value, ], + "tf2": [Profile.DY.value, ], + "tm": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class UnderexcitationLimiterDynamics:\n" + UnderexcitationLimiterDynamics.__doc__ + + def __init__(self, kf2 = 0.0, km = 0.0, melmax = 0.0, qo = 0.0, r = 0.0, tf2 = 0.0, tm = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.kf2 = kf2 + self.km = km + self.melmax = melmax + self.qo = qo + self.r = r + self.tf2 = tf2 + self.tm = tm + + def __str__(self): + str = "class=UnderexcLimX2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/UnderexcitationLimiterDynamics.py b/cimpy/cgmes_v2_4_15/UnderexcitationLimiterDynamics.py index f6ad3cd5..1f8d16c3 100644 --- a/cimpy/cgmes_v2_4_15/UnderexcitationLimiterDynamics.py +++ b/cimpy/cgmes_v2_4_15/UnderexcitationLimiterDynamics.py @@ -1,34 +1,36 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class UnderexcitationLimiterDynamics(DynamicsFunctionBlock): - ''' - Underexcitation limiter function block whose behaviour is described by reference to a standard model - - :RemoteInputSignal: Remote input signal used by this underexcitation limiter model. Default: None - :ExcitationSystemDynamics: Excitation system model with which this underexcitation limiter model is associated. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'RemoteInputSignal': [cgmesProfile.DY.value, ], - 'ExcitationSystemDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, RemoteInputSignal = None, ExcitationSystemDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.RemoteInputSignal = RemoteInputSignal - self.ExcitationSystemDynamics = ExcitationSystemDynamics - - def __str__(self): - str = 'class=UnderexcitationLimiterDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class UnderexcitationLimiterDynamics(DynamicsFunctionBlock): + """ + Underexcitation limiter function block whose behaviour is described by reference to a standard model + + :ExcitationSystemDynamics: Excitation system model with which this underexcitation limiter model is associated. Default: None + :RemoteInputSignal: Remote input signal used by this underexcitation limiter model. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ExcitationSystemDynamics": [Profile.DY.value, ], + "RemoteInputSignal": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, ExcitationSystemDynamics = None, RemoteInputSignal = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ExcitationSystemDynamics = ExcitationSystemDynamics + self.RemoteInputSignal = RemoteInputSignal + + def __str__(self): + str = "class=UnderexcitationLimiterDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/UnderexcitationLimiterUserDefined.py b/cimpy/cgmes_v2_4_15/UnderexcitationLimiterUserDefined.py index a833a4b8..06052689 100644 --- a/cimpy/cgmes_v2_4_15/UnderexcitationLimiterUserDefined.py +++ b/cimpy/cgmes_v2_4_15/UnderexcitationLimiterUserDefined.py @@ -1,34 +1,36 @@ -from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics - - -class UnderexcitationLimiterUserDefined(UnderexcitationLimiterDynamics): - ''' - Underexcitation limiter function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = UnderexcitationLimiterDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class UnderexcitationLimiterDynamics: \n' + UnderexcitationLimiterDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=UnderexcitationLimiterUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics +from .CGMESProfile import Profile + + +class UnderexcitationLimiterUserDefined(UnderexcitationLimiterDynamics): + """ + Underexcitation limiter function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class UnderexcitationLimiterDynamics:\n" + UnderexcitationLimiterDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=UnderexcitationLimiterUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/UnitMultiplier.py b/cimpy/cgmes_v2_4_15/UnitMultiplier.py index 9a57d471..609cebff 100644 --- a/cimpy/cgmes_v2_4_15/UnitMultiplier.py +++ b/cimpy/cgmes_v2_4_15/UnitMultiplier.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class UnitMultiplier(Base): - ''' - The unit multipliers defined for the CIM. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=UnitMultiplier\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class UnitMultiplier(Base): + """ + The unit multipliers defined for the CIM. + + """ + + possibleProfileList = { + "class": [Profile.DL.value, Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=UnitMultiplier\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/UnitSymbol.py b/cimpy/cgmes_v2_4_15/UnitSymbol.py index eb5b0dfd..4c860e83 100644 --- a/cimpy/cgmes_v2_4_15/UnitSymbol.py +++ b/cimpy/cgmes_v2_4_15/UnitSymbol.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class UnitSymbol(Base): - ''' - The units defined for usage in the CIM. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.DY.value, cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=UnitSymbol\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class UnitSymbol(Base): + """ + The units defined for usage in the CIM. + + """ + + possibleProfileList = { + "class": [Profile.DL.value, Profile.DY.value, Profile.EQ_BD.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=UnitSymbol\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VAdjIEEE.py b/cimpy/cgmes_v2_4_15/VAdjIEEE.py index fa38b7aa..a17ea01f 100644 --- a/cimpy/cgmes_v2_4_15/VAdjIEEE.py +++ b/cimpy/cgmes_v2_4_15/VAdjIEEE.py @@ -1,46 +1,48 @@ -from .VoltageAdjusterDynamics import VoltageAdjusterDynamics - - -class VAdjIEEE(VoltageAdjusterDynamics): - ''' - The class represents IEEE Voltage Adjuster which is used to represent the voltage adjuster in either a power factor or var control system. Reference: IEEE Standard 421.5-2005 Section 11.1. - - :vadjf: Set high to provide a continuous raise or lower (). Default: 0.0 - :adjslew: Rate at which output of adjuster changes (). Unit = sec./PU. Typical Value = 300. Default: 0.0 - :vadjmax: Maximum output of the adjuster (). Typical Value = 1.1. Default: 0.0 - :vadjmin: Minimum output of the adjuster (). Typical Value = 0.9. Default: 0.0 - :taon: Time that adjuster pulses are on (). Typical Value = 0.1. Default: 0 - :taoff: Time that adjuster pulses are off (). Typical Value = 0.5. Default: 0 - ''' - - cgmesProfile = VoltageAdjusterDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'vadjf': [cgmesProfile.DY.value, ], - 'adjslew': [cgmesProfile.DY.value, ], - 'vadjmax': [cgmesProfile.DY.value, ], - 'vadjmin': [cgmesProfile.DY.value, ], - 'taon': [cgmesProfile.DY.value, ], - 'taoff': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class VoltageAdjusterDynamics: \n' + VoltageAdjusterDynamics.__doc__ - - def __init__(self, vadjf = 0.0, adjslew = 0.0, vadjmax = 0.0, vadjmin = 0.0, taon = 0, taoff = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.vadjf = vadjf - self.adjslew = adjslew - self.vadjmax = vadjmax - self.vadjmin = vadjmin - self.taon = taon - self.taoff = taoff - - def __str__(self): - str = 'class=VAdjIEEE\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .VoltageAdjusterDynamics import VoltageAdjusterDynamics +from .CGMESProfile import Profile + + +class VAdjIEEE(VoltageAdjusterDynamics): + """ + The class represents IEEE Voltage Adjuster which is used to represent the voltage adjuster in either a power factor or var control system. Reference: IEEE Standard 421.5-2005 Section 11.1. + + :adjslew: Rate at which output of adjuster changes (). Unit = sec./PU. Typical Value = 300. Default: 0.0 + :taoff: Time that adjuster pulses are off (). Typical Value = 0.5. Default: 0.0 + :taon: Time that adjuster pulses are on (). Typical Value = 0.1. Default: 0.0 + :vadjf: Set high to provide a continuous raise or lower (). Default: 0.0 + :vadjmax: Maximum output of the adjuster (). Typical Value = 1.1. Default: 0.0 + :vadjmin: Minimum output of the adjuster (). Typical Value = 0.9. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "adjslew": [Profile.DY.value, ], + "taoff": [Profile.DY.value, ], + "taon": [Profile.DY.value, ], + "vadjf": [Profile.DY.value, ], + "vadjmax": [Profile.DY.value, ], + "vadjmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class VoltageAdjusterDynamics:\n" + VoltageAdjusterDynamics.__doc__ + + def __init__(self, adjslew = 0.0, taoff = 0.0, taon = 0.0, vadjf = 0.0, vadjmax = 0.0, vadjmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.adjslew = adjslew + self.taoff = taoff + self.taon = taon + self.vadjf = vadjf + self.vadjmax = vadjmax + self.vadjmin = vadjmin + + def __str__(self): + str = "class=VAdjIEEE\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VCompIEEEType1.py b/cimpy/cgmes_v2_4_15/VCompIEEEType1.py index 13af9c86..fa9fa3d2 100644 --- a/cimpy/cgmes_v2_4_15/VCompIEEEType1.py +++ b/cimpy/cgmes_v2_4_15/VCompIEEEType1.py @@ -1,37 +1,39 @@ -from .VoltageCompensatorDynamics import VoltageCompensatorDynamics - - -class VCompIEEEType1(VoltageCompensatorDynamics): - ''' - Reference: IEEE Standard 421.5-2005 Section 4. - - :rc: Default: 0.0 - :xc: Default: 0.0 - :tr: Default: 0 - ''' - - cgmesProfile = VoltageCompensatorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'rc': [cgmesProfile.DY.value, ], - 'xc': [cgmesProfile.DY.value, ], - 'tr': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class VoltageCompensatorDynamics: \n' + VoltageCompensatorDynamics.__doc__ - - def __init__(self, rc = 0.0, xc = 0.0, tr = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.rc = rc - self.xc = xc - self.tr = tr - - def __str__(self): - str = 'class=VCompIEEEType1\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .VoltageCompensatorDynamics import VoltageCompensatorDynamics +from .CGMESProfile import Profile + + +class VCompIEEEType1(VoltageCompensatorDynamics): + """ + Reference: IEEE Standard 421.5-2005 Section 4. + + :rc: Default: 0.0 + :tr: Default: 0.0 + :xc: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "rc": [Profile.DY.value, ], + "tr": [Profile.DY.value, ], + "xc": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class VoltageCompensatorDynamics:\n" + VoltageCompensatorDynamics.__doc__ + + def __init__(self, rc = 0.0, tr = 0.0, xc = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.rc = rc + self.tr = tr + self.xc = xc + + def __str__(self): + str = "class=VCompIEEEType1\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VCompIEEEType2.py b/cimpy/cgmes_v2_4_15/VCompIEEEType2.py index a57ab00a..7d514a1e 100644 --- a/cimpy/cgmes_v2_4_15/VCompIEEEType2.py +++ b/cimpy/cgmes_v2_4_15/VCompIEEEType2.py @@ -1,34 +1,36 @@ -from .VoltageCompensatorDynamics import VoltageCompensatorDynamics - - -class VCompIEEEType2(VoltageCompensatorDynamics): - ''' - - - :tr: Default: 0 - :GenICompensationForGenJ: Compensation of this voltage compensator`s generator for current flow out of another generator. Default: "list" - ''' - - cgmesProfile = VoltageCompensatorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'tr': [cgmesProfile.DY.value, ], - 'GenICompensationForGenJ': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class VoltageCompensatorDynamics: \n' + VoltageCompensatorDynamics.__doc__ - - def __init__(self, tr = 0, GenICompensationForGenJ = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.tr = tr - self.GenICompensationForGenJ = GenICompensationForGenJ - - def __str__(self): - str = 'class=VCompIEEEType2\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .VoltageCompensatorDynamics import VoltageCompensatorDynamics +from .CGMESProfile import Profile + + +class VCompIEEEType2(VoltageCompensatorDynamics): + """ + + + :GenICompensationForGenJ: Compensation of this voltage compensator`s generator for current flow out of another generator. Default: "list" + :tr: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "GenICompensationForGenJ": [Profile.DY.value, ], + "tr": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class VoltageCompensatorDynamics:\n" + VoltageCompensatorDynamics.__doc__ + + def __init__(self, GenICompensationForGenJ = "list", tr = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.GenICompensationForGenJ = GenICompensationForGenJ + self.tr = tr + + def __str__(self): + str = "class=VCompIEEEType2\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Validity.py b/cimpy/cgmes_v2_4_15/Validity.py index 00451f68..9349c984 100644 --- a/cimpy/cgmes_v2_4_15/Validity.py +++ b/cimpy/cgmes_v2_4_15/Validity.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class Validity(Base): - ''' - Validity for MeasurementValue. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=Validity\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Validity(Base): + """ + Validity for MeasurementValue. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=Validity\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ValueAliasSet.py b/cimpy/cgmes_v2_4_15/ValueAliasSet.py index a7a98aa6..021f04db 100644 --- a/cimpy/cgmes_v2_4_15/ValueAliasSet.py +++ b/cimpy/cgmes_v2_4_15/ValueAliasSet.py @@ -1,40 +1,42 @@ -from .IdentifiedObject import IdentifiedObject - - -class ValueAliasSet(IdentifiedObject): - ''' - Describes the translation of a set of values into a name and is intendend to facilitate cusom translations. Each ValueAliasSet has a name, description etc. A specific Measurement may represent a discrete state like Open, Closed, Intermediate etc. This requires a translation from the MeasurementValue.value number to a string, e.g. 0->"Invalid", 1->"Open", 2->"Closed", 3->"Intermediate". Each ValueToAlias member in ValueAliasSet.Value describe a mapping for one particular value to a name. - - :Commands: The Commands using the set for translation. Default: "list" - :Discretes: The Measurements using the set for translation. Default: "list" - :RaiseLowerCommands: The Commands using the set for translation. Default: "list" - :Values: The ValueAliasSet having the ValueToAlias mappings. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'Commands': [cgmesProfile.EQ.value, ], - 'Discretes': [cgmesProfile.EQ.value, ], - 'RaiseLowerCommands': [cgmesProfile.EQ.value, ], - 'Values': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, Commands = "list", Discretes = "list", RaiseLowerCommands = "list", Values = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.Commands = Commands - self.Discretes = Discretes - self.RaiseLowerCommands = RaiseLowerCommands - self.Values = Values - - def __str__(self): - str = 'class=ValueAliasSet\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class ValueAliasSet(IdentifiedObject): + """ + Describes the translation of a set of values into a name and is intendend to facilitate cusom translations. Each ValueAliasSet has a name, description etc. A specific Measurement may represent a discrete state like Open, Closed, Intermediate etc. This requires a translation from the MeasurementValue.value number to a string, e.g. 0->"Invalid", 1->"Open", 2->"Closed", 3->"Intermediate". Each ValueToAlias member in ValueAliasSet.Value describe a mapping for one particular value to a name. + + :Commands: The Commands using the set for translation. Default: "list" + :Discretes: The Measurements using the set for translation. Default: "list" + :RaiseLowerCommands: The Commands using the set for translation. Default: "list" + :Values: The ValueAliasSet having the ValueToAlias mappings. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "Commands": [Profile.EQ.value, ], + "Discretes": [Profile.EQ.value, ], + "RaiseLowerCommands": [Profile.EQ.value, ], + "Values": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, Commands = "list", Discretes = "list", RaiseLowerCommands = "list", Values = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.Commands = Commands + self.Discretes = Discretes + self.RaiseLowerCommands = RaiseLowerCommands + self.Values = Values + + def __str__(self): + str = "class=ValueAliasSet\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/ValueToAlias.py b/cimpy/cgmes_v2_4_15/ValueToAlias.py index 357bc071..48e43085 100644 --- a/cimpy/cgmes_v2_4_15/ValueToAlias.py +++ b/cimpy/cgmes_v2_4_15/ValueToAlias.py @@ -1,34 +1,36 @@ -from .IdentifiedObject import IdentifiedObject - - -class ValueToAlias(IdentifiedObject): - ''' - Describes the translation of one particular value into a name, e.g. 1 as "Open". - - :ValueAliasSet: The ValueToAlias mappings included in the set. Default: None - :value: The value that is mapped. Default: 0 - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'ValueAliasSet': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, ValueAliasSet = None, value = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.ValueAliasSet = ValueAliasSet - self.value = value - - def __str__(self): - str = 'class=ValueToAlias\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class ValueToAlias(IdentifiedObject): + """ + Describes the translation of one particular value into a name, e.g. 1 as "Open". + + :ValueAliasSet: The ValueToAlias mappings included in the set. Default: None + :value: The value that is mapped. Default: 0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "ValueAliasSet": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, ValueAliasSet = None, value = 0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ValueAliasSet = ValueAliasSet + self.value = value + + def __str__(self): + str = "class=ValueToAlias\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VisibilityLayer.py b/cimpy/cgmes_v2_4_15/VisibilityLayer.py index 0f77b875..c1032d09 100644 --- a/cimpy/cgmes_v2_4_15/VisibilityLayer.py +++ b/cimpy/cgmes_v2_4_15/VisibilityLayer.py @@ -1,34 +1,36 @@ -from .IdentifiedObject import IdentifiedObject - - -class VisibilityLayer(IdentifiedObject): - ''' - Layers are typically used for grouping diagram objects according to themes and scales. Themes are used to display or hide certain information (e.g., lakes, borders), while scales are used for hiding or displaying information depending on the current zoom level (hide text when it is too small to be read, or when it exceeds the screen size). This is also called de-cluttering. CIM based graphics exchange will support an m:n relationship between diagram objects and layers. It will be the task of the importing system to convert an m:n case into an appropriate 1:n representation if the importing system does not support m:n. - - :VisibleObjects: A visibility layer can contain one or more diagram objects. Default: "list" - :drawingOrder: The drawing order for this layer. The higher the number, the later the layer and the objects within it are rendered. Default: 0 - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DL.value, ], - 'VisibleObjects': [cgmesProfile.DL.value, ], - 'drawingOrder': [cgmesProfile.DL.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, VisibleObjects = "list", drawingOrder = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.VisibleObjects = VisibleObjects - self.drawingOrder = drawingOrder - - def __str__(self): - str = 'class=VisibilityLayer\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class VisibilityLayer(IdentifiedObject): + """ + Layers are typically used for grouping diagram objects according to themes and scales. Themes are used to display or hide certain information (e.g., lakes, borders), while scales are used for hiding or displaying information depending on the current zoom level (hide text when it is too small to be read, or when it exceeds the screen size). This is also called de-cluttering. CIM based graphics exchange will support an m:n relationship between diagram objects and layers. It will be the task of the importing system to convert an m:n case into an appropriate 1:n representation if the importing system does not support m:n. + + :VisibleObjects: A visibility layer can contain one or more diagram objects. Default: "list" + :drawingOrder: The drawing order for this layer. The higher the number, the later the layer and the objects within it are rendered. Default: 0 + """ + + possibleProfileList = { + "class": [Profile.DL.value, ], + "VisibleObjects": [Profile.DL.value, ], + "drawingOrder": [Profile.DL.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DL.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, VisibleObjects = "list", drawingOrder = 0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.VisibleObjects = VisibleObjects + self.drawingOrder = drawingOrder + + def __str__(self): + str = "class=VisibilityLayer\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/Voltage.py b/cimpy/cgmes_v2_4_15/Voltage.py index c16805ae..fe8ca102 100644 --- a/cimpy/cgmes_v2_4_15/Voltage.py +++ b/cimpy/cgmes_v2_4_15/Voltage.py @@ -1,36 +1,37 @@ -from .Base import Base - - -class Voltage(Base): - ''' - Electrical voltage, can be both AC and DC. - - :value: Default: 0.0 - :unit: Default: None - :multiplier: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.EQ_BD.value, ], - 'value': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.EQ_BD.value, ], - 'unit': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.EQ_BD.value, ], - 'multiplier': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, cgmesProfile.EQ_BD.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, multiplier = None, ): - - self.value = value - self.unit = unit - self.multiplier = multiplier - - def __str__(self): - str = 'class=Voltage\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class Voltage(Base): + """ + Electrical voltage, can be both AC and DC. + + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ_BD.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "multiplier": [Profile.EQ_BD.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "unit": [Profile.EQ_BD.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "value": [Profile.EQ_BD.value, Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, multiplier = None, unit = None, value = 0.0): + + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=Voltage\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VoltageAdjusterDynamics.py b/cimpy/cgmes_v2_4_15/VoltageAdjusterDynamics.py index b3f865f1..486988f3 100644 --- a/cimpy/cgmes_v2_4_15/VoltageAdjusterDynamics.py +++ b/cimpy/cgmes_v2_4_15/VoltageAdjusterDynamics.py @@ -1,31 +1,33 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class VoltageAdjusterDynamics(DynamicsFunctionBlock): - ''' - Voltage adjuster function block whose behaviour is described by reference to a standard model - - :PFVArControllerType1Dynamics: Power Factor or VAr controller Type I model with which this voltage adjuster is associated. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'PFVArControllerType1Dynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, PFVArControllerType1Dynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.PFVArControllerType1Dynamics = PFVArControllerType1Dynamics - - def __str__(self): - str = 'class=VoltageAdjusterDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class VoltageAdjusterDynamics(DynamicsFunctionBlock): + """ + Voltage adjuster function block whose behaviour is described by reference to a standard model + + :PFVArControllerType1Dynamics: Power Factor or VAr controller Type I model with which this voltage adjuster is associated. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "PFVArControllerType1Dynamics": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, PFVArControllerType1Dynamics = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.PFVArControllerType1Dynamics = PFVArControllerType1Dynamics + + def __str__(self): + str = "class=VoltageAdjusterDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VoltageAdjusterUserDefined.py b/cimpy/cgmes_v2_4_15/VoltageAdjusterUserDefined.py index 3bd9b1f0..b7373919 100644 --- a/cimpy/cgmes_v2_4_15/VoltageAdjusterUserDefined.py +++ b/cimpy/cgmes_v2_4_15/VoltageAdjusterUserDefined.py @@ -1,34 +1,36 @@ -from .VoltageAdjusterDynamics import VoltageAdjusterDynamics - - -class VoltageAdjusterUserDefined(VoltageAdjusterDynamics): - ''' - function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = VoltageAdjusterDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class VoltageAdjusterDynamics: \n' + VoltageAdjusterDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=VoltageAdjusterUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .VoltageAdjusterDynamics import VoltageAdjusterDynamics +from .CGMESProfile import Profile + + +class VoltageAdjusterUserDefined(VoltageAdjusterDynamics): + """ + function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class VoltageAdjusterDynamics:\n" + VoltageAdjusterDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=VoltageAdjusterUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VoltageCompensatorDynamics.py b/cimpy/cgmes_v2_4_15/VoltageCompensatorDynamics.py index c5d13248..9765b529 100644 --- a/cimpy/cgmes_v2_4_15/VoltageCompensatorDynamics.py +++ b/cimpy/cgmes_v2_4_15/VoltageCompensatorDynamics.py @@ -1,34 +1,36 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class VoltageCompensatorDynamics(DynamicsFunctionBlock): - ''' - Voltage compensator function block whose behaviour is described by reference to a standard model - - :RemoteInputSignal: Remote input signal used by this voltage compensator model. Default: None - :ExcitationSystemDynamics: Excitation system model with which this voltage compensator is associated. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'RemoteInputSignal': [cgmesProfile.DY.value, ], - 'ExcitationSystemDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, RemoteInputSignal = None, ExcitationSystemDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.RemoteInputSignal = RemoteInputSignal - self.ExcitationSystemDynamics = ExcitationSystemDynamics - - def __str__(self): - str = 'class=VoltageCompensatorDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class VoltageCompensatorDynamics(DynamicsFunctionBlock): + """ + Voltage compensator function block whose behaviour is described by reference to a standard model + + :ExcitationSystemDynamics: Excitation system model with which this voltage compensator is associated. Default: None + :RemoteInputSignal: Remote input signal used by this voltage compensator model. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ExcitationSystemDynamics": [Profile.DY.value, ], + "RemoteInputSignal": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, ExcitationSystemDynamics = None, RemoteInputSignal = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ExcitationSystemDynamics = ExcitationSystemDynamics + self.RemoteInputSignal = RemoteInputSignal + + def __str__(self): + str = "class=VoltageCompensatorDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VoltageCompensatorUserDefined.py b/cimpy/cgmes_v2_4_15/VoltageCompensatorUserDefined.py index 3f4002d1..4d40c429 100644 --- a/cimpy/cgmes_v2_4_15/VoltageCompensatorUserDefined.py +++ b/cimpy/cgmes_v2_4_15/VoltageCompensatorUserDefined.py @@ -1,34 +1,36 @@ -from .VoltageCompensatorDynamics import VoltageCompensatorDynamics - - -class VoltageCompensatorUserDefined(VoltageCompensatorDynamics): - ''' - Voltage compensator function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = VoltageCompensatorDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class VoltageCompensatorDynamics: \n' + VoltageCompensatorDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=VoltageCompensatorUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .VoltageCompensatorDynamics import VoltageCompensatorDynamics +from .CGMESProfile import Profile + + +class VoltageCompensatorUserDefined(VoltageCompensatorDynamics): + """ + Voltage compensator function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class VoltageCompensatorDynamics:\n" + VoltageCompensatorDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=VoltageCompensatorUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VoltageLevel.py b/cimpy/cgmes_v2_4_15/VoltageLevel.py index 00f2edc1..cebd2c1d 100644 --- a/cimpy/cgmes_v2_4_15/VoltageLevel.py +++ b/cimpy/cgmes_v2_4_15/VoltageLevel.py @@ -1,43 +1,45 @@ -from .EquipmentContainer import EquipmentContainer - - -class VoltageLevel(EquipmentContainer): - ''' - A collection of equipment at one common system voltage forming a switchgear. The equipment typically consist of breakers, busbars, instrumentation, control, regulation and protection devices as well as assemblies of all these. - - :BaseVoltage: The base voltage used for all equipment within the voltage level. Default: None - :Substation: The substation of the voltage level. Default: None - :highVoltageLimit: The bus bar`s high voltage limit Default: 0.0 - :lowVoltageLimit: The bus bar`s low voltage limit Default: 0.0 - :Bays: The bays within this voltage level. Default: "list" - ''' - - cgmesProfile = EquipmentContainer.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'BaseVoltage': [cgmesProfile.EQ.value, ], - 'Substation': [cgmesProfile.EQ.value, ], - 'highVoltageLimit': [cgmesProfile.EQ.value, ], - 'lowVoltageLimit': [cgmesProfile.EQ.value, ], - 'Bays': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class EquipmentContainer: \n' + EquipmentContainer.__doc__ - - def __init__(self, BaseVoltage = None, Substation = None, highVoltageLimit = 0.0, lowVoltageLimit = 0.0, Bays = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.BaseVoltage = BaseVoltage - self.Substation = Substation - self.highVoltageLimit = highVoltageLimit - self.lowVoltageLimit = lowVoltageLimit - self.Bays = Bays - - def __str__(self): - str = 'class=VoltageLevel\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .EquipmentContainer import EquipmentContainer +from .CGMESProfile import Profile + + +class VoltageLevel(EquipmentContainer): + """ + A collection of equipment at one common system voltage forming a switchgear. The equipment typically consist of breakers, busbars, instrumentation, control, regulation and protection devices as well as assemblies of all these. + + :BaseVoltage: The base voltage used for all equipment within the voltage level. Default: None + :Bays: The bays within this voltage level. Default: "list" + :Substation: The substation of the voltage level. Default: None + :highVoltageLimit: The bus bar`s high voltage limit Default: 0.0 + :lowVoltageLimit: The bus bar`s low voltage limit Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "BaseVoltage": [Profile.EQ.value, ], + "Bays": [Profile.EQ.value, ], + "Substation": [Profile.EQ.value, ], + "highVoltageLimit": [Profile.EQ.value, ], + "lowVoltageLimit": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class EquipmentContainer:\n" + EquipmentContainer.__doc__ + + def __init__(self, BaseVoltage = None, Bays = "list", Substation = None, highVoltageLimit = 0.0, lowVoltageLimit = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.BaseVoltage = BaseVoltage + self.Bays = Bays + self.Substation = Substation + self.highVoltageLimit = highVoltageLimit + self.lowVoltageLimit = lowVoltageLimit + + def __str__(self): + str = "class=VoltageLevel\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VoltageLimit.py b/cimpy/cgmes_v2_4_15/VoltageLimit.py index d2f9ed65..55d12f1d 100644 --- a/cimpy/cgmes_v2_4_15/VoltageLimit.py +++ b/cimpy/cgmes_v2_4_15/VoltageLimit.py @@ -1,31 +1,33 @@ -from .OperationalLimit import OperationalLimit - - -class VoltageLimit(OperationalLimit): - ''' - Operational limit applied to voltage. - - :value: Limit on voltage. High or low limit nature of the limit depends upon the properties of the operational limit type. Default: 0.0 - ''' - - cgmesProfile = OperationalLimit.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class OperationalLimit: \n' + OperationalLimit.__doc__ - - def __init__(self, value = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.value = value - - def __str__(self): - str = 'class=VoltageLimit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .OperationalLimit import OperationalLimit +from .CGMESProfile import Profile + + +class VoltageLimit(OperationalLimit): + """ + Operational limit applied to voltage. + + :value: Limit on voltage. High or low limit nature of the limit depends upon the properties of the operational limit type. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class OperationalLimit:\n" + OperationalLimit.__doc__ + + def __init__(self, value = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.value = value + + def __str__(self): + str = "class=VoltageLimit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VoltagePerReactivePower.py b/cimpy/cgmes_v2_4_15/VoltagePerReactivePower.py index 575c4740..b8e7eeb0 100644 --- a/cimpy/cgmes_v2_4_15/VoltagePerReactivePower.py +++ b/cimpy/cgmes_v2_4_15/VoltagePerReactivePower.py @@ -1,42 +1,43 @@ -from .Base import Base - - -class VoltagePerReactivePower(Base): - ''' - Voltage variation with reactive power. - - :value: Default: 0.0 - :unit: Default: None - :denominatorMultiplier: Default: None - :multiplier: Default: None - :denominatorUnit: Default: None - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'value': [cgmesProfile.EQ.value, ], - 'unit': [cgmesProfile.EQ.value, ], - 'denominatorMultiplier': [cgmesProfile.EQ.value, ], - 'multiplier': [cgmesProfile.EQ.value, ], - 'denominatorUnit': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, value = 0.0, unit = None, denominatorMultiplier = None, multiplier = None, denominatorUnit = None, ): - - self.value = value - self.unit = unit - self.denominatorMultiplier = denominatorMultiplier - self.multiplier = multiplier - self.denominatorUnit = denominatorUnit - - def __str__(self): - str = 'class=VoltagePerReactivePower\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class VoltagePerReactivePower(Base): + """ + Voltage variation with reactive power. + + :denominatorMultiplier: Default: None + :denominatorUnit: Default: None + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "denominatorMultiplier": [Profile.EQ.value, ], + "denominatorUnit": [Profile.EQ.value, ], + "multiplier": [Profile.EQ.value, ], + "unit": [Profile.EQ.value, ], + "value": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self, denominatorMultiplier = None, denominatorUnit = None, multiplier = None, unit = None, value = 0.0): + + self.denominatorMultiplier = denominatorMultiplier + self.denominatorUnit = denominatorUnit + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=VoltagePerReactivePower\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VolumeFlowRate.py b/cimpy/cgmes_v2_4_15/VolumeFlowRate.py index e07d07f9..4511e2d6 100644 --- a/cimpy/cgmes_v2_4_15/VolumeFlowRate.py +++ b/cimpy/cgmes_v2_4_15/VolumeFlowRate.py @@ -1,42 +1,43 @@ -from .Base import Base - - -class VolumeFlowRate(Base): - ''' - Volume per time. - - :denominatorMultiplier: Default: None - :denominatorUnit: Default: None - :multiplier: Default: None - :unit: Default: None - :value: Default: 0.0 - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'denominatorMultiplier': [cgmesProfile.DY.value, ], - 'denominatorUnit': [cgmesProfile.DY.value, ], - 'multiplier': [cgmesProfile.DY.value, ], - 'unit': [cgmesProfile.DY.value, ], - 'value': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, denominatorMultiplier = None, denominatorUnit = None, multiplier = None, unit = None, value = 0.0, ): - - self.denominatorMultiplier = denominatorMultiplier - self.denominatorUnit = denominatorUnit - self.multiplier = multiplier - self.unit = unit - self.value = value - - def __str__(self): - str = 'class=VolumeFlowRate\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class VolumeFlowRate(Base): + """ + Volume per time. + + :denominatorMultiplier: Default: None + :denominatorUnit: Default: None + :multiplier: Default: None + :unit: Default: None + :value: Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "denominatorMultiplier": [Profile.DY.value, ], + "denominatorUnit": [Profile.DY.value, ], + "multiplier": [Profile.DY.value, ], + "unit": [Profile.DY.value, ], + "value": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self, denominatorMultiplier = None, denominatorUnit = None, multiplier = None, unit = None, value = 0.0): + + self.denominatorMultiplier = denominatorMultiplier + self.denominatorUnit = denominatorUnit + self.multiplier = multiplier + self.unit = unit + self.value = value + + def __str__(self): + str = "class=VolumeFlowRate\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VsCapabilityCurve.py b/cimpy/cgmes_v2_4_15/VsCapabilityCurve.py index 5710a6f5..5eab41b2 100644 --- a/cimpy/cgmes_v2_4_15/VsCapabilityCurve.py +++ b/cimpy/cgmes_v2_4_15/VsCapabilityCurve.py @@ -1,31 +1,33 @@ -from .Curve import Curve - - -class VsCapabilityCurve(Curve): - ''' - The P-Q capability curve for a voltage source converter, with P on x-axis and Qmin and Qmax on y1-axis and y2-axis. - - :VsConverterDCSides: Capability curve of this converter. Default: "list" - ''' - - cgmesProfile = Curve.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - 'VsConverterDCSides': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class Curve: \n' + Curve.__doc__ - - def __init__(self, VsConverterDCSides = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.VsConverterDCSides = VsConverterDCSides - - def __str__(self): - str = 'class=VsCapabilityCurve\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Curve import Curve +from .CGMESProfile import Profile + + +class VsCapabilityCurve(Curve): + """ + The P-Q capability curve for a voltage source converter, with P on x-axis and Qmin and Qmax on y1-axis and y2-axis. + + :VsConverterDCSides: Capability curve of this converter. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + "VsConverterDCSides": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class Curve:\n" + Curve.__doc__ + + def __init__(self, VsConverterDCSides = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.VsConverterDCSides = VsConverterDCSides + + def __str__(self): + str = "class=VsCapabilityCurve\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VsConverter.py b/cimpy/cgmes_v2_4_15/VsConverter.py index 37c7f498..2985ca6c 100644 --- a/cimpy/cgmes_v2_4_15/VsConverter.py +++ b/cimpy/cgmes_v2_4_15/VsConverter.py @@ -1,64 +1,66 @@ -from .ACDCConverter import ACDCConverter - - -class VsConverter(ACDCConverter): - ''' - DC side of the voltage source converter (VSC). - - :CapabilityCurve: All converters with this capability curve. Default: None - :maxModulationIndex: The max quotient between the AC converter voltage (Uc) and DC voltage (Ud). A factor typically less than 1. VSC configuration data used in power flow. Default: 0.0 - :maxValveCurrent: The maximum current through a valve. This current limit is the basis for calculating the capability diagram. VSC configuration data. Default: 0.0 - :droop: Droop constant; pu value is obtained as D [kV^2 / MW] x Sb / Ubdc^2. Default: 0.0 - :droopCompensation: Compensation (resistance) constant. Used to compensate for voltage drop when controlling voltage at a distant bus. Default: 0.0 - :pPccControl: Kind of control of real power and/or DC voltage. Default: None - :qPccControl: Default: None - :qShare: Reactive power sharing factor among parallel converters on Uac control. Default: 0.0 - :targetQpcc: Reactive power injection target in AC grid, at point of common coupling. Default: 0.0 - :targetUpcc: Voltage target in AC grid, at point of common coupling. Default: 0.0 - :delta: Angle between uf and uc. Converter state variable used in power flow. Default: 0.0 - :uf: Filter bus voltage. Converter state variable, result from power flow. Default: 0.0 - ''' - - cgmesProfile = ACDCConverter.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, cgmesProfile.SV.value, ], - 'CapabilityCurve': [cgmesProfile.EQ.value, ], - 'maxModulationIndex': [cgmesProfile.EQ.value, ], - 'maxValveCurrent': [cgmesProfile.EQ.value, ], - 'droop': [cgmesProfile.SSH.value, ], - 'droopCompensation': [cgmesProfile.SSH.value, ], - 'pPccControl': [cgmesProfile.SSH.value, ], - 'qPccControl': [cgmesProfile.SSH.value, ], - 'qShare': [cgmesProfile.SSH.value, ], - 'targetQpcc': [cgmesProfile.SSH.value, ], - 'targetUpcc': [cgmesProfile.SSH.value, ], - 'delta': [cgmesProfile.SV.value, ], - 'uf': [cgmesProfile.SV.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class ACDCConverter: \n' + ACDCConverter.__doc__ - - def __init__(self, CapabilityCurve = None, maxModulationIndex = 0.0, maxValveCurrent = 0.0, droop = 0.0, droopCompensation = 0.0, pPccControl = None, qPccControl = None, qShare = 0.0, targetQpcc = 0.0, targetUpcc = 0.0, delta = 0.0, uf = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.CapabilityCurve = CapabilityCurve - self.maxModulationIndex = maxModulationIndex - self.maxValveCurrent = maxValveCurrent - self.droop = droop - self.droopCompensation = droopCompensation - self.pPccControl = pPccControl - self.qPccControl = qPccControl - self.qShare = qShare - self.targetQpcc = targetQpcc - self.targetUpcc = targetUpcc - self.delta = delta - self.uf = uf - - def __str__(self): - str = 'class=VsConverter\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .ACDCConverter import ACDCConverter +from .CGMESProfile import Profile + + +class VsConverter(ACDCConverter): + """ + DC side of the voltage source converter (VSC). + + :CapabilityCurve: All converters with this capability curve. Default: None + :delta: Angle between uf and uc. Converter state variable used in power flow. Default: 0.0 + :droop: Droop constant; pu value is obtained as D [kV^2 / MW] x Sb / Ubdc^2. Default: 0.0 + :droopCompensation: Compensation (resistance) constant. Used to compensate for voltage drop when controlling voltage at a distant bus. Default: 0.0 + :maxModulationIndex: The max quotient between the AC converter voltage (Uc) and DC voltage (Ud). A factor typically less than 1. VSC configuration data used in power flow. Default: 0.0 + :maxValveCurrent: The maximum current through a valve. This current limit is the basis for calculating the capability diagram. VSC configuration data. Default: 0.0 + :pPccControl: Kind of control of real power and/or DC voltage. Default: None + :qPccControl: Default: None + :qShare: Reactive power sharing factor among parallel converters on Uac control. Default: 0.0 + :targetQpcc: Reactive power injection target in AC grid, at point of common coupling. Default: 0.0 + :targetUpcc: Voltage target in AC grid, at point of common coupling. Default: 0.0 + :uf: Filter bus voltage. Converter state variable, result from power flow. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SV.value, Profile.SSH.value, ], + "CapabilityCurve": [Profile.EQ.value, ], + "delta": [Profile.SV.value, ], + "droop": [Profile.SSH.value, ], + "droopCompensation": [Profile.SSH.value, ], + "maxModulationIndex": [Profile.EQ.value, ], + "maxValveCurrent": [Profile.EQ.value, ], + "pPccControl": [Profile.SSH.value, ], + "qPccControl": [Profile.SSH.value, ], + "qShare": [Profile.SSH.value, ], + "targetQpcc": [Profile.SSH.value, ], + "targetUpcc": [Profile.SSH.value, ], + "uf": [Profile.SV.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class ACDCConverter:\n" + ACDCConverter.__doc__ + + def __init__(self, CapabilityCurve = None, delta = 0.0, droop = 0.0, droopCompensation = 0.0, maxModulationIndex = 0.0, maxValveCurrent = 0.0, pPccControl = None, qPccControl = None, qShare = 0.0, targetQpcc = 0.0, targetUpcc = 0.0, uf = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.CapabilityCurve = CapabilityCurve + self.delta = delta + self.droop = droop + self.droopCompensation = droopCompensation + self.maxModulationIndex = maxModulationIndex + self.maxValveCurrent = maxValveCurrent + self.pPccControl = pPccControl + self.qPccControl = qPccControl + self.qShare = qShare + self.targetQpcc = targetQpcc + self.targetUpcc = targetUpcc + self.uf = uf + + def __str__(self): + str = "class=VsConverter\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VsPpccControlKind.py b/cimpy/cgmes_v2_4_15/VsPpccControlKind.py index b5798535..47c074cc 100644 --- a/cimpy/cgmes_v2_4_15/VsPpccControlKind.py +++ b/cimpy/cgmes_v2_4_15/VsPpccControlKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class VsPpccControlKind(Base): - ''' - Types applicable to the control of real power and/or DC voltage by voltage source converter. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=VsPpccControlKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class VsPpccControlKind(Base): + """ + Types applicable to the control of real power and/or DC voltage by voltage source converter. + + """ + + possibleProfileList = { + "class": [Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SSH.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=VsPpccControlKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/VsQpccControlKind.py b/cimpy/cgmes_v2_4_15/VsQpccControlKind.py index 9fa6f941..670a800b 100644 --- a/cimpy/cgmes_v2_4_15/VsQpccControlKind.py +++ b/cimpy/cgmes_v2_4_15/VsQpccControlKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class VsQpccControlKind(Base): - ''' - - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.SSH.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=VsQpccControlKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class VsQpccControlKind(Base): + """ + + + """ + + possibleProfileList = { + "class": [Profile.SSH.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.SSH.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=VsQpccControlKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindAeroConstIEC.py b/cimpy/cgmes_v2_4_15/WindAeroConstIEC.py index da659403..2f570c4f 100644 --- a/cimpy/cgmes_v2_4_15/WindAeroConstIEC.py +++ b/cimpy/cgmes_v2_4_15/WindAeroConstIEC.py @@ -1,31 +1,33 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindAeroConstIEC(IdentifiedObject): - ''' - The constant aerodynamic torque model assumes that the aerodynamic torque is constant. Reference: IEC Standard 61400-27-1 Section 6.6.1.1. - - :WindGenTurbineType1IEC: Wind turbine type 1 model with which this wind aerodynamic model is associated. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindGenTurbineType1IEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, WindGenTurbineType1IEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindGenTurbineType1IEC = WindGenTurbineType1IEC - - def __str__(self): - str = 'class=WindAeroConstIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindAeroConstIEC(IdentifiedObject): + """ + The constant aerodynamic torque model assumes that the aerodynamic torque is constant. Reference: IEC Standard 61400-27-1 Section 6.6.1.1. + + :WindGenTurbineType1IEC: Wind turbine type 1 model with which this wind aerodynamic model is associated. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindGenTurbineType1IEC": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindGenTurbineType1IEC = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindGenTurbineType1IEC = WindGenTurbineType1IEC + + def __str__(self): + str = "class=WindAeroConstIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindAeroLinearIEC.py b/cimpy/cgmes_v2_4_15/WindAeroLinearIEC.py index 4e2f992f..f7c01f0a 100644 --- a/cimpy/cgmes_v2_4_15/WindAeroLinearIEC.py +++ b/cimpy/cgmes_v2_4_15/WindAeroLinearIEC.py @@ -1,46 +1,48 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindAeroLinearIEC(IdentifiedObject): - ''' - The linearised aerodynamic model. Reference: IEC Standard 614000-27-1 Section 6.6.1.2. - - :dpomega: Partial derivative of aerodynamic power with respect to changes in WTR speed (). It is case dependent parameter. Default: 0.0 - :dptheta: Partial derivative of aerodynamic power with respect to changes in pitch angle (). It is case dependent parameter. Default: 0.0 - :omegazero: Rotor speed if the wind turbine is not derated (). It is case dependent parameter. Default: 0.0 - :pavail: Available aerodynamic power (). It is case dependent parameter. Default: 0.0 - :thetazero: Pitch angle if the wind turbine is not derated (). It is case dependent parameter. Default: 0.0 - :WindGenTurbineType3IEC: Wind generator type 3 model with which this wind aerodynamic model is associated. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'dpomega': [cgmesProfile.DY.value, ], - 'dptheta': [cgmesProfile.DY.value, ], - 'omegazero': [cgmesProfile.DY.value, ], - 'pavail': [cgmesProfile.DY.value, ], - 'thetazero': [cgmesProfile.DY.value, ], - 'WindGenTurbineType3IEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, dpomega = 0.0, dptheta = 0.0, omegazero = 0.0, pavail = 0.0, thetazero = 0.0, WindGenTurbineType3IEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.dpomega = dpomega - self.dptheta = dptheta - self.omegazero = omegazero - self.pavail = pavail - self.thetazero = thetazero - self.WindGenTurbineType3IEC = WindGenTurbineType3IEC - - def __str__(self): - str = 'class=WindAeroLinearIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindAeroLinearIEC(IdentifiedObject): + """ + The linearised aerodynamic model. Reference: IEC Standard 614000-27-1 Section 6.6.1.2. + + :WindGenTurbineType3IEC: Wind generator type 3 model with which this wind aerodynamic model is associated. Default: None + :dpomega: Partial derivative of aerodynamic power with respect to changes in WTR speed (). It is case dependent parameter. Default: 0.0 + :dptheta: Partial derivative of aerodynamic power with respect to changes in pitch angle (). It is case dependent parameter. Default: 0.0 + :omegazero: Rotor speed if the wind turbine is not derated (). It is case dependent parameter. Default: 0.0 + :pavail: Available aerodynamic power (). It is case dependent parameter. Default: 0.0 + :thetazero: Pitch angle if the wind turbine is not derated (). It is case dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindGenTurbineType3IEC": [Profile.DY.value, ], + "dpomega": [Profile.DY.value, ], + "dptheta": [Profile.DY.value, ], + "omegazero": [Profile.DY.value, ], + "pavail": [Profile.DY.value, ], + "thetazero": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindGenTurbineType3IEC = None, dpomega = 0.0, dptheta = 0.0, omegazero = 0.0, pavail = 0.0, thetazero = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindGenTurbineType3IEC = WindGenTurbineType3IEC + self.dpomega = dpomega + self.dptheta = dptheta + self.omegazero = omegazero + self.pavail = pavail + self.thetazero = thetazero + + def __str__(self): + str = "class=WindAeroLinearIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindContCurrLimIEC.py b/cimpy/cgmes_v2_4_15/WindContCurrLimIEC.py index ef4c0c68..8b358164 100644 --- a/cimpy/cgmes_v2_4_15/WindContCurrLimIEC.py +++ b/cimpy/cgmes_v2_4_15/WindContCurrLimIEC.py @@ -1,49 +1,51 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindContCurrLimIEC(IdentifiedObject): - ''' - Current limitation model. The current limitation model combines the physical limits. Reference: IEC Standard 61400-27-1 Section 6.6.5.7. - - :imax: Maximum continuous current at the wind turbine terminals (). It is type dependent parameter. Default: 0.0 - :imaxdip: Maximum current during voltage dip at the wind turbine terminals (). It is project dependent parameter. Default: 0.0 - :mdfslim: Limitation of type 3 stator current (): - false=0: total current limitation, - true=1: stator current limitation). It is type dependent parameter. Default: False - :mqpri: Prioritisation of q control during LVRT (): - true = 1: reactive power priority, - false = 0: active power priority. It is project dependent parameter. Default: False - :tufilt: Voltage measurement filter time constant (). It is type dependent parameter. Default: 0 - :WindTurbineType3or4IEC: Wind turbine type 3 or 4 model with which this wind control current limitation model is associated. Default: None - :WindDynamicsLookupTable: The current control limitation model with which this wind dynamics lookup table is associated. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'imax': [cgmesProfile.DY.value, ], - 'imaxdip': [cgmesProfile.DY.value, ], - 'mdfslim': [cgmesProfile.DY.value, ], - 'mqpri': [cgmesProfile.DY.value, ], - 'tufilt': [cgmesProfile.DY.value, ], - 'WindTurbineType3or4IEC': [cgmesProfile.DY.value, ], - 'WindDynamicsLookupTable': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, imax = 0.0, imaxdip = 0.0, mdfslim = False, mqpri = False, tufilt = 0, WindTurbineType3or4IEC = None, WindDynamicsLookupTable = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.imax = imax - self.imaxdip = imaxdip - self.mdfslim = mdfslim - self.mqpri = mqpri - self.tufilt = tufilt - self.WindTurbineType3or4IEC = WindTurbineType3or4IEC - self.WindDynamicsLookupTable = WindDynamicsLookupTable - - def __str__(self): - str = 'class=WindContCurrLimIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindContCurrLimIEC(IdentifiedObject): + """ + Current limitation model. The current limitation model combines the physical limits. Reference: IEC Standard 61400-27-1 Section 6.6.5.7. + + :WindDynamicsLookupTable: The current control limitation model with which this wind dynamics lookup table is associated. Default: "list" + :WindTurbineType3or4IEC: Wind turbine type 3 or 4 model with which this wind control current limitation model is associated. Default: None + :imax: Maximum continuous current at the wind turbine terminals (). It is type dependent parameter. Default: 0.0 + :imaxdip: Maximum current during voltage dip at the wind turbine terminals (). It is project dependent parameter. Default: 0.0 + :mdfslim: Limitation of type 3 stator current (): - false=0: total current limitation, - true=1: stator current limitation). It is type dependent parameter. Default: False + :mqpri: Prioritisation of q control during LVRT (): - true = 1: reactive power priority, - false = 0: active power priority. It is project dependent parameter. Default: False + :tufilt: Voltage measurement filter time constant (). It is type dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindDynamicsLookupTable": [Profile.DY.value, ], + "WindTurbineType3or4IEC": [Profile.DY.value, ], + "imax": [Profile.DY.value, ], + "imaxdip": [Profile.DY.value, ], + "mdfslim": [Profile.DY.value, ], + "mqpri": [Profile.DY.value, ], + "tufilt": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindDynamicsLookupTable = "list", WindTurbineType3or4IEC = None, imax = 0.0, imaxdip = 0.0, mdfslim = False, mqpri = False, tufilt = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindDynamicsLookupTable = WindDynamicsLookupTable + self.WindTurbineType3or4IEC = WindTurbineType3or4IEC + self.imax = imax + self.imaxdip = imaxdip + self.mdfslim = mdfslim + self.mqpri = mqpri + self.tufilt = tufilt + + def __str__(self): + str = "class=WindContCurrLimIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindContPType3IEC.py b/cimpy/cgmes_v2_4_15/WindContPType3IEC.py index e623554b..87f57ec1 100644 --- a/cimpy/cgmes_v2_4_15/WindContPType3IEC.py +++ b/cimpy/cgmes_v2_4_15/WindContPType3IEC.py @@ -1,97 +1,99 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindContPType3IEC(IdentifiedObject): - ''' - P control model Type 3. Reference: IEC Standard 61400-27-1 Section 6.6.5.3. - - :dpmax: Maximum wind turbine power ramp rate (). It is project dependent parameter. Default: 0.0 - :dtrisemaxlvrt: Limitation of torque rise rate during LVRT for S (d). It is project dependent parameter. Default: 0.0 - :kdtd: Gain for active drive train damping (). It is type dependent parameter. Default: 0.0 - :kip: PI controller integration parameter (). It is type dependent parameter. Default: 0.0 - :kpp: PI controller proportional gain (). It is type dependent parameter. Default: 0.0 - :mplvrt: Enable LVRT power control mode (M true = 1: voltage control false = 0: reactive power control. It is project dependent parameter. Default: False - :omegaoffset: Offset to reference value that limits controller action during rotor speed changes (omega). It is case dependent parameter. Default: 0.0 - :pdtdmax: Maximum active drive train damping power (). It is type dependent parameter. Default: 0.0 - :rramp: Ramp limitation of torque, required in some grid codes (). It is project dependent parameter. Default: 0.0 - :tdvs: Timedelay after deep voltage sags (T). It is project dependent parameter. Default: 0 - :temin: Minimum electrical generator torque (). It is type dependent parameter. Default: 0.0 - :tomegafilt: Filter time constant for generator speed measurement (). It is type dependent parameter. Default: 0 - :tpfilt: Filter time constant for power measurement (). It is type dependent parameter. Default: 0 - :tpord: Time constant in power order lag (). It is type dependent parameter. Default: 0.0 - :tufilt: Filter time constant for voltage measurement (). It is type dependent parameter. Default: 0 - :tuscale: Voltage scaling factor of reset-torque (T). It is project dependent parameter. Default: 0.0 - :twref: Time constant in speed reference filter (). It is type dependent parameter. Default: 0 - :udvs: Voltage limit for hold LVRT status after deep voltage sags (). It is project dependent parameter. Default: 0.0 - :updip: Voltage dip threshold for P-control (). Part of turbine control, often different (e.g 0.8) from converter thresholds. It is project dependent parameter. Default: 0.0 - :wdtd: Active drive train damping frequency (omega). It can be calculated from two mass model parameters. It is type dependent parameter. Default: 0.0 - :zeta: Coefficient for active drive train damping (zeta). It is type dependent parameter. Default: 0.0 - :WindGenTurbineType3IEC: Wind turbine type 3 model with which this Wind control P type 3 model is associated. Default: None - :WindDynamicsLookupTable: The P control type 3 model with which this wind dynamics lookup table is associated. Default: "list" - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'dpmax': [cgmesProfile.DY.value, ], - 'dtrisemaxlvrt': [cgmesProfile.DY.value, ], - 'kdtd': [cgmesProfile.DY.value, ], - 'kip': [cgmesProfile.DY.value, ], - 'kpp': [cgmesProfile.DY.value, ], - 'mplvrt': [cgmesProfile.DY.value, ], - 'omegaoffset': [cgmesProfile.DY.value, ], - 'pdtdmax': [cgmesProfile.DY.value, ], - 'rramp': [cgmesProfile.DY.value, ], - 'tdvs': [cgmesProfile.DY.value, ], - 'temin': [cgmesProfile.DY.value, ], - 'tomegafilt': [cgmesProfile.DY.value, ], - 'tpfilt': [cgmesProfile.DY.value, ], - 'tpord': [cgmesProfile.DY.value, ], - 'tufilt': [cgmesProfile.DY.value, ], - 'tuscale': [cgmesProfile.DY.value, ], - 'twref': [cgmesProfile.DY.value, ], - 'udvs': [cgmesProfile.DY.value, ], - 'updip': [cgmesProfile.DY.value, ], - 'wdtd': [cgmesProfile.DY.value, ], - 'zeta': [cgmesProfile.DY.value, ], - 'WindGenTurbineType3IEC': [cgmesProfile.DY.value, ], - 'WindDynamicsLookupTable': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, dpmax = 0.0, dtrisemaxlvrt = 0.0, kdtd = 0.0, kip = 0.0, kpp = 0.0, mplvrt = False, omegaoffset = 0.0, pdtdmax = 0.0, rramp = 0.0, tdvs = 0, temin = 0.0, tomegafilt = 0, tpfilt = 0, tpord = 0.0, tufilt = 0, tuscale = 0.0, twref = 0, udvs = 0.0, updip = 0.0, wdtd = 0.0, zeta = 0.0, WindGenTurbineType3IEC = None, WindDynamicsLookupTable = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.dpmax = dpmax - self.dtrisemaxlvrt = dtrisemaxlvrt - self.kdtd = kdtd - self.kip = kip - self.kpp = kpp - self.mplvrt = mplvrt - self.omegaoffset = omegaoffset - self.pdtdmax = pdtdmax - self.rramp = rramp - self.tdvs = tdvs - self.temin = temin - self.tomegafilt = tomegafilt - self.tpfilt = tpfilt - self.tpord = tpord - self.tufilt = tufilt - self.tuscale = tuscale - self.twref = twref - self.udvs = udvs - self.updip = updip - self.wdtd = wdtd - self.zeta = zeta - self.WindGenTurbineType3IEC = WindGenTurbineType3IEC - self.WindDynamicsLookupTable = WindDynamicsLookupTable - - def __str__(self): - str = 'class=WindContPType3IEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindContPType3IEC(IdentifiedObject): + """ + P control model Type 3. Reference: IEC Standard 61400-27-1 Section 6.6.5.3. + + :WindDynamicsLookupTable: The P control type 3 model with which this wind dynamics lookup table is associated. Default: "list" + :WindGenTurbineType3IEC: Wind turbine type 3 model with which this Wind control P type 3 model is associated. Default: None + :dpmax: Maximum wind turbine power ramp rate (). It is project dependent parameter. Default: 0.0 + :dtrisemaxlvrt: Limitation of torque rise rate during LVRT for S (d). It is project dependent parameter. Default: 0.0 + :kdtd: Gain for active drive train damping (). It is type dependent parameter. Default: 0.0 + :kip: PI controller integration parameter (). It is type dependent parameter. Default: 0.0 + :kpp: PI controller proportional gain (). It is type dependent parameter. Default: 0.0 + :mplvrt: Enable LVRT power control mode (M true = 1: voltage control false = 0: reactive power control. It is project dependent parameter. Default: False + :omegaoffset: Offset to reference value that limits controller action during rotor speed changes (omega). It is case dependent parameter. Default: 0.0 + :pdtdmax: Maximum active drive train damping power (). It is type dependent parameter. Default: 0.0 + :rramp: Ramp limitation of torque, required in some grid codes (). It is project dependent parameter. Default: 0.0 + :tdvs: Timedelay after deep voltage sags (T). It is project dependent parameter. Default: 0.0 + :temin: Minimum electrical generator torque (). It is type dependent parameter. Default: 0.0 + :tomegafilt: Filter time constant for generator speed measurement (). It is type dependent parameter. Default: 0.0 + :tpfilt: Filter time constant for power measurement (). It is type dependent parameter. Default: 0.0 + :tpord: Time constant in power order lag (). It is type dependent parameter. Default: 0.0 + :tufilt: Filter time constant for voltage measurement (). It is type dependent parameter. Default: 0.0 + :tuscale: Voltage scaling factor of reset-torque (T). It is project dependent parameter. Default: 0.0 + :twref: Time constant in speed reference filter (). It is type dependent parameter. Default: 0.0 + :udvs: Voltage limit for hold LVRT status after deep voltage sags (). It is project dependent parameter. Default: 0.0 + :updip: Voltage dip threshold for P-control (). Part of turbine control, often different (e.g 0.8) from converter thresholds. It is project dependent parameter. Default: 0.0 + :wdtd: Active drive train damping frequency (omega). It can be calculated from two mass model parameters. It is type dependent parameter. Default: 0.0 + :zeta: Coefficient for active drive train damping (zeta). It is type dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindDynamicsLookupTable": [Profile.DY.value, ], + "WindGenTurbineType3IEC": [Profile.DY.value, ], + "dpmax": [Profile.DY.value, ], + "dtrisemaxlvrt": [Profile.DY.value, ], + "kdtd": [Profile.DY.value, ], + "kip": [Profile.DY.value, ], + "kpp": [Profile.DY.value, ], + "mplvrt": [Profile.DY.value, ], + "omegaoffset": [Profile.DY.value, ], + "pdtdmax": [Profile.DY.value, ], + "rramp": [Profile.DY.value, ], + "tdvs": [Profile.DY.value, ], + "temin": [Profile.DY.value, ], + "tomegafilt": [Profile.DY.value, ], + "tpfilt": [Profile.DY.value, ], + "tpord": [Profile.DY.value, ], + "tufilt": [Profile.DY.value, ], + "tuscale": [Profile.DY.value, ], + "twref": [Profile.DY.value, ], + "udvs": [Profile.DY.value, ], + "updip": [Profile.DY.value, ], + "wdtd": [Profile.DY.value, ], + "zeta": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindDynamicsLookupTable = "list", WindGenTurbineType3IEC = None, dpmax = 0.0, dtrisemaxlvrt = 0.0, kdtd = 0.0, kip = 0.0, kpp = 0.0, mplvrt = False, omegaoffset = 0.0, pdtdmax = 0.0, rramp = 0.0, tdvs = 0.0, temin = 0.0, tomegafilt = 0.0, tpfilt = 0.0, tpord = 0.0, tufilt = 0.0, tuscale = 0.0, twref = 0.0, udvs = 0.0, updip = 0.0, wdtd = 0.0, zeta = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindDynamicsLookupTable = WindDynamicsLookupTable + self.WindGenTurbineType3IEC = WindGenTurbineType3IEC + self.dpmax = dpmax + self.dtrisemaxlvrt = dtrisemaxlvrt + self.kdtd = kdtd + self.kip = kip + self.kpp = kpp + self.mplvrt = mplvrt + self.omegaoffset = omegaoffset + self.pdtdmax = pdtdmax + self.rramp = rramp + self.tdvs = tdvs + self.temin = temin + self.tomegafilt = tomegafilt + self.tpfilt = tpfilt + self.tpord = tpord + self.tufilt = tufilt + self.tuscale = tuscale + self.twref = twref + self.udvs = udvs + self.updip = updip + self.wdtd = wdtd + self.zeta = zeta + + def __str__(self): + str = "class=WindContPType3IEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindContPType4aIEC.py b/cimpy/cgmes_v2_4_15/WindContPType4aIEC.py index dada5451..4eee04a8 100644 --- a/cimpy/cgmes_v2_4_15/WindContPType4aIEC.py +++ b/cimpy/cgmes_v2_4_15/WindContPType4aIEC.py @@ -1,40 +1,42 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindContPType4aIEC(IdentifiedObject): - ''' - P control model Type 4A. Reference: IEC Standard 61400-27-1 Section 6.6.5.4. - - :dpmax: Maximum wind turbine power ramp rate (). It is project dependent parameter. Default: 0.0 - :tpord: Time constant in power order lag (). It is type dependent parameter. Default: 0 - :tufilt: Voltage measurement filter time constant (). It is type dependent parameter. Default: 0 - :WindTurbineType4aIEC: Wind turbine type 4A model with which this wind control P type 4A model is associated. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'dpmax': [cgmesProfile.DY.value, ], - 'tpord': [cgmesProfile.DY.value, ], - 'tufilt': [cgmesProfile.DY.value, ], - 'WindTurbineType4aIEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, dpmax = 0.0, tpord = 0, tufilt = 0, WindTurbineType4aIEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.dpmax = dpmax - self.tpord = tpord - self.tufilt = tufilt - self.WindTurbineType4aIEC = WindTurbineType4aIEC - - def __str__(self): - str = 'class=WindContPType4aIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindContPType4aIEC(IdentifiedObject): + """ + P control model Type 4A. Reference: IEC Standard 61400-27-1 Section 6.6.5.4. + + :WindTurbineType4aIEC: Wind turbine type 4A model with which this wind control P type 4A model is associated. Default: None + :dpmax: Maximum wind turbine power ramp rate (). It is project dependent parameter. Default: 0.0 + :tpord: Time constant in power order lag (). It is type dependent parameter. Default: 0.0 + :tufilt: Voltage measurement filter time constant (). It is type dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindTurbineType4aIEC": [Profile.DY.value, ], + "dpmax": [Profile.DY.value, ], + "tpord": [Profile.DY.value, ], + "tufilt": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindTurbineType4aIEC = None, dpmax = 0.0, tpord = 0.0, tufilt = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindTurbineType4aIEC = WindTurbineType4aIEC + self.dpmax = dpmax + self.tpord = tpord + self.tufilt = tufilt + + def __str__(self): + str = "class=WindContPType4aIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindContPType4bIEC.py b/cimpy/cgmes_v2_4_15/WindContPType4bIEC.py index b10f8175..a2018202 100644 --- a/cimpy/cgmes_v2_4_15/WindContPType4bIEC.py +++ b/cimpy/cgmes_v2_4_15/WindContPType4bIEC.py @@ -1,43 +1,45 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindContPType4bIEC(IdentifiedObject): - ''' - P control model Type 4B. Reference: IEC Standard 61400-27-1 Section 6.6.5.5. - - :dpmax: Maximum wind turbine power ramp rate (). It is project dependent parameter. Default: 0.0 - :tpaero: Time constant in aerodynamic power response (). It is type dependent parameter. Default: 0 - :tpord: Time constant in power order lag (). It is type dependent parameter. Default: 0 - :tufilt: Voltage measurement filter time constant (). It is type dependent parameter. Default: 0 - :WindTurbineType4bIEC: Wind turbine type 4B model with which this wind control P type 4B model is associated. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'dpmax': [cgmesProfile.DY.value, ], - 'tpaero': [cgmesProfile.DY.value, ], - 'tpord': [cgmesProfile.DY.value, ], - 'tufilt': [cgmesProfile.DY.value, ], - 'WindTurbineType4bIEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, dpmax = 0.0, tpaero = 0, tpord = 0, tufilt = 0, WindTurbineType4bIEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.dpmax = dpmax - self.tpaero = tpaero - self.tpord = tpord - self.tufilt = tufilt - self.WindTurbineType4bIEC = WindTurbineType4bIEC - - def __str__(self): - str = 'class=WindContPType4bIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindContPType4bIEC(IdentifiedObject): + """ + P control model Type 4B. Reference: IEC Standard 61400-27-1 Section 6.6.5.5. + + :WindTurbineType4bIEC: Wind turbine type 4B model with which this wind control P type 4B model is associated. Default: None + :dpmax: Maximum wind turbine power ramp rate (). It is project dependent parameter. Default: 0.0 + :tpaero: Time constant in aerodynamic power response (). It is type dependent parameter. Default: 0.0 + :tpord: Time constant in power order lag (). It is type dependent parameter. Default: 0.0 + :tufilt: Voltage measurement filter time constant (). It is type dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindTurbineType4bIEC": [Profile.DY.value, ], + "dpmax": [Profile.DY.value, ], + "tpaero": [Profile.DY.value, ], + "tpord": [Profile.DY.value, ], + "tufilt": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindTurbineType4bIEC = None, dpmax = 0.0, tpaero = 0.0, tpord = 0.0, tufilt = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindTurbineType4bIEC = WindTurbineType4bIEC + self.dpmax = dpmax + self.tpaero = tpaero + self.tpord = tpord + self.tufilt = tufilt + + def __str__(self): + str = "class=WindContPType4bIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindContPitchAngleIEC.py b/cimpy/cgmes_v2_4_15/WindContPitchAngleIEC.py index be835831..f9117d53 100644 --- a/cimpy/cgmes_v2_4_15/WindContPitchAngleIEC.py +++ b/cimpy/cgmes_v2_4_15/WindContPitchAngleIEC.py @@ -1,61 +1,63 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindContPitchAngleIEC(IdentifiedObject): - ''' - Pitch angle control model. Reference: IEC Standard 61400-27-1 Section 6.6.5.8. - - :dthetamax: Maximum pitch positive ramp rate (d). It is type dependent parameter. Unit = degrees/sec. Default: 0.0 - :dthetamin: Maximum pitch negative ramp rate (d). It is type dependent parameter. Unit = degrees/sec. Default: 0.0 - :kic: Power PI controller integration gain (). It is type dependent parameter. Default: 0.0 - :kiomega: Speed PI controller integration gain (). It is type dependent parameter. Default: 0.0 - :kpc: Power PI controller proportional gain (). It is type dependent parameter. Default: 0.0 - :kpomega: Speed PI controller proportional gain (). It is type dependent parameter. Default: 0.0 - :kpx: Pitch cross coupling gain (K). It is type dependent parameter. Default: 0.0 - :thetamax: Maximum pitch angle (). It is type dependent parameter. Default: 0.0 - :thetamin: Minimum pitch angle (). It is type dependent parameter. Default: 0.0 - :ttheta: Pitch time constant (t). It is type dependent parameter. Default: 0 - :WindGenTurbineType3IEC: Wind turbine type 3 model with which this pitch control model is associated. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'dthetamax': [cgmesProfile.DY.value, ], - 'dthetamin': [cgmesProfile.DY.value, ], - 'kic': [cgmesProfile.DY.value, ], - 'kiomega': [cgmesProfile.DY.value, ], - 'kpc': [cgmesProfile.DY.value, ], - 'kpomega': [cgmesProfile.DY.value, ], - 'kpx': [cgmesProfile.DY.value, ], - 'thetamax': [cgmesProfile.DY.value, ], - 'thetamin': [cgmesProfile.DY.value, ], - 'ttheta': [cgmesProfile.DY.value, ], - 'WindGenTurbineType3IEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, dthetamax = 0.0, dthetamin = 0.0, kic = 0.0, kiomega = 0.0, kpc = 0.0, kpomega = 0.0, kpx = 0.0, thetamax = 0.0, thetamin = 0.0, ttheta = 0, WindGenTurbineType3IEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.dthetamax = dthetamax - self.dthetamin = dthetamin - self.kic = kic - self.kiomega = kiomega - self.kpc = kpc - self.kpomega = kpomega - self.kpx = kpx - self.thetamax = thetamax - self.thetamin = thetamin - self.ttheta = ttheta - self.WindGenTurbineType3IEC = WindGenTurbineType3IEC - - def __str__(self): - str = 'class=WindContPitchAngleIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindContPitchAngleIEC(IdentifiedObject): + """ + Pitch angle control model. Reference: IEC Standard 61400-27-1 Section 6.6.5.8. + + :WindGenTurbineType3IEC: Wind turbine type 3 model with which this pitch control model is associated. Default: None + :dthetamax: Maximum pitch positive ramp rate (d). It is type dependent parameter. Unit = degrees/sec. Default: 0.0 + :dthetamin: Maximum pitch negative ramp rate (d). It is type dependent parameter. Unit = degrees/sec. Default: 0.0 + :kic: Power PI controller integration gain (). It is type dependent parameter. Default: 0.0 + :kiomega: Speed PI controller integration gain (). It is type dependent parameter. Default: 0.0 + :kpc: Power PI controller proportional gain (). It is type dependent parameter. Default: 0.0 + :kpomega: Speed PI controller proportional gain (). It is type dependent parameter. Default: 0.0 + :kpx: Pitch cross coupling gain (K). It is type dependent parameter. Default: 0.0 + :thetamax: Maximum pitch angle (). It is type dependent parameter. Default: 0.0 + :thetamin: Minimum pitch angle (). It is type dependent parameter. Default: 0.0 + :ttheta: Pitch time constant (t). It is type dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindGenTurbineType3IEC": [Profile.DY.value, ], + "dthetamax": [Profile.DY.value, ], + "dthetamin": [Profile.DY.value, ], + "kic": [Profile.DY.value, ], + "kiomega": [Profile.DY.value, ], + "kpc": [Profile.DY.value, ], + "kpomega": [Profile.DY.value, ], + "kpx": [Profile.DY.value, ], + "thetamax": [Profile.DY.value, ], + "thetamin": [Profile.DY.value, ], + "ttheta": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindGenTurbineType3IEC = None, dthetamax = 0.0, dthetamin = 0.0, kic = 0.0, kiomega = 0.0, kpc = 0.0, kpomega = 0.0, kpx = 0.0, thetamax = 0.0, thetamin = 0.0, ttheta = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindGenTurbineType3IEC = WindGenTurbineType3IEC + self.dthetamax = dthetamax + self.dthetamin = dthetamin + self.kic = kic + self.kiomega = kiomega + self.kpc = kpc + self.kpomega = kpomega + self.kpx = kpx + self.thetamax = thetamax + self.thetamin = thetamin + self.ttheta = ttheta + + def __str__(self): + str = "class=WindContPitchAngleIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindContQIEC.py b/cimpy/cgmes_v2_4_15/WindContQIEC.py index f3c84722..60272e0b 100644 --- a/cimpy/cgmes_v2_4_15/WindContQIEC.py +++ b/cimpy/cgmes_v2_4_15/WindContQIEC.py @@ -1,109 +1,111 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindContQIEC(IdentifiedObject): - ''' - Q control model. Reference: IEC Standard 61400-27-1 Section 6.6.5.6. - - :iqh1: Maximum reactive current injection during dip (i). It is type dependent parameter. Default: 0.0 - :iqmax: Maximum reactive current injection (i). It is type dependent parameter. Default: 0.0 - :iqmin: Minimum reactive current injection (i). It is type dependent parameter. Default: 0.0 - :iqpost: Post fault reactive current injection (). It is project dependent parameter. Default: 0.0 - :kiq: Reactive power PI controller integration gain (). It is type dependent parameter. Default: 0.0 - :kiu: Voltage PI controller integration gain (). It is type dependent parameter. Default: 0.0 - :kpq: Reactive power PI controller proportional gain (). It is type dependent parameter. Default: 0.0 - :kpu: Voltage PI controller proportional gain (). It is type dependent parameter. Default: 0.0 - :kqv: Voltage scaling factor for LVRT current (). It is project dependent parameter. Default: 0.0 - :qmax: Maximum reactive power (q). It is type dependent parameter. Default: 0.0 - :qmin: Minimum reactive power (q). It is type dependent parameter. Default: 0.0 - :rdroop: Resistive component of voltage drop impedance (). It is project dependent parameter. Default: 0.0 - :tiq: Time constant in reactive current lag (T). It is type dependent parameter. Default: 0 - :tpfilt: Power measurement filter time constant (). It is type dependent parameter. Default: 0 - :tpost: Length of time period where post fault reactive power is injected (). It is project dependent parameter. Default: 0 - :tqord: Time constant in reactive power order lag (). It is type dependent parameter. Default: 0 - :tufilt: Voltage measurement filter time constant (). It is type dependent parameter. Default: 0 - :udb1: Voltage dead band lower limit (). It is type dependent parameter. Default: 0.0 - :udb2: Voltage dead band upper limit (). It is type dependent parameter. Default: 0.0 - :umax: Maximum voltage in voltage PI controller integral term (u). It is type dependent parameter. Default: 0.0 - :umin: Minimum voltage in voltage PI controller integral term (u). It is type dependent parameter. Default: 0.0 - :uqdip: Voltage threshold for LVRT detection in q control (). It is type dependent parameter. Default: 0.0 - :uref0: User defined bias in voltage reference (), used when =. It is case dependent parameter. Default: 0.0 - :windLVRTQcontrolModesType: Types of LVRT Q control modes (). It is project dependent parameter. Default: None - :windQcontrolModesType: Types of general wind turbine Q control modes (). It is project dependent parameter. Default: None - :xdroop: Inductive component of voltage drop impedance (). It is project dependent parameter. Default: 0.0 - :WindTurbineType3or4IEC: Wind turbine type 3 or 4 model with which this reactive control mode is associated. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'iqh1': [cgmesProfile.DY.value, ], - 'iqmax': [cgmesProfile.DY.value, ], - 'iqmin': [cgmesProfile.DY.value, ], - 'iqpost': [cgmesProfile.DY.value, ], - 'kiq': [cgmesProfile.DY.value, ], - 'kiu': [cgmesProfile.DY.value, ], - 'kpq': [cgmesProfile.DY.value, ], - 'kpu': [cgmesProfile.DY.value, ], - 'kqv': [cgmesProfile.DY.value, ], - 'qmax': [cgmesProfile.DY.value, ], - 'qmin': [cgmesProfile.DY.value, ], - 'rdroop': [cgmesProfile.DY.value, ], - 'tiq': [cgmesProfile.DY.value, ], - 'tpfilt': [cgmesProfile.DY.value, ], - 'tpost': [cgmesProfile.DY.value, ], - 'tqord': [cgmesProfile.DY.value, ], - 'tufilt': [cgmesProfile.DY.value, ], - 'udb1': [cgmesProfile.DY.value, ], - 'udb2': [cgmesProfile.DY.value, ], - 'umax': [cgmesProfile.DY.value, ], - 'umin': [cgmesProfile.DY.value, ], - 'uqdip': [cgmesProfile.DY.value, ], - 'uref0': [cgmesProfile.DY.value, ], - 'windLVRTQcontrolModesType': [cgmesProfile.DY.value, ], - 'windQcontrolModesType': [cgmesProfile.DY.value, ], - 'xdroop': [cgmesProfile.DY.value, ], - 'WindTurbineType3or4IEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, iqh1 = 0.0, iqmax = 0.0, iqmin = 0.0, iqpost = 0.0, kiq = 0.0, kiu = 0.0, kpq = 0.0, kpu = 0.0, kqv = 0.0, qmax = 0.0, qmin = 0.0, rdroop = 0.0, tiq = 0, tpfilt = 0, tpost = 0, tqord = 0, tufilt = 0, udb1 = 0.0, udb2 = 0.0, umax = 0.0, umin = 0.0, uqdip = 0.0, uref0 = 0.0, windLVRTQcontrolModesType = None, windQcontrolModesType = None, xdroop = 0.0, WindTurbineType3or4IEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.iqh1 = iqh1 - self.iqmax = iqmax - self.iqmin = iqmin - self.iqpost = iqpost - self.kiq = kiq - self.kiu = kiu - self.kpq = kpq - self.kpu = kpu - self.kqv = kqv - self.qmax = qmax - self.qmin = qmin - self.rdroop = rdroop - self.tiq = tiq - self.tpfilt = tpfilt - self.tpost = tpost - self.tqord = tqord - self.tufilt = tufilt - self.udb1 = udb1 - self.udb2 = udb2 - self.umax = umax - self.umin = umin - self.uqdip = uqdip - self.uref0 = uref0 - self.windLVRTQcontrolModesType = windLVRTQcontrolModesType - self.windQcontrolModesType = windQcontrolModesType - self.xdroop = xdroop - self.WindTurbineType3or4IEC = WindTurbineType3or4IEC - - def __str__(self): - str = 'class=WindContQIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindContQIEC(IdentifiedObject): + """ + Q control model. Reference: IEC Standard 61400-27-1 Section 6.6.5.6. + + :WindTurbineType3or4IEC: Wind turbine type 3 or 4 model with which this reactive control mode is associated. Default: None + :iqh1: Maximum reactive current injection during dip (i). It is type dependent parameter. Default: 0.0 + :iqmax: Maximum reactive current injection (i). It is type dependent parameter. Default: 0.0 + :iqmin: Minimum reactive current injection (i). It is type dependent parameter. Default: 0.0 + :iqpost: Post fault reactive current injection (). It is project dependent parameter. Default: 0.0 + :kiq: Reactive power PI controller integration gain (). It is type dependent parameter. Default: 0.0 + :kiu: Voltage PI controller integration gain (). It is type dependent parameter. Default: 0.0 + :kpq: Reactive power PI controller proportional gain (). It is type dependent parameter. Default: 0.0 + :kpu: Voltage PI controller proportional gain (). It is type dependent parameter. Default: 0.0 + :kqv: Voltage scaling factor for LVRT current (). It is project dependent parameter. Default: 0.0 + :qmax: Maximum reactive power (q). It is type dependent parameter. Default: 0.0 + :qmin: Minimum reactive power (q). It is type dependent parameter. Default: 0.0 + :rdroop: Resistive component of voltage drop impedance (). It is project dependent parameter. Default: 0.0 + :tiq: Time constant in reactive current lag (T). It is type dependent parameter. Default: 0.0 + :tpfilt: Power measurement filter time constant (). It is type dependent parameter. Default: 0.0 + :tpost: Length of time period where post fault reactive power is injected (). It is project dependent parameter. Default: 0.0 + :tqord: Time constant in reactive power order lag (). It is type dependent parameter. Default: 0.0 + :tufilt: Voltage measurement filter time constant (). It is type dependent parameter. Default: 0.0 + :udb1: Voltage dead band lower limit (). It is type dependent parameter. Default: 0.0 + :udb2: Voltage dead band upper limit (). It is type dependent parameter. Default: 0.0 + :umax: Maximum voltage in voltage PI controller integral term (u). It is type dependent parameter. Default: 0.0 + :umin: Minimum voltage in voltage PI controller integral term (u). It is type dependent parameter. Default: 0.0 + :uqdip: Voltage threshold for LVRT detection in q control (). It is type dependent parameter. Default: 0.0 + :uref0: User defined bias in voltage reference (), used when =. It is case dependent parameter. Default: 0.0 + :windLVRTQcontrolModesType: Types of LVRT Q control modes (). It is project dependent parameter. Default: None + :windQcontrolModesType: Types of general wind turbine Q control modes (). It is project dependent parameter. Default: None + :xdroop: Inductive component of voltage drop impedance (). It is project dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindTurbineType3or4IEC": [Profile.DY.value, ], + "iqh1": [Profile.DY.value, ], + "iqmax": [Profile.DY.value, ], + "iqmin": [Profile.DY.value, ], + "iqpost": [Profile.DY.value, ], + "kiq": [Profile.DY.value, ], + "kiu": [Profile.DY.value, ], + "kpq": [Profile.DY.value, ], + "kpu": [Profile.DY.value, ], + "kqv": [Profile.DY.value, ], + "qmax": [Profile.DY.value, ], + "qmin": [Profile.DY.value, ], + "rdroop": [Profile.DY.value, ], + "tiq": [Profile.DY.value, ], + "tpfilt": [Profile.DY.value, ], + "tpost": [Profile.DY.value, ], + "tqord": [Profile.DY.value, ], + "tufilt": [Profile.DY.value, ], + "udb1": [Profile.DY.value, ], + "udb2": [Profile.DY.value, ], + "umax": [Profile.DY.value, ], + "umin": [Profile.DY.value, ], + "uqdip": [Profile.DY.value, ], + "uref0": [Profile.DY.value, ], + "windLVRTQcontrolModesType": [Profile.DY.value, ], + "windQcontrolModesType": [Profile.DY.value, ], + "xdroop": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindTurbineType3or4IEC = None, iqh1 = 0.0, iqmax = 0.0, iqmin = 0.0, iqpost = 0.0, kiq = 0.0, kiu = 0.0, kpq = 0.0, kpu = 0.0, kqv = 0.0, qmax = 0.0, qmin = 0.0, rdroop = 0.0, tiq = 0.0, tpfilt = 0.0, tpost = 0.0, tqord = 0.0, tufilt = 0.0, udb1 = 0.0, udb2 = 0.0, umax = 0.0, umin = 0.0, uqdip = 0.0, uref0 = 0.0, windLVRTQcontrolModesType = None, windQcontrolModesType = None, xdroop = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindTurbineType3or4IEC = WindTurbineType3or4IEC + self.iqh1 = iqh1 + self.iqmax = iqmax + self.iqmin = iqmin + self.iqpost = iqpost + self.kiq = kiq + self.kiu = kiu + self.kpq = kpq + self.kpu = kpu + self.kqv = kqv + self.qmax = qmax + self.qmin = qmin + self.rdroop = rdroop + self.tiq = tiq + self.tpfilt = tpfilt + self.tpost = tpost + self.tqord = tqord + self.tufilt = tufilt + self.udb1 = udb1 + self.udb2 = udb2 + self.umax = umax + self.umin = umin + self.uqdip = uqdip + self.uref0 = uref0 + self.windLVRTQcontrolModesType = windLVRTQcontrolModesType + self.windQcontrolModesType = windQcontrolModesType + self.xdroop = xdroop + + def __str__(self): + str = "class=WindContQIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindContRotorRIEC.py b/cimpy/cgmes_v2_4_15/WindContRotorRIEC.py index 959d87f0..834e6487 100644 --- a/cimpy/cgmes_v2_4_15/WindContRotorRIEC.py +++ b/cimpy/cgmes_v2_4_15/WindContRotorRIEC.py @@ -1,58 +1,60 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindContRotorRIEC(IdentifiedObject): - ''' - Rotor resistance control model. Reference: IEC Standard 61400-27-1 Section 6.6.5.2. - - :kirr: Integral gain in rotor resistance PI controller (). It is type dependent parameter. Default: 0.0 - :komegafilt: Filter gain for generator speed measurement (K). It is type dependent parameter. Default: 0.0 - :kpfilt: Filter gain for power measurement (). It is type dependent parameter. Default: 0.0 - :kprr: Proportional gain in rotor resistance PI controller (). It is type dependent parameter. Default: 0.0 - :rmax: Maximum rotor resistance (). It is type dependent parameter. Default: 0.0 - :rmin: Minimum rotor resistance (). It is type dependent parameter. Default: 0.0 - :tomegafilt: Filter time constant for generator speed measurement (). It is type dependent parameter. Default: 0 - :tpfilt: Filter time constant for power measurement (). It is type dependent parameter. Default: 0 - :WindDynamicsLookupTable: The wind dynamics lookup table associated with this rotor resistance control model. Default: "list" - :WindGenTurbineType2IEC: Wind turbine type 2 model with whitch this wind control rotor resistance model is associated. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kirr': [cgmesProfile.DY.value, ], - 'komegafilt': [cgmesProfile.DY.value, ], - 'kpfilt': [cgmesProfile.DY.value, ], - 'kprr': [cgmesProfile.DY.value, ], - 'rmax': [cgmesProfile.DY.value, ], - 'rmin': [cgmesProfile.DY.value, ], - 'tomegafilt': [cgmesProfile.DY.value, ], - 'tpfilt': [cgmesProfile.DY.value, ], - 'WindDynamicsLookupTable': [cgmesProfile.DY.value, ], - 'WindGenTurbineType2IEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, kirr = 0.0, komegafilt = 0.0, kpfilt = 0.0, kprr = 0.0, rmax = 0.0, rmin = 0.0, tomegafilt = 0, tpfilt = 0, WindDynamicsLookupTable = "list", WindGenTurbineType2IEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kirr = kirr - self.komegafilt = komegafilt - self.kpfilt = kpfilt - self.kprr = kprr - self.rmax = rmax - self.rmin = rmin - self.tomegafilt = tomegafilt - self.tpfilt = tpfilt - self.WindDynamicsLookupTable = WindDynamicsLookupTable - self.WindGenTurbineType2IEC = WindGenTurbineType2IEC - - def __str__(self): - str = 'class=WindContRotorRIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindContRotorRIEC(IdentifiedObject): + """ + Rotor resistance control model. Reference: IEC Standard 61400-27-1 Section 6.6.5.2. + + :WindDynamicsLookupTable: The wind dynamics lookup table associated with this rotor resistance control model. Default: "list" + :WindGenTurbineType2IEC: Wind turbine type 2 model with whitch this wind control rotor resistance model is associated. Default: None + :kirr: Integral gain in rotor resistance PI controller (). It is type dependent parameter. Default: 0.0 + :komegafilt: Filter gain for generator speed measurement (K). It is type dependent parameter. Default: 0.0 + :kpfilt: Filter gain for power measurement (). It is type dependent parameter. Default: 0.0 + :kprr: Proportional gain in rotor resistance PI controller (). It is type dependent parameter. Default: 0.0 + :rmax: Maximum rotor resistance (). It is type dependent parameter. Default: 0.0 + :rmin: Minimum rotor resistance (). It is type dependent parameter. Default: 0.0 + :tomegafilt: Filter time constant for generator speed measurement (). It is type dependent parameter. Default: 0.0 + :tpfilt: Filter time constant for power measurement (). It is type dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindDynamicsLookupTable": [Profile.DY.value, ], + "WindGenTurbineType2IEC": [Profile.DY.value, ], + "kirr": [Profile.DY.value, ], + "komegafilt": [Profile.DY.value, ], + "kpfilt": [Profile.DY.value, ], + "kprr": [Profile.DY.value, ], + "rmax": [Profile.DY.value, ], + "rmin": [Profile.DY.value, ], + "tomegafilt": [Profile.DY.value, ], + "tpfilt": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindDynamicsLookupTable = "list", WindGenTurbineType2IEC = None, kirr = 0.0, komegafilt = 0.0, kpfilt = 0.0, kprr = 0.0, rmax = 0.0, rmin = 0.0, tomegafilt = 0.0, tpfilt = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindDynamicsLookupTable = WindDynamicsLookupTable + self.WindGenTurbineType2IEC = WindGenTurbineType2IEC + self.kirr = kirr + self.komegafilt = komegafilt + self.kpfilt = kpfilt + self.kprr = kprr + self.rmax = rmax + self.rmin = rmin + self.tomegafilt = tomegafilt + self.tpfilt = tpfilt + + def __str__(self): + str = "class=WindContRotorRIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindDynamicsLookupTable.py b/cimpy/cgmes_v2_4_15/WindDynamicsLookupTable.py index 9717bca5..f6788c61 100644 --- a/cimpy/cgmes_v2_4_15/WindDynamicsLookupTable.py +++ b/cimpy/cgmes_v2_4_15/WindDynamicsLookupTable.py @@ -1,52 +1,54 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindDynamicsLookupTable(IdentifiedObject): - ''' - The class models a look up table for the purpose of wind standard models. - - :WindContCurrLimIEC: The wind dynamics lookup table associated with this current control limitation model. Default: None - :WindContPType3IEC: The wind dynamics lookup table associated with this P control type 3 model. Default: None - :WindContRotorRIEC: The rotor resistance control model with which this wind dynamics lookup table is associated. Default: None - :input: Input value (x) for the lookup table function. Default: 0.0 - :lookupTableFunctionType: Type of the lookup table function. Default: None - :output: Output value (y) for the lookup table function. Default: 0.0 - :sequence: Sequence numbers of the pairs of the input (x) and the output (y) of the lookup table function. Default: 0 - :WindPlantFreqPcontrolIEC: The wind dynamics lookup table associated with this frequency and active power wind plant model. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindContCurrLimIEC': [cgmesProfile.DY.value, ], - 'WindContPType3IEC': [cgmesProfile.DY.value, ], - 'WindContRotorRIEC': [cgmesProfile.DY.value, ], - 'input': [cgmesProfile.DY.value, ], - 'lookupTableFunctionType': [cgmesProfile.DY.value, ], - 'output': [cgmesProfile.DY.value, ], - 'sequence': [cgmesProfile.DY.value, ], - 'WindPlantFreqPcontrolIEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, WindContCurrLimIEC = None, WindContPType3IEC = None, WindContRotorRIEC = None, input = 0.0, lookupTableFunctionType = None, output = 0.0, sequence = 0, WindPlantFreqPcontrolIEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindContCurrLimIEC = WindContCurrLimIEC - self.WindContPType3IEC = WindContPType3IEC - self.WindContRotorRIEC = WindContRotorRIEC - self.input = input - self.lookupTableFunctionType = lookupTableFunctionType - self.output = output - self.sequence = sequence - self.WindPlantFreqPcontrolIEC = WindPlantFreqPcontrolIEC - - def __str__(self): - str = 'class=WindDynamicsLookupTable\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindDynamicsLookupTable(IdentifiedObject): + """ + The class models a look up table for the purpose of wind standard models. + + :WindContCurrLimIEC: The wind dynamics lookup table associated with this current control limitation model. Default: None + :WindContPType3IEC: The wind dynamics lookup table associated with this P control type 3 model. Default: None + :WindContRotorRIEC: The rotor resistance control model with which this wind dynamics lookup table is associated. Default: None + :WindPlantFreqPcontrolIEC: The wind dynamics lookup table associated with this frequency and active power wind plant model. Default: None + :input: Input value (x) for the lookup table function. Default: 0.0 + :lookupTableFunctionType: Type of the lookup table function. Default: None + :output: Output value (y) for the lookup table function. Default: 0.0 + :sequence: Sequence numbers of the pairs of the input (x) and the output (y) of the lookup table function. Default: 0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindContCurrLimIEC": [Profile.DY.value, ], + "WindContPType3IEC": [Profile.DY.value, ], + "WindContRotorRIEC": [Profile.DY.value, ], + "WindPlantFreqPcontrolIEC": [Profile.DY.value, ], + "input": [Profile.DY.value, ], + "lookupTableFunctionType": [Profile.DY.value, ], + "output": [Profile.DY.value, ], + "sequence": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindContCurrLimIEC = None, WindContPType3IEC = None, WindContRotorRIEC = None, WindPlantFreqPcontrolIEC = None, input = 0.0, lookupTableFunctionType = None, output = 0.0, sequence = 0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindContCurrLimIEC = WindContCurrLimIEC + self.WindContPType3IEC = WindContPType3IEC + self.WindContRotorRIEC = WindContRotorRIEC + self.WindPlantFreqPcontrolIEC = WindPlantFreqPcontrolIEC + self.input = input + self.lookupTableFunctionType = lookupTableFunctionType + self.output = output + self.sequence = sequence + + def __str__(self): + str = "class=WindDynamicsLookupTable\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindGenTurbineType1IEC.py b/cimpy/cgmes_v2_4_15/WindGenTurbineType1IEC.py index 98f5343a..56d80fc8 100644 --- a/cimpy/cgmes_v2_4_15/WindGenTurbineType1IEC.py +++ b/cimpy/cgmes_v2_4_15/WindGenTurbineType1IEC.py @@ -1,31 +1,33 @@ -from .WindTurbineType1or2IEC import WindTurbineType1or2IEC - - -class WindGenTurbineType1IEC(WindTurbineType1or2IEC): - ''' - Wind turbine IEC Type 1. Reference: IEC Standard 61400-27-1, section 6.5.2. - - :WindAeroConstIEC: Wind aerodynamic model associated with this wind turbine type 1 model. Default: None - ''' - - cgmesProfile = WindTurbineType1or2IEC.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindAeroConstIEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindTurbineType1or2IEC: \n' + WindTurbineType1or2IEC.__doc__ - - def __init__(self, WindAeroConstIEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindAeroConstIEC = WindAeroConstIEC - - def __str__(self): - str = 'class=WindGenTurbineType1IEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindTurbineType1or2IEC import WindTurbineType1or2IEC +from .CGMESProfile import Profile + + +class WindGenTurbineType1IEC(WindTurbineType1or2IEC): + """ + Wind turbine IEC Type 1. Reference: IEC Standard 61400-27-1, section 6.5.2. + + :WindAeroConstIEC: Wind aerodynamic model associated with this wind turbine type 1 model. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindAeroConstIEC": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindTurbineType1or2IEC:\n" + WindTurbineType1or2IEC.__doc__ + + def __init__(self, WindAeroConstIEC = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindAeroConstIEC = WindAeroConstIEC + + def __str__(self): + str = "class=WindGenTurbineType1IEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindGenTurbineType2IEC.py b/cimpy/cgmes_v2_4_15/WindGenTurbineType2IEC.py index 21d8f82b..4d53a122 100644 --- a/cimpy/cgmes_v2_4_15/WindGenTurbineType2IEC.py +++ b/cimpy/cgmes_v2_4_15/WindGenTurbineType2IEC.py @@ -1,34 +1,36 @@ -from .WindTurbineType1or2IEC import WindTurbineType1or2IEC - - -class WindGenTurbineType2IEC(WindTurbineType1or2IEC): - ''' - Wind turbine IEC Type 2. Reference: IEC Standard 61400-27-1, section 6.5.3. - - :WindContRotorRIEC: Wind control rotor resistance model associated with wind turbine type 2 model. Default: None - :WindPitchContEmulIEC: Pitch control emulator model associated with this wind turbine type 2 model. Default: None - ''' - - cgmesProfile = WindTurbineType1or2IEC.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindContRotorRIEC': [cgmesProfile.DY.value, ], - 'WindPitchContEmulIEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindTurbineType1or2IEC: \n' + WindTurbineType1or2IEC.__doc__ - - def __init__(self, WindContRotorRIEC = None, WindPitchContEmulIEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindContRotorRIEC = WindContRotorRIEC - self.WindPitchContEmulIEC = WindPitchContEmulIEC - - def __str__(self): - str = 'class=WindGenTurbineType2IEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindTurbineType1or2IEC import WindTurbineType1or2IEC +from .CGMESProfile import Profile + + +class WindGenTurbineType2IEC(WindTurbineType1or2IEC): + """ + Wind turbine IEC Type 2. Reference: IEC Standard 61400-27-1, section 6.5.3. + + :WindContRotorRIEC: Wind control rotor resistance model associated with wind turbine type 2 model. Default: None + :WindPitchContEmulIEC: Pitch control emulator model associated with this wind turbine type 2 model. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindContRotorRIEC": [Profile.DY.value, ], + "WindPitchContEmulIEC": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindTurbineType1or2IEC:\n" + WindTurbineType1or2IEC.__doc__ + + def __init__(self, WindContRotorRIEC = None, WindPitchContEmulIEC = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindContRotorRIEC = WindContRotorRIEC + self.WindPitchContEmulIEC = WindPitchContEmulIEC + + def __str__(self): + str = "class=WindGenTurbineType2IEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindGenTurbineType3IEC.py b/cimpy/cgmes_v2_4_15/WindGenTurbineType3IEC.py index f2a5d598..e98c80c0 100644 --- a/cimpy/cgmes_v2_4_15/WindGenTurbineType3IEC.py +++ b/cimpy/cgmes_v2_4_15/WindGenTurbineType3IEC.py @@ -1,46 +1,48 @@ -from .WindTurbineType3or4IEC import WindTurbineType3or4IEC - - -class WindGenTurbineType3IEC(WindTurbineType3or4IEC): - ''' - Generator model for wind turbines of IEC type 3A and 3B. - - :WindAeroLinearIEC: Wind aerodynamic model associated with this wind generator type 3 model. Default: None - :WindContPitchAngleIEC: Wind control pitch angle model associated with this wind turbine type 3. Default: None - :WindContPType3IEC: Wind control P type 3 model associated with this wind turbine type 3 model. Default: None - :dipmax: Maximum active current ramp rate (di). It is project dependent parameter. Default: 0.0 - :diqmax: Maximum reactive current ramp rate (di). It is project dependent parameter. Default: 0.0 - :WindMechIEC: Wind mechanical model associated with this wind turbine Type 3 model. Default: None - ''' - - cgmesProfile = WindTurbineType3or4IEC.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindAeroLinearIEC': [cgmesProfile.DY.value, ], - 'WindContPitchAngleIEC': [cgmesProfile.DY.value, ], - 'WindContPType3IEC': [cgmesProfile.DY.value, ], - 'dipmax': [cgmesProfile.DY.value, ], - 'diqmax': [cgmesProfile.DY.value, ], - 'WindMechIEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindTurbineType3or4IEC: \n' + WindTurbineType3or4IEC.__doc__ - - def __init__(self, WindAeroLinearIEC = None, WindContPitchAngleIEC = None, WindContPType3IEC = None, dipmax = 0.0, diqmax = 0.0, WindMechIEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindAeroLinearIEC = WindAeroLinearIEC - self.WindContPitchAngleIEC = WindContPitchAngleIEC - self.WindContPType3IEC = WindContPType3IEC - self.dipmax = dipmax - self.diqmax = diqmax - self.WindMechIEC = WindMechIEC - - def __str__(self): - str = 'class=WindGenTurbineType3IEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindTurbineType3or4IEC import WindTurbineType3or4IEC +from .CGMESProfile import Profile + + +class WindGenTurbineType3IEC(WindTurbineType3or4IEC): + """ + Generator model for wind turbines of IEC type 3A and 3B. + + :WindAeroLinearIEC: Wind aerodynamic model associated with this wind generator type 3 model. Default: None + :WindContPType3IEC: Wind control P type 3 model associated with this wind turbine type 3 model. Default: None + :WindContPitchAngleIEC: Wind control pitch angle model associated with this wind turbine type 3. Default: None + :WindMechIEC: Wind mechanical model associated with this wind turbine Type 3 model. Default: None + :dipmax: Maximum active current ramp rate (di). It is project dependent parameter. Default: 0.0 + :diqmax: Maximum reactive current ramp rate (di). It is project dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindAeroLinearIEC": [Profile.DY.value, ], + "WindContPType3IEC": [Profile.DY.value, ], + "WindContPitchAngleIEC": [Profile.DY.value, ], + "WindMechIEC": [Profile.DY.value, ], + "dipmax": [Profile.DY.value, ], + "diqmax": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindTurbineType3or4IEC:\n" + WindTurbineType3or4IEC.__doc__ + + def __init__(self, WindAeroLinearIEC = None, WindContPType3IEC = None, WindContPitchAngleIEC = None, WindMechIEC = None, dipmax = 0.0, diqmax = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindAeroLinearIEC = WindAeroLinearIEC + self.WindContPType3IEC = WindContPType3IEC + self.WindContPitchAngleIEC = WindContPitchAngleIEC + self.WindMechIEC = WindMechIEC + self.dipmax = dipmax + self.diqmax = diqmax + + def __str__(self): + str = "class=WindGenTurbineType3IEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindGenTurbineType3aIEC.py b/cimpy/cgmes_v2_4_15/WindGenTurbineType3aIEC.py index ee268f9c..4abd3446 100644 --- a/cimpy/cgmes_v2_4_15/WindGenTurbineType3aIEC.py +++ b/cimpy/cgmes_v2_4_15/WindGenTurbineType3aIEC.py @@ -1,37 +1,39 @@ -from .WindGenTurbineType3IEC import WindGenTurbineType3IEC - - -class WindGenTurbineType3aIEC(WindGenTurbineType3IEC): - ''' - IEC Type 3A generator set model. Reference: IEC Standard 61400-27-1 Section 6.6.3.2. - - :kpc: Current PI controller proportional gain (K). It is type dependent parameter. Default: 0.0 - :xs: Electromagnetic transient reactance (x). It is type dependent parameter. Default: 0.0 - :tic: Current PI controller integration time constant (T). It is type dependent parameter. Default: 0 - ''' - - cgmesProfile = WindGenTurbineType3IEC.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'kpc': [cgmesProfile.DY.value, ], - 'xs': [cgmesProfile.DY.value, ], - 'tic': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindGenTurbineType3IEC: \n' + WindGenTurbineType3IEC.__doc__ - - def __init__(self, kpc = 0.0, xs = 0.0, tic = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.kpc = kpc - self.xs = xs - self.tic = tic - - def __str__(self): - str = 'class=WindGenTurbineType3aIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindGenTurbineType3IEC import WindGenTurbineType3IEC +from .CGMESProfile import Profile + + +class WindGenTurbineType3aIEC(WindGenTurbineType3IEC): + """ + IEC Type 3A generator set model. Reference: IEC Standard 61400-27-1 Section 6.6.3.2. + + :kpc: Current PI controller proportional gain (K). It is type dependent parameter. Default: 0.0 + :tic: Current PI controller integration time constant (T). It is type dependent parameter. Default: 0.0 + :xs: Electromagnetic transient reactance (x). It is type dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "kpc": [Profile.DY.value, ], + "tic": [Profile.DY.value, ], + "xs": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindGenTurbineType3IEC:\n" + WindGenTurbineType3IEC.__doc__ + + def __init__(self, kpc = 0.0, tic = 0.0, xs = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.kpc = kpc + self.tic = tic + self.xs = xs + + def __str__(self): + str = "class=WindGenTurbineType3aIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindGenTurbineType3bIEC.py b/cimpy/cgmes_v2_4_15/WindGenTurbineType3bIEC.py index 532c105c..5e047cdb 100644 --- a/cimpy/cgmes_v2_4_15/WindGenTurbineType3bIEC.py +++ b/cimpy/cgmes_v2_4_15/WindGenTurbineType3bIEC.py @@ -1,43 +1,45 @@ -from .WindGenTurbineType3IEC import WindGenTurbineType3IEC - - -class WindGenTurbineType3bIEC(WindGenTurbineType3IEC): - ''' - IEC Type 3B generator set model. Reference: IEC Standard 61400-27-1 Section 6.6.3.3. - - :fducw: Crowbar duration versus voltage variation look-up table (f()). It is case dependent parameter. Default: 0.0 - :tg: Current generation Time constant (). It is type dependent parameter. Default: 0 - :two: Time constant for crowbar washout filter (). It is case dependent parameter. Default: 0 - :mwtcwp: Crowbar control mode (). The parameter is case dependent parameter. Default: False - :xs: Electromagnetic transient reactance (x). It is type dependent parameter. Default: 0.0 - ''' - - cgmesProfile = WindGenTurbineType3IEC.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'fducw': [cgmesProfile.DY.value, ], - 'tg': [cgmesProfile.DY.value, ], - 'two': [cgmesProfile.DY.value, ], - 'mwtcwp': [cgmesProfile.DY.value, ], - 'xs': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindGenTurbineType3IEC: \n' + WindGenTurbineType3IEC.__doc__ - - def __init__(self, fducw = 0.0, tg = 0, two = 0, mwtcwp = False, xs = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.fducw = fducw - self.tg = tg - self.two = two - self.mwtcwp = mwtcwp - self.xs = xs - - def __str__(self): - str = 'class=WindGenTurbineType3bIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindGenTurbineType3IEC import WindGenTurbineType3IEC +from .CGMESProfile import Profile + + +class WindGenTurbineType3bIEC(WindGenTurbineType3IEC): + """ + IEC Type 3B generator set model. Reference: IEC Standard 61400-27-1 Section 6.6.3.3. + + :fducw: Crowbar duration versus voltage variation look-up table (f()). It is case dependent parameter. Default: 0.0 + :mwtcwp: Crowbar control mode (). The parameter is case dependent parameter. Default: False + :tg: Current generation Time constant (). It is type dependent parameter. Default: 0.0 + :two: Time constant for crowbar washout filter (). It is case dependent parameter. Default: 0.0 + :xs: Electromagnetic transient reactance (x). It is type dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "fducw": [Profile.DY.value, ], + "mwtcwp": [Profile.DY.value, ], + "tg": [Profile.DY.value, ], + "two": [Profile.DY.value, ], + "xs": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindGenTurbineType3IEC:\n" + WindGenTurbineType3IEC.__doc__ + + def __init__(self, fducw = 0.0, mwtcwp = False, tg = 0.0, two = 0.0, xs = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.fducw = fducw + self.mwtcwp = mwtcwp + self.tg = tg + self.two = two + self.xs = xs + + def __str__(self): + str = "class=WindGenTurbineType3bIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindGenType4IEC.py b/cimpy/cgmes_v2_4_15/WindGenType4IEC.py index 2d850d43..97b623c9 100644 --- a/cimpy/cgmes_v2_4_15/WindGenType4IEC.py +++ b/cimpy/cgmes_v2_4_15/WindGenType4IEC.py @@ -1,40 +1,42 @@ -from .WindTurbineType3or4IEC import WindTurbineType3or4IEC - - -class WindGenType4IEC(WindTurbineType3or4IEC): - ''' - IEC Type 4 generator set model. Reference: IEC Standard 61400-27-1 Section 6.6.3.4. - - :dipmax: Maximum active current ramp rate (di). It is project dependent parameter. Default: 0.0 - :diqmin: Minimum reactive current ramp rate (d). It is case dependent parameter. Default: 0.0 - :diqmax: Maximum reactive current ramp rate (di). It is project dependent parameter. Default: 0.0 - :tg: Time constant (T). It is type dependent parameter. Default: 0 - ''' - - cgmesProfile = WindTurbineType3or4IEC.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'dipmax': [cgmesProfile.DY.value, ], - 'diqmin': [cgmesProfile.DY.value, ], - 'diqmax': [cgmesProfile.DY.value, ], - 'tg': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindTurbineType3or4IEC: \n' + WindTurbineType3or4IEC.__doc__ - - def __init__(self, dipmax = 0.0, diqmin = 0.0, diqmax = 0.0, tg = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.dipmax = dipmax - self.diqmin = diqmin - self.diqmax = diqmax - self.tg = tg - - def __str__(self): - str = 'class=WindGenType4IEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindTurbineType3or4IEC import WindTurbineType3or4IEC +from .CGMESProfile import Profile + + +class WindGenType4IEC(WindTurbineType3or4IEC): + """ + IEC Type 4 generator set model. Reference: IEC Standard 61400-27-1 Section 6.6.3.4. + + :dipmax: Maximum active current ramp rate (di). It is project dependent parameter. Default: 0.0 + :diqmax: Maximum reactive current ramp rate (di). It is project dependent parameter. Default: 0.0 + :diqmin: Minimum reactive current ramp rate (d). It is case dependent parameter. Default: 0.0 + :tg: Time constant (T). It is type dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "dipmax": [Profile.DY.value, ], + "diqmax": [Profile.DY.value, ], + "diqmin": [Profile.DY.value, ], + "tg": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindTurbineType3or4IEC:\n" + WindTurbineType3or4IEC.__doc__ + + def __init__(self, dipmax = 0.0, diqmax = 0.0, diqmin = 0.0, tg = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.dipmax = dipmax + self.diqmax = diqmax + self.diqmin = diqmin + self.tg = tg + + def __str__(self): + str = "class=WindGenType4IEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindGenUnitKind.py b/cimpy/cgmes_v2_4_15/WindGenUnitKind.py index d97d352f..0520a056 100644 --- a/cimpy/cgmes_v2_4_15/WindGenUnitKind.py +++ b/cimpy/cgmes_v2_4_15/WindGenUnitKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class WindGenUnitKind(Base): - ''' - Kind of wind generating unit. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=WindGenUnitKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class WindGenUnitKind(Base): + """ + Kind of wind generating unit. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=WindGenUnitKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindGeneratingUnit.py b/cimpy/cgmes_v2_4_15/WindGeneratingUnit.py index d58234fd..e5569e9a 100644 --- a/cimpy/cgmes_v2_4_15/WindGeneratingUnit.py +++ b/cimpy/cgmes_v2_4_15/WindGeneratingUnit.py @@ -1,31 +1,33 @@ -from .GeneratingUnit import GeneratingUnit - - -class WindGeneratingUnit(GeneratingUnit): - ''' - A wind driven generating unit. May be used to represent a single turbine or an aggregation. - - :windGenUnitType: The kind of wind generating unit Default: None - ''' - - cgmesProfile = GeneratingUnit.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, cgmesProfile.SSH.value, ], - 'windGenUnitType': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class GeneratingUnit: \n' + GeneratingUnit.__doc__ - - def __init__(self, windGenUnitType = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.windGenUnitType = windGenUnitType - - def __str__(self): - str = 'class=WindGeneratingUnit\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .GeneratingUnit import GeneratingUnit +from .CGMESProfile import Profile + + +class WindGeneratingUnit(GeneratingUnit): + """ + A wind driven generating unit. May be used to represent a single turbine or an aggregation. + + :windGenUnitType: The kind of wind generating unit Default: None + """ + + possibleProfileList = { + "class": [Profile.EQ.value, Profile.SSH.value, ], + "windGenUnitType": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + __doc__ += "\nDocumentation of parent class GeneratingUnit:\n" + GeneratingUnit.__doc__ + + def __init__(self, windGenUnitType = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.windGenUnitType = windGenUnitType + + def __str__(self): + str = "class=WindGeneratingUnit\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindLVRTQcontrolModesKind.py b/cimpy/cgmes_v2_4_15/WindLVRTQcontrolModesKind.py index 0c68ed95..6bed81bd 100644 --- a/cimpy/cgmes_v2_4_15/WindLVRTQcontrolModesKind.py +++ b/cimpy/cgmes_v2_4_15/WindLVRTQcontrolModesKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class WindLVRTQcontrolModesKind(Base): - ''' - LVRT Q control modes . - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=WindLVRTQcontrolModesKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class WindLVRTQcontrolModesKind(Base): + """ + LVRT Q control modes . + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=WindLVRTQcontrolModesKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindLookupTableFunctionKind.py b/cimpy/cgmes_v2_4_15/WindLookupTableFunctionKind.py index 020c6c1b..bffdd664 100644 --- a/cimpy/cgmes_v2_4_15/WindLookupTableFunctionKind.py +++ b/cimpy/cgmes_v2_4_15/WindLookupTableFunctionKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class WindLookupTableFunctionKind(Base): - ''' - Function of the lookup table. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=WindLookupTableFunctionKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class WindLookupTableFunctionKind(Base): + """ + Function of the lookup table. + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=WindLookupTableFunctionKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindMechIEC.py b/cimpy/cgmes_v2_4_15/WindMechIEC.py index 45b49b8e..ba8aa3a4 100644 --- a/cimpy/cgmes_v2_4_15/WindMechIEC.py +++ b/cimpy/cgmes_v2_4_15/WindMechIEC.py @@ -1,49 +1,51 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindMechIEC(IdentifiedObject): - ''' - Two mass model. Reference: IEC Standard 61400-27-1 Section 6.6.2.1. - - :WindGenTurbineType3IEC: Wind turbine Type 3 model with which this wind mechanical model is associated. Default: None - :cdrt: Drive train damping (. It is type dependent parameter. Default: 0.0 - :hgen: Inertia constant of generator (). It is type dependent parameter. Default: 0 - :hwtr: Inertia constant of wind turbine rotor (). It is type dependent parameter. Default: 0 - :kdrt: Drive train stiffness (). It is type dependent parameter. Default: 0.0 - :WindTurbineType4bIEC: Wind turbine type 4B model with which this wind mechanical model is associated. Default: None - :WindTurbineType1or2IEC: Wind generator type 1 or 2 model with which this wind mechanical model is associated. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindGenTurbineType3IEC': [cgmesProfile.DY.value, ], - 'cdrt': [cgmesProfile.DY.value, ], - 'hgen': [cgmesProfile.DY.value, ], - 'hwtr': [cgmesProfile.DY.value, ], - 'kdrt': [cgmesProfile.DY.value, ], - 'WindTurbineType4bIEC': [cgmesProfile.DY.value, ], - 'WindTurbineType1or2IEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, WindGenTurbineType3IEC = None, cdrt = 0.0, hgen = 0, hwtr = 0, kdrt = 0.0, WindTurbineType4bIEC = None, WindTurbineType1or2IEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindGenTurbineType3IEC = WindGenTurbineType3IEC - self.cdrt = cdrt - self.hgen = hgen - self.hwtr = hwtr - self.kdrt = kdrt - self.WindTurbineType4bIEC = WindTurbineType4bIEC - self.WindTurbineType1or2IEC = WindTurbineType1or2IEC - - def __str__(self): - str = 'class=WindMechIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindMechIEC(IdentifiedObject): + """ + Two mass model. Reference: IEC Standard 61400-27-1 Section 6.6.2.1. + + :WindGenTurbineType3IEC: Wind turbine Type 3 model with which this wind mechanical model is associated. Default: None + :WindTurbineType1or2IEC: Wind generator type 1 or 2 model with which this wind mechanical model is associated. Default: None + :WindTurbineType4bIEC: Wind turbine type 4B model with which this wind mechanical model is associated. Default: None + :cdrt: Drive train damping (. It is type dependent parameter. Default: 0.0 + :hgen: Inertia constant of generator (). It is type dependent parameter. Default: 0.0 + :hwtr: Inertia constant of wind turbine rotor (). It is type dependent parameter. Default: 0.0 + :kdrt: Drive train stiffness (). It is type dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindGenTurbineType3IEC": [Profile.DY.value, ], + "WindTurbineType1or2IEC": [Profile.DY.value, ], + "WindTurbineType4bIEC": [Profile.DY.value, ], + "cdrt": [Profile.DY.value, ], + "hgen": [Profile.DY.value, ], + "hwtr": [Profile.DY.value, ], + "kdrt": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindGenTurbineType3IEC = None, WindTurbineType1or2IEC = None, WindTurbineType4bIEC = None, cdrt = 0.0, hgen = 0.0, hwtr = 0.0, kdrt = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindGenTurbineType3IEC = WindGenTurbineType3IEC + self.WindTurbineType1or2IEC = WindTurbineType1or2IEC + self.WindTurbineType4bIEC = WindTurbineType4bIEC + self.cdrt = cdrt + self.hgen = hgen + self.hwtr = hwtr + self.kdrt = kdrt + + def __str__(self): + str = "class=WindMechIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindPitchContEmulIEC.py b/cimpy/cgmes_v2_4_15/WindPitchContEmulIEC.py index c863f2c2..a6026ec1 100644 --- a/cimpy/cgmes_v2_4_15/WindPitchContEmulIEC.py +++ b/cimpy/cgmes_v2_4_15/WindPitchContEmulIEC.py @@ -1,61 +1,63 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindPitchContEmulIEC(IdentifiedObject): - ''' - Pitch control emulator model. Reference: IEC Standard 61400-27-1 Section 6.6.5.1. - - :WindGenTurbineType2IEC: Wind turbine type 2 model with which this Pitch control emulator model is associated. Default: None - :kdroop: Power error gain (). It is case dependent parameter. Default: 0.0 - :kipce: Pitch control emulator integral constant (). It is type dependent parameter. Default: 0.0 - :komegaaero: Aerodynamic power change vs. omegachange (). It is case dependent parameter. Default: 0.0 - :kppce: Pitch control emulator proportional constant (). It is type dependent parameter. Default: 0.0 - :omegaref: Rotor speed in initial steady state (omega). It is case dependent parameter. Default: 0.0 - :pimax: Maximum steady state power (). It is case dependent parameter. Default: 0.0 - :pimin: Minimum steady state power (). It is case dependent parameter. Default: 0.0 - :t1: First time constant in pitch control lag (). It is type dependent parameter. Default: 0 - :t2: Second time constant in pitch control lag (). It is type dependent parameter. Default: 0 - :tpe: Time constant in generator air gap power lag (). It is type dependent parameter. Default: 0 - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindGenTurbineType2IEC': [cgmesProfile.DY.value, ], - 'kdroop': [cgmesProfile.DY.value, ], - 'kipce': [cgmesProfile.DY.value, ], - 'komegaaero': [cgmesProfile.DY.value, ], - 'kppce': [cgmesProfile.DY.value, ], - 'omegaref': [cgmesProfile.DY.value, ], - 'pimax': [cgmesProfile.DY.value, ], - 'pimin': [cgmesProfile.DY.value, ], - 't1': [cgmesProfile.DY.value, ], - 't2': [cgmesProfile.DY.value, ], - 'tpe': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, WindGenTurbineType2IEC = None, kdroop = 0.0, kipce = 0.0, komegaaero = 0.0, kppce = 0.0, omegaref = 0.0, pimax = 0.0, pimin = 0.0, t1 = 0, t2 = 0, tpe = 0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindGenTurbineType2IEC = WindGenTurbineType2IEC - self.kdroop = kdroop - self.kipce = kipce - self.komegaaero = komegaaero - self.kppce = kppce - self.omegaref = omegaref - self.pimax = pimax - self.pimin = pimin - self.t1 = t1 - self.t2 = t2 - self.tpe = tpe - - def __str__(self): - str = 'class=WindPitchContEmulIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindPitchContEmulIEC(IdentifiedObject): + """ + Pitch control emulator model. Reference: IEC Standard 61400-27-1 Section 6.6.5.1. + + :WindGenTurbineType2IEC: Wind turbine type 2 model with which this Pitch control emulator model is associated. Default: None + :kdroop: Power error gain (). It is case dependent parameter. Default: 0.0 + :kipce: Pitch control emulator integral constant (). It is type dependent parameter. Default: 0.0 + :komegaaero: Aerodynamic power change vs. omegachange (). It is case dependent parameter. Default: 0.0 + :kppce: Pitch control emulator proportional constant (). It is type dependent parameter. Default: 0.0 + :omegaref: Rotor speed in initial steady state (omega). It is case dependent parameter. Default: 0.0 + :pimax: Maximum steady state power (). It is case dependent parameter. Default: 0.0 + :pimin: Minimum steady state power (). It is case dependent parameter. Default: 0.0 + :t1: First time constant in pitch control lag (). It is type dependent parameter. Default: 0.0 + :t2: Second time constant in pitch control lag (). It is type dependent parameter. Default: 0.0 + :tpe: Time constant in generator air gap power lag (). It is type dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindGenTurbineType2IEC": [Profile.DY.value, ], + "kdroop": [Profile.DY.value, ], + "kipce": [Profile.DY.value, ], + "komegaaero": [Profile.DY.value, ], + "kppce": [Profile.DY.value, ], + "omegaref": [Profile.DY.value, ], + "pimax": [Profile.DY.value, ], + "pimin": [Profile.DY.value, ], + "t1": [Profile.DY.value, ], + "t2": [Profile.DY.value, ], + "tpe": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindGenTurbineType2IEC = None, kdroop = 0.0, kipce = 0.0, komegaaero = 0.0, kppce = 0.0, omegaref = 0.0, pimax = 0.0, pimin = 0.0, t1 = 0.0, t2 = 0.0, tpe = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindGenTurbineType2IEC = WindGenTurbineType2IEC + self.kdroop = kdroop + self.kipce = kipce + self.komegaaero = komegaaero + self.kppce = kppce + self.omegaref = omegaref + self.pimax = pimax + self.pimin = pimin + self.t1 = t1 + self.t2 = t2 + self.tpe = tpe + + def __str__(self): + str = "class=WindPitchContEmulIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindPlantDynamics.py b/cimpy/cgmes_v2_4_15/WindPlantDynamics.py index 9636dce8..e9d3d676 100644 --- a/cimpy/cgmes_v2_4_15/WindPlantDynamics.py +++ b/cimpy/cgmes_v2_4_15/WindPlantDynamics.py @@ -1,34 +1,36 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class WindPlantDynamics(DynamicsFunctionBlock): - ''' - Parent class supporting relationships to wind turbines Type 3 and 4 and wind plant IEC and user defined wind plants including their control models. - - :RemoteInputSignal: The wind plant using the remote signal. Default: None - :WindTurbineType3or4Dynamics: The wind turbine type 3 or 4 associated with this wind plant. Default: "list" - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'RemoteInputSignal': [cgmesProfile.DY.value, ], - 'WindTurbineType3or4Dynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, RemoteInputSignal = None, WindTurbineType3or4Dynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.RemoteInputSignal = RemoteInputSignal - self.WindTurbineType3or4Dynamics = WindTurbineType3or4Dynamics - - def __str__(self): - str = 'class=WindPlantDynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class WindPlantDynamics(DynamicsFunctionBlock): + """ + Parent class supporting relationships to wind turbines Type 3 and 4 and wind plant IEC and user defined wind plants including their control models. + + :RemoteInputSignal: The wind plant using the remote signal. Default: None + :WindTurbineType3or4Dynamics: The wind turbine type 3 or 4 associated with this wind plant. Default: "list" + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "RemoteInputSignal": [Profile.DY.value, ], + "WindTurbineType3or4Dynamics": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, RemoteInputSignal = None, WindTurbineType3or4Dynamics = "list", *args, **kw_args): + super().__init__(*args, **kw_args) + + self.RemoteInputSignal = RemoteInputSignal + self.WindTurbineType3or4Dynamics = WindTurbineType3or4Dynamics + + def __str__(self): + str = "class=WindPlantDynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindPlantFreqPcontrolIEC.py b/cimpy/cgmes_v2_4_15/WindPlantFreqPcontrolIEC.py index 7df19aaf..28d233ab 100644 --- a/cimpy/cgmes_v2_4_15/WindPlantFreqPcontrolIEC.py +++ b/cimpy/cgmes_v2_4_15/WindPlantFreqPcontrolIEC.py @@ -1,64 +1,66 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindPlantFreqPcontrolIEC(IdentifiedObject): - ''' - Frequency and active power controller model. Reference: IEC Standard 61400-27-1 Annex E. - - :WindDynamicsLookupTable: The frequency and active power wind plant control model with which this wind dynamics lookup table is associated. Default: "list" - :dprefmax: Maximum ramp rate of request from the plant controller to the wind turbines (). It is project dependent parameter. Default: 0.0 - :dprefmin: Minimum (negative) ramp rate of request from the plant controller to the wind turbines (). It is project dependent parameter. Default: 0.0 - :kiwpp: Plant P controller integral gain (). It is type dependent parameter. Default: 0.0 - :kpwpp: Plant P controller proportional gain (). It is type dependent parameter. Default: 0.0 - :prefmax: Maximum request from the plant controller to the wind turbines (). It is type dependent parameter. Default: 0.0 - :prefmin: Minimum request from the plant controller to the wind turbines (). It is type dependent parameter. Default: 0.0 - :tpft: Lead time constant in reference value transfer function (). It is type dependent parameter. Default: 0 - :tpfv: Lag time constant in reference value transfer function (). It is type dependent parameter. Default: 0 - :twpffilt: Filter time constant for frequency measurement (). It is type dependent parameter. Default: 0 - :twppfilt: Filter time constant for active power measurement (). It is type dependent parameter. Default: 0 - :WindPlantIEC: Wind plant model with which this wind plant frequency and active power control is associated. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindDynamicsLookupTable': [cgmesProfile.DY.value, ], - 'dprefmax': [cgmesProfile.DY.value, ], - 'dprefmin': [cgmesProfile.DY.value, ], - 'kiwpp': [cgmesProfile.DY.value, ], - 'kpwpp': [cgmesProfile.DY.value, ], - 'prefmax': [cgmesProfile.DY.value, ], - 'prefmin': [cgmesProfile.DY.value, ], - 'tpft': [cgmesProfile.DY.value, ], - 'tpfv': [cgmesProfile.DY.value, ], - 'twpffilt': [cgmesProfile.DY.value, ], - 'twppfilt': [cgmesProfile.DY.value, ], - 'WindPlantIEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, WindDynamicsLookupTable = "list", dprefmax = 0.0, dprefmin = 0.0, kiwpp = 0.0, kpwpp = 0.0, prefmax = 0.0, prefmin = 0.0, tpft = 0, tpfv = 0, twpffilt = 0, twppfilt = 0, WindPlantIEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindDynamicsLookupTable = WindDynamicsLookupTable - self.dprefmax = dprefmax - self.dprefmin = dprefmin - self.kiwpp = kiwpp - self.kpwpp = kpwpp - self.prefmax = prefmax - self.prefmin = prefmin - self.tpft = tpft - self.tpfv = tpfv - self.twpffilt = twpffilt - self.twppfilt = twppfilt - self.WindPlantIEC = WindPlantIEC - - def __str__(self): - str = 'class=WindPlantFreqPcontrolIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindPlantFreqPcontrolIEC(IdentifiedObject): + """ + Frequency and active power controller model. Reference: IEC Standard 61400-27-1 Annex E. + + :WindDynamicsLookupTable: The frequency and active power wind plant control model with which this wind dynamics lookup table is associated. Default: "list" + :WindPlantIEC: Wind plant model with which this wind plant frequency and active power control is associated. Default: None + :dprefmax: Maximum ramp rate of request from the plant controller to the wind turbines (). It is project dependent parameter. Default: 0.0 + :dprefmin: Minimum (negative) ramp rate of request from the plant controller to the wind turbines (). It is project dependent parameter. Default: 0.0 + :kiwpp: Plant P controller integral gain (). It is type dependent parameter. Default: 0.0 + :kpwpp: Plant P controller proportional gain (). It is type dependent parameter. Default: 0.0 + :prefmax: Maximum request from the plant controller to the wind turbines (). It is type dependent parameter. Default: 0.0 + :prefmin: Minimum request from the plant controller to the wind turbines (). It is type dependent parameter. Default: 0.0 + :tpft: Lead time constant in reference value transfer function (). It is type dependent parameter. Default: 0.0 + :tpfv: Lag time constant in reference value transfer function (). It is type dependent parameter. Default: 0.0 + :twpffilt: Filter time constant for frequency measurement (). It is type dependent parameter. Default: 0.0 + :twppfilt: Filter time constant for active power measurement (). It is type dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindDynamicsLookupTable": [Profile.DY.value, ], + "WindPlantIEC": [Profile.DY.value, ], + "dprefmax": [Profile.DY.value, ], + "dprefmin": [Profile.DY.value, ], + "kiwpp": [Profile.DY.value, ], + "kpwpp": [Profile.DY.value, ], + "prefmax": [Profile.DY.value, ], + "prefmin": [Profile.DY.value, ], + "tpft": [Profile.DY.value, ], + "tpfv": [Profile.DY.value, ], + "twpffilt": [Profile.DY.value, ], + "twppfilt": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindDynamicsLookupTable = "list", WindPlantIEC = None, dprefmax = 0.0, dprefmin = 0.0, kiwpp = 0.0, kpwpp = 0.0, prefmax = 0.0, prefmin = 0.0, tpft = 0.0, tpfv = 0.0, twpffilt = 0.0, twppfilt = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindDynamicsLookupTable = WindDynamicsLookupTable + self.WindPlantIEC = WindPlantIEC + self.dprefmax = dprefmax + self.dprefmin = dprefmin + self.kiwpp = kiwpp + self.kpwpp = kpwpp + self.prefmax = prefmax + self.prefmin = prefmin + self.tpft = tpft + self.tpfv = tpfv + self.twpffilt = twpffilt + self.twppfilt = twppfilt + + def __str__(self): + str = "class=WindPlantFreqPcontrolIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindPlantIEC.py b/cimpy/cgmes_v2_4_15/WindPlantIEC.py index f97cc448..4cb2c999 100644 --- a/cimpy/cgmes_v2_4_15/WindPlantIEC.py +++ b/cimpy/cgmes_v2_4_15/WindPlantIEC.py @@ -1,34 +1,36 @@ -from .WindPlantDynamics import WindPlantDynamics - - -class WindPlantIEC(WindPlantDynamics): - ''' - Simplified IEC type plant level model. Reference: IEC 61400-27-1, AnnexE. - - :WindPlantFreqPcontrolIEC: Wind plant frequency and active power control model associated with this wind plant. Default: None - :WindPlantReactiveControlIEC: Wind plant reactive control model associated with this wind plant. Default: None - ''' - - cgmesProfile = WindPlantDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindPlantFreqPcontrolIEC': [cgmesProfile.DY.value, ], - 'WindPlantReactiveControlIEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindPlantDynamics: \n' + WindPlantDynamics.__doc__ - - def __init__(self, WindPlantFreqPcontrolIEC = None, WindPlantReactiveControlIEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindPlantFreqPcontrolIEC = WindPlantFreqPcontrolIEC - self.WindPlantReactiveControlIEC = WindPlantReactiveControlIEC - - def __str__(self): - str = 'class=WindPlantIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindPlantDynamics import WindPlantDynamics +from .CGMESProfile import Profile + + +class WindPlantIEC(WindPlantDynamics): + """ + Simplified IEC type plant level model. Reference: IEC 61400-27-1, AnnexE. + + :WindPlantFreqPcontrolIEC: Wind plant frequency and active power control model associated with this wind plant. Default: None + :WindPlantReactiveControlIEC: Wind plant reactive control model associated with this wind plant. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindPlantFreqPcontrolIEC": [Profile.DY.value, ], + "WindPlantReactiveControlIEC": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindPlantDynamics:\n" + WindPlantDynamics.__doc__ + + def __init__(self, WindPlantFreqPcontrolIEC = None, WindPlantReactiveControlIEC = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindPlantFreqPcontrolIEC = WindPlantFreqPcontrolIEC + self.WindPlantReactiveControlIEC = WindPlantReactiveControlIEC + + def __str__(self): + str = "class=WindPlantIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindPlantReactiveControlIEC.py b/cimpy/cgmes_v2_4_15/WindPlantReactiveControlIEC.py index 915b8bf8..0b6902d1 100644 --- a/cimpy/cgmes_v2_4_15/WindPlantReactiveControlIEC.py +++ b/cimpy/cgmes_v2_4_15/WindPlantReactiveControlIEC.py @@ -1,70 +1,72 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindPlantReactiveControlIEC(IdentifiedObject): - ''' - Simplified plant voltage and reactive power control model for use with type 3 and type 4 wind turbine models. Reference: IEC Standard 61400-27-1 Annex E. - - :WindPlantIEC: Wind plant model with which this wind reactive control is associated. Default: None - :kiwpx: Plant Q controller integral gain (). It is type dependent parameter. Default: 0.0 - :kpwpx: Plant Q controller proportional gain (). It is type dependent parameter. Default: 0.0 - :kwpqu: Plant voltage control droop (). It is project dependent parameter. Default: 0.0 - :mwppf: Power factor control modes selector (). Used only if mwpu is set to false. true = 1: power factor control false = 0: reactive power control. It is project dependent parameter. Default: False - :mwpu: Reactive power control modes selector (). true = 1: voltage control false = 0: reactive power control. It is project dependent parameter. Default: False - :twppfilt: Filter time constant for active power measurement (). It is type dependent parameter. Default: 0 - :twpqfilt: Filter time constant for reactive power measurement (). It is type dependent parameter. Default: 0 - :twpufilt: Filter time constant for voltage measurement (). It is type dependent parameter. Default: 0 - :txft: Lead time constant in reference value transfer function (). It is type dependent parameter. Default: 0 - :txfv: Lag time constant in reference value transfer function (). It is type dependent parameter. Default: 0 - :uwpqdip: Voltage threshold for LVRT detection in q control (). It is type dependent parameter. Default: 0.0 - :xrefmax: Maximum ( or delta ) request from the plant controller (). It is project dependent parameter. Default: 0.0 - :xrefmin: Minimum ( or delta) request from the plant controller (). It is project dependent parameter. Default: 0.0 - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindPlantIEC': [cgmesProfile.DY.value, ], - 'kiwpx': [cgmesProfile.DY.value, ], - 'kpwpx': [cgmesProfile.DY.value, ], - 'kwpqu': [cgmesProfile.DY.value, ], - 'mwppf': [cgmesProfile.DY.value, ], - 'mwpu': [cgmesProfile.DY.value, ], - 'twppfilt': [cgmesProfile.DY.value, ], - 'twpqfilt': [cgmesProfile.DY.value, ], - 'twpufilt': [cgmesProfile.DY.value, ], - 'txft': [cgmesProfile.DY.value, ], - 'txfv': [cgmesProfile.DY.value, ], - 'uwpqdip': [cgmesProfile.DY.value, ], - 'xrefmax': [cgmesProfile.DY.value, ], - 'xrefmin': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, WindPlantIEC = None, kiwpx = 0.0, kpwpx = 0.0, kwpqu = 0.0, mwppf = False, mwpu = False, twppfilt = 0, twpqfilt = 0, twpufilt = 0, txft = 0, txfv = 0, uwpqdip = 0.0, xrefmax = 0.0, xrefmin = 0.0, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindPlantIEC = WindPlantIEC - self.kiwpx = kiwpx - self.kpwpx = kpwpx - self.kwpqu = kwpqu - self.mwppf = mwppf - self.mwpu = mwpu - self.twppfilt = twppfilt - self.twpqfilt = twpqfilt - self.twpufilt = twpufilt - self.txft = txft - self.txfv = txfv - self.uwpqdip = uwpqdip - self.xrefmax = xrefmax - self.xrefmin = xrefmin - - def __str__(self): - str = 'class=WindPlantReactiveControlIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindPlantReactiveControlIEC(IdentifiedObject): + """ + Simplified plant voltage and reactive power control model for use with type 3 and type 4 wind turbine models. Reference: IEC Standard 61400-27-1 Annex E. + + :WindPlantIEC: Wind plant model with which this wind reactive control is associated. Default: None + :kiwpx: Plant Q controller integral gain (). It is type dependent parameter. Default: 0.0 + :kpwpx: Plant Q controller proportional gain (). It is type dependent parameter. Default: 0.0 + :kwpqu: Plant voltage control droop (). It is project dependent parameter. Default: 0.0 + :mwppf: Power factor control modes selector (). Used only if mwpu is set to false. true = 1: power factor control false = 0: reactive power control. It is project dependent parameter. Default: False + :mwpu: Reactive power control modes selector (). true = 1: voltage control false = 0: reactive power control. It is project dependent parameter. Default: False + :twppfilt: Filter time constant for active power measurement (). It is type dependent parameter. Default: 0.0 + :twpqfilt: Filter time constant for reactive power measurement (). It is type dependent parameter. Default: 0.0 + :twpufilt: Filter time constant for voltage measurement (). It is type dependent parameter. Default: 0.0 + :txft: Lead time constant in reference value transfer function (). It is type dependent parameter. Default: 0.0 + :txfv: Lag time constant in reference value transfer function (). It is type dependent parameter. Default: 0.0 + :uwpqdip: Voltage threshold for LVRT detection in q control (). It is type dependent parameter. Default: 0.0 + :xrefmax: Maximum ( or delta ) request from the plant controller (). It is project dependent parameter. Default: 0.0 + :xrefmin: Minimum ( or delta) request from the plant controller (). It is project dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindPlantIEC": [Profile.DY.value, ], + "kiwpx": [Profile.DY.value, ], + "kpwpx": [Profile.DY.value, ], + "kwpqu": [Profile.DY.value, ], + "mwppf": [Profile.DY.value, ], + "mwpu": [Profile.DY.value, ], + "twppfilt": [Profile.DY.value, ], + "twpqfilt": [Profile.DY.value, ], + "twpufilt": [Profile.DY.value, ], + "txft": [Profile.DY.value, ], + "txfv": [Profile.DY.value, ], + "uwpqdip": [Profile.DY.value, ], + "xrefmax": [Profile.DY.value, ], + "xrefmin": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindPlantIEC = None, kiwpx = 0.0, kpwpx = 0.0, kwpqu = 0.0, mwppf = False, mwpu = False, twppfilt = 0.0, twpqfilt = 0.0, twpufilt = 0.0, txft = 0.0, txfv = 0.0, uwpqdip = 0.0, xrefmax = 0.0, xrefmin = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindPlantIEC = WindPlantIEC + self.kiwpx = kiwpx + self.kpwpx = kpwpx + self.kwpqu = kwpqu + self.mwppf = mwppf + self.mwpu = mwpu + self.twppfilt = twppfilt + self.twpqfilt = twpqfilt + self.twpufilt = twpufilt + self.txft = txft + self.txfv = txfv + self.uwpqdip = uwpqdip + self.xrefmax = xrefmax + self.xrefmin = xrefmin + + def __str__(self): + str = "class=WindPlantReactiveControlIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindPlantUserDefined.py b/cimpy/cgmes_v2_4_15/WindPlantUserDefined.py index 0bddde31..f07d1d1a 100644 --- a/cimpy/cgmes_v2_4_15/WindPlantUserDefined.py +++ b/cimpy/cgmes_v2_4_15/WindPlantUserDefined.py @@ -1,34 +1,36 @@ -from .WindPlantDynamics import WindPlantDynamics - - -class WindPlantUserDefined(WindPlantDynamics): - ''' - Wind plant function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = WindPlantDynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindPlantDynamics: \n' + WindPlantDynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=WindPlantUserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindPlantDynamics import WindPlantDynamics +from .CGMESProfile import Profile + + +class WindPlantUserDefined(WindPlantDynamics): + """ + Wind plant function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindPlantDynamics:\n" + WindPlantDynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=WindPlantUserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindProtectionIEC.py b/cimpy/cgmes_v2_4_15/WindProtectionIEC.py index 06b2707d..129ecb81 100644 --- a/cimpy/cgmes_v2_4_15/WindProtectionIEC.py +++ b/cimpy/cgmes_v2_4_15/WindProtectionIEC.py @@ -1,58 +1,60 @@ -from .IdentifiedObject import IdentifiedObject - - -class WindProtectionIEC(IdentifiedObject): - ''' - The grid protection model includes protection against over and under voltage, and against over and under frequency. Reference: IEC Standard 614000-27-1 Section 6.6.6. - - :fover: Set of wind turbine over frequency protection levels (). It is project dependent parameter. Default: 0.0 - :funder: Set of wind turbine under frequency protection levels (). It is project dependent parameter. Default: 0.0 - :tfover: Set of corresponding wind turbine over frequency protection disconnection times (). It is project dependent parameter. Default: 0 - :tfunder: Set of corresponding wind turbine under frequency protection disconnection times (). It is project dependent parameter. Default: 0 - :tuover: Set of corresponding wind turbine over voltage protection disconnection times (). It is project dependent parameter. Default: 0 - :tuunder: Set of corresponding wind turbine under voltage protection disconnection times (). It is project dependent parameter. Default: 0 - :uover: Set of wind turbine over voltage protection levels (). It is project dependent parameter. Default: 0.0 - :uunder: Set of wind turbine under voltage protection levels (). It is project dependent parameter. Default: 0.0 - :WindTurbineType3or4IEC: Wind generator type 3 or 4 model with which this wind turbine protection model is associated. Default: None - :WindTurbineType1or2IEC: Wind generator type 1 or 2 model with which this wind turbine protection model is associated. Default: None - ''' - - cgmesProfile = IdentifiedObject.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'fover': [cgmesProfile.DY.value, ], - 'funder': [cgmesProfile.DY.value, ], - 'tfover': [cgmesProfile.DY.value, ], - 'tfunder': [cgmesProfile.DY.value, ], - 'tuover': [cgmesProfile.DY.value, ], - 'tuunder': [cgmesProfile.DY.value, ], - 'uover': [cgmesProfile.DY.value, ], - 'uunder': [cgmesProfile.DY.value, ], - 'WindTurbineType3or4IEC': [cgmesProfile.DY.value, ], - 'WindTurbineType1or2IEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class IdentifiedObject: \n' + IdentifiedObject.__doc__ - - def __init__(self, fover = 0.0, funder = 0.0, tfover = 0, tfunder = 0, tuover = 0, tuunder = 0, uover = 0.0, uunder = 0.0, WindTurbineType3or4IEC = None, WindTurbineType1or2IEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.fover = fover - self.funder = funder - self.tfover = tfover - self.tfunder = tfunder - self.tuover = tuover - self.tuunder = tuunder - self.uover = uover - self.uunder = uunder - self.WindTurbineType3or4IEC = WindTurbineType3or4IEC - self.WindTurbineType1or2IEC = WindTurbineType1or2IEC - - def __str__(self): - str = 'class=WindProtectionIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .IdentifiedObject import IdentifiedObject +from .CGMESProfile import Profile + + +class WindProtectionIEC(IdentifiedObject): + """ + The grid protection model includes protection against over and under voltage, and against over and under frequency. Reference: IEC Standard 614000-27-1 Section 6.6.6. + + :WindTurbineType1or2IEC: Wind generator type 1 or 2 model with which this wind turbine protection model is associated. Default: None + :WindTurbineType3or4IEC: Wind generator type 3 or 4 model with which this wind turbine protection model is associated. Default: None + :fover: Set of wind turbine over frequency protection levels (). It is project dependent parameter. Default: 0.0 + :funder: Set of wind turbine under frequency protection levels (). It is project dependent parameter. Default: 0.0 + :tfover: Set of corresponding wind turbine over frequency protection disconnection times (). It is project dependent parameter. Default: 0.0 + :tfunder: Set of corresponding wind turbine under frequency protection disconnection times (). It is project dependent parameter. Default: 0.0 + :tuover: Set of corresponding wind turbine over voltage protection disconnection times (). It is project dependent parameter. Default: 0.0 + :tuunder: Set of corresponding wind turbine under voltage protection disconnection times (). It is project dependent parameter. Default: 0.0 + :uover: Set of wind turbine over voltage protection levels (). It is project dependent parameter. Default: 0.0 + :uunder: Set of wind turbine under voltage protection levels (). It is project dependent parameter. Default: 0.0 + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindTurbineType1or2IEC": [Profile.DY.value, ], + "WindTurbineType3or4IEC": [Profile.DY.value, ], + "fover": [Profile.DY.value, ], + "funder": [Profile.DY.value, ], + "tfover": [Profile.DY.value, ], + "tfunder": [Profile.DY.value, ], + "tuover": [Profile.DY.value, ], + "tuunder": [Profile.DY.value, ], + "uover": [Profile.DY.value, ], + "uunder": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class IdentifiedObject:\n" + IdentifiedObject.__doc__ + + def __init__(self, WindTurbineType1or2IEC = None, WindTurbineType3or4IEC = None, fover = 0.0, funder = 0.0, tfover = 0.0, tfunder = 0.0, tuover = 0.0, tuunder = 0.0, uover = 0.0, uunder = 0.0, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindTurbineType1or2IEC = WindTurbineType1or2IEC + self.WindTurbineType3or4IEC = WindTurbineType3or4IEC + self.fover = fover + self.funder = funder + self.tfover = tfover + self.tfunder = tfunder + self.tuover = tuover + self.tuunder = tuunder + self.uover = uover + self.uunder = uunder + + def __str__(self): + str = "class=WindProtectionIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindQcontrolModesKind.py b/cimpy/cgmes_v2_4_15/WindQcontrolModesKind.py index 2a5709d4..3e6679d9 100644 --- a/cimpy/cgmes_v2_4_15/WindQcontrolModesKind.py +++ b/cimpy/cgmes_v2_4_15/WindQcontrolModesKind.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class WindQcontrolModesKind(Base): - ''' - General wind turbine Q control modes . - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=WindQcontrolModesKind\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class WindQcontrolModesKind(Base): + """ + General wind turbine Q control modes . + + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=WindQcontrolModesKind\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindTurbineType1or2Dynamics.py b/cimpy/cgmes_v2_4_15/WindTurbineType1or2Dynamics.py index 1fcc2293..6b422b3e 100644 --- a/cimpy/cgmes_v2_4_15/WindTurbineType1or2Dynamics.py +++ b/cimpy/cgmes_v2_4_15/WindTurbineType1or2Dynamics.py @@ -1,34 +1,36 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class WindTurbineType1or2Dynamics(DynamicsFunctionBlock): - ''' - Parent class supporting relationships to wind turbines Type 1 and 2 and their control models. - - :RemoteInputSignal: Remote input signal used by this wind generator Type 1 or Type 2 model. Default: None - :AsynchronousMachineDynamics: Asynchronous machine model with which this wind generator type 1 or 2 model is associated. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'RemoteInputSignal': [cgmesProfile.DY.value, ], - 'AsynchronousMachineDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, RemoteInputSignal = None, AsynchronousMachineDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.RemoteInputSignal = RemoteInputSignal - self.AsynchronousMachineDynamics = AsynchronousMachineDynamics - - def __str__(self): - str = 'class=WindTurbineType1or2Dynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class WindTurbineType1or2Dynamics(DynamicsFunctionBlock): + """ + Parent class supporting relationships to wind turbines Type 1 and 2 and their control models. + + :AsynchronousMachineDynamics: Asynchronous machine model with which this wind generator type 1 or 2 model is associated. Default: None + :RemoteInputSignal: Remote input signal used by this wind generator Type 1 or Type 2 model. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "AsynchronousMachineDynamics": [Profile.DY.value, ], + "RemoteInputSignal": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, AsynchronousMachineDynamics = None, RemoteInputSignal = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.AsynchronousMachineDynamics = AsynchronousMachineDynamics + self.RemoteInputSignal = RemoteInputSignal + + def __str__(self): + str = "class=WindTurbineType1or2Dynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindTurbineType1or2IEC.py b/cimpy/cgmes_v2_4_15/WindTurbineType1or2IEC.py index 9dbf2362..e1e97435 100644 --- a/cimpy/cgmes_v2_4_15/WindTurbineType1or2IEC.py +++ b/cimpy/cgmes_v2_4_15/WindTurbineType1or2IEC.py @@ -1,34 +1,36 @@ -from .WindTurbineType1or2Dynamics import WindTurbineType1or2Dynamics - - -class WindTurbineType1or2IEC(WindTurbineType1or2Dynamics): - ''' - Generator model for wind turbine of IEC Type 1 or Type 2 is a standard asynchronous generator model. Reference: IEC Standard 614000-27-1 Section 6.6.3.1. - - :WindMechIEC: Wind mechanical model associated with this wind generator type 1 or 2 model. Default: None - :WindProtectionIEC: Wind turbune protection model associated with this wind generator type 1 or 2 model. Default: None - ''' - - cgmesProfile = WindTurbineType1or2Dynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindMechIEC': [cgmesProfile.DY.value, ], - 'WindProtectionIEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindTurbineType1or2Dynamics: \n' + WindTurbineType1or2Dynamics.__doc__ - - def __init__(self, WindMechIEC = None, WindProtectionIEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindMechIEC = WindMechIEC - self.WindProtectionIEC = WindProtectionIEC - - def __str__(self): - str = 'class=WindTurbineType1or2IEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindTurbineType1or2Dynamics import WindTurbineType1or2Dynamics +from .CGMESProfile import Profile + + +class WindTurbineType1or2IEC(WindTurbineType1or2Dynamics): + """ + Generator model for wind turbine of IEC Type 1 or Type 2 is a standard asynchronous generator model. Reference: IEC Standard 614000-27-1 Section 6.6.3.1. + + :WindMechIEC: Wind mechanical model associated with this wind generator type 1 or 2 model. Default: None + :WindProtectionIEC: Wind turbune protection model associated with this wind generator type 1 or 2 model. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindMechIEC": [Profile.DY.value, ], + "WindProtectionIEC": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindTurbineType1or2Dynamics:\n" + WindTurbineType1or2Dynamics.__doc__ + + def __init__(self, WindMechIEC = None, WindProtectionIEC = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindMechIEC = WindMechIEC + self.WindProtectionIEC = WindProtectionIEC + + def __str__(self): + str = "class=WindTurbineType1or2IEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindTurbineType3or4Dynamics.py b/cimpy/cgmes_v2_4_15/WindTurbineType3or4Dynamics.py index a5abf9aa..c294f04a 100644 --- a/cimpy/cgmes_v2_4_15/WindTurbineType3or4Dynamics.py +++ b/cimpy/cgmes_v2_4_15/WindTurbineType3or4Dynamics.py @@ -1,37 +1,39 @@ -from .DynamicsFunctionBlock import DynamicsFunctionBlock - - -class WindTurbineType3or4Dynamics(DynamicsFunctionBlock): - ''' - Parent class supporting relationships to wind turbines Type 3 and 4 and wind plant including their control models. - - :EnergySource: Energy Source (current source) with which this wind Type 3 or 4 dynamics model is asoociated. Default: None - :RemoteInputSignal: Wind turbine Type 3 or 4 models using this remote input signal. Default: None - :WindPlantDynamics: The wind plant with which the wind turbines type 3 or 4 are associated. Default: None - ''' - - cgmesProfile = DynamicsFunctionBlock.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'EnergySource': [cgmesProfile.DY.value, ], - 'RemoteInputSignal': [cgmesProfile.DY.value, ], - 'WindPlantDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class DynamicsFunctionBlock: \n' + DynamicsFunctionBlock.__doc__ - - def __init__(self, EnergySource = None, RemoteInputSignal = None, WindPlantDynamics = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.EnergySource = EnergySource - self.RemoteInputSignal = RemoteInputSignal - self.WindPlantDynamics = WindPlantDynamics - - def __str__(self): - str = 'class=WindTurbineType3or4Dynamics\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .DynamicsFunctionBlock import DynamicsFunctionBlock +from .CGMESProfile import Profile + + +class WindTurbineType3or4Dynamics(DynamicsFunctionBlock): + """ + Parent class supporting relationships to wind turbines Type 3 and 4 and wind plant including their control models. + + :EnergySource: Energy Source (current source) with which this wind Type 3 or 4 dynamics model is asoociated. Default: None + :RemoteInputSignal: Wind turbine Type 3 or 4 models using this remote input signal. Default: None + :WindPlantDynamics: The wind plant with which the wind turbines type 3 or 4 are associated. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "EnergySource": [Profile.DY.value, ], + "RemoteInputSignal": [Profile.DY.value, ], + "WindPlantDynamics": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class DynamicsFunctionBlock:\n" + DynamicsFunctionBlock.__doc__ + + def __init__(self, EnergySource = None, RemoteInputSignal = None, WindPlantDynamics = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.EnergySource = EnergySource + self.RemoteInputSignal = RemoteInputSignal + self.WindPlantDynamics = WindPlantDynamics + + def __str__(self): + str = "class=WindTurbineType3or4Dynamics\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindTurbineType3or4IEC.py b/cimpy/cgmes_v2_4_15/WindTurbineType3or4IEC.py index fa4d707a..e520223b 100644 --- a/cimpy/cgmes_v2_4_15/WindTurbineType3or4IEC.py +++ b/cimpy/cgmes_v2_4_15/WindTurbineType3or4IEC.py @@ -1,37 +1,39 @@ -from .WindTurbineType3or4Dynamics import WindTurbineType3or4Dynamics - - -class WindTurbineType3or4IEC(WindTurbineType3or4Dynamics): - ''' - Parent class supporting relationships to IEC wind turbines Type 3 and 4 and wind plant including their control models. - - :WindContCurrLimIEC: Wind control current limitation model associated with this wind turbine type 3 or 4 model. Default: None - :WIndContQIEC: Wind control Q model associated with this wind turbine type 3 or 4 model. Default: None - :WindProtectionIEC: Wind turbune protection model associated with this wind generator type 3 or 4 model. Default: None - ''' - - cgmesProfile = WindTurbineType3or4Dynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindContCurrLimIEC': [cgmesProfile.DY.value, ], - 'WIndContQIEC': [cgmesProfile.DY.value, ], - 'WindProtectionIEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindTurbineType3or4Dynamics: \n' + WindTurbineType3or4Dynamics.__doc__ - - def __init__(self, WindContCurrLimIEC = None, WIndContQIEC = None, WindProtectionIEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindContCurrLimIEC = WindContCurrLimIEC - self.WIndContQIEC = WIndContQIEC - self.WindProtectionIEC = WindProtectionIEC - - def __str__(self): - str = 'class=WindTurbineType3or4IEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindTurbineType3or4Dynamics import WindTurbineType3or4Dynamics +from .CGMESProfile import Profile + + +class WindTurbineType3or4IEC(WindTurbineType3or4Dynamics): + """ + Parent class supporting relationships to IEC wind turbines Type 3 and 4 and wind plant including their control models. + + :WIndContQIEC: Wind control Q model associated with this wind turbine type 3 or 4 model. Default: None + :WindContCurrLimIEC: Wind control current limitation model associated with this wind turbine type 3 or 4 model. Default: None + :WindProtectionIEC: Wind turbune protection model associated with this wind generator type 3 or 4 model. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WIndContQIEC": [Profile.DY.value, ], + "WindContCurrLimIEC": [Profile.DY.value, ], + "WindProtectionIEC": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindTurbineType3or4Dynamics:\n" + WindTurbineType3or4Dynamics.__doc__ + + def __init__(self, WIndContQIEC = None, WindContCurrLimIEC = None, WindProtectionIEC = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WIndContQIEC = WIndContQIEC + self.WindContCurrLimIEC = WindContCurrLimIEC + self.WindProtectionIEC = WindProtectionIEC + + def __str__(self): + str = "class=WindTurbineType3or4IEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindTurbineType4aIEC.py b/cimpy/cgmes_v2_4_15/WindTurbineType4aIEC.py index 24989781..ee8a4ef0 100644 --- a/cimpy/cgmes_v2_4_15/WindTurbineType4aIEC.py +++ b/cimpy/cgmes_v2_4_15/WindTurbineType4aIEC.py @@ -1,31 +1,33 @@ -from .WindGenType4IEC import WindGenType4IEC - - -class WindTurbineType4aIEC(WindGenType4IEC): - ''' - Wind turbine IEC Type 4A. Reference: IEC Standard 61400-27-1, section 6.5.5.2. - - :WindContPType4aIEC: Wind control P type 4A model associated with this wind turbine type 4A model. Default: None - ''' - - cgmesProfile = WindGenType4IEC.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindContPType4aIEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindGenType4IEC: \n' + WindGenType4IEC.__doc__ - - def __init__(self, WindContPType4aIEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindContPType4aIEC = WindContPType4aIEC - - def __str__(self): - str = 'class=WindTurbineType4aIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindGenType4IEC import WindGenType4IEC +from .CGMESProfile import Profile + + +class WindTurbineType4aIEC(WindGenType4IEC): + """ + Wind turbine IEC Type 4A. Reference: IEC Standard 61400-27-1, section 6.5.5.2. + + :WindContPType4aIEC: Wind control P type 4A model associated with this wind turbine type 4A model. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindContPType4aIEC": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindGenType4IEC:\n" + WindGenType4IEC.__doc__ + + def __init__(self, WindContPType4aIEC = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindContPType4aIEC = WindContPType4aIEC + + def __str__(self): + str = "class=WindTurbineType4aIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindTurbineType4bIEC.py b/cimpy/cgmes_v2_4_15/WindTurbineType4bIEC.py index f84e053b..3dd714cc 100644 --- a/cimpy/cgmes_v2_4_15/WindTurbineType4bIEC.py +++ b/cimpy/cgmes_v2_4_15/WindTurbineType4bIEC.py @@ -1,34 +1,36 @@ -from .WindGenType4IEC import WindGenType4IEC - - -class WindTurbineType4bIEC(WindGenType4IEC): - ''' - Wind turbine IEC Type 4A. Reference: IEC Standard 61400-27-1, section 6.5.5.3. - - :WindContPType4bIEC: Wind control P type 4B model associated with this wind turbine type 4B model. Default: None - :WindMechIEC: Wind mechanical model associated with this wind turbine Type 4B model. Default: None - ''' - - cgmesProfile = WindGenType4IEC.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'WindContPType4bIEC': [cgmesProfile.DY.value, ], - 'WindMechIEC': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindGenType4IEC: \n' + WindGenType4IEC.__doc__ - - def __init__(self, WindContPType4bIEC = None, WindMechIEC = None, *args, **kw_args): - super().__init__(*args, **kw_args) - - self.WindContPType4bIEC = WindContPType4bIEC - self.WindMechIEC = WindMechIEC - - def __str__(self): - str = 'class=WindTurbineType4bIEC\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindGenType4IEC import WindGenType4IEC +from .CGMESProfile import Profile + + +class WindTurbineType4bIEC(WindGenType4IEC): + """ + Wind turbine IEC Type 4A. Reference: IEC Standard 61400-27-1, section 6.5.5.3. + + :WindContPType4bIEC: Wind control P type 4B model associated with this wind turbine type 4B model. Default: None + :WindMechIEC: Wind mechanical model associated with this wind turbine Type 4B model. Default: None + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "WindContPType4bIEC": [Profile.DY.value, ], + "WindMechIEC": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindGenType4IEC:\n" + WindGenType4IEC.__doc__ + + def __init__(self, WindContPType4bIEC = None, WindMechIEC = None, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.WindContPType4bIEC = WindContPType4bIEC + self.WindMechIEC = WindMechIEC + + def __str__(self): + str = "class=WindTurbineType4bIEC\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindType1or2UserDefined.py b/cimpy/cgmes_v2_4_15/WindType1or2UserDefined.py index 3b966d46..3a9ae016 100644 --- a/cimpy/cgmes_v2_4_15/WindType1or2UserDefined.py +++ b/cimpy/cgmes_v2_4_15/WindType1or2UserDefined.py @@ -1,34 +1,36 @@ -from .WindTurbineType1or2Dynamics import WindTurbineType1or2Dynamics - - -class WindType1or2UserDefined(WindTurbineType1or2Dynamics): - ''' - Wind Type 1 or Type 2 function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = WindTurbineType1or2Dynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindTurbineType1or2Dynamics: \n' + WindTurbineType1or2Dynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=WindType1or2UserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindTurbineType1or2Dynamics import WindTurbineType1or2Dynamics +from .CGMESProfile import Profile + + +class WindType1or2UserDefined(WindTurbineType1or2Dynamics): + """ + Wind Type 1 or Type 2 function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindTurbineType1or2Dynamics:\n" + WindTurbineType1or2Dynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=WindType1or2UserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindType3or4UserDefined.py b/cimpy/cgmes_v2_4_15/WindType3or4UserDefined.py index bcb93e14..082adf7d 100644 --- a/cimpy/cgmes_v2_4_15/WindType3or4UserDefined.py +++ b/cimpy/cgmes_v2_4_15/WindType3or4UserDefined.py @@ -1,34 +1,36 @@ -from .WindTurbineType3or4Dynamics import WindTurbineType3or4Dynamics - - -class WindType3or4UserDefined(WindTurbineType3or4Dynamics): - ''' - Wind Type 3 or Type 4 function block whose dynamic behaviour is described by - - :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False - :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" - ''' - - cgmesProfile = WindTurbineType3or4Dynamics.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.DY.value, ], - 'proprietary': [cgmesProfile.DY.value, ], - 'ProprietaryParameterDynamics': [cgmesProfile.DY.value, ], - } - - serializationProfile = {} - - __doc__ += '\n Documentation of parent class WindTurbineType3or4Dynamics: \n' + WindTurbineType3or4Dynamics.__doc__ - - def __init__(self, proprietary = False, ProprietaryParameterDynamics = "list", *args, **kw_args): - super().__init__(*args, **kw_args) - - self.proprietary = proprietary - self.ProprietaryParameterDynamics = ProprietaryParameterDynamics - - def __str__(self): - str = 'class=WindType3or4UserDefined\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .WindTurbineType3or4Dynamics import WindTurbineType3or4Dynamics +from .CGMESProfile import Profile + + +class WindType3or4UserDefined(WindTurbineType3or4Dynamics): + """ + Wind Type 3 or Type 4 function block whose dynamic behaviour is described by + + :ProprietaryParameterDynamics: Parameter of this proprietary user-defined model. Default: "list" + :proprietary: Behaviour is based on proprietary model as opposed to detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: False + """ + + possibleProfileList = { + "class": [Profile.DY.value, ], + "ProprietaryParameterDynamics": [Profile.DY.value, ], + "proprietary": [Profile.DY.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.DY.value + + __doc__ += "\nDocumentation of parent class WindTurbineType3or4Dynamics:\n" + WindTurbineType3or4Dynamics.__doc__ + + def __init__(self, ProprietaryParameterDynamics = "list", proprietary = False, *args, **kw_args): + super().__init__(*args, **kw_args) + + self.ProprietaryParameterDynamics = ProprietaryParameterDynamics + self.proprietary = proprietary + + def __str__(self): + str = "class=WindType3or4UserDefined\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/WindingConnection.py b/cimpy/cgmes_v2_4_15/WindingConnection.py index ca3bb250..a5f7b368 100644 --- a/cimpy/cgmes_v2_4_15/WindingConnection.py +++ b/cimpy/cgmes_v2_4_15/WindingConnection.py @@ -1,28 +1,29 @@ -from .Base import Base - - -class WindingConnection(Base): - ''' - Winding connection type. - - ''' - - cgmesProfile = Base.cgmesProfile - - possibleProfileList = {'class': [cgmesProfile.EQ.value, ], - } - - serializationProfile = {} - - - - def __init__(self, ): - - pass - - def __str__(self): - str = 'class=WindingConnection\n' - attributes = self.__dict__ - for key in attributes.keys(): - str = str + key + '={}\n'.format(attributes[key]) - return str +from .Base import Base +from .CGMESProfile import Profile + + +class WindingConnection(Base): + """ + Winding connection type. + + """ + + possibleProfileList = { + "class": [Profile.EQ.value, ], + } + + serializationProfile = {} + + recommendedClassProfile = Profile.EQ.value + + + def __init__(self): + + pass + + def __str__(self): + str = "class=WindingConnection\n" + attributes = self.__dict__ + for key in attributes.keys(): + str = str + key + "={}\n".format(attributes[key]) + return str diff --git a/cimpy/cgmes_v2_4_15/__init__.py b/cimpy/cgmes_v2_4_15/__init__.py index 3df66f11..90e14474 100644 --- a/cimpy/cgmes_v2_4_15/__init__.py +++ b/cimpy/cgmes_v2_4_15/__init__.py @@ -1,483 +1,482 @@ -from .DCConductingEquipment import DCConductingEquipment as DCConductingEquipment -from .MeasurementValueSource import MeasurementValueSource as MeasurementValueSource -from .DCBaseTerminal import DCBaseTerminal as DCBaseTerminal -from .ApparentPowerLimit import ApparentPowerLimit as ApparentPowerLimit -from .ExcDC3A import ExcDC3A as ExcDC3A -from .GovGAST import GovGAST as GovGAST -from .ConformLoad import ConformLoad as ConformLoad -from .RatioTapChangerTablePoint import RatioTapChangerTablePoint as RatioTapChangerTablePoint -from .Junction import Junction as Junction -from .PerCent import PerCent as PerCent -from .VoltagePerReactivePower import VoltagePerReactivePower as VoltagePerReactivePower -from .RotationSpeed import RotationSpeed as RotationSpeed -from .GovHydroIEEE0 import GovHydroIEEE0 as GovHydroIEEE0 -from .ExcIEEEST6B import ExcIEEEST6B as ExcIEEEST6B -from .VoltageCompensatorUserDefined import VoltageCompensatorUserDefined as VoltageCompensatorUserDefined -from .HydroPlantStorageKind import HydroPlantStorageKind as HydroPlantStorageKind -from .Resistance import Resistance as Resistance -from .GovHydroPelton import GovHydroPelton as GovHydroPelton -from .GroundDisconnector import GroundDisconnector as GroundDisconnector -from .StaticLoadModelKind import StaticLoadModelKind as StaticLoadModelKind -from .Currency import Currency as Currency -from .DCBusbar import DCBusbar as DCBusbar -from .GovGAST1 import GovGAST1 as GovGAST1 -from .DCTerminal import DCTerminal as DCTerminal -from .ResistancePerLength import ResistancePerLength as ResistancePerLength -from .Control import Control as Control -from .Curve import Curve as Curve -from .ExcST4B import ExcST4B as ExcST4B -from .PssPTIST1 import PssPTIST1 as PssPTIST1 -from .UnitMultiplier import UnitMultiplier as UnitMultiplier -from .RegulationSchedule import RegulationSchedule as RegulationSchedule -from .Line import Line as Line -from .ExcREXSFeedbackSignalKind import ExcREXSFeedbackSignalKind as ExcREXSFeedbackSignalKind -from .GovSteamFV2 import GovSteamFV2 as GovSteamFV2 -from .ApparentPower import ApparentPower as ApparentPower -from .PositionPoint import PositionPoint as PositionPoint -from .PowerTransformer import PowerTransformer as PowerTransformer -from .HydroEnergyConversionKind import HydroEnergyConversionKind as HydroEnergyConversionKind -from .WindingConnection import WindingConnection as WindingConnection -from .PhaseTapChangerNonLinear import PhaseTapChangerNonLinear as PhaseTapChangerNonLinear -from .WindContRotorRIEC import WindContRotorRIEC as WindContRotorRIEC -from .Susceptance import Susceptance as Susceptance -from .WindTurbineType3or4Dynamics import WindTurbineType3or4Dynamics as WindTurbineType3or4Dynamics -from .EnergySchedulingType import EnergySchedulingType as EnergySchedulingType -from .Breaker import Breaker as Breaker -from .RatioTapChangerTable import RatioTapChangerTable as RatioTapChangerTable -from .RemoteSignalKind import RemoteSignalKind as RemoteSignalKind -from .MechanicalLoadDynamics import MechanicalLoadDynamics as MechanicalLoadDynamics -from .EquivalentEquipment import EquivalentEquipment as EquivalentEquipment -from .PFVArControllerType1Dynamics import PFVArControllerType1Dynamics as PFVArControllerType1Dynamics -from .PFVArControllerType2Dynamics import PFVArControllerType2Dynamics as PFVArControllerType2Dynamics -from .Terminal import Terminal as Terminal -from .Switch import Switch as Switch -from .Ground import Ground as Ground -from .CsOperatingModeKind import CsOperatingModeKind as CsOperatingModeKind -from .TurbLCFB1 import TurbLCFB1 as TurbLCFB1 -from .OverexcLim2 import OverexcLim2 as OverexcLim2 -from .ExcIEEEAC7B import ExcIEEEAC7B as ExcIEEEAC7B -from .ExcST7B import ExcST7B as ExcST7B -from .RegulatingControlModeKind import RegulatingControlModeKind as RegulatingControlModeKind -from .SvTapStep import SvTapStep as SvTapStep -from .LimitSet import LimitSet as LimitSet -from .ExcIEEEAC8B import ExcIEEEAC8B as ExcIEEEAC8B -from .Quality61850 import Quality61850 as Quality61850 -from .ExcAC8B import ExcAC8B as ExcAC8B -from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics as UnderexcitationLimiterDynamics -from .ExcCZ import ExcCZ as ExcCZ -from .SynchronousMachineSimplified import SynchronousMachineSimplified as SynchronousMachineSimplified -from .WindDynamicsLookupTable import WindDynamicsLookupTable as WindDynamicsLookupTable -from .ExcOEX3T import ExcOEX3T as ExcOEX3T -from .SVCControlMode import SVCControlMode as SVCControlMode -from .NuclearGeneratingUnit import NuclearGeneratingUnit as NuclearGeneratingUnit -from .ExcIEEEDC3A import ExcIEEEDC3A as ExcIEEEDC3A -from .ExcAVR7 import ExcAVR7 as ExcAVR7 -from .PhaseTapChangerTable import PhaseTapChangerTable as PhaseTapChangerTable -from .DCSwitch import DCSwitch as DCSwitch -from .Accumulator import Accumulator as Accumulator -from .ExcIEEEST4B import ExcIEEEST4B as ExcIEEEST4B -from .SeriesCompensator import SeriesCompensator as SeriesCompensator -from .SynchronousMachineUserDefined import SynchronousMachineUserDefined as SynchronousMachineUserDefined -from .Pss2B import Pss2B as Pss2B -from .WindGenUnitKind import WindGenUnitKind as WindGenUnitKind -from .ExcELIN2 import ExcELIN2 as ExcELIN2 -from .__init__ import __init__ as __init__ -from .WindTurbineType1or2IEC import WindTurbineType1or2IEC as WindTurbineType1or2IEC -from .WindTurbineType3or4IEC import WindTurbineType3or4IEC as WindTurbineType3or4IEC -from .GovSteamFV4 import GovSteamFV4 as GovSteamFV4 -from .PhaseTapChangerAsymmetrical import PhaseTapChangerAsymmetrical as PhaseTapChangerAsymmetrical -from .TapChangerTablePoint import TapChangerTablePoint as TapChangerTablePoint -from .VCompIEEEType1 import VCompIEEEType1 as VCompIEEEType1 -from .TurbineLoadControllerUserDefined import TurbineLoadControllerUserDefined as TurbineLoadControllerUserDefined -from .VAdjIEEE import VAdjIEEE as VAdjIEEE -from .PerLengthDCLineParameter import PerLengthDCLineParameter as PerLengthDCLineParameter -from .ThermalGeneratingUnit import ThermalGeneratingUnit as ThermalGeneratingUnit -from .CoordinateSystem import CoordinateSystem as CoordinateSystem -from .GovHydroPID import GovHydroPID as GovHydroPID -from .Limit import Limit as Limit -from .ExcBBC import ExcBBC as ExcBBC -from .CurrentFlow import CurrentFlow as CurrentFlow -from .ReactivePower import ReactivePower as ReactivePower -from .FossilFuel import FossilFuel as FossilFuel -from .DCLineSegment import DCLineSegment as DCLineSegment -from .ShortCircuitRotorKind import ShortCircuitRotorKind as ShortCircuitRotorKind -from .WindType1or2UserDefined import WindType1or2UserDefined as WindType1or2UserDefined -from .InputSignalKind import InputSignalKind as InputSignalKind -from .DynamicsVersion import DynamicsVersion as DynamicsVersion -from .GovHydro3 import GovHydro3 as GovHydro3 -from .ReactiveCapabilityCurve import ReactiveCapabilityCurve as ReactiveCapabilityCurve -from .PFVArControllerType2UserDefined import PFVArControllerType2UserDefined as PFVArControllerType2UserDefined -from .TransformerControlMode import TransformerControlMode as TransformerControlMode -from .GovSteamIEEE1 import GovSteamIEEE1 as GovSteamIEEE1 -from .FrancisGovernorControlKind import FrancisGovernorControlKind as FrancisGovernorControlKind -from .TapSchedule import TapSchedule as TapSchedule -from .ExcIEEEDC4B import ExcIEEEDC4B as ExcIEEEDC4B -from .ExcIEEEST1A import ExcIEEEST1A as ExcIEEEST1A -from .ExcIEEEAC3A import ExcIEEEAC3A as ExcIEEEAC3A -from .SubLoadArea import SubLoadArea as SubLoadArea -from .AsynchronousMachine import AsynchronousMachine as AsynchronousMachine -from .PhaseTapChangerLinear import PhaseTapChangerLinear as PhaseTapChangerLinear -from .VoltageAdjusterDynamics import VoltageAdjusterDynamics as VoltageAdjusterDynamics -from .GeneratingUnit import GeneratingUnit as GeneratingUnit -from .DiscontinuousExcitationControlDynamics import DiscontinuousExcitationControlDynamics as DiscontinuousExcitationControlDynamics -from .ACDCConverterDCTerminal import ACDCConverterDCTerminal as ACDCConverterDCTerminal -from .AsynchronousMachineEquivalentCircuit import AsynchronousMachineEquivalentCircuit as AsynchronousMachineEquivalentCircuit -from .EquipmentBoundaryVersion import EquipmentBoundaryVersion as EquipmentBoundaryVersion -from .CsConverter import CsConverter as CsConverter -from .VoltageLimit import VoltageLimit as VoltageLimit -from .ExcST3A import ExcST3A as ExcST3A -from .GovSteamEU import GovSteamEU as GovSteamEU -from .BasicIntervalSchedule import BasicIntervalSchedule as BasicIntervalSchedule -from .WindContQIEC import WindContQIEC as WindContQIEC -from .Length import Length as Length -from .GovHydro1 import GovHydro1 as GovHydro1 -from .WindPlantReactiveControlIEC import WindPlantReactiveControlIEC as WindPlantReactiveControlIEC -from .AsynchronousMachineKind import AsynchronousMachineKind as AsynchronousMachineKind -from .MechLoad1 import MechLoad1 as MechLoad1 -from .AnalogControl import AnalogControl as AnalogControl -from .RaiseLowerCommand import RaiseLowerCommand as RaiseLowerCommand -from .DynamicsFunctionBlock import DynamicsFunctionBlock as DynamicsFunctionBlock -from .WindTurbineType1or2Dynamics import WindTurbineType1or2Dynamics as WindTurbineType1or2Dynamics -from .VCompIEEEType2 import VCompIEEEType2 as VCompIEEEType2 -from .OperationalLimitSet import OperationalLimitSet as OperationalLimitSet -from .PssIEEE1A import PssIEEE1A as PssIEEE1A -from .SvShuntCompensatorSections import SvShuntCompensatorSections as SvShuntCompensatorSections -from .EarthFaultCompensator import EarthFaultCompensator as EarthFaultCompensator -from .TransformerEnd import TransformerEnd as TransformerEnd -from .UnderexcLimIEEE1 import UnderexcLimIEEE1 as UnderexcLimIEEE1 -from .GovGAST2 import GovGAST2 as GovGAST2 -from .ExcSCRX import ExcSCRX as ExcSCRX -from .VolumeFlowRate import VolumeFlowRate as VolumeFlowRate -from .GovGAST4 import GovGAST4 as GovGAST4 -from .DCShunt import DCShunt as DCShunt -from .ExcAVR3 import ExcAVR3 as ExcAVR3 -from .MeasurementValue import MeasurementValue as MeasurementValue -from .VisibilityLayer import VisibilityLayer as VisibilityLayer -from .StateVariablesVersion import StateVariablesVersion as StateVariablesVersion -from .MonthDay import MonthDay as MonthDay -from .WindPlantUserDefined import WindPlantUserDefined as WindPlantUserDefined -from .MutualCoupling import MutualCoupling as MutualCoupling -from .GovHydroFrancis import GovHydroFrancis as GovHydroFrancis -from .PhaseTapChangerSymmetrical import PhaseTapChangerSymmetrical as PhaseTapChangerSymmetrical -from .TapChangerControl import TapChangerControl as TapChangerControl -from .PFVArType1IEEEPFController import PFVArType1IEEEPFController as PFVArType1IEEEPFController -from .Bay import Bay as Bay -from .GovSteam1 import GovSteam1 as GovSteam1 -from .SynchronousMachineOperatingMode import SynchronousMachineOperatingMode as SynchronousMachineOperatingMode -from .Base import Base as Base -from .NonConformLoad import NonConformLoad as NonConformLoad -from .GovCT2 import GovCT2 as GovCT2 -from .LoadGroup import LoadGroup as LoadGroup -from .DroopSignalFeedbackKind import DroopSignalFeedbackKind as DroopSignalFeedbackKind -from .WindGeneratingUnit import WindGeneratingUnit as WindGeneratingUnit -from .ActivePowerPerCurrentFlow import ActivePowerPerCurrentFlow as ActivePowerPerCurrentFlow -from .DiagramStyle import DiagramStyle as DiagramStyle -from .HydroPump import HydroPump as HydroPump -from .ExcIEEEAC2A import ExcIEEEAC2A as ExcIEEEAC2A -from .RegulatingCondEq import RegulatingCondEq as RegulatingCondEq -from .ExcAC3A import ExcAC3A as ExcAC3A -from .ExternalNetworkInjection import ExternalNetworkInjection as ExternalNetworkInjection -from .WindProtectionIEC import WindProtectionIEC as WindProtectionIEC -from .GovHydroPID2 import GovHydroPID2 as GovHydroPID2 -from .UnderexcLimX2 import UnderexcLimX2 as UnderexcLimX2 -from .SteadyStateHypothesisVersion import SteadyStateHypothesisVersion as SteadyStateHypothesisVersion -from .ExcREXS import ExcREXS as ExcREXS -from .ACLineSegment import ACLineSegment as ACLineSegment -from .Pss2ST import Pss2ST as Pss2ST -from .Connector import Connector as Connector -from .Area import Area as Area -from .DCPolarityKind import DCPolarityKind as DCPolarityKind -from .IdentifiedObject import IdentifiedObject as IdentifiedObject -from .SynchronousMachineKind import SynchronousMachineKind as SynchronousMachineKind -from .EquivalentInjection import EquivalentInjection as EquivalentInjection -from .ExcAC5A import ExcAC5A as ExcAC5A -from .DCDisconnector import DCDisconnector as DCDisconnector -from .ExcELIN1 import ExcELIN1 as ExcELIN1 -from .StringMeasurement import StringMeasurement as StringMeasurement -from .ExcDC3A1 import ExcDC3A1 as ExcDC3A1 -from .ValueAliasSet import ValueAliasSet as ValueAliasSet -from .EnergyArea import EnergyArea as EnergyArea -from .ReportingGroup import ReportingGroup as ReportingGroup -from .FuelType import FuelType as FuelType -from .Substation import Substation as Substation -from .RemoteInputSignal import RemoteInputSignal as RemoteInputSignal -from .PhaseTapChangerTabular import PhaseTapChangerTabular as PhaseTapChangerTabular -from .ExcDC2A import ExcDC2A as ExcDC2A -from .MeasurementValueQuality import MeasurementValueQuality as MeasurementValueQuality -from .OperationalLimit import OperationalLimit as OperationalLimit -from .LoadArea import LoadArea as LoadArea -from .ExcANS import ExcANS as ExcANS -from .LinearShuntCompensator import LinearShuntCompensator as LinearShuntCompensator -from .PFVArType2Common1 import PFVArType2Common1 as PFVArType2Common1 -from .ExcIEEEST2A import ExcIEEEST2A as ExcIEEEST2A -from .ExcST1A import ExcST1A as ExcST1A -from .ActivePowerLimit import ActivePowerLimit as ActivePowerLimit -from .DiagramObjectStyle import DiagramObjectStyle as DiagramObjectStyle -from .DiscontinuousExcitationControlUserDefined import DiscontinuousExcitationControlUserDefined as DiscontinuousExcitationControlUserDefined -from .RotatingMachine import RotatingMachine as RotatingMachine -from .SynchronousMachineModelKind import SynchronousMachineModelKind as SynchronousMachineModelKind -from .Boolean import Boolean as Boolean -from .ExcSEXS import ExcSEXS as ExcSEXS -from .PFVArType1IEEEVArController import PFVArType1IEEEVArController as PFVArType1IEEEVArController -from .StringMeasurementValue import StringMeasurementValue as StringMeasurementValue -from .WindPlantFreqPcontrolIEC import WindPlantFreqPcontrolIEC as WindPlantFreqPcontrolIEC -from .EquivalentShunt import EquivalentShunt as EquivalentShunt -from .InductancePerLength import InductancePerLength as InductancePerLength -from .TopologyBoundaryVersion import TopologyBoundaryVersion as TopologyBoundaryVersion -from .WindGenType4IEC import WindGenType4IEC as WindGenType4IEC -from .Reactance import Reactance as Reactance -from .VoltageAdjusterUserDefined import VoltageAdjusterUserDefined as VoltageAdjusterUserDefined -from .PowerSystemStabilizerUserDefined import PowerSystemStabilizerUserDefined as PowerSystemStabilizerUserDefined -from .WindAeroLinearIEC import WindAeroLinearIEC as WindAeroLinearIEC -from .ExcitationSystemDynamics import ExcitationSystemDynamics as ExcitationSystemDynamics -from .Command import Command as Command -from .ControlArea import ControlArea as ControlArea -from .ConnectivityNodeContainer import ConnectivityNodeContainer as ConnectivityNodeContainer -from .TapChanger import TapChanger as TapChanger -from .Conductor import Conductor as Conductor -from .PhaseTapChanger import PhaseTapChanger as PhaseTapChanger -from .ExcST6BOELselectorKind import ExcST6BOELselectorKind as ExcST6BOELselectorKind -from .EnergySource import EnergySource as EnergySource -from .LimitTypeKind import LimitTypeKind as LimitTypeKind -from .OverexcitationLimiterDynamics import OverexcitationLimiterDynamics as OverexcitationLimiterDynamics -from .TurbineGovernorDynamics import TurbineGovernorDynamics as TurbineGovernorDynamics -from .DiagramObjectPoint import DiagramObjectPoint as DiagramObjectPoint -from .SvInjection import SvInjection as SvInjection -from .CurveStyle import CurveStyle as CurveStyle -from .ActivePower import ActivePower as ActivePower -from .HydroGeneratingUnit import HydroGeneratingUnit as HydroGeneratingUnit -from .GovHydroWEH import GovHydroWEH as GovHydroWEH -from .Decimal import Decimal as Decimal -from .GovCT1 import GovCT1 as GovCT1 -from .AccumulatorLimit import AccumulatorLimit as AccumulatorLimit -from .OverexcLimIEEE import OverexcLimIEEE as OverexcLimIEEE -from .Inductance import Inductance as Inductance -from .AsynchronousMachineDynamics import AsynchronousMachineDynamics as AsynchronousMachineDynamics -from .DateTime import DateTime as DateTime -from .DCGround import DCGround as DCGround -from .EquipmentContainer import EquipmentContainer as EquipmentContainer -from .ExcST6B import ExcST6B as ExcST6B -from .ExcIEEEAC5A import ExcIEEEAC5A as ExcIEEEAC5A -from .WindType3or4UserDefined import WindType3or4UserDefined as WindType3or4UserDefined -from .PetersenCoil import PetersenCoil as PetersenCoil -from .ControlAreaGeneratingUnit import ControlAreaGeneratingUnit as ControlAreaGeneratingUnit -from .AccumulatorLimitSet import AccumulatorLimitSet as AccumulatorLimitSet -from .SolarGeneratingUnit import SolarGeneratingUnit as SolarGeneratingUnit -from .PssIEEE3B import PssIEEE3B as PssIEEE3B -from .GovSteam2 import GovSteam2 as GovSteam2 -from .GovSteamFV3 import GovSteamFV3 as GovSteamFV3 -from .SvVoltage import SvVoltage as SvVoltage -from .SeasonDayTypeSchedule import SeasonDayTypeSchedule as SeasonDayTypeSchedule -from .UnderexcitationLimiterUserDefined import UnderexcitationLimiterUserDefined as UnderexcitationLimiterUserDefined -from .PetersenCoilModeKind import PetersenCoilModeKind as PetersenCoilModeKind -from .WindLookupTableFunctionKind import WindLookupTableFunctionKind as WindLookupTableFunctionKind -from .NonConformLoadGroup import NonConformLoadGroup as NonConformLoadGroup -from .RegulatingControl import RegulatingControl as RegulatingControl -from .WindLVRTQcontrolModesKind import WindLVRTQcontrolModesKind as WindLVRTQcontrolModesKind -from .GovSteamSGO import GovSteamSGO as GovSteamSGO -from .ActivePowerPerFrequency import ActivePowerPerFrequency as ActivePowerPerFrequency -from .DCChopper import DCChopper as DCChopper -from .CurrentLimit import CurrentLimit as CurrentLimit -from .ExcAVR4 import ExcAVR4 as ExcAVR4 -from .DCBreaker import DCBreaker as DCBreaker -from .ExcIEEEST1AUELselectorKind import ExcIEEEST1AUELselectorKind as ExcIEEEST1AUELselectorKind -from .Date import Date as Date -from .Float import Float as Float -from .DiscExcContIEEEDEC3A import DiscExcContIEEEDEC3A as DiscExcContIEEEDEC3A -from .ConductingEquipment import ConductingEquipment as ConductingEquipment -from .TurbineGovernorUserDefined import TurbineGovernorUserDefined as TurbineGovernorUserDefined -from .OverexcLimX2 import OverexcLimX2 as OverexcLimX2 -from .NonlinearShuntCompensatorPoint import NonlinearShuntCompensatorPoint as NonlinearShuntCompensatorPoint -from .PFVArType2IEEEPFController import PFVArType2IEEEPFController as PFVArType2IEEEPFController -from .ExcIEEEAC1A import ExcIEEEAC1A as ExcIEEEAC1A -from .ExcAVR2 import ExcAVR2 as ExcAVR2 -from .Money import Money as Money -from .WindGenTurbineType3IEC import WindGenTurbineType3IEC as WindGenTurbineType3IEC -from .Equipment import Equipment as Equipment -from .ExcIEEEDC1A import ExcIEEEDC1A as ExcIEEEDC1A -from .UnderexcLimIEEE2 import UnderexcLimIEEE2 as UnderexcLimIEEE2 -from .VsPpccControlKind import VsPpccControlKind as VsPpccControlKind -from .LoadMotor import LoadMotor as LoadMotor -from .Pss1 import Pss1 as Pss1 -from .DiagramLayoutVersion import DiagramLayoutVersion as DiagramLayoutVersion -from .OverexcLimX1 import OverexcLimX1 as OverexcLimX1 -from .Capacitance import Capacitance as Capacitance -from .GeographicalRegion import GeographicalRegion as GeographicalRegion -from .ConformLoadSchedule import ConformLoadSchedule as ConformLoadSchedule -from .GovHydroWPID import GovHydroWPID as GovHydroWPID -from .PowerSystemResource import PowerSystemResource as PowerSystemResource -from .DCConverterOperatingModeKind import DCConverterOperatingModeKind as DCConverterOperatingModeKind -from .ExcIEEEST5B import ExcIEEEST5B as ExcIEEEST5B -from .Integer import Integer as Integer -from .ConformLoadGroup import ConformLoadGroup as ConformLoadGroup -from .AsynchronousMachineTimeConstantReactance import AsynchronousMachineTimeConstantReactance as AsynchronousMachineTimeConstantReactance -from .ExcAC6A import ExcAC6A as ExcAC6A -from .EnergyConsumer import EnergyConsumer as EnergyConsumer -from .AccumulatorReset import AccumulatorReset as AccumulatorReset -from .ExcAC4A import ExcAC4A as ExcAC4A -from .BaseVoltage import BaseVoltage as BaseVoltage -from .ControlAreaTypeKind import ControlAreaTypeKind as ControlAreaTypeKind -from .Source import Source as Source -from .Location import Location as Location -from .VoltageCompensatorDynamics import VoltageCompensatorDynamics as VoltageCompensatorDynamics -from .ExcDC1A import ExcDC1A as ExcDC1A -from .WindContPType3IEC import WindContPType3IEC as WindContPType3IEC -from .OverexcitationLimiterUserDefined import OverexcitationLimiterUserDefined as OverexcitationLimiterUserDefined -from .OperationalLimitDirectionKind import OperationalLimitDirectionKind as OperationalLimitDirectionKind -from .VsCapabilityCurve import VsCapabilityCurve as VsCapabilityCurve -from .ExcAVR1 import ExcAVR1 as ExcAVR1 -from .ExcST7BUELselectorKind import ExcST7BUELselectorKind as ExcST7BUELselectorKind -from .AngleDegrees import AngleDegrees as AngleDegrees -from .BusNameMarker import BusNameMarker as BusNameMarker -from .EquivalentNetwork import EquivalentNetwork as EquivalentNetwork -from .GovHydro2 import GovHydro2 as GovHydro2 -from .ExcitationSystemUserDefined import ExcitationSystemUserDefined as ExcitationSystemUserDefined -from .DiagramObject import DiagramObject as DiagramObject -from .VsConverter import VsConverter as VsConverter -from .DiagramObjectGluePoint import DiagramObjectGluePoint as DiagramObjectGluePoint -from .ExcST7BOELselectorKind import ExcST7BOELselectorKind as ExcST7BOELselectorKind -from .MechanicalLoadUserDefined import MechanicalLoadUserDefined as MechanicalLoadUserDefined -from .WindAeroConstIEC import WindAeroConstIEC as WindAeroConstIEC -from .Frequency import Frequency as Frequency -from .IfdBaseKind import IfdBaseKind as IfdBaseKind -from .GeneratorControlSource import GeneratorControlSource as GeneratorControlSource -from .LoadBreakSwitch import LoadBreakSwitch as LoadBreakSwitch -from .DiscExcContIEEEDEC2A import DiscExcContIEEEDEC2A as DiscExcContIEEEDEC2A -from .VsQpccControlKind import VsQpccControlKind as VsQpccControlKind -from .LoadGenericNonLinear import LoadGenericNonLinear as LoadGenericNonLinear -from .ExcHU import ExcHU as ExcHU -from .DCEquipmentContainer import DCEquipmentContainer as DCEquipmentContainer -from .DCTopologicalIsland import DCTopologicalIsland as DCTopologicalIsland -from .Season import Season as Season -from .ExcAVR5 import ExcAVR5 as ExcAVR5 -from .Seconds import Seconds as Seconds -from .WindPlantIEC import WindPlantIEC as WindPlantIEC -from .UnderexcLimX1 import UnderexcLimX1 as UnderexcLimX1 -from .DiscreteValue import DiscreteValue as DiscreteValue -from .PssELIN2 import PssELIN2 as PssELIN2 -from .TopologyVersion import TopologyVersion as TopologyVersion -from .DiscExcContIEEEDEC1A import DiscExcContIEEEDEC1A as DiscExcContIEEEDEC1A -from .UnitSymbol import UnitSymbol as UnitSymbol -from .SynchronousMachineDetailed import SynchronousMachineDetailed as SynchronousMachineDetailed -from .Voltage import Voltage as Voltage -from .GovGAST3 import GovGAST3 as GovGAST3 -from .WindGenTurbineType2IEC import WindGenTurbineType2IEC as WindGenTurbineType2IEC -from .GenICompensationForGenJ import GenICompensationForGenJ as GenICompensationForGenJ -from .ExcIEEEST7B import ExcIEEEST7B as ExcIEEEST7B -from .AnalogValue import AnalogValue as AnalogValue -from .NonlinearShuntCompensator import NonlinearShuntCompensator as NonlinearShuntCompensator -from .NonConformLoadSchedule import NonConformLoadSchedule as NonConformLoadSchedule -from .StaticVarCompensator import StaticVarCompensator as StaticVarCompensator -from .GovHydro4 import GovHydro4 as GovHydro4 -from .RatioTapChanger import RatioTapChanger as RatioTapChanger -from .ExcAC1A import ExcAC1A as ExcAC1A -from .PssIEEE2B import PssIEEE2B as PssIEEE2B -from .AngleRadians import AngleRadians as AngleRadians -from .PssSK import PssSK as PssSK -from .PFVArType2IEEEVArController import PFVArType2IEEEVArController as PFVArType2IEEEVArController -from .ACDCConverter import ACDCConverter as ACDCConverter -from .WindContPitchAngleIEC import WindContPitchAngleIEC as WindContPitchAngleIEC -from .WindGenTurbineType1IEC import WindGenTurbineType1IEC as WindGenTurbineType1IEC -from .SynchronousMachineDynamics import SynchronousMachineDynamics as SynchronousMachineDynamics -from .WindContPType4aIEC import WindContPType4aIEC as WindContPType4aIEC -from .VoltageLevel import VoltageLevel as VoltageLevel -from .OrientationKind import OrientationKind as OrientationKind -from .GroundingImpedance import GroundingImpedance as GroundingImpedance -from .DCSeriesDevice import DCSeriesDevice as DCSeriesDevice -from .PhaseCode import PhaseCode as PhaseCode -from .GovHydroDD import GovHydroDD as GovHydroDD -from .Disconnector import Disconnector as Disconnector -from .SwitchSchedule import SwitchSchedule as SwitchSchedule -from .HydroPowerPlant import HydroPowerPlant as HydroPowerPlant -from .Temperature import Temperature as Temperature -from .ConnectivityNode import ConnectivityNode as ConnectivityNode -from .ExcST2A import ExcST2A as ExcST2A -from .UnderexcLim2Simplified import UnderexcLim2Simplified as UnderexcLim2Simplified -from .Measurement import Measurement as Measurement -from .ExcIEEEAC4A import ExcIEEEAC4A as ExcIEEEAC4A -from .PU import PU as PU -from .Analog import Analog as Analog -from .WindPitchContEmulIEC import WindPitchContEmulIEC as WindPitchContEmulIEC -from .OperationalLimitType import OperationalLimitType as OperationalLimitType -from .BusbarSection import BusbarSection as BusbarSection -from .LoadAggregate import LoadAggregate as LoadAggregate -from .ExcPIC import ExcPIC as ExcPIC -from .WindTurbineType4bIEC import WindTurbineType4bIEC as WindTurbineType4bIEC -from .GrossToNetActivePowerCurve import GrossToNetActivePowerCurve as GrossToNetActivePowerCurve -from .TieFlow import TieFlow as TieFlow -from .AsynchronousMachineUserDefined import AsynchronousMachineUserDefined as AsynchronousMachineUserDefined -from .GovHydroR import GovHydroR as GovHydroR -from .StationSupply import StationSupply as StationSupply -from .WindTurbineType4aIEC import WindTurbineType4aIEC as WindTurbineType4aIEC -from .ExcAC2A import ExcAC2A as ExcAC2A -from .TextDiagramObject import TextDiagramObject as TextDiagramObject -from .RotorKind import RotorKind as RotorKind -from .LoadStatic import LoadStatic as LoadStatic -from .CurveData import CurveData as CurveData -from .RotatingMachineDynamics import RotatingMachineDynamics as RotatingMachineDynamics -from .RegularIntervalSchedule import RegularIntervalSchedule as RegularIntervalSchedule -from .SvStatus import SvStatus as SvStatus -from .DCNode import DCNode as DCNode -from .WindGenTurbineType3bIEC import WindGenTurbineType3bIEC as WindGenTurbineType3bIEC -from .ShuntCompensator import ShuntCompensator as ShuntCompensator -from .LoadDynamics import LoadDynamics as LoadDynamics -from .GenericNonLinearLoadModelKind import GenericNonLinearLoadModelKind as GenericNonLinearLoadModelKind -from .ExcIEEEAC6A import ExcIEEEAC6A as ExcIEEEAC6A -from .ACDCTerminal import ACDCTerminal as ACDCTerminal -from .ExcSK import ExcSK as ExcSK -from .LoadResponseCharacteristic import LoadResponseCharacteristic as LoadResponseCharacteristic -from .PhaseTapChangerTablePoint import PhaseTapChangerTablePoint as PhaseTapChangerTablePoint -from .WindGenTurbineType3aIEC import WindGenTurbineType3aIEC as WindGenTurbineType3aIEC -from .WindMechIEC import WindMechIEC as WindMechIEC -from .AnalogLimitSet import AnalogLimitSet as AnalogLimitSet -from .Simple_Float import Simple_Float as Simple_Float -from .ExcIEEEDC2A import ExcIEEEDC2A as ExcIEEEDC2A -from .DCConverterUnit import DCConverterUnit as DCConverterUnit -from .SynchronousMachineEquivalentCircuit import SynchronousMachineEquivalentCircuit as SynchronousMachineEquivalentCircuit -from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics as PowerSystemStabilizerDynamics -from .AnalogLimit import AnalogLimit as AnalogLimit -from .GovHydroIEEE2 import GovHydroIEEE2 as GovHydroIEEE2 -from .PssWECC import PssWECC as PssWECC -from .EquivalentBranch import EquivalentBranch as EquivalentBranch -from .SubGeographicalRegion import SubGeographicalRegion as SubGeographicalRegion -from .LoadUserDefined import LoadUserDefined as LoadUserDefined -from .PssIEEE4B import PssIEEE4B as PssIEEE4B -from .DCLine import DCLine as DCLine -from .Conductance import Conductance as Conductance -from .WindContCurrLimIEC import WindContCurrLimIEC as WindContCurrLimIEC -from .LoadComposite import LoadComposite as LoadComposite -from .SvPowerFlow import SvPowerFlow as SvPowerFlow -from .CsPpccControlKind import CsPpccControlKind as CsPpccControlKind -from .GovGASTWD import GovGASTWD as GovGASTWD -from .ProprietaryParameterDynamics import ProprietaryParameterDynamics as ProprietaryParameterDynamics -from .Discrete import Discrete as Discrete -from .ValueToAlias import ValueToAlias as ValueToAlias -from .SetPoint import SetPoint as SetPoint -from .Diagram import Diagram as Diagram -from .GeographicalLocationVersion import GeographicalLocationVersion as GeographicalLocationVersion -from .DCTopologicalNode import DCTopologicalNode as DCTopologicalNode -from .WindPlantDynamics import WindPlantDynamics as WindPlantDynamics -from .PssSH import PssSH as PssSH -from .PssPTIST3 import PssPTIST3 as PssPTIST3 -from .Pss1A import Pss1A as Pss1A -from .TopologicalNode import TopologicalNode as TopologicalNode -from .WindContPType4bIEC import WindContPType4bIEC as WindContPType4bIEC -from .PowerTransformerEnd import PowerTransformerEnd as PowerTransformerEnd -from .DayType import DayType as DayType -from .EquipmentVersion import EquipmentVersion as EquipmentVersion -from .ProtectedSwitch import ProtectedSwitch as ProtectedSwitch -from .WindQcontrolModesKind import WindQcontrolModesKind as WindQcontrolModesKind -from .RegularTimePoint import RegularTimePoint as RegularTimePoint -from .AccumulatorValue import AccumulatorValue as AccumulatorValue -from .SynchronousMachine import SynchronousMachine as SynchronousMachine -from .Validity import Validity as Validity -from .SynchronousMachineTimeConstantReactance import SynchronousMachineTimeConstantReactance as SynchronousMachineTimeConstantReactance -from .CapacitancePerLength import CapacitancePerLength as CapacitancePerLength -from .GovSteam0 import GovSteam0 as GovSteam0 -from .TurbineLoadControllerDynamics import TurbineLoadControllerDynamics as TurbineLoadControllerDynamics -from .PFVArControllerType1UserDefined import PFVArControllerType1UserDefined as PFVArControllerType1UserDefined -from .ExcIEEEST3A import ExcIEEEST3A as ExcIEEEST3A -from .Pss5 import Pss5 as Pss5 -from .PssSB4 import PssSB4 as PssSB4 -from .GovSteamCC import GovSteamCC as GovSteamCC -from .TopologicalIsland import TopologicalIsland as TopologicalIsland +from .ACDCConverter import ACDCConverter as ACDCConverter +from .ACDCConverterDCTerminal import ACDCConverterDCTerminal as ACDCConverterDCTerminal +from .ACDCTerminal import ACDCTerminal as ACDCTerminal +from .ACLineSegment import ACLineSegment as ACLineSegment +from .Accumulator import Accumulator as Accumulator +from .AccumulatorLimit import AccumulatorLimit as AccumulatorLimit +from .AccumulatorLimitSet import AccumulatorLimitSet as AccumulatorLimitSet +from .AccumulatorReset import AccumulatorReset as AccumulatorReset +from .AccumulatorValue import AccumulatorValue as AccumulatorValue +from .ActivePower import ActivePower as ActivePower +from .ActivePowerLimit import ActivePowerLimit as ActivePowerLimit +from .ActivePowerPerCurrentFlow import ActivePowerPerCurrentFlow as ActivePowerPerCurrentFlow +from .ActivePowerPerFrequency import ActivePowerPerFrequency as ActivePowerPerFrequency +from .Analog import Analog as Analog +from .AnalogControl import AnalogControl as AnalogControl +from .AnalogLimit import AnalogLimit as AnalogLimit +from .AnalogLimitSet import AnalogLimitSet as AnalogLimitSet +from .AnalogValue import AnalogValue as AnalogValue +from .AngleDegrees import AngleDegrees as AngleDegrees +from .AngleRadians import AngleRadians as AngleRadians +from .ApparentPower import ApparentPower as ApparentPower +from .ApparentPowerLimit import ApparentPowerLimit as ApparentPowerLimit +from .Area import Area as Area +from .AsynchronousMachine import AsynchronousMachine as AsynchronousMachine +from .AsynchronousMachineDynamics import AsynchronousMachineDynamics as AsynchronousMachineDynamics +from .AsynchronousMachineEquivalentCircuit import AsynchronousMachineEquivalentCircuit as AsynchronousMachineEquivalentCircuit +from .AsynchronousMachineKind import AsynchronousMachineKind as AsynchronousMachineKind +from .AsynchronousMachineTimeConstantReactance import AsynchronousMachineTimeConstantReactance as AsynchronousMachineTimeConstantReactance +from .AsynchronousMachineUserDefined import AsynchronousMachineUserDefined as AsynchronousMachineUserDefined +from .Base import Base as Base +from .BaseVoltage import BaseVoltage as BaseVoltage +from .BasicIntervalSchedule import BasicIntervalSchedule as BasicIntervalSchedule +from .Bay import Bay as Bay +from .Boolean import Boolean as Boolean +from .Breaker import Breaker as Breaker +from .BusNameMarker import BusNameMarker as BusNameMarker +from .BusbarSection import BusbarSection as BusbarSection +from .Capacitance import Capacitance as Capacitance +from .CapacitancePerLength import CapacitancePerLength as CapacitancePerLength +from .Command import Command as Command +from .Conductance import Conductance as Conductance +from .ConductingEquipment import ConductingEquipment as ConductingEquipment +from .Conductor import Conductor as Conductor +from .ConformLoad import ConformLoad as ConformLoad +from .ConformLoadGroup import ConformLoadGroup as ConformLoadGroup +from .ConformLoadSchedule import ConformLoadSchedule as ConformLoadSchedule +from .ConnectivityNode import ConnectivityNode as ConnectivityNode +from .ConnectivityNodeContainer import ConnectivityNodeContainer as ConnectivityNodeContainer +from .Connector import Connector as Connector +from .Control import Control as Control +from .ControlArea import ControlArea as ControlArea +from .ControlAreaGeneratingUnit import ControlAreaGeneratingUnit as ControlAreaGeneratingUnit +from .ControlAreaTypeKind import ControlAreaTypeKind as ControlAreaTypeKind +from .CoordinateSystem import CoordinateSystem as CoordinateSystem +from .CsConverter import CsConverter as CsConverter +from .CsOperatingModeKind import CsOperatingModeKind as CsOperatingModeKind +from .CsPpccControlKind import CsPpccControlKind as CsPpccControlKind +from .Currency import Currency as Currency +from .CurrentFlow import CurrentFlow as CurrentFlow +from .CurrentLimit import CurrentLimit as CurrentLimit +from .Curve import Curve as Curve +from .CurveData import CurveData as CurveData +from .CurveStyle import CurveStyle as CurveStyle +from .DCBaseTerminal import DCBaseTerminal as DCBaseTerminal +from .DCBreaker import DCBreaker as DCBreaker +from .DCBusbar import DCBusbar as DCBusbar +from .DCChopper import DCChopper as DCChopper +from .DCConductingEquipment import DCConductingEquipment as DCConductingEquipment +from .DCConverterOperatingModeKind import DCConverterOperatingModeKind as DCConverterOperatingModeKind +from .DCConverterUnit import DCConverterUnit as DCConverterUnit +from .DCDisconnector import DCDisconnector as DCDisconnector +from .DCEquipmentContainer import DCEquipmentContainer as DCEquipmentContainer +from .DCGround import DCGround as DCGround +from .DCLine import DCLine as DCLine +from .DCLineSegment import DCLineSegment as DCLineSegment +from .DCNode import DCNode as DCNode +from .DCPolarityKind import DCPolarityKind as DCPolarityKind +from .DCSeriesDevice import DCSeriesDevice as DCSeriesDevice +from .DCShunt import DCShunt as DCShunt +from .DCSwitch import DCSwitch as DCSwitch +from .DCTerminal import DCTerminal as DCTerminal +from .DCTopologicalIsland import DCTopologicalIsland as DCTopologicalIsland +from .DCTopologicalNode import DCTopologicalNode as DCTopologicalNode +from .Date import Date as Date +from .DateTime import DateTime as DateTime +from .DayType import DayType as DayType +from .Decimal import Decimal as Decimal +from .Diagram import Diagram as Diagram +from .DiagramLayoutVersion import DiagramLayoutVersion as DiagramLayoutVersion +from .DiagramObject import DiagramObject as DiagramObject +from .DiagramObjectGluePoint import DiagramObjectGluePoint as DiagramObjectGluePoint +from .DiagramObjectPoint import DiagramObjectPoint as DiagramObjectPoint +from .DiagramObjectStyle import DiagramObjectStyle as DiagramObjectStyle +from .DiagramStyle import DiagramStyle as DiagramStyle +from .DiscExcContIEEEDEC1A import DiscExcContIEEEDEC1A as DiscExcContIEEEDEC1A +from .DiscExcContIEEEDEC2A import DiscExcContIEEEDEC2A as DiscExcContIEEEDEC2A +from .DiscExcContIEEEDEC3A import DiscExcContIEEEDEC3A as DiscExcContIEEEDEC3A +from .Disconnector import Disconnector as Disconnector +from .DiscontinuousExcitationControlDynamics import DiscontinuousExcitationControlDynamics as DiscontinuousExcitationControlDynamics +from .DiscontinuousExcitationControlUserDefined import DiscontinuousExcitationControlUserDefined as DiscontinuousExcitationControlUserDefined +from .Discrete import Discrete as Discrete +from .DiscreteValue import DiscreteValue as DiscreteValue +from .DroopSignalFeedbackKind import DroopSignalFeedbackKind as DroopSignalFeedbackKind +from .DynamicsFunctionBlock import DynamicsFunctionBlock as DynamicsFunctionBlock +from .DynamicsVersion import DynamicsVersion as DynamicsVersion +from .EarthFaultCompensator import EarthFaultCompensator as EarthFaultCompensator +from .EnergyArea import EnergyArea as EnergyArea +from .EnergyConsumer import EnergyConsumer as EnergyConsumer +from .EnergySchedulingType import EnergySchedulingType as EnergySchedulingType +from .EnergySource import EnergySource as EnergySource +from .Equipment import Equipment as Equipment +from .EquipmentBoundaryVersion import EquipmentBoundaryVersion as EquipmentBoundaryVersion +from .EquipmentContainer import EquipmentContainer as EquipmentContainer +from .EquipmentVersion import EquipmentVersion as EquipmentVersion +from .EquivalentBranch import EquivalentBranch as EquivalentBranch +from .EquivalentEquipment import EquivalentEquipment as EquivalentEquipment +from .EquivalentInjection import EquivalentInjection as EquivalentInjection +from .EquivalentNetwork import EquivalentNetwork as EquivalentNetwork +from .EquivalentShunt import EquivalentShunt as EquivalentShunt +from .ExcAC1A import ExcAC1A as ExcAC1A +from .ExcAC2A import ExcAC2A as ExcAC2A +from .ExcAC3A import ExcAC3A as ExcAC3A +from .ExcAC4A import ExcAC4A as ExcAC4A +from .ExcAC5A import ExcAC5A as ExcAC5A +from .ExcAC6A import ExcAC6A as ExcAC6A +from .ExcAC8B import ExcAC8B as ExcAC8B +from .ExcANS import ExcANS as ExcANS +from .ExcAVR1 import ExcAVR1 as ExcAVR1 +from .ExcAVR2 import ExcAVR2 as ExcAVR2 +from .ExcAVR3 import ExcAVR3 as ExcAVR3 +from .ExcAVR4 import ExcAVR4 as ExcAVR4 +from .ExcAVR5 import ExcAVR5 as ExcAVR5 +from .ExcAVR7 import ExcAVR7 as ExcAVR7 +from .ExcBBC import ExcBBC as ExcBBC +from .ExcCZ import ExcCZ as ExcCZ +from .ExcDC1A import ExcDC1A as ExcDC1A +from .ExcDC2A import ExcDC2A as ExcDC2A +from .ExcDC3A import ExcDC3A as ExcDC3A +from .ExcDC3A1 import ExcDC3A1 as ExcDC3A1 +from .ExcELIN1 import ExcELIN1 as ExcELIN1 +from .ExcELIN2 import ExcELIN2 as ExcELIN2 +from .ExcHU import ExcHU as ExcHU +from .ExcIEEEAC1A import ExcIEEEAC1A as ExcIEEEAC1A +from .ExcIEEEAC2A import ExcIEEEAC2A as ExcIEEEAC2A +from .ExcIEEEAC3A import ExcIEEEAC3A as ExcIEEEAC3A +from .ExcIEEEAC4A import ExcIEEEAC4A as ExcIEEEAC4A +from .ExcIEEEAC5A import ExcIEEEAC5A as ExcIEEEAC5A +from .ExcIEEEAC6A import ExcIEEEAC6A as ExcIEEEAC6A +from .ExcIEEEAC7B import ExcIEEEAC7B as ExcIEEEAC7B +from .ExcIEEEAC8B import ExcIEEEAC8B as ExcIEEEAC8B +from .ExcIEEEDC1A import ExcIEEEDC1A as ExcIEEEDC1A +from .ExcIEEEDC2A import ExcIEEEDC2A as ExcIEEEDC2A +from .ExcIEEEDC3A import ExcIEEEDC3A as ExcIEEEDC3A +from .ExcIEEEDC4B import ExcIEEEDC4B as ExcIEEEDC4B +from .ExcIEEEST1A import ExcIEEEST1A as ExcIEEEST1A +from .ExcIEEEST1AUELselectorKind import ExcIEEEST1AUELselectorKind as ExcIEEEST1AUELselectorKind +from .ExcIEEEST2A import ExcIEEEST2A as ExcIEEEST2A +from .ExcIEEEST3A import ExcIEEEST3A as ExcIEEEST3A +from .ExcIEEEST4B import ExcIEEEST4B as ExcIEEEST4B +from .ExcIEEEST5B import ExcIEEEST5B as ExcIEEEST5B +from .ExcIEEEST6B import ExcIEEEST6B as ExcIEEEST6B +from .ExcIEEEST7B import ExcIEEEST7B as ExcIEEEST7B +from .ExcOEX3T import ExcOEX3T as ExcOEX3T +from .ExcPIC import ExcPIC as ExcPIC +from .ExcREXS import ExcREXS as ExcREXS +from .ExcREXSFeedbackSignalKind import ExcREXSFeedbackSignalKind as ExcREXSFeedbackSignalKind +from .ExcSCRX import ExcSCRX as ExcSCRX +from .ExcSEXS import ExcSEXS as ExcSEXS +from .ExcSK import ExcSK as ExcSK +from .ExcST1A import ExcST1A as ExcST1A +from .ExcST2A import ExcST2A as ExcST2A +from .ExcST3A import ExcST3A as ExcST3A +from .ExcST4B import ExcST4B as ExcST4B +from .ExcST6B import ExcST6B as ExcST6B +from .ExcST6BOELselectorKind import ExcST6BOELselectorKind as ExcST6BOELselectorKind +from .ExcST7B import ExcST7B as ExcST7B +from .ExcST7BOELselectorKind import ExcST7BOELselectorKind as ExcST7BOELselectorKind +from .ExcST7BUELselectorKind import ExcST7BUELselectorKind as ExcST7BUELselectorKind +from .ExcitationSystemDynamics import ExcitationSystemDynamics as ExcitationSystemDynamics +from .ExcitationSystemUserDefined import ExcitationSystemUserDefined as ExcitationSystemUserDefined +from .ExternalNetworkInjection import ExternalNetworkInjection as ExternalNetworkInjection +from .Float import Float as Float +from .FossilFuel import FossilFuel as FossilFuel +from .FrancisGovernorControlKind import FrancisGovernorControlKind as FrancisGovernorControlKind +from .Frequency import Frequency as Frequency +from .FuelType import FuelType as FuelType +from .GenICompensationForGenJ import GenICompensationForGenJ as GenICompensationForGenJ +from .GeneratingUnit import GeneratingUnit as GeneratingUnit +from .GeneratorControlSource import GeneratorControlSource as GeneratorControlSource +from .GenericNonLinearLoadModelKind import GenericNonLinearLoadModelKind as GenericNonLinearLoadModelKind +from .GeographicalLocationVersion import GeographicalLocationVersion as GeographicalLocationVersion +from .GeographicalRegion import GeographicalRegion as GeographicalRegion +from .GovCT1 import GovCT1 as GovCT1 +from .GovCT2 import GovCT2 as GovCT2 +from .GovGAST import GovGAST as GovGAST +from .GovGAST1 import GovGAST1 as GovGAST1 +from .GovGAST2 import GovGAST2 as GovGAST2 +from .GovGAST3 import GovGAST3 as GovGAST3 +from .GovGAST4 import GovGAST4 as GovGAST4 +from .GovGASTWD import GovGASTWD as GovGASTWD +from .GovHydro1 import GovHydro1 as GovHydro1 +from .GovHydro2 import GovHydro2 as GovHydro2 +from .GovHydro3 import GovHydro3 as GovHydro3 +from .GovHydro4 import GovHydro4 as GovHydro4 +from .GovHydroDD import GovHydroDD as GovHydroDD +from .GovHydroFrancis import GovHydroFrancis as GovHydroFrancis +from .GovHydroIEEE0 import GovHydroIEEE0 as GovHydroIEEE0 +from .GovHydroIEEE2 import GovHydroIEEE2 as GovHydroIEEE2 +from .GovHydroPID import GovHydroPID as GovHydroPID +from .GovHydroPID2 import GovHydroPID2 as GovHydroPID2 +from .GovHydroPelton import GovHydroPelton as GovHydroPelton +from .GovHydroR import GovHydroR as GovHydroR +from .GovHydroWEH import GovHydroWEH as GovHydroWEH +from .GovHydroWPID import GovHydroWPID as GovHydroWPID +from .GovSteam0 import GovSteam0 as GovSteam0 +from .GovSteam1 import GovSteam1 as GovSteam1 +from .GovSteam2 import GovSteam2 as GovSteam2 +from .GovSteamCC import GovSteamCC as GovSteamCC +from .GovSteamEU import GovSteamEU as GovSteamEU +from .GovSteamFV2 import GovSteamFV2 as GovSteamFV2 +from .GovSteamFV3 import GovSteamFV3 as GovSteamFV3 +from .GovSteamFV4 import GovSteamFV4 as GovSteamFV4 +from .GovSteamIEEE1 import GovSteamIEEE1 as GovSteamIEEE1 +from .GovSteamSGO import GovSteamSGO as GovSteamSGO +from .GrossToNetActivePowerCurve import GrossToNetActivePowerCurve as GrossToNetActivePowerCurve +from .Ground import Ground as Ground +from .GroundDisconnector import GroundDisconnector as GroundDisconnector +from .GroundingImpedance import GroundingImpedance as GroundingImpedance +from .HydroEnergyConversionKind import HydroEnergyConversionKind as HydroEnergyConversionKind +from .HydroGeneratingUnit import HydroGeneratingUnit as HydroGeneratingUnit +from .HydroPlantStorageKind import HydroPlantStorageKind as HydroPlantStorageKind +from .HydroPowerPlant import HydroPowerPlant as HydroPowerPlant +from .HydroPump import HydroPump as HydroPump +from .IdentifiedObject import IdentifiedObject as IdentifiedObject +from .IfdBaseKind import IfdBaseKind as IfdBaseKind +from .Inductance import Inductance as Inductance +from .InductancePerLength import InductancePerLength as InductancePerLength +from .InputSignalKind import InputSignalKind as InputSignalKind +from .Integer import Integer as Integer +from .Junction import Junction as Junction +from .Length import Length as Length +from .Limit import Limit as Limit +from .LimitSet import LimitSet as LimitSet +from .LimitTypeKind import LimitTypeKind as LimitTypeKind +from .Line import Line as Line +from .LinearShuntCompensator import LinearShuntCompensator as LinearShuntCompensator +from .LoadAggregate import LoadAggregate as LoadAggregate +from .LoadArea import LoadArea as LoadArea +from .LoadBreakSwitch import LoadBreakSwitch as LoadBreakSwitch +from .LoadComposite import LoadComposite as LoadComposite +from .LoadDynamics import LoadDynamics as LoadDynamics +from .LoadGenericNonLinear import LoadGenericNonLinear as LoadGenericNonLinear +from .LoadGroup import LoadGroup as LoadGroup +from .LoadMotor import LoadMotor as LoadMotor +from .LoadResponseCharacteristic import LoadResponseCharacteristic as LoadResponseCharacteristic +from .LoadStatic import LoadStatic as LoadStatic +from .LoadUserDefined import LoadUserDefined as LoadUserDefined +from .Location import Location as Location +from .Measurement import Measurement as Measurement +from .MeasurementValue import MeasurementValue as MeasurementValue +from .MeasurementValueQuality import MeasurementValueQuality as MeasurementValueQuality +from .MeasurementValueSource import MeasurementValueSource as MeasurementValueSource +from .MechLoad1 import MechLoad1 as MechLoad1 +from .MechanicalLoadDynamics import MechanicalLoadDynamics as MechanicalLoadDynamics +from .MechanicalLoadUserDefined import MechanicalLoadUserDefined as MechanicalLoadUserDefined +from .Money import Money as Money +from .MonthDay import MonthDay as MonthDay +from .MutualCoupling import MutualCoupling as MutualCoupling +from .NonConformLoad import NonConformLoad as NonConformLoad +from .NonConformLoadGroup import NonConformLoadGroup as NonConformLoadGroup +from .NonConformLoadSchedule import NonConformLoadSchedule as NonConformLoadSchedule +from .NonlinearShuntCompensator import NonlinearShuntCompensator as NonlinearShuntCompensator +from .NonlinearShuntCompensatorPoint import NonlinearShuntCompensatorPoint as NonlinearShuntCompensatorPoint +from .NuclearGeneratingUnit import NuclearGeneratingUnit as NuclearGeneratingUnit +from .OperationalLimit import OperationalLimit as OperationalLimit +from .OperationalLimitDirectionKind import OperationalLimitDirectionKind as OperationalLimitDirectionKind +from .OperationalLimitSet import OperationalLimitSet as OperationalLimitSet +from .OperationalLimitType import OperationalLimitType as OperationalLimitType +from .OrientationKind import OrientationKind as OrientationKind +from .OverexcLim2 import OverexcLim2 as OverexcLim2 +from .OverexcLimIEEE import OverexcLimIEEE as OverexcLimIEEE +from .OverexcLimX1 import OverexcLimX1 as OverexcLimX1 +from .OverexcLimX2 import OverexcLimX2 as OverexcLimX2 +from .OverexcitationLimiterDynamics import OverexcitationLimiterDynamics as OverexcitationLimiterDynamics +from .OverexcitationLimiterUserDefined import OverexcitationLimiterUserDefined as OverexcitationLimiterUserDefined +from .PFVArControllerType1Dynamics import PFVArControllerType1Dynamics as PFVArControllerType1Dynamics +from .PFVArControllerType1UserDefined import PFVArControllerType1UserDefined as PFVArControllerType1UserDefined +from .PFVArControllerType2Dynamics import PFVArControllerType2Dynamics as PFVArControllerType2Dynamics +from .PFVArControllerType2UserDefined import PFVArControllerType2UserDefined as PFVArControllerType2UserDefined +from .PFVArType1IEEEPFController import PFVArType1IEEEPFController as PFVArType1IEEEPFController +from .PFVArType1IEEEVArController import PFVArType1IEEEVArController as PFVArType1IEEEVArController +from .PFVArType2Common1 import PFVArType2Common1 as PFVArType2Common1 +from .PFVArType2IEEEPFController import PFVArType2IEEEPFController as PFVArType2IEEEPFController +from .PFVArType2IEEEVArController import PFVArType2IEEEVArController as PFVArType2IEEEVArController +from .PU import PU as PU +from .PerCent import PerCent as PerCent +from .PerLengthDCLineParameter import PerLengthDCLineParameter as PerLengthDCLineParameter +from .PetersenCoil import PetersenCoil as PetersenCoil +from .PetersenCoilModeKind import PetersenCoilModeKind as PetersenCoilModeKind +from .PhaseCode import PhaseCode as PhaseCode +from .PhaseTapChanger import PhaseTapChanger as PhaseTapChanger +from .PhaseTapChangerAsymmetrical import PhaseTapChangerAsymmetrical as PhaseTapChangerAsymmetrical +from .PhaseTapChangerLinear import PhaseTapChangerLinear as PhaseTapChangerLinear +from .PhaseTapChangerNonLinear import PhaseTapChangerNonLinear as PhaseTapChangerNonLinear +from .PhaseTapChangerSymmetrical import PhaseTapChangerSymmetrical as PhaseTapChangerSymmetrical +from .PhaseTapChangerTable import PhaseTapChangerTable as PhaseTapChangerTable +from .PhaseTapChangerTablePoint import PhaseTapChangerTablePoint as PhaseTapChangerTablePoint +from .PhaseTapChangerTabular import PhaseTapChangerTabular as PhaseTapChangerTabular +from .PositionPoint import PositionPoint as PositionPoint +from .PowerSystemResource import PowerSystemResource as PowerSystemResource +from .PowerSystemStabilizerDynamics import PowerSystemStabilizerDynamics as PowerSystemStabilizerDynamics +from .PowerSystemStabilizerUserDefined import PowerSystemStabilizerUserDefined as PowerSystemStabilizerUserDefined +from .PowerTransformer import PowerTransformer as PowerTransformer +from .PowerTransformerEnd import PowerTransformerEnd as PowerTransformerEnd +from .ProprietaryParameterDynamics import ProprietaryParameterDynamics as ProprietaryParameterDynamics +from .ProtectedSwitch import ProtectedSwitch as ProtectedSwitch +from .Pss1 import Pss1 as Pss1 +from .Pss1A import Pss1A as Pss1A +from .Pss2B import Pss2B as Pss2B +from .Pss2ST import Pss2ST as Pss2ST +from .Pss5 import Pss5 as Pss5 +from .PssELIN2 import PssELIN2 as PssELIN2 +from .PssIEEE1A import PssIEEE1A as PssIEEE1A +from .PssIEEE2B import PssIEEE2B as PssIEEE2B +from .PssIEEE3B import PssIEEE3B as PssIEEE3B +from .PssIEEE4B import PssIEEE4B as PssIEEE4B +from .PssPTIST1 import PssPTIST1 as PssPTIST1 +from .PssPTIST3 import PssPTIST3 as PssPTIST3 +from .PssSB4 import PssSB4 as PssSB4 +from .PssSH import PssSH as PssSH +from .PssSK import PssSK as PssSK +from .PssWECC import PssWECC as PssWECC +from .Quality61850 import Quality61850 as Quality61850 +from .RaiseLowerCommand import RaiseLowerCommand as RaiseLowerCommand +from .RatioTapChanger import RatioTapChanger as RatioTapChanger +from .RatioTapChangerTable import RatioTapChangerTable as RatioTapChangerTable +from .RatioTapChangerTablePoint import RatioTapChangerTablePoint as RatioTapChangerTablePoint +from .Reactance import Reactance as Reactance +from .ReactiveCapabilityCurve import ReactiveCapabilityCurve as ReactiveCapabilityCurve +from .ReactivePower import ReactivePower as ReactivePower +from .RegularIntervalSchedule import RegularIntervalSchedule as RegularIntervalSchedule +from .RegularTimePoint import RegularTimePoint as RegularTimePoint +from .RegulatingCondEq import RegulatingCondEq as RegulatingCondEq +from .RegulatingControl import RegulatingControl as RegulatingControl +from .RegulatingControlModeKind import RegulatingControlModeKind as RegulatingControlModeKind +from .RegulationSchedule import RegulationSchedule as RegulationSchedule +from .RemoteInputSignal import RemoteInputSignal as RemoteInputSignal +from .RemoteSignalKind import RemoteSignalKind as RemoteSignalKind +from .ReportingGroup import ReportingGroup as ReportingGroup +from .Resistance import Resistance as Resistance +from .ResistancePerLength import ResistancePerLength as ResistancePerLength +from .RotatingMachine import RotatingMachine as RotatingMachine +from .RotatingMachineDynamics import RotatingMachineDynamics as RotatingMachineDynamics +from .RotationSpeed import RotationSpeed as RotationSpeed +from .RotorKind import RotorKind as RotorKind +from .SVCControlMode import SVCControlMode as SVCControlMode +from .Season import Season as Season +from .SeasonDayTypeSchedule import SeasonDayTypeSchedule as SeasonDayTypeSchedule +from .Seconds import Seconds as Seconds +from .SeriesCompensator import SeriesCompensator as SeriesCompensator +from .SetPoint import SetPoint as SetPoint +from .ShortCircuitRotorKind import ShortCircuitRotorKind as ShortCircuitRotorKind +from .ShuntCompensator import ShuntCompensator as ShuntCompensator +from .Simple_Float import Simple_Float as Simple_Float +from .SolarGeneratingUnit import SolarGeneratingUnit as SolarGeneratingUnit +from .Source import Source as Source +from .StateVariablesVersion import StateVariablesVersion as StateVariablesVersion +from .StaticLoadModelKind import StaticLoadModelKind as StaticLoadModelKind +from .StaticVarCompensator import StaticVarCompensator as StaticVarCompensator +from .StationSupply import StationSupply as StationSupply +from .SteadyStateHypothesisVersion import SteadyStateHypothesisVersion as SteadyStateHypothesisVersion +from .StringMeasurement import StringMeasurement as StringMeasurement +from .StringMeasurementValue import StringMeasurementValue as StringMeasurementValue +from .SubGeographicalRegion import SubGeographicalRegion as SubGeographicalRegion +from .SubLoadArea import SubLoadArea as SubLoadArea +from .Substation import Substation as Substation +from .Susceptance import Susceptance as Susceptance +from .SvInjection import SvInjection as SvInjection +from .SvPowerFlow import SvPowerFlow as SvPowerFlow +from .SvShuntCompensatorSections import SvShuntCompensatorSections as SvShuntCompensatorSections +from .SvStatus import SvStatus as SvStatus +from .SvTapStep import SvTapStep as SvTapStep +from .SvVoltage import SvVoltage as SvVoltage +from .Switch import Switch as Switch +from .SwitchSchedule import SwitchSchedule as SwitchSchedule +from .SynchronousMachine import SynchronousMachine as SynchronousMachine +from .SynchronousMachineDetailed import SynchronousMachineDetailed as SynchronousMachineDetailed +from .SynchronousMachineDynamics import SynchronousMachineDynamics as SynchronousMachineDynamics +from .SynchronousMachineEquivalentCircuit import SynchronousMachineEquivalentCircuit as SynchronousMachineEquivalentCircuit +from .SynchronousMachineKind import SynchronousMachineKind as SynchronousMachineKind +from .SynchronousMachineModelKind import SynchronousMachineModelKind as SynchronousMachineModelKind +from .SynchronousMachineOperatingMode import SynchronousMachineOperatingMode as SynchronousMachineOperatingMode +from .SynchronousMachineSimplified import SynchronousMachineSimplified as SynchronousMachineSimplified +from .SynchronousMachineTimeConstantReactance import SynchronousMachineTimeConstantReactance as SynchronousMachineTimeConstantReactance +from .SynchronousMachineUserDefined import SynchronousMachineUserDefined as SynchronousMachineUserDefined +from .TapChanger import TapChanger as TapChanger +from .TapChangerControl import TapChangerControl as TapChangerControl +from .TapChangerTablePoint import TapChangerTablePoint as TapChangerTablePoint +from .TapSchedule import TapSchedule as TapSchedule +from .Temperature import Temperature as Temperature +from .Terminal import Terminal as Terminal +from .TextDiagramObject import TextDiagramObject as TextDiagramObject +from .ThermalGeneratingUnit import ThermalGeneratingUnit as ThermalGeneratingUnit +from .TieFlow import TieFlow as TieFlow +from .TopologicalIsland import TopologicalIsland as TopologicalIsland +from .TopologicalNode import TopologicalNode as TopologicalNode +from .TopologyBoundaryVersion import TopologyBoundaryVersion as TopologyBoundaryVersion +from .TopologyVersion import TopologyVersion as TopologyVersion +from .TransformerControlMode import TransformerControlMode as TransformerControlMode +from .TransformerEnd import TransformerEnd as TransformerEnd +from .TurbLCFB1 import TurbLCFB1 as TurbLCFB1 +from .TurbineGovernorDynamics import TurbineGovernorDynamics as TurbineGovernorDynamics +from .TurbineGovernorUserDefined import TurbineGovernorUserDefined as TurbineGovernorUserDefined +from .TurbineLoadControllerDynamics import TurbineLoadControllerDynamics as TurbineLoadControllerDynamics +from .TurbineLoadControllerUserDefined import TurbineLoadControllerUserDefined as TurbineLoadControllerUserDefined +from .UnderexcLim2Simplified import UnderexcLim2Simplified as UnderexcLim2Simplified +from .UnderexcLimIEEE1 import UnderexcLimIEEE1 as UnderexcLimIEEE1 +from .UnderexcLimIEEE2 import UnderexcLimIEEE2 as UnderexcLimIEEE2 +from .UnderexcLimX1 import UnderexcLimX1 as UnderexcLimX1 +from .UnderexcLimX2 import UnderexcLimX2 as UnderexcLimX2 +from .UnderexcitationLimiterDynamics import UnderexcitationLimiterDynamics as UnderexcitationLimiterDynamics +from .UnderexcitationLimiterUserDefined import UnderexcitationLimiterUserDefined as UnderexcitationLimiterUserDefined +from .UnitMultiplier import UnitMultiplier as UnitMultiplier +from .UnitSymbol import UnitSymbol as UnitSymbol +from .VAdjIEEE import VAdjIEEE as VAdjIEEE +from .VCompIEEEType1 import VCompIEEEType1 as VCompIEEEType1 +from .VCompIEEEType2 import VCompIEEEType2 as VCompIEEEType2 +from .Validity import Validity as Validity +from .ValueAliasSet import ValueAliasSet as ValueAliasSet +from .ValueToAlias import ValueToAlias as ValueToAlias +from .VisibilityLayer import VisibilityLayer as VisibilityLayer +from .Voltage import Voltage as Voltage +from .VoltageAdjusterDynamics import VoltageAdjusterDynamics as VoltageAdjusterDynamics +from .VoltageAdjusterUserDefined import VoltageAdjusterUserDefined as VoltageAdjusterUserDefined +from .VoltageCompensatorDynamics import VoltageCompensatorDynamics as VoltageCompensatorDynamics +from .VoltageCompensatorUserDefined import VoltageCompensatorUserDefined as VoltageCompensatorUserDefined +from .VoltageLevel import VoltageLevel as VoltageLevel +from .VoltageLimit import VoltageLimit as VoltageLimit +from .VoltagePerReactivePower import VoltagePerReactivePower as VoltagePerReactivePower +from .VolumeFlowRate import VolumeFlowRate as VolumeFlowRate +from .VsCapabilityCurve import VsCapabilityCurve as VsCapabilityCurve +from .VsConverter import VsConverter as VsConverter +from .VsPpccControlKind import VsPpccControlKind as VsPpccControlKind +from .VsQpccControlKind import VsQpccControlKind as VsQpccControlKind +from .WindAeroConstIEC import WindAeroConstIEC as WindAeroConstIEC +from .WindAeroLinearIEC import WindAeroLinearIEC as WindAeroLinearIEC +from .WindContCurrLimIEC import WindContCurrLimIEC as WindContCurrLimIEC +from .WindContPType3IEC import WindContPType3IEC as WindContPType3IEC +from .WindContPType4aIEC import WindContPType4aIEC as WindContPType4aIEC +from .WindContPType4bIEC import WindContPType4bIEC as WindContPType4bIEC +from .WindContPitchAngleIEC import WindContPitchAngleIEC as WindContPitchAngleIEC +from .WindContQIEC import WindContQIEC as WindContQIEC +from .WindContRotorRIEC import WindContRotorRIEC as WindContRotorRIEC +from .WindDynamicsLookupTable import WindDynamicsLookupTable as WindDynamicsLookupTable +from .WindGenTurbineType1IEC import WindGenTurbineType1IEC as WindGenTurbineType1IEC +from .WindGenTurbineType2IEC import WindGenTurbineType2IEC as WindGenTurbineType2IEC +from .WindGenTurbineType3IEC import WindGenTurbineType3IEC as WindGenTurbineType3IEC +from .WindGenTurbineType3aIEC import WindGenTurbineType3aIEC as WindGenTurbineType3aIEC +from .WindGenTurbineType3bIEC import WindGenTurbineType3bIEC as WindGenTurbineType3bIEC +from .WindGenType4IEC import WindGenType4IEC as WindGenType4IEC +from .WindGenUnitKind import WindGenUnitKind as WindGenUnitKind +from .WindGeneratingUnit import WindGeneratingUnit as WindGeneratingUnit +from .WindLVRTQcontrolModesKind import WindLVRTQcontrolModesKind as WindLVRTQcontrolModesKind +from .WindLookupTableFunctionKind import WindLookupTableFunctionKind as WindLookupTableFunctionKind +from .WindMechIEC import WindMechIEC as WindMechIEC +from .WindPitchContEmulIEC import WindPitchContEmulIEC as WindPitchContEmulIEC +from .WindPlantDynamics import WindPlantDynamics as WindPlantDynamics +from .WindPlantFreqPcontrolIEC import WindPlantFreqPcontrolIEC as WindPlantFreqPcontrolIEC +from .WindPlantIEC import WindPlantIEC as WindPlantIEC +from .WindPlantReactiveControlIEC import WindPlantReactiveControlIEC as WindPlantReactiveControlIEC +from .WindPlantUserDefined import WindPlantUserDefined as WindPlantUserDefined +from .WindProtectionIEC import WindProtectionIEC as WindProtectionIEC +from .WindQcontrolModesKind import WindQcontrolModesKind as WindQcontrolModesKind +from .WindTurbineType1or2Dynamics import WindTurbineType1or2Dynamics as WindTurbineType1or2Dynamics +from .WindTurbineType1or2IEC import WindTurbineType1or2IEC as WindTurbineType1or2IEC +from .WindTurbineType3or4Dynamics import WindTurbineType3or4Dynamics as WindTurbineType3or4Dynamics +from .WindTurbineType3or4IEC import WindTurbineType3or4IEC as WindTurbineType3or4IEC +from .WindTurbineType4aIEC import WindTurbineType4aIEC as WindTurbineType4aIEC +from .WindTurbineType4bIEC import WindTurbineType4bIEC as WindTurbineType4bIEC +from .WindType1or2UserDefined import WindType1or2UserDefined as WindType1or2UserDefined +from .WindType3or4UserDefined import WindType3or4UserDefined as WindType3or4UserDefined +from .WindingConnection import WindingConnection as WindingConnection diff --git a/cimpy/cimexport.py b/cimpy/cimexport.py index 97795962..1bbec059 100644 --- a/cimpy/cimexport.py +++ b/cimpy/cimexport.py @@ -6,12 +6,8 @@ import importlib import logging import os +from cimpy.cgmes_v2_4_15.CGMESProfile import Profile -from cimpy.cgmes_v2_4_15.Base import Profile -from cimpy.cgmes_v2_4_15.Base import Base - - -cgmesProfile = Base.cgmesProfile logger = logging.getLogger(__name__) @@ -43,7 +39,7 @@ def _get_reference_uuid(attr_dict, version, topology, mRID, urls): base_module = importlib.import_module(base_class_name) base_class = getattr(base_module, "Base") for key in attr_dict: - if key in ["serializationProfile", "possibleProfileList"]: + if key in ["serializationProfile", "possibleProfileList", "recommendedClassProfile"]: reference_list.append({key: attr_dict[key]}) continue @@ -170,9 +166,10 @@ def _create_namespaces_list(namespaces_dict): # This function sorts the classes and their attributes to the corresponding profiles. Either the classes/attributes are # imported or they are set afterwards. In the first case the serializationProfile is used to determine from which # profile this class/attribute was read. If an entry exists the class/attribute is added to this profile. In the -# possibleProfileList dictionary the possible origins of the class/attributes is stored. All profiles have a different -# priority which is stored in the enum cgmesProfile. As default the smallest entry in the dictionary is used to -# determine the profile for the class/attributes. +# possibleProfileList dictionary the possible origins of the class/attributes is stored. +# If the profile is not found for a class in possibleProfileList the recommended class profile is used. +# If it is not found for an attribute the class profile is used, but only if this is a possible profile for this +# attribute. Otherwise, the first entry in the list of possible profiles for this attribute is used. def _sort_classes_to_profile(class_attributes_list, activeProfileList): export_dict = {} export_about_dict = {} @@ -187,6 +184,7 @@ def _sort_classes_to_profile(class_attributes_list, activeProfileList): # of same class, only last origin of variable stored serialization_profile = copy.deepcopy(klass["attributes"][0]["serializationProfile"]) possible_profile_list = copy.deepcopy(klass["attributes"][1]["possibleProfileList"]) + recommended_class_profile = klass["attributes"][2]["recommendedClassProfile"] class_serialization_profile = "" @@ -217,9 +215,13 @@ def _sort_classes_to_profile(class_attributes_list, activeProfileList): # Class was created if klass["name"] in possible_profile_list.keys(): if "class" in possible_profile_list[klass["name"]].keys(): - possible_profile_list[klass["name"]]["class"].sort() - for klass_profile in possible_profile_list[klass["name"]]["class"]: - if Profile(klass_profile).name in activeProfileList: + # Sort recommended profile to first place + sorted_profiles = sorted( + possible_profile_list[klass["name"]]["class"], + key=lambda x: x == recommended_class_profile and -1 or x, + ) + for klass_profile in sorted_profiles: + if Profile(klass_profile) in activeProfileList: # Active profile for class export found class_serialization_profile = Profile(klass_profile).name break @@ -258,8 +260,12 @@ def _sort_classes_to_profile(class_attributes_list, activeProfileList): # Attribute was added if attribute_class in possible_profile_list.keys(): if attribute_name in possible_profile_list[attribute_class].keys(): - possible_profile_list[attribute_class][attribute_name].sort() - for attr_profile in possible_profile_list[attribute_class][attribute_name]: + # Sort class profile to first place + sorted_profiles = sorted( + possible_profile_list[attribute_class][attribute_name], + key=lambda x: x == Profile[class_serialization_profile].value and -1 or x, + ) + for attr_profile in sorted_profiles: if Profile(attr_profile) in activeProfileList: # Active profile for class export found attribute_serialization_profile = Profile(attr_profile).name @@ -328,7 +334,29 @@ def _sort_classes_to_profile(class_attributes_list, activeProfileList): return export_dict, export_about_dict -def cim_export(import_result, file_name, version, activeProfileList): +def cim_export_to_string_array(import_result, model_name, version, activeProfileList=()): + """Function for serialization of cgmes classes to a list of strings + + See :func:`~cimpy.cimexport.cim_export()` for details. + + :param import_result: a dictionary containing the topology and meta information. It can be created via \ + :func:`~cimpy.cimimport.cim_import()` + :param model_name: a string with the name of the model. + :param version: cgmes version, e.g. ``version="cgmes_v2_4_15"`` + :param activeProfileList: a list containing the strings of all short names of the profiles \ + used for serialization, no activeProfileList means output to all profile files with data + :return: a list of strings with the CIM RDF/XML data + """ + result = [] + profile_list = list(map(lambda a: Profile[a], activeProfileList)) + for profile in profile_list or [p for p in Profile]: + output = generate_xml(import_result, version, model_name, profile, profile_list) + if output: + result.append(output) + return result + + +def cim_export(import_result, file_name, version, activeProfileList=()): """Function for serialization of cgmes classes This function serializes cgmes classes with the template engine chevron. The classes are separated by their profile @@ -341,13 +369,14 @@ def cim_export(import_result, file_name, version, activeProfileList): The meta information can be extracted via import_result['meta_info']. The meta_info dictionary contains a new \ dictionary with the keys: 'author', 'namespaces' and 'urls'. The last two are also dictionaries. \ 'urls' contains a mapping between references to URLs and the extracted value of the URL, e.g. 'absoluteValue': \ - 'http://iec.ch/TC57/2012/CIM-schema-cim16#OperationalLimitDirectionKind.absoluteValue' These mappings are \ + 'http://iec.ch/TC57/2012/CIM-schema-cim16#OperationalLimitDirectionKind.absoluteValue'. These mappings are \ accessible via the name of the attribute, \ e.g. import_result['meta_info']['urls'}[attr_name] = {mapping like example above}. \ 'namespaces' is a dictionary containing all RDF namespaces used in the imported xml files. :param file_name: a string with the name of the xml files which will be created - :param version: cgmes version, e.g. version = "cgmes_v2_4_15" - :param activeProfileList: a list containing the strings of all short names of the profiles used for serialization + :param version: cgmes version, e.g. ``version="cgmes_v2_4_15"`` + :param activeProfileList: a list containing the strings of all short names of the profiles \ + used for serialization, no activeProfileList means output to all profile files with data """ t0 = time() @@ -356,18 +385,17 @@ def cim_export(import_result, file_name, version, activeProfileList): profile_list = list(map(lambda a: Profile[a], activeProfileList)) # Iterate over all profiles - for profile in profile_list: + for profile in profile_list or [p for p in Profile]: # File name full_file_name = file_name + "_" + profile.long_name() + ".xml" if not os.path.exists(full_file_name): output = generate_xml(import_result, version, file_name, profile, profile_list) - - with open(full_file_name, "w") as file: - logger.info('Write file "%s"', full_file_name) - - file.write(output) + if output: + with open(full_file_name, "w") as file: + logger.info('Write file "%s"', full_file_name) + file.write(output) else: logger.error( "File %s already exists. Delete file or change file name to serialize CGMES classes.", full_file_name @@ -384,10 +412,12 @@ def generate_xml(cim_data, version, model_name, profile, available_profiles): :param cim_data: a dictionary containing the topology and meta information. It can be created via \ :func:`~cimpy.cimimport.cim_import()` - :param version: cgmes version, e.g. ``version="cgmes_v2_4_15"`` - :param profile: The :class:`~cimpy.cgmes_v2_4_15.Base.Profile` for which the serialization should be generated. + :param version: cgmes version, e.g. ``version="cgmes_v2_4_15"`` + :param profile: The :class:`~cimpy.cgmes_v2_4_15.CGMESProfile.Profile` for which the serialization \ + should be generated. :param model_name: a string with the name of the model. - :param available_profiles: a list of all :class:`~cimpy.cgmes_v2_4_15.Base.Profile`s in `cim_data` + :param available_profiles: a list of all :class:`~cimpy.cgmes_v2_4_15.CGMESProfile.Profile` values in `cim_data` + :result: a string with the CIM RDF/XML data """ # Returns all classes with their attributes and resolved references @@ -396,20 +426,25 @@ def generate_xml(cim_data, version, model_name, profile, available_profiles): # Determine class and attribute export profiles. The export dict contains all classes and their attributes where # the class definition and the attribute definitions are in the same profile. Every entry in about_dict generates # a rdf:about in another profile - export_dict, about_dict = _sort_classes_to_profile(class_attributes_list, available_profiles) + export_dict, about_dict = _sort_classes_to_profile( + class_attributes_list, available_profiles or [p for p in Profile] + ) namespaces_list = _create_namespaces_list(cim_data["meta_info"]["namespaces"]) if profile.name not in export_dict.keys() and profile.name not in about_dict.keys(): - raise RuntimeError( - "Profile " - + profile.name - + " not available for export, export_dict=" - + str(export_dict.keys()) - + " and about_dict=" - + str(about_dict.keys()) - + "." - ) + if available_profiles: + raise RuntimeError( + "Profile " + + profile.name + + " not available for export, export_dict=" + + str(export_dict.keys()) + + " and about_dict=" + + str(about_dict.keys()) + + "." + ) + else: + return "" # Extract class lists from export_dict and about_dict if profile.name in export_dict.keys(): @@ -424,16 +459,18 @@ def generate_xml(cim_data, version, model_name, profile, available_profiles): # Model header model_description = { - "mRID": model_name, + "mRID": model_name + "_" + profile.long_name(), "description": [ { "attr_name": "created", "value": datetime.now().strftime("%d/%m/%Y %H:%M:%S"), }, {"attr_name": "modelingAuthoritySet", "value": "www.sogno.energy"}, - {"attr_name": "profile", "value": profile.long_name()}, ], } + for uri in profile.uris(): + model_description["description"].append({"attr_name": "profile", "value": uri}) + template_path = Path(os.path.join(os.path.dirname(__file__), "export_template.mustache")).resolve() with open(template_path) as f: output = chevron.render( @@ -465,7 +502,11 @@ def _get_attributes(class_object): class_type = type(parent) # Dictionary containing all attributes with key: 'Class_Name.Attribute_Name' - attributes_dict = dict(serializationProfile=class_object.serializationProfile, possibleProfileList={}) + attributes_dict = dict( + serializationProfile=class_object.serializationProfile, + possibleProfileList={}, + recommendedClassProfile=class_object.recommendedClassProfile, + ) # __dict__ of a subclass returns also the attributes of the parent classes # to avoid multiple attributes create list with all attributes already processed diff --git a/cimpy/cimimport.py b/cimpy/cimimport.py index ef2aa701..f058da41 100644 --- a/cimpy/cimimport.py +++ b/cimpy/cimimport.py @@ -2,6 +2,7 @@ from time import time import importlib import logging +from cimpy.cgmes_v2_4_15.CGMESProfile import short_profile_name logger = logging.getLogger(__name__) @@ -19,12 +20,12 @@ def cim_import(xml_files, cgmes_version, start_dict=None): :param start_dict: a list of classes which indicates which classes will be read e.g. elements=["BaseVoltage", "ACLineSegment"] * If start_dict=None the complete file will be read - :return: import_result: a dictionary containing the topology and meta information.The topology can be extracted \ + :return: import_result: a dictionary containing the topology and meta information. The topology can be extracted \ via import_result['topology']. The topology dictionary contains all objects accessible via their mRID. The meta \ information can be extracted via import_result['meta_info']. The meta_info dictionary contains a new dictionary \ with the keys: 'author', 'namespaces' and 'urls'. The last two are also dictionaries. 'urls' contains a mapping \ between references to URLs and the extracted value of the URL, e.g. 'absoluteValue': \ - 'http://iec.ch/TC57/2012/CIM-schema-cim16#OperationalLimitDirectionKind.absoluteValue' These mappings are \ + 'http://iec.ch/TC57/2012/CIM-schema-cim16#OperationalLimitDirectionKind.absoluteValue'. These mappings are \ accessible via the name of the attribute, \ e.g. import_result['meta_info']['urls'}[attr_name] = {mapping like example above}. \ 'namespaces' is a dictionary containing all RDF namespaces used in the imported xml files. @@ -118,7 +119,6 @@ def _instantiate_classes(import_result, xml_files, cgmes_version_path, namespace # Element tag without namespace (e.g. VoltageLevel). tag = elem.tag[m:] try: - # module_name = package_map[package][tag] # Import the module for the CGMES object. module_name = cgmes_version_path + "." + tag module = importlib.import_module(module_name) @@ -135,7 +135,6 @@ def _instantiate_classes(import_result, xml_files, cgmes_version_path, namespace # Get the CGMES class from the module. klass = getattr(module, tag) # Instantiate the class and map it to the uuid. - # res[uuid] = klass(UUID=uuid) topology[uuid] = klass() info_msg = "CIM object {} created".format(module_name.split(".")[-1]) try: @@ -149,7 +148,7 @@ def _instantiate_classes(import_result, xml_files, cgmes_version_path, namespace topology[uuid].mRID = uuid if package != "": - topology[uuid].serializationProfile["class"] = short_package_name[package] + topology[uuid].serializationProfile["class"] = short_profile_name[package] else: error_msg = "Package information not found for class {}".format(klass.__class__.__name__) try: @@ -160,7 +159,7 @@ def _instantiate_classes(import_result, xml_files, cgmes_version_path, namespace # Check which package is read elif event == "end": if "Model.profile" in elem.tag: - for package_key in short_package_name.keys(): + for package_key in short_profile_name.keys(): if package_key in elem.text: package = package_key break @@ -363,7 +362,7 @@ def _set_attributes(import_result, xml_files, namespace_rdf, base, logger_groupe setattr(obj, attr, val) if package != "": - obj.serializationProfile[attr] = short_package_name[package] + obj.serializationProfile[attr] = short_profile_name[package] else: error_msg = "Package information not found for class {}, attribute {}".format( obj.__class__.__name__, attr @@ -378,7 +377,7 @@ def _set_attributes(import_result, xml_files, namespace_rdf, base, logger_groupe # Check which package is read elif event == "end" and "Model.profile" in elem.tag: - for package_key in short_package_name.keys(): + for package_key in short_profile_name.keys(): if package_key in elem.text: package = package_key break @@ -417,16 +416,3 @@ def _get_rdf_namespace(namespaces): logger.warning("No rdf namespace found. Using %s", ns) return namespace - - -# TODO: use cimpy.cgmes.Profile instead -# used to map the profile name to their abbreviations according to the CGMES standard -short_package_name = { - "DiagramLayout": "DL", - "Dynamics": "DY", - "Equipment": "EQ", - "GeographicalLocation": "GL", - "StateVariables": "SV", - "SteadyStateHypothesis": "SSH", - "Topology": "TP", -} diff --git a/cimpy/examples/export_cigre_mv.py b/cimpy/examples/export_cigre_mv.py index 694e88b8..8b541456 100644 --- a/cimpy/examples/export_cigre_mv.py +++ b/cimpy/examples/export_cigre_mv.py @@ -20,6 +20,6 @@ import_result = cimpy.cim_import(xml_files, "cgmes_v2_4_15") -active_profile_list = ["DL", "EQ", "SV", "TP"] +active_profile_list = ["DL", "EQ", "SSH", "SV", "TP"] cimpy.cim_export(import_result, "CIGREMV_reference_cgmes_v2_4_15", "cgmes_v2_4_15", active_profile_list) diff --git a/tests/CIGREMV_import_reference_cgmes_v2_4_15.p b/tests/CIGREMV_import_reference_cgmes_v2_4_15.p index 09a789bd..82e3412b 100644 Binary files a/tests/CIGREMV_import_reference_cgmes_v2_4_15.p and b/tests/CIGREMV_import_reference_cgmes_v2_4_15.p differ diff --git a/tests/CIGREMV_reference_cgmes_v2_4_15_DiagramLayout.xml b/tests/CIGREMV_reference_cgmes_v2_4_15_DiagramLayout.xml index 325806ea..0764170b 100644 --- a/tests/CIGREMV_reference_cgmes_v2_4_15_DiagramLayout.xml +++ b/tests/CIGREMV_reference_cgmes_v2_4_15_DiagramLayout.xml @@ -1,1053 +1,1053 @@ - - - - 29/01/2020 15:09:48 - www.acs.eonerc.rwth-aachen.de - DiagramLayout - - - Load6 - - - - - - - - - 1 - 210.8 - 252.0 - - - - 2 - 210.8 - 246.0 - - - - - - - - 1 - 222.8 - 88.0 - - - - 2 - 222.8 - 98.0 - - - - - - - - 1 - 230.8 - 178.0 - - - - 2 - 230.8 - 172.0 - - - - - - - - 1 - 234.8 - 142.0 - - - - 2 - 234.8 - 138.0 - - - - - - - - 1 - 237.1 - 104.0 - - - - 2 - 236.8 - 98.0 - - - - - - - - 1 - 130.9 - 30.0 - - - - 2 - 130.8 - 40.0 - - - - - - - - 1 - 86.0 - 46.0 - - - - 2 - 86.8 - 40.0 - - - - - - - - 1 - 106.8 - 102.0 - - - - 2 - 106.8 - 94.0 - - - - - - - - 1 - 94.8 - 156.0 - - - - 2 - 94.8 - 150.5 - - - - - - - - 1 - 222.8 - 48.0 - - - - 2 - 222.8 - 40.0 - - - - - - - - 1 - 86.0 - 82.6 - - - - 2 - 86.8 - 94.0 - - - - - - - - 1 - 108.8 - 156.0 - - - - 2 - 108.8 - 150.5 - - - - - - - - 1 - 102.8 - 224.0 - - - - 2 - 102.8 - 216.5 - - - - - - - - 1 - 96.0 - 102.0 - - - - 2 - 96.8 - 94.0 - - - - - - - - 1 - 242.6 - 178.0 - - - - 2 - 242.8 - 172.0 - - - - - - - - 1 - 249.2 - 104.0 - - - - 2 - 248.8 - 98.0 - - - - - - - - 1 - 38.0 - 222.0 - - - - 2 - 38.0 - 216.0 - - - - - - - - 1 - 58.8 - 180.7 - - - - 2 - 58.8 - 180.0 - - - - 3 - 58.8 - 173.8 - - - - - - - - 1 - 94.8 - 198.0 - - - - 2 - 94.8 - 192.0 - - - - - - - - 1 - 88.8 - 224.0 - - - - 2 - 88.8 - 216.5 - - - - - - - - 1 - 112.8 - 264.0 - - - - 2 - 102.8 - 264.0 - - - - - - - - 1 - 212.8 - 274.0 - - - - 2 - 212.8 - 280.0 - - - - - - - - 1 - 152.8 - 221.2 - - - - 2 - 152.8 - 216.0 - - - - - - - - 1 - 204.8 - 98.0 - - - - 2 - 254.8 - 98.0 - - - - - - - - 1 - 208.8 - 138.0 - - - - 2 - 238.8 - 138.0 - - - - - - - - 1 - 208.8 - 172.0 - - - - 2 - 248.8 - 172.0 - - - - - - - - 1 - 60.8 - 40.0 - - - - 2 - 246.8 - 40.0 - - - - - - - - 1 - 64.9 - 94.0 - - - - 2 - 110.9 - 94.0 - - - - - - - - 1 - 74.8 - 123.8 - - - - 2 - 98.8 - 123.8 - - - - - - - - 1 - 42.5 - 150.5 - - - - 2 - 142.5 - 150.5 - - - - - - - - 1 - 34.8 - 173.8 - - - - 2 - 86.8 - 173.8 - - - - - - - - 1 - 34.8 - 216.0 - - - - 2 - 52.8 - 216.0 - - - - - - - - 1 - 68.8 - 192.0 - - - - 2 - 100.8 - 192.0 - - - - - - - - 1 - 70.8 - 216.5 - - - - 2 - 110.8 - 216.5 - - - - - - - - 1 - 120.8 - 216.0 - - - - 2 - 226.8 - 216.0 - - - - - - - - 1 - 182.8 - 246.0 - - - - 2 - 214.8 - 246.0 - - - - - - - - 1 - 182.8 - 274.0 - - - - 2 - 218.8 - 274.0 - - - - - - - - 1 - 102.8 - 250.0 - - - - 2 - 102.8 - 272.0 - - - - - - - - 1 - 222.8 - 98.0 - - - - 2 - 222.8 - 138.0 - - - - - - - - 1 - 222.8 - 138.0 - - - - 2 - 222.8 - 172.0 - - - - - - - - 1 - 86.8 - 94.0 - - - - 2 - 86.5 - 123.8 - - - - - - - - 1 - 86.5 - 123.8 - - - - 2 - 86.5 - 150.5 - - - - - - - - 1 - 58.8 - 150.5 - - - - 2 - 58.8 - 173.8 - - - - - - - - 1 - 44.8 - 173.8 - - - - 2 - 44.8 - 216.0 - - - - - - - - 1 - 44.8 - 216.0 - - - - 2 - 44.8 - 292.0 - - - - 3 - 194.8 - 292.0 - - - - 4 - 194.8 - 274.0 - - - - - - - - 1 - 134.8 - 216.0 - - - - 2 - 134.8 - 150.5 - - - - - - - - 1 - 80.8 - 192.0 - - - - 2 - 80.8 - 216.5 - - - - - - - - 1 - 74.8 - 216.5 - - - - 2 - 74.8 - 256.0 - - - - 3 - 102.8 - 256.0 - - - - - - - - 1 - 102.8 - 256.0 - - - - 2 - 134.8 - 256.0 - - - - 3 - 134.8 - 216.0 - - - - - - - - 1 - 194.8 - 216.0 - - - - 2 - 194.8 - 246.0 - - - - - - - - 1 - 86.0 - 64.3 - - - - - - - - 1 - 222.8 - 68.0 - - - - -90.0 - - - - - 1 - 130.9 - 19.2 - - - - - - - - 1 - 210.8 - 255.8 - - - - - - - - 1 - 230.8 - 181.8 - - - - - - - - 1 - 234.8 - 145.8 - - - - - - - - 1 - 237.1 - 107.8 - - - - - - - - 1 - 106.8 - 105.8 - - - - - - - - 1 - 94.8 - 159.8 - - - - - - - - 1 - 108.8 - 159.8 - - - - - - - - 1 - 102.8 - 227.8 - - - - - - - - 1 - 96.0 - 105.8 - - - - - - - - 1 - 249.2 - 107.8 - - - - - - - - 1 - 242.6 - 181.8 - - - - - - - - 1 - 38.0 - 225.8 - - - - - - - - 1 - 58.8 - 184.5 - - - - - - - - 1 - 94.8 - 201.8 - - - - - - - - 1 - 88.8 - 227.8 - - - - - - - - 1 - 112.8 - 267.8 - - - - - - - - 1 - 212.8 - 283.8 - - - - - - - - 1 - 152.8 - 225.0 - - + + + + 12/08/2024 16:34:44 + www.sogno.energy + http://entsoe.eu/CIM/DiagramLayout/3/1 + + + Load6 + + + + + + + + + 1 + 210.8 + 252.0 + + + + 2 + 210.8 + 246.0 + + + + + + + + 1 + 222.8 + 88.0 + + + + 2 + 222.8 + 98.0 + + + + + + + + 1 + 230.8 + 178.0 + + + + 2 + 230.8 + 172.0 + + + + + + + + 1 + 234.8 + 142.0 + + + + 2 + 234.8 + 138.0 + + + + + + + + 1 + 237.1 + 104.0 + + + + 2 + 236.8 + 98.0 + + + + + + + + 1 + 130.9 + 30.0 + + + + 2 + 130.8 + 40.0 + + + + + + + + 1 + 86.0 + 46.0 + + + + 2 + 86.8 + 40.0 + + + + + + + + 1 + 106.8 + 102.0 + + + + 2 + 106.8 + 94.0 + + + + + + + + 1 + 94.8 + 156.0 + + + + 2 + 94.8 + 150.5 + + + + + + + + 1 + 222.8 + 48.0 + + + + 2 + 222.8 + 40.0 + + + + + + + + 1 + 86.0 + 82.6 + + + + 2 + 86.8 + 94.0 + + + + + + + + 1 + 108.8 + 156.0 + + + + 2 + 108.8 + 150.5 + + + + + + + + 1 + 102.8 + 224.0 + + + + 2 + 102.8 + 216.5 + + + + + + + + 1 + 96.0 + 102.0 + + + + 2 + 96.8 + 94.0 + + + + + + + + 1 + 242.6 + 178.0 + + + + 2 + 242.8 + 172.0 + + + + + + + + 1 + 249.2 + 104.0 + + + + 2 + 248.8 + 98.0 + + + + + + + + 1 + 38.0 + 222.0 + + + + 2 + 38.0 + 216.0 + + + + + + + + 1 + 58.8 + 180.7 + + + + 2 + 58.8 + 180.0 + + + + 3 + 58.8 + 173.8 + + + + + + + + 1 + 94.8 + 198.0 + + + + 2 + 94.8 + 192.0 + + + + + + + + 1 + 88.8 + 224.0 + + + + 2 + 88.8 + 216.5 + + + + + + + + 1 + 112.8 + 264.0 + + + + 2 + 102.8 + 264.0 + + + + + + + + 1 + 212.8 + 274.0 + + + + 2 + 212.8 + 280.0 + + + + + + + + 1 + 152.8 + 221.2 + + + + 2 + 152.8 + 216.0 + + + + + + + + 1 + 204.8 + 98.0 + + + + 2 + 254.8 + 98.0 + + + + + + + + 1 + 208.8 + 138.0 + + + + 2 + 238.8 + 138.0 + + + + + + + + 1 + 208.8 + 172.0 + + + + 2 + 248.8 + 172.0 + + + + + + + + 1 + 60.8 + 40.0 + + + + 2 + 246.8 + 40.0 + + + + + + + + 1 + 64.9 + 94.0 + + + + 2 + 110.9 + 94.0 + + + + + + + + 1 + 74.8 + 123.8 + + + + 2 + 98.8 + 123.8 + + + + + + + + 1 + 42.5 + 150.5 + + + + 2 + 142.5 + 150.5 + + + + + + + + 1 + 34.8 + 173.8 + + + + 2 + 86.8 + 173.8 + + + + + + + + 1 + 34.8 + 216.0 + + + + 2 + 52.8 + 216.0 + + + + + + + + 1 + 68.8 + 192.0 + + + + 2 + 100.8 + 192.0 + + + + + + + + 1 + 70.8 + 216.5 + + + + 2 + 110.8 + 216.5 + + + + + + + + 1 + 120.8 + 216.0 + + + + 2 + 226.8 + 216.0 + + + + + + + + 1 + 182.8 + 246.0 + + + + 2 + 214.8 + 246.0 + + + + + + + + 1 + 182.8 + 274.0 + + + + 2 + 218.8 + 274.0 + + + + + + + + 1 + 102.8 + 250.0 + + + + 2 + 102.8 + 272.0 + + + + + + + + 1 + 222.8 + 98.0 + + + + 2 + 222.8 + 138.0 + + + + + + + + 1 + 222.8 + 138.0 + + + + 2 + 222.8 + 172.0 + + + + + + + + 1 + 86.8 + 94.0 + + + + 2 + 86.5 + 123.8 + + + + + + + + 1 + 86.5 + 123.8 + + + + 2 + 86.5 + 150.5 + + + + + + + + 1 + 58.8 + 150.5 + + + + 2 + 58.8 + 173.8 + + + + + + + + 1 + 44.8 + 173.8 + + + + 2 + 44.8 + 216.0 + + + + + + + + 1 + 44.8 + 216.0 + + + + 2 + 44.8 + 292.0 + + + + 3 + 194.8 + 292.0 + + + + 4 + 194.8 + 274.0 + + + + + + + + 1 + 134.8 + 216.0 + + + + 2 + 134.8 + 150.5 + + + + + + + + 1 + 80.8 + 192.0 + + + + 2 + 80.8 + 216.5 + + + + + + + + 1 + 74.8 + 216.5 + + + + 2 + 74.8 + 256.0 + + + + 3 + 102.8 + 256.0 + + + + + + + + 1 + 102.8 + 256.0 + + + + 2 + 134.8 + 256.0 + + + + 3 + 134.8 + 216.0 + + + + + + + + 1 + 194.8 + 216.0 + + + + 2 + 194.8 + 246.0 + + + + + + + + 1 + 86.0 + 64.3 + + + + + + + + 1 + 222.8 + 68.0 + + + + + -90.0 + + + + 1 + 130.9 + 19.2 + + + + + + + + 1 + 210.8 + 255.8 + + + + + + + + 1 + 230.8 + 181.8 + + + + + + + + 1 + 234.8 + 145.8 + + + + + + + + 1 + 237.1 + 107.8 + + + + + + + + 1 + 106.8 + 105.8 + + + + + + + + 1 + 94.8 + 159.8 + + + + + + + + 1 + 108.8 + 159.8 + + + + + + + + 1 + 102.8 + 227.8 + + + + + + + + 1 + 96.0 + 105.8 + + + + + + + + 1 + 249.2 + 107.8 + + + + + + + + 1 + 242.6 + 181.8 + + + + + + + + 1 + 38.0 + 225.8 + + + + + + + + 1 + 58.8 + 184.5 + + + + + + + + 1 + 94.8 + 201.8 + + + + + + + + 1 + 88.8 + 227.8 + + + + + + + + 1 + 112.8 + 267.8 + + + + + + + + 1 + 212.8 + 283.8 + + + + + + + + 1 + 152.8 + 225.0 + + diff --git a/tests/CIGREMV_reference_cgmes_v2_4_15_Equipment.xml b/tests/CIGREMV_reference_cgmes_v2_4_15_Equipment.xml index 6b4a679f..90515753 100644 --- a/tests/CIGREMV_reference_cgmes_v2_4_15_Equipment.xml +++ b/tests/CIGREMV_reference_cgmes_v2_4_15_Equipment.xml @@ -1,1066 +1,1068 @@ - - - - 29/01/2020 15:09:48 - www.acs.eonerc.rwth-aachen.de - Equipment - - - 20.0 - - - - - - - - - - - - - - - - - 110.0 - - - - 189 - - - - - 136 - - - - - 153 - - - - - 145 - - - - - 139 - - - - - 128 - - - - - 112 - - - - - 291 - - - - - 120 - - - - - 83 - - - - - 41 - - - - - 156 - - - - - 297 - - - - - 305 - - - - - 142 - - - - - N0 - - - - N7 - - - - N6 - - - - N9 - - - - N1 - - - - N14 - - - - N2 - - - - N3 - - - - N4 - - - - N5 - - - - N11 - - - - N10 - - - - N8 - - - - N12 - - - - N13 - - - - Area 1 - - - Zone 1 - - - - PATL - 45000 - - - - TATL - 60 - - - - Load7-I - - - - Load7-I_0 - 1 - - - - Load14-H - - - - Load14-H_0 - 1 - - - - Load13-I - - - - Load13-I_0 - 1 - - - - Load12-H - - - - Load12-H_0 - 1 - - - - Load1-I - - - - Load1-I_0 - 1 - - - - Load3-H - - - - Load3-H_0 - 1 - - - - Load3-I - - - - Load3-I_0 - 1 - - - - Load10-I - - - - Load10-I_0 - 1 - - - - Load1-H - - - - Load1-H_0 - 1 - - - - Load12-I - - - - Load12-I_0 - 1 - - - - Load14-I - - - - Load14-I_0 - 1 - - - - Load5_H - - - - Load5_H_0 - 1 - - - - Load4-H - - - - Load4-H_0 - 1 - - - - Load11-H - - - - Load11-H_0 - 1 - - - - Load10-H - - - - Load10-H_0 - 1 - - - - Load9-I - - - - Load9-I_0 - 1 - - - - Load6-H - - - - Load6-H_0 - 1 - - - - Load8-H - - - - Load8-H_0 - 1 - - - - HV-Netz - - True - 1.0 - - - HV-Netz_0 - 1 - - - - L12-13 - - - 4.89 - 0.000250221 - 1.64793 - 1.75062 - 0.0003902047 - 4.89 - 250.0 - 4.89 - - - L12-13_0 - 1 - - - - - L12-13_1 - 2 - - - - Ratings - - - - - Normal - - - 320.0 - - - ShortTerm - - - - Emergency - - - 320.0 - - - L13-14 - - - 2.99 - 0.0004493794 - 0.60398 - 0.36478 - 0.0002385914 - 2.99 - 250.0 - 2.99 - - - L13-14_0 - 1 - - - - - L13-14_1 - 2 - - - - Ratings - - - - - Normal - - - 410.0 - - - ShortTerm - - - - Emergency - - - 410.0 - - - L1-2 - - - 2.82 - 0.0001407573 - 1.63278 - 1.03494 - 0.000225026 - 2.82 - 250.0 - 2.82 - - - L1-2_0 - 1 - - - - - L1-2_1 - 2 - - - - Ratings - - - - - Normal - - - 320.0 - - - ShortTerm - - - - Emergency - - - 320.0 - - - L2-3 - - - 4.42 - 0.0009175791 - 0.72488 - 0.49946 - 0.0003249286 - 4.42 - 250.0 - 4.42 - - - L2-3_0 - 1 - - - - - L2-3_1 - 2 - - - - Ratings - - - - - Normal - - - 287.0 - - - ShortTerm - - - - Emergency - - - 287.0 - - - L3-4 - - - 0.61 - 0.0001241814 - 0.15982 - 0.07381 - 4.48431e-05 - 0.61 - 250.0 - 0.61 - - - L3-4_0 - 1 - - - - - L3-4_1 - 2 - - - - Ratings - - - - - Normal - - - 287.0 - - - ShortTerm - - - - Emergency - - - 287.0 - - - L4-5 - - - 0.56 - 8.02239e-05 - 0.19824 - 0.07224 - 4.11674e-05 - 0.56 - 250.0 - 0.56 - - - L4-5_0 - 1 - - - - - L4-5_1 - 2 - - - - Ratings - - - - - Normal - - - 287.0 - - - ShortTerm - - - - Emergency - - - 287.0 - - - L5-6 - - - 1.54 - 0.0002655128 - 0.51744 - 0.19404 - 0.0001132104 - 1.54 - 250.0 - 1.54 - - - L5-6_0 - 1 - - - - - L5-6_1 - 2 - - - - Ratings - - - - - Normal - - - 287.0 - - - ShortTerm - - - - Emergency - - - 287.0 - - - L3-8 - - - 1.3 - 0.0002685697 - 0.2236 - 0.1495 - 9.55672e-05 - 1.3 - 250.0 - 1.3 - - - L3-8_0 - 1 - - - - - L3-8_1 - 2 - - - - Ratings - - - - - Normal - - - 287.0 - - - ShortTerm - - - - Emergency - - - 287.0 - - - L10-11 - - - 0.33 - 4.72748e-05 - 0.12111 - 0.04389 - 2.42594e-05 - 0.33 - 250.0 - 0.33 - - - L10-11_0 - 1 - - - - - L10-11_1 - 2 - - - - Ratings - - - - - Normal - - - 287.0 - - - ShortTerm - - - - Emergency - - - 287.0 - - - L9-10 - - - 0.77 - 0.0001168876 - 0.30723 - 0.10241 - 5.66052e-05 - 0.77 - 250.0 - 0.77 - - - L9-10_0 - 1 - - - - - L9-10_1 - 2 - - - - Ratings - - - - - Normal - - - 287.0 - - - ShortTerm - - - - Emergency - - - 287.0 - - - L8-9 - - - 0.32 - 4.3912e-05 - 0.10848 - 0.0416 - 2.35242e-05 - 0.32 - 250.0 - 0.32 - - - L8-9_0 - 1 - - - - - L8-9_1 - 2 - - - - Ratings - - - - - Normal - - - 287.0 - - - ShortTerm - - - - Emergency - - - 287.0 - - - L7-8 - - - 1.67 - 0.0002938033 - 0.49098 - 0.20541 - 0.0001227672 - 1.67 - 250.0 - 1.67 - - - L7-8_0 - 1 - - - - - L7-8_1 - 2 - - - - Ratings - - - - - Normal - - - 287.0 - - - ShortTerm - - - - Emergency - - - 287.0 - - - TR1 - - - - - - - - TR1_0 - 1 - - - - - TR1 - - - 1 - True - - -1.9835e-06 - - 40.0 - 110.0 - 1.90575 - 36.371106 - 1.90575 - 34.432301 - - - Ratings - - - - - Normal - - - - - ShortTerm - - - - Emergency - - - - - TR1_1 - 2 - - - - - TR1 - - - 2 - True - - - 40.0 - 20.0 - 5 - - - Ratings - - - - - Normal - - - - - ShortTerm - - - - Emergency - - - - - TR2 - - - - - - - - TR2_0 - 1 - - - - - TR2 - - - 1 - True - - -1.9835e-06 - - 40.0 - 110.0 - 1.90575 - 36.371106 - 1.90575 - 34.432301 - - - Ratings - - - - - Normal - - - - - ShortTerm - - - - Emergency - - - - - TR2_1 - 2 - - - - - TR2 - - - 2 - True - - - 40.0 - 20.0 - 5 - - - Ratings - - - - - Normal - - - - - ShortTerm - - - - Emergency - - - - + + + + 12/08/2024 16:34:44 + www.sogno.energy + http://entsoe.eu/CIM/EquipmentCore/3/1 + http://entsoe.eu/CIM/EquipmentOperation/3/1 + http://entsoe.eu/CIM/EquipmentShortCircuit/3/1 + + + + + + + + + + + + + + + + + 20.0 + + + + 110.0 + + + 189 + + + + + 136 + + + + + 153 + + + + + 145 + + + + + 139 + + + + + 128 + + + + + 112 + + + + + 291 + + + + + 120 + + + + + 83 + + + + + 41 + + + + + 156 + + + + + 297 + + + + + 305 + + + + + 142 + + + + + N0 + + + + N7 + + + + N6 + + + + N9 + + + + N1 + + + + N14 + + + + N2 + + + + N3 + + + + N4 + + + + N5 + + + + N11 + + + + N10 + + + + N8 + + + + N12 + + + + N13 + + + + Area 1 + + + Zone 1 + + + + PATL + 45000.0 + + + + TATL + 60.0 + + + + Load7-I + + + + Load7-I_0 + 1 + + + + Load14-H + + + + Load14-H_0 + 1 + + + + Load13-I + + + + Load13-I_0 + 1 + + + + Load12-H + + + + Load12-H_0 + 1 + + + + Load1-I + + + + Load1-I_0 + 1 + + + + Load3-H + + + + Load3-H_0 + 1 + + + + Load3-I + + + + Load3-I_0 + 1 + + + + Load10-I + + + + Load10-I_0 + 1 + + + + Load1-H + + + + Load1-H_0 + 1 + + + + Load12-I + + + + Load12-I_0 + 1 + + + + Load14-I + + + + Load14-I_0 + 1 + + + + Load5_H + + + + Load5_H_0 + 1 + + + + Load4-H + + + + Load4-H_0 + 1 + + + + Load11-H + + + + Load11-H_0 + 1 + + + + Load10-H + + + + Load10-H_0 + 1 + + + + Load9-I + + + + Load9-I_0 + 1 + + + + Load6-H + + + + Load6-H_0 + 1 + + + + Load8-H + + + + Load8-H_0 + 1 + + + + HV-Netz + + True + 1.0 + + + HV-Netz_0 + 1 + + + + L12-13 + + + 4.89 + 0.0003902047 + 0.000250221 + 1.64793 + 4.89 + 250.0 + 1.75062 + 4.89 + + + L12-13_0 + + 1 + + + + L12-13_1 + 2 + + + + Ratings + + + + + Normal + + + 320.0 + + + ShortTerm + + + + Emergency + + + 320.0 + + + L13-14 + + + 2.99 + 0.0002385914 + 0.0004493794 + 0.60398 + 2.99 + 250.0 + 0.36478 + 2.99 + + + L13-14_0 + + 1 + + + + L13-14_1 + 2 + + + + Ratings + + + + + Normal + + + 410.0 + + + ShortTerm + + + + Emergency + + + 410.0 + + + L1-2 + + + 2.82 + 0.000225026 + 0.0001407573 + 1.63278 + 2.82 + 250.0 + 1.03494 + 2.82 + + + L1-2_0 + + 1 + + + + L1-2_1 + 2 + + + + Ratings + + + + + Normal + + + 320.0 + + + ShortTerm + + + + Emergency + + + 320.0 + + + L2-3 + + + 4.42 + 0.0003249286 + 0.0009175791 + 0.72488 + 4.42 + 250.0 + 0.49946 + 4.42 + + + L2-3_0 + + 1 + + + + L2-3_1 + 2 + + + + Ratings + + + + + Normal + + + 287.0 + + + ShortTerm + + + + Emergency + + + 287.0 + + + L3-4 + + + 0.61 + 4.48431e-05 + 0.0001241814 + 0.15982 + 0.61 + 250.0 + 0.07381 + 0.61 + + + L3-4_0 + + 1 + + + + L3-4_1 + 2 + + + + Ratings + + + + + Normal + + + 287.0 + + + ShortTerm + + + + Emergency + + + 287.0 + + + L4-5 + + + 0.56 + 4.11674e-05 + 8.02239e-05 + 0.19824 + 0.56 + 250.0 + 0.07224 + 0.56 + + + L4-5_0 + + 1 + + + + L4-5_1 + 2 + + + + Ratings + + + + + Normal + + + 287.0 + + + ShortTerm + + + + Emergency + + + 287.0 + + + L5-6 + + + 1.54 + 0.0001132104 + 0.0002655128 + 0.51744 + 1.54 + 250.0 + 0.19404 + 1.54 + + + L5-6_0 + + 1 + + + + L5-6_1 + 2 + + + + Ratings + + + + + Normal + + + 287.0 + + + ShortTerm + + + + Emergency + + + 287.0 + + + L3-8 + + + 1.3 + 9.55672e-05 + 0.0002685697 + 0.2236 + 1.3 + 250.0 + 0.1495 + 1.3 + + + L3-8_0 + + 1 + + + + L3-8_1 + 2 + + + + Ratings + + + + + Normal + + + 287.0 + + + ShortTerm + + + + Emergency + + + 287.0 + + + L10-11 + + + 0.33 + 2.42594e-05 + 4.72748e-05 + 0.12111 + 0.33 + 250.0 + 0.04389 + 0.33 + + + L10-11_0 + + 1 + + + + L10-11_1 + 2 + + + + Ratings + + + + + Normal + + + 287.0 + + + ShortTerm + + + + Emergency + + + 287.0 + + + L9-10 + + + 0.77 + 5.66052e-05 + 0.0001168876 + 0.30723 + 0.77 + 250.0 + 0.10241 + 0.77 + + + L9-10_0 + + 1 + + + + L9-10_1 + 2 + + + + Ratings + + + + + Normal + + + 287.0 + + + ShortTerm + + + + Emergency + + + 287.0 + + + L8-9 + + + 0.32 + 2.35242e-05 + 4.3912e-05 + 0.10848 + 0.32 + 250.0 + 0.0416 + 0.32 + + + L8-9_0 + + 1 + + + + L8-9_1 + 2 + + + + Ratings + + + + + Normal + + + 287.0 + + + ShortTerm + + + + Emergency + + + 287.0 + + + L7-8 + + + 1.67 + 0.0001227672 + 0.0002938033 + 0.49098 + 1.67 + 250.0 + 0.20541 + 1.67 + + + L7-8_0 + + 1 + + + + L7-8_1 + 2 + + + + Ratings + + + + + Normal + + + 287.0 + + + ShortTerm + + + + Emergency + + + 287.0 + + + TR1 + + + + + + + + TR1_0 + + 1 + + + + TR1 + + + 1 + True + + -1.9835e-06 + + 1.90575 + 1.90575 + 40.0 + 110.0 + 36.371106 + 34.432301 + + + Ratings + + + + + Normal + + + + + ShortTerm + + + + Emergency + + + + + TR1_1 + + 2 + + + + TR1 + + + 2 + True + + + 5 + 40.0 + 20.0 + + + Ratings + + + + + Normal + + + + + ShortTerm + + + + Emergency + + + + + TR2 + + + + + + + + TR2_0 + + 1 + + + + TR2 + + + 1 + True + + -1.9835e-06 + + 1.90575 + 1.90575 + 40.0 + 110.0 + 36.371106 + 34.432301 + + + Ratings + + + + + Normal + + + + + ShortTerm + + + + Emergency + + + + + TR2_1 + + 2 + + + + TR2 + + + 2 + True + + + 5 + 40.0 + 20.0 + + + Ratings + + + + + Normal + + + + + ShortTerm + + + + Emergency + + + + diff --git a/tests/CIGREMV_reference_cgmes_v2_4_15_StateVariables.xml b/tests/CIGREMV_reference_cgmes_v2_4_15_StateVariables.xml index fe2203b6..c13601c8 100644 --- a/tests/CIGREMV_reference_cgmes_v2_4_15_StateVariables.xml +++ b/tests/CIGREMV_reference_cgmes_v2_4_15_StateVariables.xml @@ -1,271 +1,271 @@ - - - - 29/01/2020 15:09:48 - www.acs.eonerc.rwth-aachen.de - StateVariables - - - -3.57295 - 19.605385 - - - - -3.70772 - 19.55215 - - - - -3.72158 - 19.532346 - - - - 110.0 - - - - -4.26829 - 19.531205 - - - - -4.64028 - 19.086952 - - - - -4.81668 - 18.882252 - - - - -4.82967 - 18.86667 - - - - -4.83776 - 18.852447 - - - - -4.85252 - 18.825361 - - - - -4.85164 - 18.827665 - - - - -4.84708 - 18.852622 - - - - -4.84996 - 18.850663 - - - - -4.84739 - 18.836402 - - - - -4.84744 - 18.843089 - - - - - 0.077 - 0.048 - - - - 0.207 - 0.052 - - - - 0.032 - 0.02 - - - - 15.0 - 3.0 - - - - 5.0 - 1.0 - - - - 0.276 - 0.69 - - - - 0.224 - 0.139 - - - - 0.068 - 0.042 - - - - 15.0 - 3.1 - - - - 5.0 - 1.7 - - - - 0.33 - 0.205 - - - - 0.725 - 0.182 - - - - 0.432 - 0.108 - - - - 0.331 - 0.083 - - - - 0.477 - 0.12 - - - - 0.574 - 0.356 - - - - 0.55 - 0.138 - - - - 0.588 - 0.147 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + 12/08/2024 16:34:44 + www.sogno.energy + http://entsoe.eu/CIM/StateVariables/4/1 + + + + -3.57295 + 19.605385 + + + + -3.70772 + 19.55215 + + + + -3.72158 + 19.532346 + + + + 110.0 + + + + -4.26829 + 19.531205 + + + + -4.64028 + 19.086952 + + + + -4.81668 + 18.882252 + + + + -4.82967 + 18.86667 + + + + -4.83776 + 18.852447 + + + + -4.85252 + 18.825361 + + + + -4.85164 + 18.827665 + + + + -4.84708 + 18.852622 + + + + -4.84996 + 18.850663 + + + + -4.84739 + 18.836402 + + + + -4.84744 + 18.843089 + + + + 0.077 + 0.048 + + + + 0.207 + 0.052 + + + + 0.032 + 0.02 + + + + 15.0 + 3.0 + + + + 5.0 + 1.0 + + + + 0.276 + 0.69 + + + + 0.224 + 0.139 + + + + 0.068 + 0.042 + + + + 15.0 + 3.1 + + + + 5.0 + 1.7 + + + + 0.33 + 0.205 + + + + 0.725 + 0.182 + + + + 0.432 + 0.108 + + + + 0.331 + 0.083 + + + + 0.477 + 0.12 + + + + 0.574 + 0.356 + + + + 0.55 + 0.138 + + + + 0.588 + 0.147 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/CIGREMV_reference_cgmes_v2_4_15_SteadyStateHypothesis.xml b/tests/CIGREMV_reference_cgmes_v2_4_15_SteadyStateHypothesis.xml new file mode 100644 index 00000000..5a78df0d --- /dev/null +++ b/tests/CIGREMV_reference_cgmes_v2_4_15_SteadyStateHypothesis.xml @@ -0,0 +1,152 @@ + + + + 12/08/2024 16:34:44 + www.sogno.energy + http://entsoe.eu/CIM/SteadyStateHypothesis/1/1 + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + 1 + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + + True + + diff --git a/tests/CIGREMV_reference_cgmes_v2_4_15_Topology.xml b/tests/CIGREMV_reference_cgmes_v2_4_15_Topology.xml index 95d1d759..85379ea5 100644 --- a/tests/CIGREMV_reference_cgmes_v2_4_15_Topology.xml +++ b/tests/CIGREMV_reference_cgmes_v2_4_15_Topology.xml @@ -1,335 +1,335 @@ - - - - 29/01/2020 15:09:48 - www.acs.eonerc.rwth-aachen.de - Topology - - - N12 - - - - - - - - - N13 - - - - - - - - N14 - - - - - - - - N0 - - - - - - - - N1 - - - - - - - - - N2 - - - - - - - N3 - - - - - - - - - - N4 - - - - - - - - N5 - - - - - - - - N11 - - - - - - - N10 - - - - - - - - - N8 - - - - - - - - - N7 - - - - - - - N6 - - - - - - - N9 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + 12/08/2024 16:34:44 + www.sogno.energy + http://entsoe.eu/CIM/Topology/4/1 + + + N12 + + + + + + + + + N13 + + + + + + + + N14 + + + + + + + + N0 + + + + + + + + N1 + + + + + + + + + N2 + + + + + + + N3 + + + + + + + + + + N4 + + + + + + + + N5 + + + + + + + + N11 + + + + + + + N10 + + + + + + + + + N8 + + + + + + + + + N7 + + + + + + + N6 + + + + + + + N9 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/create_pickle_dump.py b/tests/create_pickle_dump.py index eb11b742..00955750 100644 --- a/tests/create_pickle_dump.py +++ b/tests/create_pickle_dump.py @@ -1,9 +1,9 @@ +import os import pickle from pathlib import Path import cimpy -tests = Path(".").resolve().parent -example_path = tests / "examples" / "sampledata" / "CIGRE_MV" +example_path = Path(os.path.join(os.path.dirname(__file__), "../cimpy/examples/sampledata/CIGRE_MV")).resolve() def create_pickle(): diff --git a/tests/test_export.py b/tests/test_export.py index 9e0c4112..fa9726a1 100644 --- a/tests/test_export.py +++ b/tests/test_export.py @@ -1,6 +1,6 @@ import logging import cimpy -from cimpy.cgmes_v2_4_15.Base import short_profile_name +from cimpy.cgmes_v2_4_15.CGMESProfile import short_profile_name import xmltodict import os import pytest_check as check @@ -34,9 +34,14 @@ def read_ref_xml(): test_dict = {} for elem in test_list: profile = elem["md:FullModel"]["md:Model.profile"] + if type(profile) is list: + profile = profile[0] for key in short_profile_name.keys(): if key in profile: test_dict[key] = elem + break + else: + pytest.fail("Profile '%s' not found" % profile) return test_dict @@ -53,9 +58,14 @@ def read_exported_xml(directory): export_dict = {} for export_file in export_list: profile = export_file["md:FullModel"]["md:Model.profile"] + if type(profile) is list: + profile = profile[0] for key in short_profile_name.keys(): if key in profile: export_dict[key] = export_file + break + else: + pytest.fail("Profile '%s' not found" % profile) return export_dict @@ -64,7 +74,7 @@ def read_exported_xml(directory): def test_export_with_exported_files(sample_cimdata, tmpdir): - active_profile_list = ["DL", "EQ", "SV", "TP"] + active_profile_list = ["DL", "EQ", "SSH", "SV", "TP"] cimpy.cim_export(sample_cimdata, tmpdir + "/EXPORTED_Test", "cgmes_v2_4_15", active_profile_list)