Reorganizing of ModeSolver and ModeSolverData

Author: momchil-flex

tests/test_components.py

@@ -768,7 +768,7 @@ def test_monitor_plane():
         with pytest.raises(ValidationError) as e_info:
             ModeMonitor(size=size, freqs=freqs, modes=[])
         with pytest.raises(ValidationError) as e_info:
-            ModeSolverMonitor(size=size, freqs=freqs, modes=[])
+            ModeFieldMonitor(size=size, freqs=freqs, modes=[])
         with pytest.raises(ValidationError) as e_info:
             FluxMonitor(size=size, freqs=freqs, modes=[])
 

tests/test_plugins.py

@@ -74,15 +74,17 @@ def test_mode_solver():
         size=(2, 2, 2), grid_size=(0.1, 0.1, 0.1), structures=[waveguide], run_time=1e-12
     )
     plane = td.Box(center=(0, 0, 0), size=(0, 1, 1))
-    ms = ModeSolver(simulation=simulation, plane=plane)
     mode_spec = td.ModeSpec(
         num_modes=3,
         target_neff=2.0,
         bend_radius=3.0,
         bend_axis=0,
         num_pml=(10, 10),
     )
-    modes = ms.solve(mode_spec=mode_spec, freqs=[td.constants.C_0 / 1.0])
+    ms = ModeSolver(
+        simulation=simulation, plane=plane, mode_spec=mode_spec, freqs=[td.constants.C_0 / 1.0]
+    )
+    modes = ms.solve()
 
 
 def _test_coeffs():

tidy3d/__init__.py

@@ -33,7 +33,7 @@
 
 # monitors
 from .components import FieldMonitor, FieldTimeMonitor, FluxMonitor, FluxTimeMonitor
-from .components import ModeMonitor, ModeSolverMonitor
+from .components import ModeMonitor, ModeFieldMonitor
 
 # simulation
 from .components import Simulation

tidy3d/components/__init__.py

@@ -29,7 +29,7 @@
 # monitor
 from .monitor import FreqMonitor, TimeMonitor, FieldMonitor, FieldTimeMonitor
 from .monitor import Monitor, FluxMonitor, FluxTimeMonitor, ModeMonitor
-from .monitor import ModeSolverMonitor
+from .monitor import ModeFieldMonitor
 
 # simulation
 from .simulation import Simulation

tidy3d/components/data.py

@@ -826,48 +826,6 @@ def sel_mode_index(self, mode_index):
         return FieldData(data_dict=data_dict)
 
 
-class ModeSolverData(CollectionData):
-    """Stores a collection of mode field profiles and mode effective indexes from the mode solver.
-
-    Parameters
-    ----------
-    data_dict : Dict[str, :class:`AbstractModeData`]
-        Mapping of "n_complex" to :class:`ModeIndexData`, and "fields" to :class:`ModeFieldData`.
-    """
-
-    data_dict: Dict[str, Union[AbstractModeData, AbstractFieldData]]
-    type: Literal["ModeSolverData"] = "ModeSolverData"
-
-    @property
-    def fields(self):
-        """Get field data."""
-        return self.data_dict.get("fields")
-
-    @property
-    def n_complex(self):
-        """Get complex effective indexes."""
-        scalar_data = self.data_dict.get("n_complex")
-        if scalar_data:
-            return scalar_data.data
-        return None
-
-    @property
-    def n_eff(self):
-        """Get real part of effective index."""
-        scalar_data = self.data_dict.get("n_complex")
-        if scalar_data:
-            return scalar_data.n_eff
-        return None
-
-    @property
-    def k_eff(self):
-        """Get imaginary part of effective index."""
-        scalar_data = self.data_dict.get("n_complex")
-        if scalar_data:
-            return scalar_data.k_eff
-        return None
-
-
 # maps MonitorData.type string to the actual type, for MonitorData.from_file()
 DATA_TYPE_MAP = {
     "ScalarFieldData": ScalarFieldData,
@@ -881,7 +839,6 @@ def k_eff(self):
     "ModeData": ModeData,
     "ModeFieldData": ModeFieldData,
     "ScalarModeFieldData": ScalarModeFieldData,
-    "ModeSolverData": ModeSolverData,
 }
 
 
@@ -977,8 +934,6 @@ def at_centers(self, field_monitor_name: str) -> xr.Dataset:
         # get the data
         self.ensure_monitor_exists(field_monitor_name)
         field_monitor_data = self.monitor_data.get(field_monitor_name)
