tidy3dclient.viz.relative_eps

tidy3dclient.viz.relative_eps(sim, normal='x', offset=0, ax=None, cbar=False, sources=True, probes=True, pml=True)

Plot the relative permittivity distribution in a 2D cross-section.

Parameters

• sim (Simulation) – Simulation object.

• normal (str) – 'x', 'y', or 'z', axis normal to the cross-section plane.

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

• ax (int, optional) – Matplotlib axis object to use for the plot. If None, a new figure is created.

• cbar (bool, optional) – Whether or not a colorbar should be added to the plot.

• sources (bool, optional) – Overlay the source positions.

• probes (bool, optional) – Overlay the probe positions.

• pml (bool, optional) – Overlay the pml regions.

Note

The plotting is discretized at the center positions of the grid and is for illustrative purposes only. In the FDTD evolution, the Yee grid is used and where the permittivity, source, and probe locations depend on the field polarization.