rename auto patch spec to generator type name, fixed tests

Author: dmarek-flex

tests/test_components/test_microwave.py

@@ -12,7 +12,6 @@
 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.auto_path_spec import AutoPathSpec
 from tidy3d.components.microwave.formulas.circuit_parameters import (
     capacitance_colinear_cylindrical_wire_segments,
     capacitance_rectangular_sheets,
@@ -24,6 +23,7 @@
     make_current_integral,
     make_voltage_integral,
 )
+from tidy3d.components.microwave.path_spec_generator import PathSpecGenerator
 from tidy3d.components.types import Ax, Shapely
 from tidy3d.constants import EPSILON_0
 from tidy3d.exceptions import ValidationError
@@ -320,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 = AutoPathSpec.create_current_path_specs(
+    comp_path_spec, geos = PathSpecGenerator.create_current_path_specs(
         modal_plane,
         sim.structures,
         sim.grid,
@@ -380,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 = AutoPathSpec.create_current_path_specs(
+    comp_path_spec, geos = PathSpecGenerator.create_current_path_specs(
         modal_plane,
         sim.structures,
         sim.grid,
@@ -410,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 AutoPathSpec._check_path_intersects_with_conductors(test_shapely, test_path)
+    assert PathSpecGenerator._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 AutoPathSpec._check_path_intersects_with_conductors(test_shapely, test_path)
+    assert not PathSpecGenerator._check_path_intersects_with_conductors(test_shapely, test_path)
 
     sim = make_mw_sim(False, False, "microstrip")
     coax = td.GeometryGroup(
@@ -434,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):
-        AutoPathSpec.create_current_path_specs(
+        PathSpecGenerator.create_current_path_specs(
             modal_plane,
             sim.structures,
             sim.grid,

tidy3d/components/microwave/auto_path_spec.py renamed to tidy3d/components/microwave/path_spec_generator.py

@@ -26,7 +26,7 @@
 from .path_spec import CompositeCurrentIntegralSpec, CurrentIntegralAxisAlignedSpec
 
 
-class AutoPathSpec(Tidy3dBaseModel):
+class PathSpecGenerator(Tidy3dBaseModel):
     """Automatically determines current integration paths based on structure geometry.
 
     This class analyzes the geometry of conductors in a simulation cross-section to determine
@@ -105,7 +105,7 @@ def bounding_box_from_shapely(geom: Shapely, normal_axis, normal_center):
                 min_sym_bounds[dim] = sim_box.center[dim]
         sym_sim_bounds = (tuple(min_sym_bounds), max_sym_bounds)
 
-        conductor_polygons = AutoPathSpec._get_isolated_conductors_as_shapely(
+        conductor_polygons = PathSpecGenerator._get_isolated_conductors_as_shapely(
             mode_plane, structures
         )
         normal_axis = mode_plane.size.index(0.0)
@@ -136,7 +136,9 @@ def bounding_box_from_shapely(geom: Shapely, normal_axis, normal_center):
                 ):
                     continue
                 box = Box.from_bounds(rmin=intersected_box[0], rmax=intersected_box[1])
-                boxes = AutoPathSpec._apply_symmetry(symmetry, sim_box.center, normal_axis, box)
+                boxes = PathSpecGenerator._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 = CurrentIntegralAxisAlignedSpec(
@@ -149,7 +151,9 @@ def bounding_box_from_shapely(geom: Shapely, normal_axis, normal_center):
                     current_integral_specs.append(path_spec)
 
         for path_spec in current_integral_specs:
-            if AutoPathSpec._check_path_intersects_with_conductors(conductor_polygons, path_spec):
+            if PathSpecGenerator._check_path_intersects_with_conductors(
+                conductor_polygons, path_spec
+            ):
                 raise ValidationError(
                     "Failed to automatically setup path specification for impedance calculation. "
                     "Please create a github issue so that the problem can be investigated. "
@@ -197,7 +201,7 @@ def _reflect_box(box: Box, axis: Axis, position: float) -> Box:
 
     @staticmethod
     def _apply_symmetry_to_box(box: Box, axis: Axis, position: float) -> list[Box]:
-        new_box = AutoPathSpec._reflect_box(box, axis, position)
+        new_box = PathSpecGenerator._reflect_box(box, axis, position)
         if isclose(new_box.bounds[0][axis], box.bounds[1][axis]) or isclose(
             new_box.bounds[1][axis], box.bounds[0][axis]
         ):
@@ -224,7 +228,8 @@ def _apply_symmetry(
         for dim, sym in zip(dims, symmetry):
             if sym != 0:
                 tmp_list = [
-                    AutoPathSpec._apply_symmetry_to_box(box, dim, sim_center[dim]) for box in result
+                    PathSpecGenerator._apply_symmetry_to_box(box, dim, sim_center[dim])
+                    for box in result
                 ]
                 result = list(chain.from_iterable(tmp_list))
         return result

tidy3d/components/mode/mode_solver.py

@@ -32,7 +32,7 @@
 from ..geometry.base import Box
 from ..grid.grid import Coords, Grid
 from ..medium import FullyAnisotropicMedium, LossyMetalMedium
-from ..microwave.auto_path_spec import AutoPathSpec
+from ..microwave.path_spec_generator import PathSpecGenerator
 from ..microwave.terminal_spec import TerminalSpec
 from ..mode_spec import ModeSpec
 from ..monitor import ModeMonitor, ModeSolverMonitor
@@ -1270,7 +1270,7 @@ def _add_terminal_spec(self, mode_solver_data: ModeSolverData):
         v_spec = self.mode_spec.terminal_spec.voltage_spec
         i_spec = self.mode_spec.terminal_spec.current_spec
         if v_spec is None and i_spec is None:
-            i_spec, _ = AutoPathSpec.create_current_path_specs(
+            i_spec, _ = PathSpecGenerator.create_current_path_specs(
                 self.plane,
                 self.simulation.structures,
                 self.simulation.grid,

tidy3d/components/simulation.py

@@ -4120,8 +4120,8 @@ def _validate_freq_monitors_freq_range(self) -> None:
 
     def _validate_terminal_specs(self) -> None:
         """Raise error if any terminal specificiations fail to instantiate path integrals."""
-        from .microwave.auto_path_spec import AutoPathSpec
         from .microwave.path_integral_factory import make_current_integral, make_voltage_integral
+        from .microwave.path_spec_generator import PathSpecGenerator
 
         for monitor in self.monitors:
             if not isinstance(monitor, AbstractModeMonitor):
@@ -4133,7 +4133,7 @@ def _validate_terminal_specs(self) -> None:
                 v_spec = term_spec.voltage_spec
                 i_spec = term_spec.current_spec
                 if v_spec is None and i_spec is None:
-                    i_spec, _ = AutoPathSpec.create_current_path_specs(
+                    i_spec, _ = PathSpecGenerator.create_current_path_specs(
                         monitor.bounding_box,
                         self.structures,
                         self.grid,

tidy3d/plugins/microwave/custom_path_integrals.py

@@ -11,6 +11,7 @@
 from ...components.geometry.base import Geometry
 from ...components.microwave.path_spec import (
     CompositeCurrentIntegralSpec,
+    CustomCurrentIntegral2DSpec,
     CustomPathIntegral2DSpec,
     CustomVoltageIntegral2DSpec,
 )
@@ -198,7 +199,7 @@ def compute_voltage(self, em_field: MonitorDataTypes) -> IntegralResultTypes:
         return voltage
 
 
-class CustomCurrentIntegral2D(CustomPathIntegral2D):
+class CustomCurrentIntegral2D(CustomPathIntegral2D, CustomCurrentIntegral2DSpec):
     """Class for computing conduction current via Ampère's circuital law on a custom path.
     To compute the current flowing in the positive ``axis`` direction, the vertices should be
     ordered in a counterclockwise direction."""

tidy3d/plugins/microwave/path_integrals.py

@@ -23,7 +23,7 @@
     CurrentIntegralAxisAlignedSpec,
     VoltageIntegralAxisAlignedSpec,
 )
-from ...constants import AMP, VOLT
+from ...constants import AMP, VOLT, fp_eps
 from ...exceptions import DataError
 
 MonitorDataTypes = Union[FieldData, FieldTimeData, ModeData, ModeSolverData]
@@ -259,10 +259,10 @@ def _to_path_integrals(
     ) -> tuple[AxisAlignedPathIntegral, ...]:
         """Returns four ``AxisAlignedPathIntegral`` instances, which represent a contour
         integral around the surface defined by ``self.size``."""
-        from ...components.microwave.path_integral_factory import make_current_integral
-
         path_specs = self._to_path_integral_specs(h_horizontal=h_horizontal, h_vertical=h_vertical)
-        path_integrals = [make_current_integral(path_spec) for path_spec in path_specs]
+        path_integrals = [
+            AxisAlignedPathIntegral(**path_spec.dict(exclude={"type"})) for path_spec in path_specs
+        ]
         return tuple(path_integrals)
 
     @staticmethod

tidy3d/plugins/microwave/viz.py

@@ -5,56 +5,9 @@
 from ...components.viz import PathPlotParams
 
 """ Constants """
-VOLTAGE_COLOR = "red"
-CURRENT_COLOR = "blue"
 LOBE_PEAK_COLOR = "tab:red"
 LOBE_WIDTH_COLOR = "tab:orange"
 LOBE_FNBW_COLOR = "tab:blue"
-PATH_LINEWIDTH = 2
-ARROW_CURRENT = dict(
-    arrowstyle="-|>",
-    mutation_scale=32,
-    linestyle="",
-    lw=PATH_LINEWIDTH,
-    color=CURRENT_COLOR,
-)
-
-plot_params_voltage_path = PathPlotParams(
-    alpha=1.0,
-    zorder=inf,
-    color=VOLTAGE_COLOR,
-    linestyle="--",
-    linewidth=PATH_LINEWIDTH,
-    marker="o",
-    markersize=10,
-    markeredgecolor=VOLTAGE_COLOR,
-    markerfacecolor="white",
-)
-
-plot_params_voltage_plus = PathPlotParams(
-    alpha=1.0,
-    zorder=inf,
-    color=VOLTAGE_COLOR,
-    marker="+",
-    markersize=6,
-)
-
-plot_params_voltage_minus = PathPlotParams(
-    alpha=1.0,
-    zorder=inf,
-    color=VOLTAGE_COLOR,
-    marker="_",
-    markersize=6,
-)
-
-plot_params_current_path = PathPlotParams(
-    alpha=1.0,
-    zorder=inf,
-    color=CURRENT_COLOR,
-    linestyle="--",
-    linewidth=PATH_LINEWIDTH,
-    marker="",
-)
 
 plot_params_lobe_peak = PathPlotParams(
     alpha=1.0,