fixing docstrings and cleaning up composite current integral

Author: dmarek-flex

tests/test_components/test_microwave.py

@@ -10,8 +10,6 @@
 import pydantic.v1 as pd
 import pytest
 import xarray as xr
-from shapely.geometry import LineString, Polygon
-from shapely.plotting import plot_line, plot_polygon
 
 import tidy3d as td
 import tidy3d.components.microwave.path_integrals.current_spec
@@ -30,15 +28,14 @@
     make_voltage_integral,
 )
 from tidy3d.components.mode.mode_solver import ModeSolver
-from tidy3d.components.types import Ax, Shapely
 from tidy3d.constants import EPSILON_0
 from tidy3d.exceptions import SetupError, ValidationError
 
 from ..test_data.test_monitor_data import make_directivity_data
 
 mm = 1e3
 
-MAKE_PLOTS = True
+MAKE_PLOTS = False
 if MAKE_PLOTS:
     # Interactive plotting for debugging
     from matplotlib import use
@@ -237,24 +234,6 @@ def make_mw_sim(
     return sim
 
 
-def plot_auto_path_spec(
-    path_spec: td.CompositeCurrentIntegralSpec,
-    geoms: list[Shapely],
-    ax: Ax = None,
-) -> Ax:
-    """Helper to plot composite path specifications along with the Shapely geometries used to generate them."""
-    if ax is None:
-        _, ax = plt.subplots(1, 1, tight_layout=True, figsize=(15, 15))
-
-    for geom in geoms:
-        if isinstance(geom, Polygon):
-            plot_polygon(geom, ax=ax)
-        elif isinstance(geom, LineString):
-            plot_line(geom, ax=ax)
-    i_integral = make_current_integral(path_spec)
-    i_integral.plot(x=i_integral.center[0], ax=ax)
-
-
 def test_inductance_formulas():
     """Run the formulas for inductance and compare to precomputed results."""
     bar_size = (1000e4, 1e4, 1e4)  # case from reference
@@ -399,9 +378,7 @@ def test_composite_current_integral_validation():
 
     current_spec = td.CurrentIntegralAxisAlignedSpec(center=(1, 2, 3), size=(0, 1, 1), sign="-")
     voltage_spec = td.VoltageIntegralAxisAlignedSpec(center=(1, 2, 3), size=(0, 0, 1), sign="-")
-    path_spec = td.CompositeCurrentIntegralSpec(
-        center=(1, 2, 3), size=(0, 1, 1), path_specs=[current_spec], sum_spec="sum"
-    )
+    path_spec = td.CompositeCurrentIntegralSpec(path_specs=[current_spec], sum_spec="sum")
 
     with pytest.raises(pd.ValidationError):
         path_spec.updated_copy(path_specs=[])
@@ -519,9 +496,7 @@ def test_path_integral_factory_current_validation():
     custom_2d_spec = td.CustomCurrentIntegral2DSpec(
         vertices=[(0, 1), (0, 4), (3, 4), (3, 1)], axis=1, position=2
     )
-    composite_spec = td.CompositeCurrentIntegralSpec(
-        center=(1, 2, 3), size=(0, 1, 1), path_specs=[axis_aligned_spec], sum_spec="sum"
-    )
+    composite_spec = td.CompositeCurrentIntegralSpec(path_specs=[axis_aligned_spec], sum_spec="sum")
 
     # Test successful creation with axis-aligned spec
     current_integral = make_current_integral(axis_aligned_spec)
@@ -538,7 +513,6 @@ def test_path_integral_factory_current_validation():
     # Test successful creation with composite spec
     current_integral = make_current_integral(composite_spec)
     assert current_integral is not None
-    assert current_integral.center == (1, 2, 3)
     assert len(current_integral.path_specs) == 1
 
     # Test ValidationError with unsupported type
@@ -613,7 +587,7 @@ def mock_make_voltage_integral(path_spec):
 
 
 def test_path_integral_factory_composite_current():
-    """Test make_current_integral with CompositeCurrentIntegralSpec and integration."""
+    """Test make_current_integral with CompositeCurrentIntegralSpec."""
 
     # Create base specs for the composite
     axis_aligned_spec1 = td.CurrentIntegralAxisAlignedSpec(
@@ -625,22 +599,17 @@ def test_path_integral_factory_composite_current():
 
     # Test creation of CompositeCurrentIntegralSpec
     composite_spec = td.CompositeCurrentIntegralSpec(
-        center=(1.5, 2, 3),
-        size=(2, 1, 1),
         path_specs=[axis_aligned_spec1, axis_aligned_spec2],
         sum_spec="sum",
     )
 
     # Test successful creation with composite spec
     current_integral = make_current_integral(composite_spec)
     assert current_integral is not None
-    assert current_integral.center == (1.5, 2, 3)
     assert len(current_integral.path_specs) == 2
 
     # Test with different sum_spec options
     composite_spec_split = td.CompositeCurrentIntegralSpec(
-        center=(1.5, 2, 3),
-        size=(2, 1, 1),
         path_specs=[axis_aligned_spec1, axis_aligned_spec2],
         sum_spec="split",
     )

tests/test_plugins/test_microwave.py

@@ -543,14 +543,8 @@ def test_composite_current_integral_warnings():
     coords = {"f": f, "mode_index": mode_index}
     values = np.ones((3, 5))
 
-    path_spec = (
-        tidy3d.components.microwave.path_integrals.current_spec.CurrentIntegralAxisAlignedSpec(
-            center=(0, 0, 0), size=(2, 2, 0), sign="+"
-        )
-    )
-    composite_integral = mw.CompositeCurrentIntegral(
-        center=(0, 0, 0), size=(4, 4, 0), path_specs=[path_spec], sum_spec="split"
-    )
+    path_spec = td.CurrentIntegralAxisAlignedSpec(center=(0, 0, 0), size=(2, 2, 0), sign="+")
+    composite_integral = mw.CompositeCurrentIntegral(path_specs=[path_spec], sum_spec="split")
 
     phase_diff = FreqModeDataArray(np.angle(values), coords=coords)
     with AssertLogLevel(None):
@@ -808,7 +802,7 @@ def test_composite_current_integral_compute_current():
 
     # Test with sum_spec="sum"
     composite_integral_sum = mw.CompositeCurrentIntegral(
-        center=(0, 0, 0), size=(1, 1, 0), path_specs=[path_spec1, path_spec2], sum_spec="sum"
+        path_specs=[path_spec1, path_spec2], sum_spec="sum"
     )
 
     current_sum = composite_integral_sum.compute_current(SIM_Z_DATA["field"])
@@ -817,7 +811,7 @@ def test_composite_current_integral_compute_current():
 
     # Test with sum_spec="split"
     composite_integral_split = mw.CompositeCurrentIntegral(
-        center=(0, 0, 0), size=(1, 1, 0), path_specs=[path_spec1, path_spec2], sum_spec="split"
+        path_specs=[path_spec1, path_spec2], sum_spec="split"
     )
 
     current_split = composite_integral_split.compute_current(SIM_Z_DATA["field"])
@@ -833,9 +827,7 @@ def test_composite_current_integral_time_domain_error():
 
     path_spec = mw.CurrentIntegralAxisAligned(center=(0, 0, 0), size=(0.5, 0.5, 0), sign="+")
 
-    composite_integral = mw.CompositeCurrentIntegral(
-        center=(0, 0, 0), size=(1, 1, 0), path_specs=[path_spec], sum_spec="split"
-    )
+    composite_integral = mw.CompositeCurrentIntegral(path_specs=[path_spec], sum_spec="split")
 
     # Should raise DataError for time domain data with split sum_spec
     with pytest.raises(
@@ -851,9 +843,7 @@ def test_composite_current_integral_phase_consistency_warnings():
     # Create a composite integral for testing
     path_spec = mw.CurrentIntegralAxisAligned(center=(0, 0, 0), size=(0.5, 0.5, 0), sign="+")
 
-    composite_integral = mw.CompositeCurrentIntegral(
-        center=(0, 0, 0), size=(1, 1, 0), path_specs=[path_spec], sum_spec="split"
-    )
+    composite_integral = mw.CompositeCurrentIntegral(path_specs=[path_spec], sum_spec="split")
 
     # Test _check_phase_sign_consistency with consistent data
     f = [2e9, 3e9, 4e9]
@@ -970,7 +960,7 @@ def test_composite_current_integral_freq_mode_data():
 
     # Test with sum_spec="sum" - should work with FreqModeDataArray
     composite_integral_sum = mw.CompositeCurrentIntegral(
-        center=(0, 0, 0), size=(1, 1, 0), path_specs=[path_spec1, path_spec2], sum_spec="sum"
+        path_specs=[path_spec1, path_spec2], sum_spec="sum"
     )
 
     # Use mode data which provides FreqModeDataArray
@@ -984,7 +974,7 @@ def test_composite_current_integral_freq_mode_data():
 
     # Test with sum_spec="split" - should also work with FreqModeDataArray
     composite_integral_split = mw.CompositeCurrentIntegral(
-        center=(0, 0, 0), size=(1, 1, 0), path_specs=[path_spec1, path_spec2], sum_spec="split"
+        path_specs=[path_spec1, path_spec2], sum_spec="split"
     )
 
     current_split = composite_integral_split.compute_current(SIM_Z_DATA["mode"])

tidy3d/components/microwave/path_integrals/current_spec.py

@@ -7,7 +7,7 @@
 import numpy as np
 import pydantic.v1 as pd
 
-from tidy3d.components.base import cached_property
+from tidy3d.components.base import Tidy3dBaseModel, cached_property
 from tidy3d.components.geometry.base import Box, Geometry
 from tidy3d.components.microwave.path_integrals.base_spec import (
     AbstractAxesRH,
@@ -269,10 +269,10 @@ def plot(
         return ax
 
 
-class CompositeCurrentIntegralSpec(Box):
+class CompositeCurrentIntegralSpec(Tidy3dBaseModel):
     """Specification for a composite current integral.
 
-    This class is used to set up a CompositeCurrentIntegral, which combines
+    This class is used to set up a ``CompositeCurrentIntegral``, which combines
     multiple current integrals. It does not perform any integration itself.
     """
 

tidy3d/plugins/microwave/custom_path_integrals.py

@@ -7,6 +7,7 @@
 import numpy as np
 import xarray as xr
 
+from tidy3d.components.base import cached_property
 from tidy3d.components.data.data_array import FreqDataArray, FreqModeDataArray
 from tidy3d.components.data.monitor_data import FieldTimeData
 from tidy3d.components.microwave.path_integrals.base_spec import CustomPathIntegral2DSpec
@@ -17,9 +18,9 @@
 from tidy3d.components.microwave.path_integrals.voltage_spec import CustomVoltageIntegral2DSpec
 from tidy3d.exceptions import DataError
 from tidy3d.log import log
-
-from .path_integrals import (
+from tidy3d.plugins.microwave.path_integrals import (
     AxisAlignedPathIntegral,
+    CurrentIntegralAxisAligned,
     CurrentIntegralResultTypes,
     IntegralResultTypes,
     MonitorDataTypes,
@@ -167,6 +168,18 @@ def compute_current(self, em_field: MonitorDataTypes) -> CurrentIntegralResultTy
 class CompositeCurrentIntegral(CompositeCurrentIntegralSpec):
     """Current integral comprising one or more disjoint paths"""
 
+    @cached_property
+    def current_integrals(
+        self,
+    ) -> tuple[Union[CurrentIntegralAxisAligned, CustomCurrentIntegral2D], ...]:
+        """ "Collection of closed current path integrals."""
+        from tidy3d.components.microwave.path_integrals.path_integral_factory import (
+            make_current_integral,
+        )
+
+        current_integrals = [make_current_integral(path_spec) for path_spec in self.path_specs]
+        return current_integrals
+
     def compute_current(self, em_field: MonitorDataTypes) -> IntegralResultTypes:
         """Compute current flowing in loop defined by the outer edge of a rectangle."""
         if isinstance(em_field, FieldTimeData) and self.sum_spec == "split":
@@ -175,11 +188,7 @@ def compute_current(self, em_field: MonitorDataTypes) -> IntegralResultTypes:
                 "Either switch the sum_spec to 'sum' or supply frequency domain data."
             )
 
-        from tidy3d.components.microwave.path_integrals.path_integral_factory import (
-            make_current_integral,
-        )
-
-        current_integrals = [make_current_integral(path_spec) for path_spec in self.path_specs]
+        current_integrals = self.current_integrals
 
         # Calculate currents from each path integral and store in dataarray with path index dimension
         path_currents = []