tidy3d.TemperatureMonitor

class TemperatureMonitor

Bases: HeatChargeMonitor

Temperature monitor.

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.

• interval (PositiveInt = 1) – Sampling rate of the monitor: number of time steps between each measurement. Set interval to 1 for the highest possible resolution in time. Higher integer values down-sample the data by measuring every interval time steps. This can be useful for reducing data storage as needed by the application. The last time step is included in the output when interval is commensurate with total_time_steps (i.e. total_time_steps is divisible by interval). To capture only the final state, set interval equal to total_time_steps in the simulation’s UnsteadySpec. NOTE: this is only relevant for unsteady (transient) Heat simulations.

Attributes

interval
unstructured
conformal
name
size
center

interval