refactor by splitting the path integral specification away from the integral computation, now the path specification handles pretty much everything, except for the final integral computation and results preparation

Author: dmarek-flex

tests/test_components/test_microwave.py

@@ -12,7 +12,7 @@
 from shapely.geometry import LineString, Polygon
 from shapely.plotting import plot_line, plot_polygon
 from tidy3d.components.data.monitor_data import FreqDataArray
-from tidy3d.components.microwave.data.monitor_data import AntennaMetricsData
+from tidy3d.components.microwave.auto_path_spec import AutoPathSpec
 from tidy3d.components.microwave.formulas.circuit_parameters import (
     capacitance_colinear_cylindrical_wire_segments,
     capacitance_rectangular_sheets,
@@ -200,8 +200,10 @@ def make_mw_sim(
     return sim
 
 
-def plot_auto_path_spec(path_spec: td.CompositePathSpec, geoms: list[Shapely], ax: Ax = None) -> Ax:
-    """Helper to plot composite path specificiations along with the Shapely geometries used to generate them."""
+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))
 
@@ -260,7 +262,7 @@ def test_antenna_parameters():
     f = directivity_data.coords["f"]
     power_inc = FreqDataArray(0.8 * np.ones(len(f)), coords={"f": f})
     power_refl = 0.25 * power_inc
