tidy3d.Simulation.viz_eps_2D

Simulation.viz_eps_2D(normal='x', position=0.0, ax=None, cbar=False, clim=None, source_alpha=0.3, monitor_alpha=0.3, pml_alpha=0.2, frequency=None)

Plot the real part of the relative permittivity distribution of a 2D cross-section of the simulation.

Parameters
  • normal ({'x', 'y', 'z'}) – Axis normal to the cross-section plane.

  • position (float, optional) – Position offset along the normal axis.

  • ax (Matplotlib axis object, optional) – If None, a new figure is created.

  • cbar (bool, optional) – Add a colorbar to the plot.

  • clim (List[float], optional) – Matplotlib color limit to use for plot.

  • source_alpha (float, optional) – If larger than zero, overlay all sources in the simulation, with opacity defined by source_alpha.

  • monitor_alpha (float, optional) – If larger than zero, overlay all monitors in the simulation, with opacity defined by monitor_alpha.

  • pml_alpha (float, optional) – If larger than zero, overlay the PML boundaries of the simulation, with opacity defined by pml_alpha.

  • frequency (float or None, optional) – (Hz) frequency at which to query the permittivity. If None, the instantaneous \(\epsilon_\infty\) is used.

Returns

Return type

Matplotlib axis object

Note

The plotting is discretized at the center positions of the Yee grid and is for illustrative purposes only. It does not exactly match the discretization used in the solver.