tidy3d.HeatFromElectricSource

class HeatFromElectricSource

Bases: GlobalHeatChargeSource

Volumetric heat source generated from an electric simulation.

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.

Notes

If a HeatFromElectricSource is specified as a source, appropriate boundary conditions for an electric simulation must be provided, since such a simulation will be executed before the heat simulation can run.

Example

>>> heat_source = HeatFromElectricSource()

Attributes

attrs

Methods

Inherited Common Usage

__hash__()

Hash method.