a stricter check for missing frequency

Author: dbochkov-flexcompute

tests/test_components/test_absorbers.py

@@ -298,7 +298,7 @@ def test_abc_boundaries_simulations():
             min_steps_per_wvl=10,
             wavelength=wvl_um,
         ),
-        sources=[],
+        sources=[mode_source],
         run_time=1e-20,
         boundary_spec=td.BoundarySpec.all_sides(td.ABCBoundary()),
     )
@@ -313,7 +313,7 @@ def test_abc_boundaries_simulations():
                 min_steps_per_wvl=10,
                 wavelength=wvl_um,
             ),
-            sources=[],
+            sources=[mode_source],
             medium=td.AnisotropicMedium(xx=td.Medium(), yy=td.Medium(), zz=td.Medium()),
             run_time=1e-20,
             boundary_spec=td.BoundarySpec.all_sides(td.ABCBoundary()),
@@ -332,7 +332,7 @@ def test_abc_boundaries_simulations():
             min_steps_per_wvl=10,
             wavelength=wvl_um,
         ),
-        sources=[],
+        sources=[mode_source],
         structures=[box_crossing_boundary],
         run_time=1e-20,
         boundary_spec=td.BoundarySpec(
@@ -349,7 +349,7 @@ def test_abc_boundaries_simulations():
             min_steps_per_wvl=10,
             wavelength=wvl_um,
         ),
-        sources=[],
+        sources=[mode_source],
         structures=[box_crossing_boundary],
         run_time=1e-20,
         boundary_spec=td.BoundarySpec.all_sides(td.ABCBoundary(permittivity=2)),
@@ -363,7 +363,7 @@ def test_abc_boundaries_simulations():
                 min_steps_per_wvl=10,
                 wavelength=wvl_um,
             ),
-            sources=[],
+            sources=[mode_source],
             structures=[box_crossing_boundary],
             run_time=1e-20,
             boundary_spec=td.BoundarySpec.all_sides(td.ABCBoundary()),
@@ -376,7 +376,7 @@ def test_abc_boundaries_simulations():
             min_steps_per_wvl=10,
             wavelength=wvl_um,
         ),
-        sources=[],
+        sources=[mode_source],
         structures=[box_crossing_boundary.updated_copy(geometry=td.Box(size=(1, 1, 1)))],
         run_time=1e-20,
         boundary_spec=td.BoundarySpec.all_sides(td.ABCBoundary()),
@@ -393,7 +393,7 @@ def test_abc_boundaries_simulations():
                 min_steps_per_wvl=10,
                 wavelength=wvl_um,
             ),
-            sources=[],
+            sources=[mode_source],
             medium=td.CustomMedium(
                 permittivity=td.SpatialDataArray(
                     [[[2, 3]]], coords={"x": [0], "y": [0], "z": [0, 1]}
@@ -412,7 +412,7 @@ def test_abc_boundaries_simulations():
                 min_steps_per_wvl=10,
                 wavelength=wvl_um,
             ),
-            sources=[],
+            sources=[mode_source],
             structures=[box_crossing_boundary],
             run_time=1e-20,
             boundary_spec=td.BoundarySpec.all_sides(td.ABCBoundary()),
@@ -467,3 +467,69 @@ def test_abc_boundaries_simulations():
                 td.ModeABCBoundary(plane=td.Box(size=(1, 1, 0)))
             ),
         )
+    # error if no frequency
+    with pytest.raises(pydantic.ValidationError):
+        _ = td.Simulation(
+            center=[0, 0, 0],
+            size=[1, 1, 1],
+            grid_spec=td.GridSpec.auto(
+                min_steps_per_wvl=10,
+                wavelength=wvl_um,
+            ),
+            sources=[],
+            run_time=1e-20,
+            boundary_spec=td.BoundarySpec.all_sides(
+                td.ModeABCBoundary(plane=td.Box(size=(1, 1, 0)))
+            ),
+        )
+    # error if no frequency for automatic abc from interesected mediums
+    with pytest.raises(pydantic.ValidationError):
+        _ = td.Simulation(
+            center=[0, 0, 0],
+            size=[1, 1, 1],
+            grid_spec=td.GridSpec.auto(
+                min_steps_per_wvl=10,
+                wavelength=wvl_um,
+            ),
+            sources=[],
+            run_time=1e-20,
+            boundary_spec=td.BoundarySpec.all_sides(td.ABCBoundary()),
+        )
+    # ok if abc with permittivity only
+    _ = td.Simulation(
+        center=[0, 0, 0],
+        size=[1, 1, 1],
+        grid_spec=td.GridSpec.auto(
+            min_steps_per_wvl=10,
+            wavelength=wvl_um,
+        ),
+        sources=[],
+        run_time=1e-20,
+        boundary_spec=td.BoundarySpec.all_sides(td.ABCBoundary(permittivity=2)),
+    )
+    _ = td.Simulation(
+        center=[0, 0, 0],
+        size=[1, 1, 1],
+        grid_spec=td.GridSpec.auto(
+            min_steps_per_wvl=10,
+            wavelength=wvl_um,
+        ),
+        sources=[],
+        run_time=1e-20,
+        boundary_spec=td.BoundarySpec.all_sides(td.ABCBoundary(permittivity=2, conductivity=0)),
+    )
+    # not ok if non-zerp conductivity
+    with pytest.raises(pydantic.ValidationError):
+        _ = td.Simulation(
+            center=[0, 0, 0],
+            size=[1, 1, 1],
+            grid_spec=td.GridSpec.auto(
+                min_steps_per_wvl=10,
+                wavelength=wvl_um,
+            ),
+            sources=[],
+            run_time=1e-20,
+            boundary_spec=td.BoundarySpec.all_sides(
+                td.ABCBoundary(permittivity=2, conductivity=1e-5)
+            ),
+        )

