update naming

Author: dmarek-flex

tests/test_components/test_microwave.py

@@ -202,11 +202,11 @@ def make_mw_sim(
         )
     size_port = [0, sim_width, size_sim[2]]
     center_port = [0, 0, center_sim[2]]
-    impedance_spec = (td.AutoImpedanceSpec(),) * 4
+    impedance_specs = (td.AutoImpedanceSpec(),) * 4
     mode_spec = td.ModeSpec(
         num_modes=4,
         target_neff=1.8,
-        microwave_mode_spec=td.MicrowaveModeSpec(impedance_spec=impedance_spec),
+        microwave_mode_spec=td.MicrowaveModeSpec(impedance_specs=impedance_specs),
     )
 
     mode_monitor = td.ModeMonitor(
@@ -476,7 +476,7 @@ def test_impedance_spec_validation():
     with pytest.raises(pd.ValidationError):
         _ = td.CustomImpedanceSpec(voltage_spec=None, current_spec=None)
 
-    _ = td.MicrowaveModeSpec(impedance_spec=(both, voltage_only, current_only, None))
+    _ = td.MicrowaveModeSpec(impedance_specs=(both, voltage_only, current_only, None))
 
 
 def test_path_integral_factory_voltage_validation():
@@ -565,7 +565,7 @@ def test_make_path_integrals_validation():
         voltage_spec=v_spec,
         current_spec=i_spec,
     )
-    microwave_mode_spec = td.MicrowaveModeSpec(impedance_spec=(impedance_spec,))
+    microwave_mode_spec = td.MicrowaveModeSpec(impedance_specs=(impedance_spec,))
 
     # Test successful creation
     voltage_integrals, current_integrals = make_path_integrals(microwave_mode_spec, mode_monitor)
@@ -576,7 +576,7 @@ def test_make_path_integrals_validation():
 
     # Test with None specs - when both are None, use_automatic_setup is True
     # This means current integrals will be auto-generated, not None
-    microwave_mode_spec_none = td.MicrowaveModeSpec(impedance_spec=(None,))
+    microwave_mode_spec_none = td.MicrowaveModeSpec(impedance_specs=(None,))
     voltage_integrals, current_integrals = make_path_integrals(
         microwave_mode_spec_none, mode_monitor
     )
@@ -596,7 +596,7 @@ def test_make_path_integrals_construction_errors(monkeypatch):
     v_spec = td.VoltageIntegralAxisAlignedSpec(center=(1, 2, 3), size=(0, 0, 1), sign="-")
 
     impedance_spec = td.CustomImpedanceSpec(voltage_spec=v_spec, current_spec=None)
-    microwave_mode_spec = td.MicrowaveModeSpec(impedance_spec=(impedance_spec,))
+    microwave_mode_spec = td.MicrowaveModeSpec(impedance_specs=(impedance_spec,))
 
     # Mock make_voltage_integral to raise an exception
     def mock_make_voltage_integral(path_spec):