-        if isinstance(field_monitor_data, ModeSolverData):
-            field_monitor_data = field_monitor_data.fields
         self.ensure_field_monitor(field_monitor_data)
 
         # get the monitor, discretize, and get center locations
@@ -1034,7 +989,7 @@ def plot_field(
         time: float = None
             if monitor is a :class:`FieldTimeMonitor`, specifies the time (sec) to plot the field.
         mode_index: int = None
-            if monitor is a :class:`ModeSolverMonitor`, specifies which mode index to plot.
+            if monitor is a :class:`ModeFieldMonitor`, specifies which mode index to plot.
         eps_alpha : float = 0.2
             Opacity of the structure permittivity.
             Must be between 0 and 1 (inclusive).
@@ -1055,10 +1010,10 @@ def plot_field(
         # get the monitor data
         self.ensure_monitor_exists(field_monitor_name)
         monitor_data = self.monitor_data.get(field_monitor_name)
-        if isinstance(monitor_data, ModeSolverData):
+        if isinstance(monitor_data, ModeFieldData):
             if mode_index is None:
-                raise DataError("'mode_index' must be supplied to plot a ModeSolverMonitor.")
-            monitor_data = monitor_data.fields.sel_mode_index(mode_index=mode_index)
+                raise DataError("'mode_index' must be supplied to plot a ModeFieldMonitor.")
+            monitor_data = monitor_data.sel_mode_index(mode_index=mode_index)
         self.ensure_field_monitor(monitor_data)
 
         # get the field data component

tidy3d/components/monitor.py

@@ -225,7 +225,7 @@ class FieldMonitor(AbstractFieldMonitor, FreqMonitor):
     ...     name='steady_state_monitor')
     """
 
-    _data_type: Literal["ScalarFieldData"] = pydantic.Field("ScalarFieldData")
+    _data_type: Literal["FieldData"] = pydantic.Field("FieldData")
 
     def storage_size(self, num_cells: int, tmesh: Array) -> int:
         # stores 1 complex number per grid cell, per frequency, per field
@@ -316,7 +316,7 @@ class FieldTimeMonitor(AbstractFieldMonitor, TimeMonitor):
     ...     name='movie_monitor')
     """
 
-    _data_type: Literal["ScalarFieldTimeData"] = pydantic.Field("ScalarFieldTimeData")
+    _data_type: Literal["FieldTimeData"] = pydantic.Field("FieldTimeData")
 
     def storage_size(self, num_cells: int, tmesh: Array) -> int:
         # stores 1 real number per grid cell, per time step, per field
@@ -386,32 +386,30 @@ def storage_size(self, num_cells: int, tmesh: int) -> int:
         return 3 * BYTES_COMPLEX * len(self.freqs) * self.mode_spec.num_modes
 
 
-class ModeSolverMonitor(AbstractModeMonitor):
-    """:class:`Monitor` that stores the mode data (field profiles and effective index)
-    returned by the mode solver in the monitor plane.
+class ModeFieldMonitor(AbstractModeMonitor):
+    """:class:`Monitor` that stores the mode field profiles returned by the mode solver in the
+    monitor plane.
 
     Example
     -------
     >>> mode_spec = ModeSpec(num_modes=3)
-    >>> monitor = ModeSolverMonitor(
+    >>> monitor = ModeFieldMonitor(
     ...     center=(1,2,3),
     ...     size=(2,2,0),
     ...     freqs=[200e12, 210e12],
     ...     mode_spec=mode_spec,
     ...     name='mode_monitor')
     """
 
-    _data_type: Literal["ModeSolverData"] = pydantic.Field("ModeSolverData")
+    _data_type: Literal["ModeFieldData"] = pydantic.Field("ModeFieldData")
 
     def storage_size(self, num_cells: int, tmesh: int) -> int:
         # fields store 6 complex numbers per grid cell, per frequency, per mode.
         field_size = 6 * BYTES_COMPLEX * num_cells * len(self.freqs) * self.mode_spec.num_modes
-        # effective index stores 1 complex number per frequency per mode
-        neff_size = BYTES_COMPLEX * len(self.freqs) * self.mode_spec.num_modes
-        return field_size + neff_size
+        return field_size
 
 
 # types of monitors that are accepted by simulation
 MonitorType = Union[
-    FieldMonitor, FieldTimeMonitor, FluxMonitor, FluxTimeMonitor, ModeMonitor, ModeSolverMonitor
+    FieldMonitor, FieldTimeMonitor, FluxMonitor, FluxTimeMonitor, ModeMonitor, ModeFieldMonitor
 ]