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:

  • attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

  • 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) in units of W/um^3.

Example

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

Attributes

attrs

Methods

Inherited Common Usage

rate#
__hash__()#

Hash method.