-    antenna_params = AntennaMetricsData.from_directivity_data(
+    antenna_params = td.AntennaMetricsData.from_directivity_data(
         directivity_data, power_inc, power_refl
     )
 
@@ -318,7 +320,7 @@ def test_auto_path_spec_canonical_shapes(colocate, tline_type):
     sim = make_mw_sim(False, colocate, tline_type)
     mode_monitor = sim.monitors[0]
     modal_plane = td.Box(center=mode_monitor.center, size=mode_monitor.size)
-    comp_path_spec, geos = td.AutoPathSpec.create_current_path_specs(
+    comp_path_spec, geos = AutoPathSpec.create_current_path_specs(
         modal_plane,
         sim.structures,
         sim.grid,
@@ -378,7 +380,7 @@ def test_auto_path_spec_advanced(use_2D, symmetry):
     mode_monitor = sim.monitors[0]
 
     modal_plane = td.Box(center=mode_monitor.center, size=mode_monitor.size)
-    comp_path_spec, geos = td.AutoPathSpec.create_current_path_specs(
+    comp_path_spec, geos = AutoPathSpec.create_current_path_specs(
         modal_plane,
         sim.structures,
         sim.grid,
@@ -408,11 +410,11 @@ def test_auto_path_spec_validation():
     # First some quick sanity checks with the helper
     test_path = td.Box(center=(0, 0, 0), size=(0, 0.9, 0.1))
     test_shapely = [LineString([(-1, 0), (1, 0)])]
-    assert td.AutoPathSpec._check_path_intersects_with_conductors(test_shapely, test_path)
+    assert AutoPathSpec._check_path_intersects_with_conductors(test_shapely, test_path)
 
     test_path = td.Box(center=(0, 0, 0), size=(0, 2.1, 0.1))
     test_shapely = [LineString([(-1, 0), (1, 0)])]
-    assert not td.AutoPathSpec._check_path_intersects_with_conductors(test_shapely, test_path)
+    assert not AutoPathSpec._check_path_intersects_with_conductors(test_shapely, test_path)
 
     sim = make_mw_sim(False, False, "microstrip")
     coax = td.GeometryGroup(
@@ -432,7 +434,7 @@ def test_auto_path_spec_validation():
     mode_monitor = sim.monitors[0]
     modal_plane = td.Box(center=mode_monitor.center, size=mode_monitor.size)
     with pytest.raises(ValidationError):
-        td.AutoPathSpec.create_current_path_specs(
+        AutoPathSpec.create_current_path_specs(
             modal_plane,
             sim.structures,
             sim.grid,
@@ -445,16 +447,16 @@ def test_auto_path_spec_validation():
 def test_path_integral_creation():
     """Check that path integrals are correctly constructed from path specifications."""
 
-    path_spec = td.AxisAlignedPathSpec(center=(1, 2, 3), size=(0, 0, 1), sign="-")
+    path_spec = td.VoltageIntegralAxisAlignedSpec(center=(1, 2, 3), size=(0, 0, 1), sign="-")
     voltage_integral = make_voltage_integral(path_spec)
 
-    path_spec = td.AxisAlignedPathSpec(center=(1, 2, 3), size=(0, 1, 1), sign="-")
+    path_spec = td.CurrentIntegralAxisAlignedSpec(center=(1, 2, 3), size=(0, 1, 1), sign="-")
     current_integral = make_current_integral(path_spec)
 
-    path_spec = td.PathSpec(vertices=[(0, 1), (0, 4)], axis=1, position=2)
+    path_spec = td.CustomVoltageIntegral2DSpec(vertices=[(0, 1), (0, 4)], axis=1, position=2)
     voltage_integral = make_voltage_integral(path_spec)
 
-    path_spec = td.PathSpec(
+    path_spec = td.CustomCurrentIntegral2DSpec(
         vertices=[
             (0, 1),
             (0, 4),
@@ -464,10 +466,10 @@ def test_path_integral_creation():
         axis=1,
         position=2,
     )
-    current_integral = make_current_integral(path_spec)
+    _ = make_current_integral(path_spec)
 
     with pytest.raises(pd.ValidationError):
-        path_spec = td.PathSpec(
+        path_spec = td.CustomCurrentIntegral2DSpec(
             vertices=[
                 (0, 1, 3),
                 (0, 4, 5),

tidy3d/__init__.py

@@ -15,7 +15,13 @@
 from tidy3d.components.microwave.data.monitor_data import (
     AntennaMetricsData,
 )
-from tidy3d.components.microwave.path_spec import AxisAlignedPathSpec, CompositePathSpec, PathSpec
+from tidy3d.components.microwave.path_spec import (
+    CompositeCurrentIntegralSpec,
+    CurrentIntegralAxisAlignedSpec,
+    CustomCurrentIntegral2DSpec,
+    CustomVoltageIntegral2DSpec,
+    VoltageIntegralAxisAlignedSpec,
+)
 from tidy3d.components.microwave.terminal_spec import (
     TerminalSpec,
 )
@@ -698,8 +704,10 @@ def set_logging_level(level: str) -> None:
     "IsothermalSteadyChargeDCAnalysis",
     "ChargeToleranceSpec",
     "AntennaMetricsData",
-    "AxisAlignedPathSpec",
-    "CompositePathSpec",
-    "PathSpec",
+    "CurrentIntegralAxisAlignedSpec",
+    "VoltageIntegralAxisAlignedSpec",
+    "CustomCurrentIntegral2DSpec",
+    "CustomVoltageIntegral2DSpec",
+    "CompositeCurrentIntegralSpec",
     "TerminalSpec",
 ]

tidy3d/components/microwave/auto_path_spec.py

@@ -23,19 +23,19 @@
 from ..grid.grid import Grid
 from ..structure import Structure
 from ..types import Axis, Coordinate, Shapely, Symmetry
-from .path_spec import AxisAlignedPathSpec, CompositePathSpec
+from .path_spec import CompositeCurrentIntegralSpec, CurrentIntegralAxisAlignedSpec
 
 
 class AutoPathSpec(Tidy3dBaseModel):
     """Automatically determines current integration paths based on structure geometry.
 
     This class analyzes the geometry of conductors in a simulation cross-section to determine
-    appropriate paths for computing current line integrals. These paths are used
-    in terminal impedance calculations and mode solving.
+    appropriate paths for computing current line integrals. These paths are typically used
+    in terminal impedance calculations after mode solving.
 
     The paths are chosen by:
     1. Finding and merging conductor surfaces that intersect with the plane
-    2. Creating current paths that enclose individual conductors
+    2. Creating current paths that enclose isolated conductors
     """
 
     @staticmethod
@@ -66,7 +66,7 @@ def create_current_path_specs(
         symmetry: tuple[Symmetry, Symmetry, Symmetry],
         sim_box: Box,
         field_data_colocated: bool = False,
-    ) -> tuple[CompositePathSpec, list[Shapely]]:
+    ) -> tuple[CompositeCurrentIntegralSpec, list[Shapely]]:
         """Creates path specifications for path integrals that encompass each isolated conductor in the mode plane.
 
         This method identifies isolated conductor geometries in the given plane and creates
@@ -139,12 +139,12 @@ def bounding_box_from_shapely(geom: Shapely, normal_axis, normal_center):
                 boxes = AutoPathSpec._apply_symmetry(symmetry, sim_box.center, normal_axis, box)
                 for box in boxes:
                     box_snapped = snap_box_to_grid(grid, box, snap_spec)
-                    path_spec = AxisAlignedPathSpec(
+                    path_spec = CurrentIntegralAxisAlignedSpec(
                         center=box_snapped.center,
                         size=box_snapped.size,
                         sign="+",
                         extrapolate_to_endpoints=False,
-                        snap_path_to_grid=True,
+                        snap_contour_to_grid=True,
                     )
                     current_integral_specs.append(path_spec)
 
@@ -156,7 +156,7 @@ def bounding_box_from_shapely(geom: Shapely, normal_axis, normal_center):
                     "In the meantime, please specify the path specification manually for this structure."
                 )
 
-        path_spec = CompositePathSpec(
+        path_spec = CompositeCurrentIntegralSpec(
             center=mode_plane.center,
             size=mode_plane.size,
             path_specs=current_integral_specs,

tidy3d/components/microwave/path_integral_factory.py

@@ -9,10 +9,18 @@
     VoltageIntegralAxisAligned,
     VoltageIntegralTypes,
 )
-from .path_spec import AxisAlignedPathSpec, CompositePathSpec, PathSpec, PathSpecTypes
+from .path_spec import (
+    CompositeCurrentIntegralSpec,
+    CurrentIntegralAxisAlignedSpec,
+    CurrentPathSpecTypes,
+    CustomCurrentIntegral2DSpec,
+    CustomVoltageIntegral2DSpec,
+    VoltageIntegralAxisAlignedSpec,
+    VoltagePathSpecTypes,
+)
 
 
-def make_voltage_integral(path_spec: PathSpecTypes) -> VoltageIntegralTypes:
+def make_voltage_integral(path_spec: VoltagePathSpecTypes) -> VoltageIntegralTypes:
     """Create a voltage path integral from a path specification.
 
     Parameters
@@ -27,14 +35,14 @@ def make_voltage_integral(path_spec: PathSpecTypes) -> VoltageIntegralTypes:
         Voltage path integral instance corresponding to the provided specification type.
     """
     v_integral = None
-    if isinstance(path_spec, AxisAlignedPathSpec):
+    if isinstance(path_spec, VoltageIntegralAxisAlignedSpec):
         v_integral = VoltageIntegralAxisAligned(**path_spec.dict(exclude={"type"}))
-    elif isinstance(path_spec, PathSpec):
+    elif isinstance(path_spec, CustomVoltageIntegral2DSpec):
         v_integral = CustomVoltageIntegral2D(**path_spec.dict(exclude={"type"}))
     return v_integral
 
 
-def make_current_integral(path_spec: PathSpecTypes) -> CurrentIntegralTypes:
+def make_current_integral(path_spec: CurrentPathSpecTypes) -> CurrentIntegralTypes:
     """Create a current path integral from a path specification.
 
     Parameters
@@ -50,26 +58,23 @@ def make_current_integral(path_spec: PathSpecTypes) -> CurrentIntegralTypes:
     """
     i_integral = None
     if path_spec is not None:
-        if isinstance(path_spec, AxisAlignedPathSpec):
-            snap = path_spec.snap_path_to_grid
-            spec_dict = path_spec.dict(exclude={"type", "snap_path_to_grid"})
-            spec_dict["snap_contour_to_grid"] = snap
-            i_integral = CurrentIntegralAxisAligned(**spec_dict)
-        elif isinstance(path_spec, PathSpec):
+        if isinstance(path_spec, CurrentIntegralAxisAlignedSpec):
+            i_integral = CurrentIntegralAxisAligned(**path_spec.dict(exclude={"type"}))
+        elif isinstance(path_spec, CustomCurrentIntegral2DSpec):
             i_integral = CustomCurrentIntegral2D(**path_spec.dict(exclude={"type"}))
-        elif isinstance(path_spec, CompositePathSpec):
-            i_integral = _make_composite_current_integral(path_spec)
+        elif isinstance(path_spec, CompositeCurrentIntegralSpec):
+            i_integral = CompositeCurrentIntegral(**path_spec.dict(exclude={"type"}))
     return i_integral
 
 
 def _make_composite_current_integral(
-    composite_path_spec: CompositePathSpec,
+    composite_path_spec: CompositeCurrentIntegralSpec,
 ) -> CompositeCurrentIntegral:
     """Create a composite current path integral from a composite path specification.
 
     Parameters
     ----------
-    composite_path_spec : CompositePathSpec
+    composite_path_spec : CompositeCurrentIntegralSpec
         Specification defining the composite path for current integration.
 
     Returns