tidy3d.EMESimulation.compute_interface_overlap

EMESimulation.compute_interface_overlap(left_modes, right_modes, left_overlap=None, right_overlap=None, include_diagnostic_metrics=None)

Compute cross-cell overlaps for one interface.

The result feeds into compute_interface_smatrix(). See propagate() for the one-shot alternative.

Parameters:

• left_modes (EMEStageCellModes) – Staged modes for the two cells forming this interface, matching a pair from cell_index_pairs.

• right_modes (EMEStageCellModes) – Staged modes for the two cells forming this interface, matching a pair from cell_index_pairs.

• left_overlap (EMEStageCellOverlap or None) – Cell overlap stages for the same two cells.

• right_overlap (EMEStageCellOverlap or None) – Cell overlap stages for the same two cells.

• include_diagnostic_metrics (bool or None, optional) – When True and both cell overlaps are provided, also include the per-interface full and non-PML-aperture tangential-field metric matrices used by compute_interface_diagnostics(). When None (default), this follows eme_diagnostics.

Return type:

EMEStageInterfaceOverlap