tidy3d.TemperatureData

class TemperatureData

Bases: HeatChargeMonitorData

Data associated with a TemperatureMonitor: spatial temperature field.

Parameters:

• monitor (TemperatureMonitor) – Temperature monitor associated with the data.

• symmetry (tuple[Literal[0, 1], Literal[0, 1], Literal[0, 1]] = (0, 0, 0)) – Symmetry of the original simulation in x, y, and z.

• symmetry_center (tuple[float, float, float] = (0, 0, 0)) – Symmetry center of the original simulation in x, y, and z.

• temperature (Optional[Union[Union[TriangularGridDataset, TetrahedralGridDataset], SpatialDataArray, ScalarFieldTimeDataArray]] = None) – [units = K]. Spatial temperature field.

Example

>>> from tidy3d import TemperatureMonitor, SpatialDataArray
>>> import numpy as np
>>> temp_data = SpatialDataArray(
...     np.ones((2, 3, 4)), coords={"x": [0, 1], "y": [0, 1, 2], "z": [0, 1, 2, 3]}
... )
>>> temp_mnt = TemperatureMonitor(size=(1, 2, 3), name="temperature", unstructured=True)
>>> temp_mnt_data = TemperatureData(
...     monitor=temp_mnt, temperature=temp_data, symmetry=(0, 1, 0), symmetry_center=(0, 0, 0)
... )
>>> temp_mnt_data_expanded = temp_mnt_data.symmetry_expanded_copy

Attributes

field_components	Maps the field components to their associated data.
monitor
temperature
symmetry
symmetry_center

monitor

temperature

property field_components

Maps the field components to their associated data.