refactor microwavemodespec to using inheritance

Author: dmarek-flex

tests/test_components/test_microwave.py

@@ -200,10 +200,10 @@ def make_mw_sim(
     size_port = [0, sim_width, size_sim[2]]
     center_port = [0, 0, center_sim[2]]
     impedance_specs = (td.AutoImpedanceSpec(),) * 4
-    mode_spec = td.ModeSpec(
+    mode_spec = td.MicrowaveModeSpec(
         num_modes=4,
         target_neff=1.8,
-        microwave_mode_spec=td.MicrowaveModeSpec(impedance_specs=impedance_specs),
+        impedance_specs=impedance_specs,
     )
 
     mode_monitor = td.ModeMonitor(
@@ -484,7 +484,7 @@ def test_impedance_spec_validation():
     with pytest.raises(pd.ValidationError):
         _ = td.CustomImpedanceSpec(voltage_spec=None, current_spec=None)
 
-    _ = td.MicrowaveModeSpec(impedance_specs=(both, voltage_only, current_only, None))
+    _ = td.MicrowaveModeSpec(num_modes=4, impedance_specs=(both, voltage_only, current_only, None))
 
 
 def test_path_integral_factory_voltage_validation():
@@ -697,10 +697,10 @@ def test_mode_solver_with_microwave_mode_spec():
     plane = td.Box(center=(0, 0, 0), size=(0, 10 * width, 2 * height + metal_thickness))
     num_modes = 3
     impedance_specs = (td.AutoImpedanceSpec(), None, None)
-    mode_spec = td.ModeSpec(
+    mode_spec = td.MicrowaveModeSpec(
         num_modes=num_modes,
         target_neff=2.2,
-        microwave_mode_spec=td.MicrowaveModeSpec(impedance_specs=impedance_specs),
+        impedance_specs=impedance_specs,
     )
     mms = ModeSolver(
         simulation=stripline_sim,
@@ -728,7 +728,7 @@ def test_mode_solver_with_microwave_mode_spec():
         ),
     )
     impedance_specs = (custom_spec, None, None)
-    mms = mms.updated_copy(path="mode_spec/microwave_mode_spec/", impedance_specs=impedance_specs)
+    mms = mms.updated_copy(path="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

@@ -389,9 +389,15 @@ 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."""
+    """Test that the number of impedance specs is validated against the number of modes in MicrowaveModeSpec."""
 
     impedance_specs = (td.AutoImpedanceSpec(),)
-    mw_mode_spec = td.MicrowaveModeSpec(impedance_specs=impedance_specs)
+
+    # Should work when impedance_specs matches num_modes
+    mw_mode_spec = td.MicrowaveModeSpec(num_modes=1, impedance_specs=impedance_specs)
+    assert mw_mode_spec.num_modes == 1
+    assert len(mw_mode_spec.impedance_specs) == 1
+
+    # Should fail when impedance_specs doesn't match num_modes
     with pytest.raises(pydantic.ValidationError):
-        td.ModeSpec(num_modes=2, microwave_mode_spec=mw_mode_spec)
+        td.MicrowaveModeSpec(num_modes=2, impedance_specs=impedance_specs)

tidy3d/components/microwave/microwave_mode_spec.py

@@ -6,15 +6,17 @@
 
 import pydantic.v1 as pd
 
-from tidy3d.components.base import Tidy3dBaseModel, cached_property
+from tidy3d.components.base import cached_property
 from tidy3d.components.microwave.path_integrals.impedance_spec import (
     AutoImpedanceSpec,
     ImpedanceSpecTypes,
 )
+from tidy3d.components.mode_spec import ModeSpec
 from tidy3d.components.types import annotate_type
+from tidy3d.exceptions import SetupError
 
 
-class MicrowaveModeSpec(Tidy3dBaseModel):
+class MicrowaveModeSpec(ModeSpec):
     """
     The :class:`.MicrowaveModeSpec` class specifies how quantities related to transmission line
     modes and microwave waveguides are computed. For example, it defines the paths for line integrals, which are used to
@@ -38,3 +40,21 @@ def _using_auto_current_spec(self) -> bool:
     def num_impedance_specs(self) -> int:
         """The number of impedance specifications to be used."""
         return len(self.impedance_specs)
+
+    @pd.validator("impedance_specs", always=True)
+    def check_impedance_specs_consistent_with_num_modes(cls, val, values):
+        """Check that the number of impedance specifications is equal to the number of modes."""
+        if val is None:
+            return val
+
+        num_modes = values.get("num_modes", 1)
+        valid_number_impedance_specs = len(val) == num_modes
+
+        if not valid_number_impedance_specs:
+            raise SetupError(
+                f"Given {len(val)} impedance specifications in the 'MicrowaveModeSpec', "
+                f"but the number of modes requested is {num_modes}. Please ensure that the "
+                "number of impedance specifications is equal to the number of modes."
+            )
+
+        return val

tidy3d/components/mode/mode_solver.py

@@ -35,9 +35,10 @@
     LossyMetalMedium,
 )
 from tidy3d.components.microwave.data.dataset import MicrowaveModeDataset
+from tidy3d.components.microwave.microwave_mode_spec import MicrowaveModeSpec
 from tidy3d.components.microwave.path_integrals.path_integral_factory import make_path_integrals
 from tidy3d.components.mode_spec import ModeSpec
-from tidy3d.components.monitor import ModeMonitor, ModeSolverMonitor
+from tidy3d.components.monitor import ModeMonitor, ModeSolverMonitor, ModeSpecTypes
 from tidy3d.components.scene import Scene
 from tidy3d.components.simulation import Simulation
 from tidy3d.components.source.field import ModeSource
@@ -156,7 +157,7 @@ class ModeSolver(Tidy3dBaseModel):
         discriminator=TYPE_TAG_STR,
     )
 
-    mode_spec: ModeSpec = pydantic.Field(
+    mode_spec: ModeSpecTypes = pydantic.Field(
         ...,
         title="Mode specification",
         description="Container with specifications about the modes to be solved for.",
@@ -437,6 +438,11 @@ def _num_cells_freqs_modes(self) -> tuple[int, int, int]:
         num_freqs = len(self.freqs)
         return num_cells, num_freqs, num_modes
 
+    @property
+    def _is_microwave_mode_spec(self) -> bool:
+        """Check if the mode_spec is a MicrowaveModeSpec."""
+        return isinstance(self.mode_spec, MicrowaveModeSpec)
+
     def solve(self) -> ModeSolverData:
         """:class:`.ModeSolverData` containing the field and effective index data.
 
@@ -544,7 +550,7 @@ def data_raw(self) -> ModeSolverData:
 
         mode_solver_data = self._filter_components(mode_solver_data)
         # Calculate and add the characteristic impedance
-        if self.mode_spec.microwave_mode_spec is not None:
+        if self._is_microwave_mode_spec:
             mode_solver_data = self._add_microwave_data(mode_solver_data)
         return mode_solver_data
 
@@ -1375,8 +1381,10 @@ def _make_path_integrals(
     ) -> 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."""
+        if not self._is_microwave_mode_spec:
+            raise ValueError("Cannot make path integrals for non-MicrowaveModeSpec")
         return make_path_integrals(
-            self.mode_spec.microwave_mode_spec,
+            self.mode_spec,
             self.to_monitor(name=MODE_MONITOR_NAME),
         )
 

tidy3d/components/mode_spec.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 from math import isclose
-from typing import Literal, Optional, Union
+from typing import Literal, Union
 
 import numpy as np
 import pydantic.v1 as pd
@@ -13,7 +13,6 @@
 from tidy3d.log import log
 
 from .base import Tidy3dBaseModel, skip_if_fields_missing
-from .microwave.microwave_mode_spec import MicrowaveModeSpec
 from .types import Axis2D, TrackFreq
 
 GROUP_INDEX_STEP = 0.005
@@ -164,14 +163,6 @@ class ModeSpec(Tidy3dBaseModel):
         f"default of {GROUP_INDEX_STEP} is used.",
     )
 
-    microwave_mode_spec: Optional[MicrowaveModeSpec] = pd.Field(
-        None,
-        title="Microwave Mode Specification",
-        description="Additional specification for microwave specific mode properties. For example, "
-        "it is used for setting up the computation for the characteristic impedance of a transmission "
-        "line mode.",
-    )
-
     @pd.validator("bend_axis", always=True)
     @skip_if_fields_missing(["bend_radius"])
     def bend_axis_given(cls, val, values):
@@ -244,22 +235,3 @@ def angle_rotation_with_phi(cls, val, values):
                 "enabled."
             )
         return val
-
-    @pd.validator("microwave_mode_spec")
-    def check_microwave_mode_spec_consistent(cls, val, values):
-        """Check that the number of impedance specifications is equal to the number of modes."""
-        if val is None:
-            return val
-
-        num_modes = values["num_modes"]
-        valid_number_impedance_specs = val.num_impedance_specs == num_modes
-
-        if not valid_number_impedance_specs:
-            raise SetupError(
-                f"Given {val.num_impedance_specs} impedance specifications in the 'MicrowaveModeSpec', "
-                f"but the number of modes requested is {num_modes}. Please either ensure that the "
-                "number of impedance specifications is equal to the number of modes or leave the "
-                "'MicrowaveModeSpec' field as 'None', if impedances are not needed."
-            )
-
-        return val

tidy3d/components/monitor.py

@@ -16,6 +16,7 @@
 from .base import Tidy3dBaseModel, cached_property, skip_if_fields_missing
 from .base_sim.monitor import AbstractMonitor
 from .medium import MediumType
+from .microwave.microwave_mode_spec import MicrowaveModeSpec
 from .mode_spec import ModeSpec
 from .types import (
     ArrayFloat1D,
@@ -46,6 +47,9 @@
 # for windowing the monitor.
 WINDOW_FACTOR = 15
 
+# Union type for mode specifications
+ModeSpecTypes = Union[ModeSpec, MicrowaveModeSpec]
+
 
 class Monitor(AbstractMonitor):
     """Abstract base class for monitors."""
@@ -332,7 +336,7 @@ def normal_axis(self) -> Axis:
 class AbstractModeMonitor(PlanarMonitor, FreqMonitor):
     """:class:`Monitor` that records mode-related data."""
 
-    mode_spec: ModeSpec = pydantic.Field(
+    mode_spec: ModeSpecTypes = pydantic.Field(
         ModeSpec(),
         title="Mode Specification",
         description="Parameters to feed to mode solver which determine modes measured by monitor.",

tidy3d/components/source/field.py

@@ -11,6 +11,7 @@
 from tidy3d.components.base import Tidy3dBaseModel, cached_property, skip_if_fields_missing
 from tidy3d.components.data.dataset import FieldDataset
 from tidy3d.components.data.validators import validate_can_interpolate, validate_no_nans
+from tidy3d.components.microwave.microwave_mode_spec import MicrowaveModeSpec
 from tidy3d.components.mode_spec import ModeSpec
 from tidy3d.components.source.frame import PECFrame
 from tidy3d.components.types import TYPE_TAG_STR, Ax, Axis, Coordinate, Direction
@@ -33,6 +34,9 @@
 # (oblique propagation).
 CRITICAL_FREQUENCY_FACTOR = 1.15
 
+# Union type for mode specifications
+ModeSpecTypes = Union[ModeSpec, MicrowaveModeSpec]
+
 
 class FieldSource(Source, ABC):
     """A Source defined by the desired E and/or H fields."""
@@ -389,7 +393,7 @@ class ModeSource(DirectionalSource, PlanarSource, BroadbandSource):
         * `Prelude to Integrated Photonics Simulation: Mode Injection <https://www.flexcompute.com/fdtd101/Lecture-4-Prelude-to-Integrated-Photonics-Simulation-Mode-Injection/>`_
     """
 
-    mode_spec: ModeSpec = pydantic.Field(
+    mode_spec: ModeSpecTypes = pydantic.Field(
         ModeSpec(),
         title="Mode Specification",
         description="Parameters to feed to mode solver which determine modes measured by monitor.",