VeraGridEngine 5.6.0__tar.gz → 5.6.2__tar.gz

{veragridengine-5.6.0 → veragridengine-5.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: VeraGridEngine
-Version: 5.6.0
+Version: 5.6.2
 Summary: VeraGrid is a Power Systems simulation program intended for professional use and research
 Home-page: https://github.com/SanPen/VeraGrid
 Author: Santiago Peñate Vera et. Al.

{veragridengine-5.6.0 → veragridengine-5.6.2}/VeraGridEngine/Devices/Dynamic/rms_template.py

@@ -3,8 +3,10 @@
 # file, You can obtain one at https://mozilla.org/MPL/2.0/.
 # SPDX-License-Identifier: MPL-2.0
 from __future__ import annotations
+from typing import Dict
 from VeraGridEngine.Devices.Parents.pointer_device_parent import PointerDeviceParent
 from VeraGridEngine.Utils.Symbolic.block import Block
+from VeraGridEngine.Utils.Symbolic.symbolic import Var, Const
 from VeraGridEngine.enumerations import DeviceType, SubObjectType
 
 
@@ -15,7 +17,8 @@ class RmsModelTemplate(PointerDeviceParent):
 
     __slots__ = (
         '_block',
-        '_device_type')
+        '_device_type',
+        '_init_values')
 
     def __init__(self, idtag="", name: str = ""):
         super().__init__(name=name,
@@ -26,6 +29,7 @@ class RmsModelTemplate(PointerDeviceParent):
                          device_type=DeviceType.RmsModelTemplateDevice)
 
         self._block: Block = Block()
+        self._init_values: Dict[Var, Const] = dict()
 
         self.register('block', units="p.u.", tpe=SubObjectType.DaeBlockType,
                       definition='DAE block', editable=False, display=False)
@@ -41,3 +45,15 @@ class RmsModelTemplate(PointerDeviceParent):
     @block.setter
     def block(self, obj: Block):
         self._block = obj
+
+    @property
+    def init_values(self):
+        """
+
+        :return:
+        """
+        return self._init_values
+
+    @init_values.setter
+    def init_values(self, obj: Dict[Var, Const]):
+        self._init_values = obj

{veragridengine-5.6.0 → veragridengine-5.6.2}/VeraGridEngine/Devices/Injections/generator.py

@@ -627,7 +627,10 @@ class Generator(GeneratorParent):
         Initialize the RMS model
         """
 
+
+        empty = self.rms_model.empty()
         if self.rms_model.empty():
+            empty = True
             delta = Var("delta")
             omega = Var("omega")
             psid = Var("psid")

{veragridengine-5.6.0 → veragridengine-5.6.2}/VeraGridEngine/Devices/Injections/shunt.py

@@ -72,32 +72,32 @@ class Shunt(ShuntParent):
         self.g = self.G / Sbase
         self.b = self.B / Sbase
 
-    def initialize_rms(self):
-        """
-        Initialize RMS
-        :return:
-        """
-        if self.rms_model.empty():
-            Pshunt = Var("Pshunt")
-            Qshunt = Var("Qshunt")
-
-            Vm = self.bus.rms_model.model.E(VarPowerFlowRefferenceType.Vm)
-
-            # Assign Block
-            self.rms_model.model = Block(
-                algebraic_eqs=[
-                    Pshunt - self.g * Vm ** 2,
-                    Qshunt - self.b * Vm ** 2
-                ],
-                algebraic_vars=[Pshunt, Qshunt],
-                init_eqs={
-                    Pshunt: self.g * Vm ** 2,
-                    Qshunt: self.b * Vm ** 2
-                },
-                init_vars=[Pshunt, Qshunt],
-                parameters=[],
-                external_mapping={
-                    VarPowerFlowRefferenceType.P: Pshunt,
-                    VarPowerFlowRefferenceType.Q: Qshunt
-                }
-            )
+    # def initialize_rms(self):
+    #     """
+    #     Initialize RMS
+    #     :return:
+    #     """
+    #     if self.rms_model.empty():
+    #         Pshunt = Var("Pshunt")
+    #         Qshunt = Var("Qshunt")
+    #
+    #         Vm = self.bus.rms_model.model.E(VarPowerFlowRefferenceType.Vm)
+    #
+    #         # Assign Block
+    #         self.rms_model.model = Block(
+    #             algebraic_eqs=[
+    #                 Pshunt - self.g * Vm ** 2,
+    #                 Qshunt - self.b * Vm ** 2
+    #             ],
+    #             algebraic_vars=[Pshunt, Qshunt],
+    #             init_eqs={
+    #                 Pshunt: self.g * Vm ** 2,
+    #                 Qshunt: self.b * Vm ** 2
+    #             },
+    #             init_vars=[Pshunt, Qshunt],
+    #             parameters=[],
+    #             external_mapping={
+    #                 VarPowerFlowRefferenceType.P: Pshunt,
+    #                 VarPowerFlowRefferenceType.Q: Qshunt
+    #             }
+    #         )

