tidy3d.HeatSource

tidy3d.HeatSource#

class HeatSource[source]#

Bases: StructureBasedHeatChargeSource

Adds a volumetric heat source (heat sink if negative values are provided) to specific structures in the scene.

Parameters:

name (Optional[str] = None) – Optional name for the source.
structures (tuple[str, ...]) – Names of structures where to apply heat source.
rate (Union[float, SpatialDataArray]) – [units = W/um^3]. Volumetric rate of heating or cooling (if negative).

Example

>>> heat_source = HeatSource(rate=1, structures=["box"])

Attributes