--amend

Author: George-Guryev-flxcmp

CHANGELOG.md

@@ -8,8 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
-- Add automatic structure extrusion for waveports defined on boundaries, controlled by the `extrude_structures` field in `WavePort`.
-- The extrusion method, implemented in `TerminalComponentModeler`, ensures that mode sources, absorbers, and PEC frames are fully contained within the extruded structures; extrusion occurs only when `extrude_structures` is set to `True`.
+- Added optional automatic extrusion of boundary waveport structures via `WavePort.extrude_structures`, ensuring mode sources, absorbers, and PEC frames are fully contained.
 - Added rectangular and radial taper support to `RectangularAntennaArrayCalculator` for phased array amplitude weighting; refactored array factor calculation for improved clarity and performance. 
 - Selective simulation capabilities to `TerminalComponentModeler` via `run_only` and `element_mappings` fields, allowing users to run fewer simulations and extract only needed scattering matrix elements.
 - Added KLayout plugin, with DRC functionality for running design rule checks in `plugins.klayout.drc`. Supports running DRC on GDS files as well as `Geometry`, `Structure`, and `Simulation` objects.

schemas/TerminalComponentModeler.json

@@ -16108,6 +16108,10 @@
           ],
           "type": "string"
         },
+        "extrude_structures": {
+          "default": false,
+          "type": "boolean"
+        },
         "frame": {
           "allOf": [
             {

tests/test_plugins/smatrix/test_terminal_component_modeler.py

@@ -1370,40 +1370,44 @@ def test_wave_port_extrusion_coaxial():
     port_1 = ports[0]
     port_2 = ports[1]
     port_1 = port_1.updated_copy(center=(0, 0, -50000), extrude_structures=True)
+
+    # test that structure extrusion requires an internal absorber (should raise ValidationError)
+    with pytest.raises(pd.ValidationError):
+        _ = port_2.updated_copy(center=(0, 0, 50000), extrude_structures=True, absorber=False)
+
+    # define a valid waveport
     port_2 = port_2.updated_copy(center=(0, 0, 50000), extrude_structures=True)
 
     # update component modeler
     tcm = tcm.updated_copy(ports=[port_1, port_2])
 
     # generate simulations from component modeler
-    sims = list(tcm.sim_dict.values())
+    sim = tcm.base_sim
 
-    # loop over simulations
-    for sim in sims:
-        # get injection axis that would be used to extrude structure
-        inj_axis = sim.sources[0].injection_axis
+    # get injection axis that would be used to extrude structure
+    inj_axis = sim.internal_absorbers[0].size.index(0.0)
 
-        # get grid boundaries
-        bnd_coords = sim.grid.boundaries.to_list[inj_axis]
+    # get grid boundaries
+    bnd_coords = sim.grid.boundaries.to_list[inj_axis]
 
-        # get size of structures along injection axis directions
-        str_bnds = [
-            np.min(sim.structures[0].geometry.geometries[0].slab_bounds),
-            np.max(sim.structures[2].geometry.geometries[0].slab_bounds),
-        ]
+    # get size of structures along injection axis directions
+    str_bnds = [
+        np.min(sim.structures[0].geometry.geometries[1].geometries[0].slab_bounds),
+        np.max(sim.structures[0].geometry.geometries[0].slab_bounds),
+    ]
 
-        pec_bnds = []
+    pec_bnds = []
 
-        # infer placement of PEC plates beyond internal absorber
-        for absorber in sim.internal_absorbers:
-            absorber_cntr = absorber.center[inj_axis]
-            right_ind = np.searchsorted(bnd_coords, absorber_cntr, side="right")
-            left_ind = np.searchsorted(bnd_coords, absorber_cntr, side="left") - 1
-            pec_bnds.append(bnd_coords[right_ind + 1])
-            pec_bnds.append(bnd_coords[left_ind - 1])
+    # infer placement of PEC plates beyond internal absorber
+    for absorber in sim.internal_absorbers:
+        absorber_cntr = absorber.center[inj_axis]
+        right_ind = np.searchsorted(bnd_coords, absorber_cntr, side="right")
+        left_ind = np.searchsorted(bnd_coords, absorber_cntr, side="left") - 1
+        pec_bnds.append(bnd_coords[right_ind + 1])
+        pec_bnds.append(bnd_coords[left_ind - 1])
 
-        # get range of coordinates along injection axis for PEC plates
-        pec_bnds = [np.min(pec_bnds), np.max(pec_bnds)]
+    # get range of coordinates along injection axis for PEC plates
+    pec_bnds = [np.min(pec_bnds), np.max(pec_bnds)]
 
-        # ensure that structures were extruded up to PEC plates
-        assert all(np.isclose(str_bnd, pec_bnd) for str_bnd, pec_bnd in zip(str_bnds, pec_bnds))
+    # ensure that structures were extruded up to PEC plates
+    assert all(np.isclose(str_bnd, pec_bnd) for str_bnd, pec_bnd in zip(str_bnds, pec_bnds))

tidy3d/components/simulation.py

@@ -5638,33 +5638,9 @@ def _make_pec_frame(self, obj: Union[ModeSource, InternalAbsorber]) -> Structure
         the frame is added around the injection plane. For internal absorbers, a backing pec
         plate is also added on the non-absorbing side.
         """
-        span_inds = np.array(self.grid.discretize_inds(obj))
 
-        coords = self.grid.boundaries.to_list
-        direction = obj.direction
-        if isinstance(obj, ModeSource):
-            axis = obj.injection_axis
-            length = obj.frame.length
-        else:
-            axis = obj.size.index(0.0)
-            length = 1
-
-        if direction == "+":
-            span_inds[axis][1] += length - 1
-            span_inds[axis][0] -= 1
-        else:
-            span_inds[axis][1] += 1
-            span_inds[axis][0] -= length - 1
-
-        box_bounds = [
-            [
-                c[beg],
-                c[end],
-            ]
-            for c, (beg, end) in zip(coords, span_inds)
-        ]
-
-        box = Box.from_bounds(*np.transpose(box_bounds))
+        # get pec frame bounding box, object's axis and direction
+        (box, axis, direction) = self._pec_frame_box(obj)
 
         surfaces = Box.surfaces(box.size, box.center)
         if isinstance(obj, ModeSource):
@@ -5723,3 +5699,34 @@ def _validate_finalized(self):
                 "Simulation fails after requested mode source PEC frames are added. "
                 "Please inspect '._finalized'."
             )
+
+    def _pec_frame_box(self, obj: Union[ModeSource, InternalAbsorber]) -> tuple[Box, int, str]:
+        """Return pec bounding box, frame axis and object's direction"""
+
+        span_inds = np.array(self.grid.discretize_inds(obj))
+
+        coords = self.grid.boundaries.to_list
+        direction = obj.direction
+        if isinstance(obj, ModeSource):
+            axis = obj.injection_axis
+            length = obj.frame.length
+        else:
+            axis = obj.size.index(0.0)
+            length = 1
+
+        if direction == "+":
+            span_inds[axis][1] += length - 1
+            span_inds[axis][0] -= 1
+        else:
+            span_inds[axis][1] += 1
+            span_inds[axis][0] -= length - 1
+
+        box_bounds = [
+            [
+                c[beg],
+                c[end],
+            ]
+            for c, (beg, end) in zip(coords, span_inds)
+        ]
+
+        return (Box.from_bounds(*np.transpose(box_bounds)), axis, direction)