{veragridengine-5.6.0 → veragridengine-5.6.2}/VeraGridEngine/Devices/Parents/injection_parent.py

@@ -3,7 +3,7 @@
 # file, You can obtain one at https://mozilla.org/MPL/2.0/.
 # SPDX-License-Identifier: MPL-2.0
 from __future__ import annotations
-from typing import Union, List, TYPE_CHECKING
+from typing import Union, List, TYPE_CHECKING, Tuple
 import numpy as np
 
 from VeraGridEngine.Devices.Parents.physical_device import PhysicalDevice
@@ -47,7 +47,8 @@ class InjectionParent(PhysicalDevice):
         'bus_pos',
         '_conn',
         '_rms_model',
-        'time'
+        'time',
+        'color'
     )
 
     def __init__(self,
@@ -64,7 +65,8 @@ class InjectionParent(PhysicalDevice):
                  build_status: BuildStatus,
                  device_type: DeviceType,
                  longitude=0.0,
-                 latitude=0.0):
+                 latitude=0.0,
+                 color: str | None = None):
         """
         InjectionTemplate
         :param name: Name of the device
@@ -125,10 +127,15 @@ class InjectionParent(PhysicalDevice):
 
         self.bus_pos: int = 0
 
+        self.color = color if color is not None else "#909090"  # light gray
+
         self.register(key='bus', units='', tpe=DeviceType.BusDevice, definition='Connection bus', editable=False)
 
         self.register(key='active', units='', tpe=bool, definition='Is the load active?', profile_name='active_prof')
 
+        self.register(key='color', units='', tpe=str, definition='Color to paint the element in the map diagram',
+                      is_color=True)
+
         self.register(key='mttf', units='h', tpe=float, definition='Mean time to failure')
         self.register(key='mttr', units='h', tpe=float, definition='Mean time to recovery')
 
@@ -354,3 +361,31 @@ class InjectionParent(PhysicalDevice):
         :return: bus_pos
         """
         return self.bus_pos
+
+    def try_to_find_coordinates(self) -> Tuple[float, float]:
+        """
+        Get the latitude and
+        :return: longitude, latitude
+        """
+        if self.latitude == 0.0 and self.longitude == 0.0:
+            lon, lat = self.bus.get_coordinates()
+
+            if lon == 0.0 and lat == 0.0:
+                lon, lat = self.bus.try_to_find_coordinates()
+
+                return lon, lat
+            else:
+                return lon, lat
+        else:
+            return self.longitude, self.latitude
+
+    def color_by_main_technology(self):
+        """
+        Set the color of the dominant technology
+        """
+        mx = 0.0
+        col = self.color
+        for _, val in self.technologies.data.items():
+            if val.value > mx:
+                col = val.api_object.color
+        self.color = col

{veragridengine-5.6.0 → veragridengine-5.6.2}/VeraGridEngine/Devices/Substation/bus.py

@@ -472,7 +472,7 @@ class Bus(PhysicalDevice):
         if show_fig:
             plt.show()
 
