tidy3d.EMEModeSweep

class EMEModeSweep

Bases: EMESweepSpec

Spec for sweeping number of modes in EME propagation step. Used for convergence testing.

Parameters:

num_modes (ArrayLike[dtype=int, ndim=1]) – Max number of modes to use in the EME propagation step. The EME propagation step is repeated after dropping modes with mode_index exceeding this value. This can be used for convergence testing; reliable results should be independent of the number of modes used. This value cannot exceed the maximum number of modes in any EME cell in the simulation.

Example

>>> sweep_spec = EMEModeSweep(num_modes=[1, 2, 5, 10])

Attributes

num_sweep	Number of sweep indices.
sweep_cells	Whether the sweep changes the propagation within a cell.
sweep_interfaces	Whether the sweep changes the cell interface scattering matrices.
num_modes

num_modes

property num_sweep

Number of sweep indices.

property sweep_interfaces

Whether the sweep changes the cell interface scattering matrices.

property sweep_cells

Whether the sweep changes the propagation within a cell.