tidy3d/components/simulation.py

@@ -3101,21 +3101,34 @@ def check_fixed_angle_components(cls, values):
     @skip_if_fields_missing(["sources", "boundary_spec", "internal_absorbers"], root=True)
     def _validate_frequency_mode_abc(cls, values):
         """Warn if ModeABCBoundary expects a frequency from a source, but there are multiple sources with different central frequencies."""
+
+        def boundary_needs_freq(boundary):
+            return (isinstance(boundary, ModeABCBoundary) and boundary.frequency is None) or (
+                isinstance(boundary, ABCBoundary)
+                and (
+                    (boundary.conductivity is not None and boundary.conductivity != 0)
+                    or (boundary.permittivity is None and boundary.conductivity is None)
+                )
+            )
+
+        # check domain boundaries
         boundaries = values["boundary_spec"].to_list
-        need_wavelength = any(
-            isinstance(edge, ModeABCBoundary) and edge.frequency is None
-            for edge in np.ravel(boundaries)
-        )
+        need_wavelength = any(boundary_needs_freq(edge) for edge in np.ravel(boundaries))
 
+        # check dinternal absorbers
         need_wavelength = need_wavelength or any(
-            isinstance(port_abc.boundary_spec, ModeABCBoundary)
-            and port_abc.boundary_spec.frequency is None
-            for port_abc in values["internal_absorbers"]
+            boundary_needs_freq(abc.boundary_spec) for abc in values["internal_absorbers"]
         )
 
         if need_wavelength:
             sources = values.get("sources")
 
+            if len(sources) == 0:
+                raise SetupError(
+                    "At least one 'ModeABCBoundary'/'ABCBoundary' needs specification of frequency at which the absorbed mode must be evaluated. "
+                    "Add at least one source or use parameter 'frequency' for 'ModeABCBoundary'.",
+                )
+
             freq0s = [source.source_time.freq0 for source in sources]
             if not all(math.isclose(freq0, freq0s[0]) for freq0 in freq0s):
                 log.warning(

tidy3d/plugins/smatrix/component_modelers/terminal.py

@@ -252,7 +252,9 @@ def base_sim(self) -> Simulation:
                 mode_src_pos = wave_port.center[
                     wave_port.injection_axis
                 ] + self._shift_value_signed(wave_port)
-                port_absorber = wave_port.to_absorber(snap_center=mode_src_pos)
+                port_absorber = wave_port.to_absorber(
+                    snap_center=mode_src_pos, frequency=0.5 * (min(self.freqs) + max(self.freqs))
+                )
                 new_absorbers.append(port_absorber)
 
         update_dict = {

tidy3d/plugins/smatrix/ports/wave.py

@@ -192,7 +192,9 @@ def to_mode_solver(self, simulation: Simulation, freqs: FreqArray) -> ModeSolver
         )
         return mode_solver
 
-    def to_absorber(self, snap_center: Optional[float] = None) -> InternalAbsorber:
+    def to_absorber(
+        self, snap_center: Optional[float] = None, frequency: Optional[pd.NonNegativeFloat] = None
+    ) -> InternalAbsorber:
         """Create an internal absorber from the wave port."""
         center = list(self.center)
         if snap_center:
@@ -201,7 +203,10 @@ def to_absorber(self, snap_center: Optional[float] = None) -> InternalAbsorber:
             center=center,
             size=self.size,
             boundary_spec=ModeABCBoundary(
-                mode_spec=self.mode_spec, mode_index=self.mode_index, plane=self.bounding_box
+                mode_spec=self.mode_spec,
+                mode_index=self.mode_index,
+                plane=self.bounding_box,
+                frequency=frequency,
             ),
             direction="-"
             if self.direction == "+"