-    def get_fault_impedance(self):
+    def get_fault_impedance(self) -> complex:
         """
         Get the fault impedance
         :return: complex value of fault impedance

{veragridengine-5.6.0 → veragridengine-5.6.2}/VeraGridEngine/Devices/assets.py

@@ -5938,6 +5938,17 @@ class Assets:
 
         return n
 
+    def get_load_like_devices_names(self) -> StrVec:
+        """
+        Get a list of names of the load like devices
+        :return: array of str
+        """
+        elms = list()
+        for lst in self.get_load_like_devices_lists():
+            for elm in lst:
+                elms.append(elm.name)
+        return np.array(elms)
+
     # ------------------------------------------------------------------------------------------------------------------
     # Shunt-like devices
     # ------------------------------------------------------------------------------------------------------------------

{veragridengine-5.6.0 → veragridengine-5.6.2}/VeraGridEngine/Devices/types.py

@@ -122,4 +122,4 @@ ASSOCIATION_TYPES = Union[Fuel, Technology, EmissionGas]
 # this is the data type of the VeraGrid Json
 VERAGRID_FILE_TYPE = Dict[str, Union[str, float, pd.DataFrame, Dict[str, Any], List[Dict[str, Any]]]]
 
-ALL_RMS_TEMPLATES_TYPE = Union[BusRmsTemplate, LoadRmsTemplate, Line_1_RmsTemplate, Generator_1_RmsTemplate, Line_0_RmsTemplate, Generator_0_RmsTemplate]
+# ALL_RMS_TEMPLATES_TYPE = Union[BusRmsTemplate, LoadRmsTemplate, Line_1_RmsTemplate, Generator_1_RmsTemplate, Line_0_RmsTemplate, Generator_0_RmsTemplate]

{veragridengine-5.6.0 → veragridengine-5.6.2}/VeraGridEngine/IO/veragrid/catalogue.py

@@ -14,18 +14,8 @@ from VeraGridEngine.Devices.multi_circuit import MultiCircuit
 from VeraGridEngine.enumerations import DeviceType
 from VeraGridEngine.basic_structures import Logger
 
-
-
-from VeraGridEngine.Devices.types import ALL_RMS_TEMPLATES_TYPE
 from VeraGridEngine.enumerations import DeviceType
 
-from VeraGridEngine.Templates.Rms.bus_rms_template import BusRmsTemplate
-from VeraGridEngine.Templates.Rms.generator_0_rms_template import Generator_0_RmsTemplate
-from VeraGridEngine.Templates.Rms.generator_1_rms_template import Generator_1_RmsTemplate
-from VeraGridEngine.Templates.Rms.line_0_rms_template import Line_0_RmsTemplate
-from VeraGridEngine.Templates.Rms.line_1_rms_template import Line_1_RmsTemplate
-from VeraGridEngine.Templates.Rms.load_rms_template import LoadRmsTemplate
-
 
 
 
@@ -88,7 +78,7 @@ def get_wires_catalogue_df(grid: MultiCircuit):
             'Name': elm.name,
             'Stranding': elm.stranding,
             'Material': elm.material,
-            'Diameter [cm]': elm.diameter / 10.0, # mm to cm
+            'Diameter [cm]': elm.diameter / 10.0,  # mm to cm
             'R [Ohm/km]': elm.R,
             'Rating [kA]': elm.max_current
         })
@@ -127,16 +117,16 @@ def parse_transformer_types(df: pd.DataFrame) -> List[TransformerType]:
     """
     lst = list()
     for i, item in df.iterrows():
