Heat 🔥

Simulation

tidy3d.HeatSimulation	Contains all information about heat simulation.
tidy3d.HeatChargeSimulation	Defines thermoelectric simulations.

Material Thermal

tidy3d.FluidSpec	Fluid medium class for backwards compatibility
tidy3d.SolidSpec	Solid medium class for backwards compatibility

Thermal Perturbation Specification

tidy3d.LinearHeatPerturbation	Specifies parameter's perturbation due to thermal effects as a linear function of temperature.
tidy3d.CustomHeatPerturbation	Specifies parameter's perturbation due to thermal effects as a custom function of temperature defined as an array of perturbation values at sample temperature points.

Boundary Conditions

Specifications

tidy3d.HeatBoundarySpec	Heat BC specification.
tidy3d.HeatChargeBoundarySpec	Heat-Charge boundary conditions specification.

Types

tidy3d.TemperatureBC	Constant temperature thermal boundary conditions.
tidy3d.ConvectionBC	Convective thermal boundary conditions.
tidy3d.HeatFluxBC	Constant flux thermal boundary conditions.

Placement

tidy3d.StructureStructureInterface	Placement of boundary conditions between two structures.
tidy3d.StructureBoundary	Placement of boundary conditions on the structure's boundary.
tidy3d.MediumMediumInterface	Placement of boundary conditions between two mediums.
tidy3d.StructureSimulationBoundary	Placement of boundary conditions on the simulation box boundary covered by the structure.
tidy3d.SimulationBoundary	Placement of boundary conditions on the simulation box boundary.

Thermal Sources

tidy3d.UniformHeatSource	Volumetric heat source.
tidy3d.HeatSource	Adds a volumetric heat source (heat sink if negative values are provided) to specific structures in the scene.
tidy3d.HeatFromElectricSource	Volumetric heat source generated from an electric simulation.

Grid Specification

tidy3d.UniformUnstructuredGrid	Uniform grid.
tidy3d.DistanceUnstructuredGrid	Adaptive grid based on distance to material interfaces.

Monitors

tidy3d.TemperatureMonitor

Temperature monitor.

Output Data

Simulation Data

tidy3d.HeatSimulationData	DEPRECATED: Wrapper for Heat Simulation data.
tidy3d.HeatChargeSimulationData	Stores results of a HeatChargeSimulation.

Monitor Data

tidy3d.TemperatureData

Data associated with a TemperatureMonitor: spatial temperature field.

Unstructured Data Classes

tidy3d.TriangularGridDataset	Dataset for storing triangular grid data.
tidy3d.TetrahedralGridDataset	Dataset for storing tetrahedral grid data.

Individual Datasets

tidy3d.PointDataArray	A two-dimensional array that stores coordinates of a collection of points.
tidy3d.CellDataArray	A two-dimensional array that stores indices of points composing each cell in a collection of cells of the same type (for example: triangles, tetrahedra, etc).
tidy3d.IndexedDataArray	Stores a one-dimensional array enumerated by coordinate index.