feat: add AsymPowerSensorArray and remove optional columns from GenericBranch (#113)

* Add AsymPowerSensorArray

Signed-off-by: Thijs Baaijen <[email protected]>

* rename and update test

Signed-off-by: Thijs Baaijen <[email protected]>

* remove defaulted fields for consistency

Signed-off-by: Thijs Baaijen <[email protected]>

* revert change

Signed-off-by: Thijs Baaijen <[email protected]>

* cleanup

Signed-off-by: Thijs Baaijen <[email protected]>

---------

Signed-off-by: Thijs Baaijen <[email protected]>

Author: Thijss

src/power_grid_model_ds/_core/model/arrays/__init__.py

@@ -9,6 +9,7 @@
 from power_grid_model_ds._core.model.arrays.pgm_arrays import (
     AsymCurrentSensorArray,
     AsymLineArray,
+    AsymPowerSensorArray,
     AsymVoltageSensorArray,
     Branch3Array,
     BranchArray,
@@ -29,6 +30,7 @@
 )
 
 __all__ = [
+    "AsymPowerSensorArray",
     "AsymVoltageSensorArray",
     "AsymCurrentSensorArray",
     "Branch3Array",

src/power_grid_model_ds/_core/model/arrays/pgm_arrays.py

@@ -27,6 +27,7 @@
 from power_grid_model_ds._core.model.dtypes.regulators import TransformerTapRegulator
 from power_grid_model_ds._core.model.dtypes.sensors import (
     AsymCurrentSensor,
+    AsymPowerSensor,
     AsymVoltageSensor,
     SymCurrentSensor,
     SymPowerSensor,
@@ -154,11 +155,15 @@ class SymVoltageSensorArray(IdArray, SymVoltageSensor):
     pass
 
 
-class AsymVoltageSensorArray(IdArray, AsymVoltageSensor):
+class SymCurrentSensorArray(IdArray, SymCurrentSensor):
     pass
 
 
-class SymCurrentSensorArray(IdArray, SymCurrentSensor):
+class AsymPowerSensorArray(IdArray, AsymPowerSensor):
+    pass
+
+
+class AsymVoltageSensorArray(IdArray, AsymVoltageSensor):
     pass
 
 

src/power_grid_model_ds/_core/model/dtypes/branches.py

@@ -54,15 +54,6 @@ class GenericBranch(Branch):
     x1: NDArray[np.float64]  # positive-sequence reactance
     g1: NDArray[np.float64]  # positive-sequence conductance
     b1: NDArray[np.float64]  # positive-sequence susceptance
-    k: NDArray[np.float64]  # off-nominal ratio
-    theta: NDArray[np.float64]  # angle shift (radian)
-    sn: NDArray[np.float64]  # rated power
-
-    _defaults = {
-        "k": 1.0,
-        "theta": 0.0,
-        "sn": 0.0,
-    }
 
 
 class Transformer(Branch):

src/power_grid_model_ds/_core/model/dtypes/sensors.py

@@ -43,6 +43,15 @@ class SymPowerSensor(GenericPowerSensor):
     q_sigma: NDArray[np.float64]  # std of reactive power
 
 
+class AsymPowerSensor(GenericPowerSensor):
+    """AsymPowerSensor data type"""
+
+    p_measured: NDArray3[np.float64]  # measured active power
+    q_measured: NDArray3[np.float64]  # measured reactive power
+    p_sigma: NDArray3[np.float64]  # std of active power
+    q_sigma: NDArray3[np.float64]  # std of reactive power
+
+
 class GenericVoltageSensor(Sensor):
     """Base class for voltage sensor data type"""
 

src/power_grid_model_ds/_core/model/grids/base.py

@@ -19,6 +19,7 @@
 from power_grid_model_ds._core.model.arrays import (
     AsymCurrentSensorArray,
     AsymLineArray,
+    AsymPowerSensorArray,
     AsymVoltageSensorArray,
     Branch3Array,
     BranchArray,
@@ -89,8 +90,9 @@ class Grid(FancyArrayContainer):
     # sensors
     sym_power_sensor: SymPowerSensorArray
     sym_voltage_sensor: SymVoltageSensorArray
-    asym_voltage_sensor: AsymVoltageSensorArray
     sym_current_sensor: SymCurrentSensorArray
+    asym_power_sensor: AsymPowerSensorArray
+    asym_voltage_sensor: AsymVoltageSensorArray
     asym_current_sensor: AsymCurrentSensorArray
 
     def __str__(self) -> str:

tests/unit/model/arrays/test_build.py

@@ -8,7 +8,7 @@
 from numpy.typing import NDArray
 
 from power_grid_model_ds._core import fancypy as fp
-from power_grid_model_ds._core.model.arrays import AsymVoltageSensorArray, SymPowerSensorArray
+from power_grid_model_ds._core.model.arrays import AsymVoltageSensorArray
 from power_grid_model_ds._core.model.arrays.base.array import FancyArray
 from power_grid_model_ds._core.model.arrays.base.errors import ArrayDefinitionError
 from power_grid_model_ds._core.model.constants import EMPTY_ID
@@ -232,27 +232,13 @@ def test_initialization_from_args_with_extra_columns():
     assert "undefined" not in array.dtype.names
 
 
-def test_sensor_array():
-    test_len = 2
-    # test proper intiliazation of a SensorArray
-    pow_sens = SymPowerSensorArray.empty(test_len)
-    sym_pow_fields = [
-        "measured_object",
-        "measured_terminal_type",
-        "power_sigma",
-        "p_measured",
-        "p_sigma",
-        "q_measured",
-        "q_sigma",
-    ]
-    for field in sym_pow_fields:
-        assert field in pow_sens.dtype.fields
-
+def test_asymmetric_sensor_array():
+    array_length = 2
     # test if asymmetric array has NDArray3 fields, i.e. with 3 floats per element (one per phase)
-    asym_volt_sens = AsymVoltageSensorArray.empty(test_len)
+    asym_volt_sens = AsymVoltageSensorArray.empty(array_length)
     nd3_fields = ["u_sigma", "u_measured", "u_angle_measured"]
     for field in nd3_fields:
-        assert asym_volt_sens[field].shape == (test_len, 3)
+        assert asym_volt_sens[field].shape == (array_length, 3)
 
 
 def test_inherit_defaults_from_multiple_parents():

tests/unit/model/grids/test_grid_base.py

@@ -31,24 +31,25 @@ def test_initialize_empty_grid(grid: Grid):
     assert isinstance(grid, Grid)
     fields = dataclasses.asdict(grid).keys()
     assert {
-        "link",
-        "sym_load",
-        "sym_power_sensor",
-        "source",
         "_id_counter",
-        "transformer_tap_regulator",
-        "asym_voltage_sensor",
-        "sym_current_sensor",
         "asym_current_sensor",
-        "three_winding_transformer",
-        "transformer",
-        "node",
-        "line",
-        "generic_branch",
         "asym_line",
-        "sym_gen",
+        "asym_power_sensor",
+        "asym_voltage_sensor",
+        "generic_branch",
         "graphs",
+        "line",
+        "link",
+        "node",
+        "source",
+        "sym_current_sensor",
+        "sym_gen",
+        "sym_load",
+        "sym_power_sensor",
         "sym_voltage_sensor",
+        "three_winding_transformer",
+        "transformer",
+        "transformer_tap_regulator",
     } == set(fields)