tidy3d.Simulation.set_monitor_modes

Simulation.set_monitor_modes(monitor, Nmodes=None, target_neff=None, pml_layers=(0, 0), bend_radius=None, bend_axis=None)

Set the parameters for the modes to be used in the modal decomposition in the monitor.

Parameters
  • monitor (ModeMonitor) – A mode monitor in the simulation.

  • Nmodes (None or int, optional) – Number of modes to compute. If None, uses monitor.Nmodes.

  • target_neff (None or float, optional) – Look for modes with effective index closest to target_neff. If None, the modes are computed in order of decreasing index.

  • pml_layers (tuple, optional) – Number of PML layers to be added in each direction. These are added to the interior of the mode plane, i.e. its size is not extended. The default boundaries are PEC.

  • bend_radius (float or None, optional) – A curvature radius for simulation of waveguide bends.

  • bend_axis ('x', 'y', 'z' or None, optional) – The axis normal to the plane in which the bend lies. This must be provided if bend_radius is not None, and it must be orthogonal to the axis normal to the mode plane.