tidy3d.TemperatureData#

class TemperatureData[source]#

Bases: HeatMonitorData

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 (Union[SpatialDataArray, Annotated[Union[tidy3d.components.data.dataset.TriangularGridDataset, tidy3d.components.data.dataset.TetrahedralGridDataset], FieldInfo(default=PydanticUndefined, discriminator='type', extra={})], NoneType]) – [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")
>>> 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

symmetry_expanded_copy

Return copy of self with symmetry applied.

Methods

warn_no_data(val, values)

Warn if no data provided.

Inherited Common Usage

monitor#
temperature#
classmethod warn_no_data(val, values)[source]#

Warn if no data provided.

property symmetry_expanded_copy#

Return copy of self with symmetry applied.

__hash__()#

Hash method.