tidy3d.EMESimulation.compute_overlaps

EMESimulation.compute_overlaps(mode_data, progress=True)

Stage modes and compute all per-cell and per-interface overlaps.

Convenience wrapper around stage_cell_modes(), compute_cell_overlap(), and compute_interface_overlap(). Under the supported sweep types (EMELengthSweep, EMEModeSweep, EMEPeriodicitySweep) the returned overlaps are sweep-invariant, so compute them once and pass the results to propagate_from_overlaps() as many times as you want — one per iterative design probe.

Parameters:

• mode_data (Sequence[ModeSimulationData | ModeSolverData]) – One mode result per EME cell, in cell order. Typically [ms.run_local() for ms in sim.mode_simulations].

• progress (bool) – If True (default), show a rich progress bar on the logging console.

Returns:

• cell_overlaps (list[EMEStageCellOverlap]) – One per EME cell, in cell order.

• interface_overlaps (list[EMEStageInterfaceOverlap]) – One per interface, in the order of cell_index_pairs.