tidy3d.HeatBoundarySpec#

class HeatBoundarySpec[source]#

Bases: Tidy3dBaseModel

Heat boundary conditions specification.

Parameters:
  • placement (Attribute: placement) –

    Type

    Union[StructureBoundary, StructureStructureInterface, MediumMediumInterface, SimulationBoundary, StructureSimulationBoundary]

    Default

    Description

    Location to apply boundary conditions.

  • condition (Attribute: condition) –

    Type

    Union[TemperatureBC, HeatFluxBC, ConvectionBC]

    Default

    Description

    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

Methods

placement#
condition#
__hash__()#

Hash method.