tidy3d.components.tcad.data.sim_data.AbstractHeatChargeSimulationData

tidy3d.components.tcad.data.sim_data.AbstractHeatChargeSimulationData#

class AbstractHeatChargeSimulationData[source]#

Bases: AbstractSimulationData, ABC

Abstract class for HeatChargeSimulation results, or VolumeMesher results.

Parameters:

Attributes

simulation

data

log

Methods

plot_mesh(monitor_name[, field_name, ...])

Plot the simulation mesh in a monitor region with structures overlaid.
simulation#
plot_mesh(monitor_name, field_name=None, structures_fill=True, ax=None, **sel_kwargs)[source]#

Plot the simulation mesh in a monitor region with structures overlaid.

Parameters:

  • monitor_name (str) – Name of HeatChargeMonitor to plot. Must be a monitor with the unstructured=True setting.

  • field_name (Optional[str] = "mesh") – Name of field component whose associated grid to plot. Not required if monitor data contains only one field.

  • structures_fill (bool = True) – Whether to overlay the mesh on structures filled with color or only show structure outlines.

  • ax (matplotlib.axes._subplots.Axes = None) – matplotlib axes to plot on, if not specified, one is created.

  • sel_kwargs (keyword arguments used to perform .sel() selection in the monitor data.) – These kwargs can select over the spatial dimensions (x, y, z), or time dimension (t) if applicable. For the plotting to work appropriately, the resulting data after selection must contain only two coordinates with len > 1. Furthermore, these should be spatial coordinates (x, y, or z).

Note

For 3D simulations, the 2D mesh shown here would be the result of slicing the underlying unstructured tetrahedral grid with the selected plane. If however the monitor sets conformal=True, the simulation mesh has been made to conform to the monitor plane, in which case the visualized mesh is exact.

Returns:

The supplied or created matplotlib axes.

Return type:

matplotlib.axes._subplots.Axes