-        tpe = TransformerType(hv_nominal_voltage=item.get('HV (kV)',0.0),
-                              lv_nominal_voltage=item.get('LV (kV)',0.0),
-                              nominal_power=item.get('Rate (MVA)',0.001),
-                              copper_losses=item.get('Copper losses (kW)',0.0),
-                              iron_losses=item.get('No load losses (kW)',0.0),
-                              no_load_current=item.get('No load current (%)',0.0),
-                              short_circuit_voltage=item.get('V short circuit (%)',0.0),
-                              gr_hv1=item.get("gr_hv1",0.5),
-                              gx_hv1=item.get("gx_hv1",0.5),
-                              name=item.get('Name',"TransformerType_{}".format(i)))
+        tpe = TransformerType(hv_nominal_voltage=item.get('HV (kV)', 0.0),
+                              lv_nominal_voltage=item.get('LV (kV)', 0.0),
+                              nominal_power=item.get('Rate (MVA)', 0.001),
+                              copper_losses=item.get('Copper losses (kW)', 0.0),
+                              iron_losses=item.get('No load losses (kW)', 0.0),
+                              no_load_current=item.get('No load current (%)', 0.0),
+                              short_circuit_voltage=item.get('V short circuit (%)', 0.0),
+                              gr_hv1=item.get("gr_hv1", 0.5),
+                              gx_hv1=item.get("gx_hv1", 0.5),
+                              name=item.get('Name', "TransformerType_{}".format(i)))
         lst.append(tpe)
 
     return lst
@@ -150,15 +140,15 @@ def parse_cable_types(df: pd.DataFrame) -> List[UndergroundLineType]:
     """
     lst = list()
     for i, item in df.iterrows():
-        tpe = UndergroundLineType(name=item.get('Name',"UndergroundLine_{}".format(i)),
-                                  Imax=item.get('Rated current [kA]',1.0),
-                                  Vnom=item.get('Rated voltage [kV]',1.0),
-                                  R=item.get('R [Ohm/km AC@20°C]',0.0),
-                                  X=item.get('X [Ohm/km]',0.0),
+        tpe = UndergroundLineType(name=item.get('Name', "UndergroundLine_{}".format(i)),
+                                  Imax=item.get('Rated current [kA]', 1.0),
+                                  Vnom=item.get('Rated voltage [kV]', 1.0),
+                                  R=item.get('R [Ohm/km AC@20°C]', 0.0),
+                                  X=item.get('X [Ohm/km]', 0.0),
                                   B=item.get('B [uS/km]', 0.0),
-                                  R0=item.get('R0 (AC) [Ohm/km]',0.0),
-                                  X0=item.get('X0  [Ohm/km]',0.0),
-                                  B0=item.get('B0 [uS/km]',0.0))
+                                  R0=item.get('R0 (AC) [Ohm/km]', 0.0),
+                                  X0=item.get('X0  [Ohm/km]', 0.0),
+                                  B0=item.get('B0 [uS/km]', 0.0))
         lst.append(tpe)
 
     return lst
@@ -173,11 +163,11 @@ def parse_wire_types(df: pd.DataFrame) -> List[Wire]:
     lst = list()
     for i, item in df.iterrows():
         tpe = Wire(name=str(item['Stranding']) + '_' + str(item['Material']) + '_' + str(item['Diameter [cm]']),
-                   stranding=item.get('Stranding',""),
-                   material=item.get('Material',""),
-                   diameter=item.get('Diameter [cm]',0.0) * 10.0,  # cm to mm
-                   r=item.get('R [Ohm/km]',0.01),
-                   max_current=item.get('Rating [kA]',1.0))
+                   stranding=item.get('Stranding', ""),
+                   material=item.get('Material', ""),
+                   diameter=item.get('Diameter [cm]', 0.0) * 10.0,  # cm to mm
+                   r=item.get('R [Ohm/km]', 0.01),
+                   max_current=item.get('Rating [kA]', 1.0))
         lst.append(tpe)
 
     return lst
@@ -191,32 +181,19 @@ def parse_sequence_line_types(df: pd.DataFrame) -> List[SequenceLineType]:
     """
     lst = list()
     for i, item in df.iterrows():