@@ -663,7 +663,7 @@ def test_path_integral_factory_mixed_specs():
     impedance_spec1 = td.CustomImpedanceSpec(voltage_spec=v_spec, current_spec=None)
     impedance_spec2 = td.CustomImpedanceSpec(voltage_spec=None, current_spec=i_spec)
     microwave_mode_spec = td.MicrowaveModeSpec(
-        impedance_spec=(
+        impedance_specs=(
             impedance_spec1,
             impedance_spec2,
         )
@@ -685,14 +685,6 @@ def test_mode_solver_with_microwave_mode_spec():
     height = 0.5 * mm
     metal_thickness = 0.1 * mm
 
-    def analytical_stripline_impedance(er, width, height, thickness):
-        assert width > 0.35 * height
-        term1 = 1 - thickness / height
-        Cf = 2 / np.pi * np.log(1 / term1 + 1)
-        if thickness > 0:
-            Cf -= thickness / np.pi / height * np.log(1 / term1**2 - 1)
-        return 30 * np.pi / np.sqrt(er) * (term1) / (width / height + Cf)
-
     stripline_sim = make_mw_sim(
         transmission_line_type="stripline",
         width=width,
@@ -704,11 +696,11 @@ def analytical_stripline_impedance(er, width, height, thickness):
 
     plane = td.Box(center=(0, 0, 0), size=(0, 10 * width, 2 * height + metal_thickness))
     num_modes = 3
-    impedance_spec = (td.AutoImpedanceSpec(), None, None)
+    impedance_specs = (td.AutoImpedanceSpec(), None, None)
     mode_spec = td.ModeSpec(
         num_modes=num_modes,
         target_neff=2.2,
-        microwave_mode_spec=td.MicrowaveModeSpec(impedance_spec=impedance_spec),
+        microwave_mode_spec=td.MicrowaveModeSpec(impedance_specs=impedance_specs),
     )
     mms = ModeSolver(
         simulation=stripline_sim,
@@ -735,8 +727,8 @@ def analytical_stripline_impedance(er, width, height, thickness):
             size=(0, width + dl, metal_thickness + dl), sign="+"
         ),
     )
-    impedance_spec = (custom_spec, None, None)
-    mms = mms.updated_copy(path="mode_spec/microwave_mode_spec/", impedance_spec=impedance_spec)
+    impedance_specs = (custom_spec, None, None)
+    mms = mms.updated_copy(path="mode_spec/microwave_mode_spec/", impedance_specs=impedance_specs)
     mms_data: ModeSolverData = mms.data
 
     # _, ax = plt.subplots(1, 1, tight_layout=True, figsize=(15, 15))

tests/test_components/test_mode.py

@@ -391,7 +391,7 @@ def test_plane_crosses_symmetry_plane_warning(monkeypatch):
 def test_mode_spec_with_microwave_mode_spec():
     """Test that the number of impedance specs is validated against the number of modes."""
 
-    impedance_spec = (td.AutoImpedanceSpec(),)
-    mw_mode_spec = td.MicrowaveModeSpec(impedance_spec=impedance_spec)
+    impedance_specs = (td.AutoImpedanceSpec(),)
+    mw_mode_spec = td.MicrowaveModeSpec(impedance_specs=impedance_specs)
     with pytest.raises(pydantic.ValidationError):
         td.ModeSpec(num_modes=2, microwave_mode_spec=mw_mode_spec)

tidy3d/components/microwave/microwave_mode_spec.py

@@ -21,20 +21,20 @@ class MicrowaveModeSpec(Tidy3dBaseModel):
     compute voltage, current, and characteristic impedance of the transmission line.
     """
 
-    impedance_spec: tuple[Optional[annotate_type(ImpedanceSpecTypes)], ...] = pd.Field(
+    impedance_specs: tuple[Optional[annotate_type(ImpedanceSpecTypes)], ...] = pd.Field(
         ...,
-        title="Impedance Specification",
+        title="Impedance Specifications",
         description="Field controls how the impedance is calculated for each mode calculated by the mode solver.",
     )
 
     @cached_property
     def _using_auto_current_spec(self) -> bool:
         """Checks whether at least one of the modes will require an auto setup of the current path specification."""
         return any(
-            isinstance(impedance_spec, AutoImpedanceSpec) for impedance_spec in self.impedance_spec
+            isinstance(impedance_spec, AutoImpedanceSpec) for impedance_spec in self.impedance_specs
         )
 
     @cached_property
     def num_impedance_specs(self) -> int:
         """The number of impedance specifications to be used."""
-        return len(self.impedance_spec)
+        return len(self.impedance_specs)

tidy3d/components/microwave/path_integrals/path_integral_factory.py

@@ -112,7 +112,7 @@ def make_path_integrals(
 
     v_integrals = []
     i_integrals = []
-    for idx, impedance_spec in enumerate(microwave_mode_spec.impedance_spec):
+    for idx, impedance_spec in enumerate(microwave_mode_spec.impedance_specs):
         if impedance_spec is None:
             # Do not calculate impedance for this mode
             v_integrals.append(None)

tidy3d/components/mode/mode_solver.py

@@ -1370,19 +1370,22 @@ def _filter_polarization(self, mode_solver_data: ModeSolverData):
             ]:
                 data.values[..., ifreq, :] = data.values[..., ifreq, sort_inds]
 
-    def _get_path_integrals(
+    def _make_path_integrals(
         self,
     ) -> tuple[tuple[Optional[VoltageIntegralTypes]], tuple[Optional[CurrentIntegralTypes]]]:
+        """Wrapper for making path integrals from the MicrowaveModeSpec. Note: overriden in the backend to support
+        auto creation of path integrals."""
         return make_path_integrals(
             self.mode_spec.microwave_mode_spec,
             self.to_monitor(name=MODE_MONITOR_NAME),
         )
 
     def _add_microwave_data(self, mode_solver_data: ModeSolverData) -> ModeSolverData:
-        """Calculate and add microwave data to ``mode_solver_data`` which uses the path specifications."""
+        """Calculate and add microwave data to ``mode_solver_data`` which uses the path specifications.
+        Note: this modifies ``mode_solver_data`` in-place."""
         if self.mode_spec.microwave_mode_spec is None:
             return mode_solver_data
-        voltage_integrals, current_integrals = self._get_path_integrals()
+        voltage_integrals, current_integrals = self._make_path_integrals()
         # Need to operate on the full symmetry expanded fields
         mode_solver_data_expanded = mode_solver_data.symmetry_expanded_copy
         Z0_list = []