tidy3d.HeatBoundarySpec

class HeatBoundarySpec

Bases: Tidy3dBaseModel

Heat boundary conditions specification.

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().

• placement (Union[StructureBoundary, StructureStructureInterface, MediumMediumInterface, SimulationBoundary, StructureSimulationBoundary]) – Location to apply boundary conditions.

• condition (Union[TemperatureBC, HeatFluxBC, ConvectionBC]) – Boundary conditions to apply at the selected location.

Example

>>> from tidy3d import SimulationBoundary
>>> bc_spec = HeatBoundarySpec(
...     placement=SimulationBoundary(),
...     condition=ConvectionBC(ambient_temperature=300, transfer_coeff=1),
... )

Attributes

attrs

Methods

Inherited Common Usage

placement

condition

__hash__()

Hash method.