prototype interpolated_data property

Author: dbochkov-flexcompute

schemas/EMESimulation.json

@@ -8374,6 +8374,10 @@
           "minLength": 1,
           "type": "string"
         },
+        "reduce_data": {
+          "default": false,
+          "type": "boolean"
+        },
         "size": {
           "anyOf": [
             {

schemas/ModeSimulation.json

@@ -7812,6 +7812,10 @@
           "minLength": 1,
           "type": "string"
         },
+        "reduce_data": {
+          "default": false,
+          "type": "boolean"
+        },
         "size": {
           "anyOf": [
             {

schemas/Simulation.json

@@ -11002,6 +11002,10 @@
           "minLength": 1,
           "type": "string"
         },
+        "reduce_data": {
+          "default": false,
+          "type": "boolean"
+        },
         "size": {
           "anyOf": [
             {
@@ -11778,6 +11782,10 @@
           "minLength": 1,
           "type": "string"
         },
+        "reduce_data": {
+          "default": false,
+          "type": "boolean"
+        },
         "size": {
           "anyOf": [
             {

schemas/TerminalComponentModeler.json

@@ -11072,13 +11072,6 @@
             }
           ]
         },
-        "interp_spec": {
-          "allOf": [
-            {
-              "$ref": "#/definitions/ModeInterpSpec"
-            }
-          ]
-        },
         "interval_space": {
           "default": [
             1,
@@ -11310,13 +11303,6 @@
             }
           ]
         },
-        "interp_spec": {
-          "allOf": [
-            {
-              "$ref": "#/definitions/ModeInterpSpec"
-            }
-          ]
-        },
         "interval_space": {
           "default": [
             1,
@@ -11358,6 +11344,10 @@
           "minLength": 1,
           "type": "string"
         },
+        "reduce_data": {
+          "default": false,
+          "type": "boolean"
+        },
         "size": {
           "anyOf": [
             {
@@ -11502,6 +11492,13 @@
             }
           ]
         },
+        "interp_spec": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/ModeInterpSpec"
+            }
+          ]
+        },
         "num_modes": {
           "default": 1,
           "exclusiveMinimum": 0,
@@ -11608,6 +11605,7 @@
             "bend_radius": null,
             "filter_pol": null,
             "group_index_step": false,
+            "interp_spec": null,
             "num_modes": 1,
             "num_pml": [
               0,
@@ -11792,13 +11790,6 @@
             }
           ]
         },
-        "interp_spec": {
-          "allOf": [
-            {
-              "$ref": "#/definitions/ModeInterpSpec"
-            }
-          ]
-        },
         "interval_space": {
           "default": [
             1,
@@ -11844,6 +11835,7 @@
             "bend_radius": null,
             "filter_pol": null,
             "group_index_step": false,
+            "interp_spec": null,
             "num_modes": 1,
             "num_pml": [
               0,
@@ -12060,13 +12052,6 @@
             }
           ]
         },
-        "interp_spec": {
-          "allOf": [
-            {
-              "$ref": "#/definitions/ModeInterpSpec"
-            }
-          ]
-        },
         "interval_space": {
           "default": [
             1,
@@ -12112,6 +12097,7 @@
             "bend_radius": null,
             "filter_pol": null,
             "group_index_step": false,
+            "interp_spec": null,
             "num_modes": 1,
             "num_pml": [
               0,
@@ -12138,6 +12124,10 @@
           "minLength": 1,
           "type": "string"
         },
+        "reduce_data": {
+          "default": false,
+          "type": "boolean"
+        },
         "size": {
           "anyOf": [
             {
@@ -12365,6 +12355,7 @@
             "bend_radius": null,
             "filter_pol": null,
             "group_index_step": false,
+            "interp_spec": null,
             "num_modes": 1,
             "num_pml": [
               0,
@@ -12542,6 +12533,13 @@
           ],
           "default": false
         },
+        "interp_spec": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/ModeInterpSpec"
+            }
+          ]
+        },
         "num_modes": {
           "default": 1,
           "exclusiveMinimum": 0,
@@ -17792,19 +17790,6 @@
             "type": "PECFrame"
           }
         },
-        "interp_spec": {
-          "allOf": [
-            {
-              "$ref": "#/definitions/ModeInterpSpec"
-            }
-          ],
-          "default": {
-            "attrs": {},
-            "method": "cheb",
-            "num_points": 21,
-            "type": "ModeInterpSpec"
-          }
-        },
         "mode_index": {
           "minimum": 0,
           "type": "integer"

tests/test_components/test_mode_interp.py

@@ -8,8 +8,8 @@
 
 import tidy3d as td
 from tidy3d.plugins.mode import ModeSolver
-from tidy3d.plugins.smatrix.ports.wave import DEFAULT_WAVE_PORT_MODE_SPEC
 
+# from tidy3d.plugins.smatrix.ports.wave import DEFAULT_WAVE_PORT_MODE_SPEC
 from ..test_data.test_data_arrays import MODE_SPEC, SIZE_2D
 from ..utils import AssertLogLevel
 
@@ -322,12 +322,10 @@ def get_mode_solver_data():
     """Create a simple ModeSolverData object for testing."""
     from tidy3d.components.data.data_array import GroupIndexDataArray, ModeDispersionDataArray
 
-    from ..test_data.test_data_arrays import (
-        make_scalar_mode_field_data_array,
-    )
+    from ..test_data.test_data_arrays import SIM, make_scalar_mode_field_data_array
     from ..test_data.test_monitor_data import N_COMPLEX
 
-    freqs = np.linspace(1e14, 2e14, 5)
+    freqs = N_COMPLEX.f.data
     num_modes = len(N_COMPLEX.mode_index)
     mode_indices = np.arange(num_modes)
     mode_spec = td.ModeSpec(num_modes=num_modes, sort_spec=td.ModeSortSpec(track_freq="central"))
@@ -337,6 +335,7 @@ def get_mode_solver_data():
         freqs=freqs,
         mode_spec=mode_spec,
         name="test_monitor",
+        colocate=False,
     )
 
     # Create n_group_raw and dispersion_raw with same shape as n_complex
@@ -353,18 +352,18 @@ def get_mode_solver_data():
     # Create mode data with the right frequencies
     mode_data = td.ModeSolverData(
         monitor=monitor,
-        Ex=make_scalar_mode_field_data_array("Ex"),
-        Ey=make_scalar_mode_field_data_array("Ey"),
-        Ez=make_scalar_mode_field_data_array("Ez"),
-        Hx=make_scalar_mode_field_data_array("Hx"),
-        Hy=make_scalar_mode_field_data_array("Hy"),
-        Hz=make_scalar_mode_field_data_array("Hz"),
-        n_complex=N_COMPLEX.copy(),
+        Ex=make_scalar_mode_field_data_array("Ex", symmetry=False),
+        Ey=make_scalar_mode_field_data_array("Ey", symmetry=False),
+        Ez=make_scalar_mode_field_data_array("Ez", symmetry=False),
+        Hx=make_scalar_mode_field_data_array("Hx", symmetry=False),
+        Hy=make_scalar_mode_field_data_array("Hy", symmetry=False),
+        Hz=make_scalar_mode_field_data_array("Hz", symmetry=False),
+        n_complex=N_COMPLEX,
         n_group_raw=n_group_raw,
         dispersion_raw=dispersion_raw,
         symmetry=(0, 0, 0),
         symmetry_center=(0, 0, 0),
-        grid_expanded=td.Grid(boundaries=td.Coords(x=[0, 1], y=[0, 1], z=[0, 1])),
+        grid_expanded=SIM.discretize_monitor(monitor),
     )
     return mode_data
 
@@ -425,23 +424,24 @@ def test_mode_solver_data_interp_cheb():
         freqs=freqs_cheb,
         mode_spec=mode_spec,
         name="test_cheb",
+        colocate=False,
     )
 
-    from ..test_data.test_data_arrays import make_scalar_mode_field_data_array
+    from ..test_data.test_data_arrays import SIM, make_scalar_mode_field_data_array
     from ..test_data.test_monitor_data import N_COMPLEX
 
     mode_data = td.ModeSolverData(
         monitor=monitor,
-        Ex=make_scalar_mode_field_data_array("Ex"),
-        Ey=make_scalar_mode_field_data_array("Ey"),
-        Ez=make_scalar_mode_field_data_array("Ez"),
-        Hx=make_scalar_mode_field_data_array("Hx"),
-        Hy=make_scalar_mode_field_data_array("Hy"),
-        Hz=make_scalar_mode_field_data_array("Hz"),
+        Ex=make_scalar_mode_field_data_array("Ex", symmetry=False),
+        Ey=make_scalar_mode_field_data_array("Ey", symmetry=False),
+        Ez=make_scalar_mode_field_data_array("Ez", symmetry=False),
+        Hx=make_scalar_mode_field_data_array("Hx", symmetry=False),
+        Hy=make_scalar_mode_field_data_array("Hy", symmetry=False),
+        Hz=make_scalar_mode_field_data_array("Hz", symmetry=False),
         n_complex=N_COMPLEX.copy(),
         symmetry=(0, 0, 0),
         symmetry_center=(0, 0, 0),
-        grid_expanded=td.Grid(boundaries=td.Coords(x=[0, 1], y=[0, 1], z=[0, 1])),
+        grid_expanded=SIM.discretize_monitor(monitor),
     )
 
     # Interpolate to 50 frequencies
@@ -895,32 +895,27 @@ def test_mode_monitor_interp_spec_none():
 # ============================================================================
 
 
-def make_wave_port():
+def make_wave_port(num_interp_points=3, method="linear"):
     """Make a WavePort."""
-    from tidy3d.components.microwave.path_integrals.integrals.current import (
-        AxisAlignedCurrentIntegral,
-    )
     from tidy3d.plugins.smatrix.ports.wave import WavePort
 
     return WavePort(
         center=(0, 0, 0),
         size=(1, 1, 0),
         direction="+",
         name="port1",
-        current_integral=AxisAlignedCurrentIntegral(
-            center=(0, 0, 0),
-            size=(1, 1, 0),
-            sign="+",
-            extrapolate_to_endpoints=True,
-            snap_contour_to_grid=True,
+        mode_spec=td.MicrowaveModeSpec(
+            num_modes=1,
+            sort_spec=td.ModeSortSpec(track_freq="central"),
+            interp_spec=td.ModeInterpSpec(num_points=num_interp_points, method=method),
         ),
     )
 
 
 def test_wave_port_to_monitors_propagates_default_interp_spec():
     """Test that WavePort.to_monitors() propagates default interp_spec to ModeMonitor."""
 
-    port = make_wave_port()
+    port = make_wave_port(num_interp_points=3, method="linear")
 
     freqs = np.linspace(1e14, 2e14, 20)
     monitors = port.to_monitors(freqs=freqs)
@@ -929,16 +924,13 @@ def test_wave_port_to_monitors_propagates_default_interp_spec():
     monitor = monitors[0]
     assert isinstance(monitor, td.ModeMonitor)
     assert monitor.mode_spec.interp_spec is not None
-    assert (
-        monitor.mode_spec.interp_spec.num_points
-        == DEFAULT_WAVE_PORT_MODE_SPEC.interp_spec.num_points
-    )
-    assert monitor.mode_spec.interp_spec.method == DEFAULT_WAVE_PORT_MODE_SPEC.interp_spec.method
+    assert monitor.mode_spec.interp_spec.num_points == 3
+    assert monitor.mode_spec.interp_spec.method == "linear"
 
 
 def test_wave_port_to_monitors_propagates_custom_interp_spec():
     """Test that WavePort.to_monitors() propagates custom interp_spec to ModeMonitor."""
-    custom_mode_spec = td.ModeSpec(
+    custom_mode_spec = td.MicrowaveModeSpec(
         num_modes=1,
         sort_spec=td.ModeSortSpec(track_freq="central"),
         interp_spec=td.ModeInterpSpec(num_points=8, method="cheb"),
@@ -958,7 +950,7 @@ def test_wave_port_to_monitors_propagates_custom_interp_spec():
 
 def test_wave_port_to_monitors_propagates_none_interp_spec():
     """Test that WavePort.to_monitors() propagates interp_spec=None to ModeMonitor."""
-    mode_spec_no_interp = td.ModeSpec(
+    mode_spec_no_interp = td.MicrowaveModeSpec(
         num_modes=1, sort_spec=td.ModeSortSpec(track_freq="central"), interp_spec=None
     )
     port = make_wave_port().updated_copy(mode_spec=mode_spec_no_interp)

tidy3d/components/base.py

@@ -1397,3 +1397,16 @@ def __getattribute__(self, name: str):
 
     _LazyProxy.__name__ = proxy_name
     return _LazyProxy
+
+
+class InterpolatableMixin(Tidy3dBaseModel):
+    """Mixin to add a `reduce_data` field to a model."""
+
+    reduce_data: bool = pydantic.Field(
+        False,
+        title="Reduce Data",
+        description="If `mode_spec.interp_spec` is defined, one can use this flag "
+        "to record fields and quatities only at interpolation source frequency points. "
+        "The :class:`.ModeMonitorData` at requested frequencies can be obtain through "
+        "the :attr:`.ModeMonitorData.interpolated_copy` property.",
+    )