tidy3d.UniformHeatSource#

class UniformHeatSource[source]#

Bases: HeatSource

Volumetric heat source.

Parameters:
  • name (Attribute: name) –

    Type

    Optional[str]

    Default

    = None

    Description

    Optional name for the source.

  • structures (Attribute: structures) –

    Type

    Tuple[str, …]

    Default

    Description

    Names of structures where to apply heat source.

  • rate (Attribute: rate) –

    Type

    Union[float, TimeDataArray]

    Default

    Units

    W/um^3

    Description

    Volumetric rate of heating or cooling (if negative) in units of W/um^3.

Example

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

Attributes

Methods

rate#
__hash__()#

Hash method.