tidy3d.components.tcad.monitors.abstract.HeatChargeMonitor

tidy3d.components.tcad.monitors.abstract.HeatChargeMonitor#

class HeatChargeMonitor[source]#

Bases: AbstractMonitor, ABC

Abstract base class for heat-charge monitors.

Parameters:

  • center (Optional[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]]] = None) – [units = um]. Center of object in x, y, and z.

  • size (tuple[Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box]]) – [units = um]. Size in x, y, and z directions.

  • name (str) – Unique name for monitor.

  • unstructured (bool = True) – Return data on the original unstructured grid.

  • conformal (bool = False) – If True the simulation mesh will conform to the monitor’s geometry. While this can be set for both Cartesian and unstructured monitors, it bears higher significance for the latter ones. Effectively, setting conformal = True for unstructured monitors (unstructured = True) ensures that returned values will not be obtained by interpolation during postprocessing but rather directly transferred from the computational grid. Note: if the simulation mesh uses remove_fragments=True, this option is ignored (treated as False). Deprecated: this field will be removed in version 2.12.

Attributes

unstructured

conformal

name

size

center

Methods

storage_size(num_cells, tmesh)

Size of monitor storage given the number of points after discretization.
unstructured#
conformal#
storage_size(num_cells, tmesh)[source]#

Size of monitor storage given the number of points after discretization.