-        tpe = SequenceLineType(name=item.get('Name','SequenceLine_{}'.format(i)),
-                               Vnom=item.get('Vnom (kV)',1),
-                               Imax=item.get('Imax (kA)',1),
-                               R=item.get('r (ohm/km)',0),
-                               X=item.get('x (ohm/km)',0),
-                               B=item.get('b (uS/km)',0),
-                               R0=item.get('r0 (ohm/km)',0),
-                               X0=item.get('x0 (ohm/km)',0),
-                               B0=item.get('b0 (uS/km)',0))
+        tpe = SequenceLineType(name=item.get('Name', 'SequenceLine_{}'.format(i)),
+                               Vnom=item.get('Vnom (kV)', 1),
+                               Imax=item.get('Imax (kA)', 1),
+                               R=item.get('r (ohm/km)', 0),
+                               X=item.get('x (ohm/km)', 0),
+                               B=item.get('b (uS/km)', 0),
+                               R0=item.get('r0 (ohm/km)', 0),
+                               X0=item.get('x0 (ohm/km)', 0),
+                               B0=item.get('b0 (uS/km)', 0))
         lst.append(tpe)
 
     return lst
 
-def parse_rms_model_catalogue() -> List[ALL_RMS_TEMPLATES_TYPE]:
-
-    templ_bus = BusRmsTemplate()
-    templ_gen_0 = Generator_0_RmsTemplate()
-    templ_gen_1 = Generator_1_RmsTemplate()
-    templ_line_0 = Line_0_RmsTemplate()
-    templ_line_1 = Line_1_RmsTemplate()
-    templ_load = LoadRmsTemplate()
-    templates: List[ALL_RMS_TEMPLATES_TYPE] = [templ_bus, templ_gen_0, templ_gen_1, templ_line_0, templ_line_1,
-                                               templ_load]
-
-    return templates
-
 
 def save_catalogue(fname: str, grid: MultiCircuit):
     """

{veragridengine-5.6.0 → veragridengine-5.6.2}/VeraGridEngine/IO/veragrid/pack_unpack.py

@@ -20,7 +20,6 @@ from VeraGridEngine.Utils.Symbolic.block import Block
 from VeraGridEngine.Devices.types import ALL_DEV_TYPES, VERAGRID_FILE_TYPE
 from VeraGridEngine.enumerations import (DiagramType, DeviceType, SubObjectType, TapPhaseControl, TapModuleControl,
                                          ContingencyOperationTypes)
-# from VeraGridEngine.Devices.all_dev_dict import get_objects_dictionary
 
 
 def get_objects_dictionary() -> Dict[str, ALL_DEV_TYPES]:

{veragridengine-5.6.0 → veragridengine-5.6.2}/VeraGridEngine/Simulations/OPF/Formulations/linear_opf_ts.py

@@ -2152,6 +2152,61 @@ def add_linear_branches_contingencies_formulation(t_idx: int,
     return f_obj
 
 
+def pmode3_formulation_impr(prob, t_idx, m, rate, P0, droop, theta_f, theta_t, base_name: str = "hvdc"):
+    """
+    Formulation for HVDC link with three operating regions using big-M and binary variables.
+    """
+    # Ensure droop is not zero or too small to avoid division issues
+    if abs(droop) < 1e-10:
+        droop = 1e-20
+    
+    # Variables
+    flow = prob.add_var(
+        lb=-rate,
+        ub=rate,
+        name=f"{base_name}_flow_{t_idx}_{m}"
+    )
+    z1 = prob.add_int(lb=0, ub=1, name=f"{base_name}_z1_{t_idx}_{m}")
+    z2 = prob.add_int(lb=0, ub=1, name=f"{base_name}_z2_{t_idx}_{m}")
+    z3 = prob.add_int(lb=0, ub=1, name=f"{base_name}_z3_{t_idx}_{m}")
+
+    # Constants
+    delta = theta_f - theta_t
+    delta_low = (-rate - P0) / droop
+    delta_high = (rate - P0) / droop
+    M = 20 * rate  # Big-M as per note; may need adjustment for angle constraints
+
+    # Exactly one region active
+    prob.add_cst(z1 + z2 + z3 >= 1, name=f"one_region_ge_{t_idx}_{m}")
+    prob.add_cst(z1 + z2 + z3 <= 1, name=f"one_region_le_{t_idx}_{m}")
+
+    # Region constraints
+    # Region 1 (z1=1): saturated at -rate, delta <= delta_low
+    prob.add_cst(delta <= delta_low + M * (1 - z1), name=f"region1_le_{t_idx}_{m}")
+
+    # Region 2 (z2=1): droop, delta_low <= delta <= delta_high
+    prob.add_cst(delta >= delta_low - M * (1 - z2), name=f"region2_ge_{t_idx}_{m}")
+    prob.add_cst(delta <= delta_high + M * (1 - z2), name=f"region2_le_{t_idx}_{m}")
+
+    # Region 3 (z3=1): saturated at +rate, delta >= delta_high
+    prob.add_cst(delta >= delta_high - M * (1 - z3), name=f"region3_ge_{t_idx}_{m}")
+
+    # Power constraints
+    # Region 1: flow = -rate when z1=1
+    prob.add_cst(flow >= -rate - M * (1 - z1), name=f"power1_ge_{t_idx}_{m}")
+    prob.add_cst(flow <= -rate + M * (1 - z1), name=f"power1_le_{t_idx}_{m}")
+
+    # Region 2: flow = P0 + droop * (theta_f - theta_t) when z2=1
+    prob.add_cst(flow - (P0 + droop * delta) >= -M * (1 - z2), name=f"power2_ge_{t_idx}_{m}")
+    prob.add_cst(flow - (P0 + droop * delta) <= M * (1 - z2), name=f"power2_le_{t_idx}_{m}")
+
+    # Region 3: flow = rate when z3=1
+    prob.add_cst(flow >= rate - M * (1 - z3), name=f"power3_ge_{t_idx}_{m}")
+    prob.add_cst(flow <= rate + M * (1 - z3), name=f"power3_le_{t_idx}_{m}")
+
+    return flow
+
+
 def add_linear_hvdc_formulation(t: int,
                                 Sbase: float,
                                 hvdc_data_t: HvdcData,
@@ -2179,10 +2234,28 @@ def add_linear_hvdc_formulation(t: int,
 
             if hvdc_data_t.control_mode[m] == HvdcControlType.type_0_free:
 
-                # set the flow based on the angular difference
+                # use improved pmode3 formulation with three operating regions
                 P0 = hvdc_data_t.Pset[m] / Sbase
-                k = hvdc_data_t.angle_droop[m]
-                hvdc_vars.flows[t, m] = (P0 + k * (bus_vars.Va[t, fr] - bus_vars.Va[t, to]))
+                
+                # convert MW/deg to pu/rad
+                droop = hvdc_data_t.get_angle_droop_in_pu_rad_at(m, Sbase)
+                if droop == 0.0:
+                    # avoid division by zero in pmode3_formulation_impr
+                    droop = 1e-20
+                
+                rate = hvdc_data_t.rates[m] / Sbase
+                
+                hvdc_vars.flows[t, m] = pmode3_formulation_impr(
+                    prob=prob,
+                    t_idx=t,
+                    m=m,
+                    rate=rate,
+                    P0=P0,
+                    droop=droop,
+                    theta_f=bus_vars.Va[t, fr],
+                    theta_t=bus_vars.Va[t, to],
+                    base_name="hvdc"
+                )
 
                 # add the injections matching the flow
                 bus_vars.Pbalance[t, fr] += - hvdc_vars.flows[t, m]

{veragridengine-5.6.0 → veragridengine-5.6.2}/VeraGridEngine/Simulations/PowerFlow/__init__.py

@@ -11,4 +11,5 @@ from VeraGridEngine.Simulations.PowerFlow.power_flow_ts_driver import PowerFlowT
 from VeraGridEngine.Simulations.PowerFlow.power_flow_ts_results import PowerFlowTimeSeriesResults
 from VeraGridEngine.Simulations.PowerFlow.power_flow_ts_input import PowerFlowTimeSeriesInput
 from VeraGridEngine.Simulations.PowerFlow.power_flow_results import PowerFlowResults
-from VeraGridEngine.Simulations.PowerFlow.power_flow_results_3ph import PowerFlowResults3Ph
+from VeraGridEngine.Simulations.PowerFlow.power_flow_results_3ph import PowerFlowResults3Ph
+from VeraGridEngine.Simulations.PowerFlow.power_flow_driver_3ph import PowerFlowDriver3Ph