tidy3d.SolidMedium

class SolidMedium

Bases: AbstractHeatMedium

Solid medium for heat simulations.

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 unique name for medium.

• capacity (Optional[PositiveFloat] = None) – [units = J/(kg*K)]. Specific heat capacity in unit of J/(kg*K).

• conductivity (PositiveFloat) – [units = W/(um*K)]. Thermal conductivity of material in units of W/(um*K).

• density (Optional[PositiveFloat] = None) – [units = kg/um^3]. Mass density of material in units of kg/um^3.

Example

>>> solid = SolidMedium(
...     capacity=2,
...     conductivity=3,
... )

Attributes

attrs

Methods

from_si_units([capacity, density])

Create a SolidMedium using SI units

Inherited Common Usage

capacity

conductivity

density

from_si_units(capacity=None, density=None)

Create a SolidMedium using SI units

__hash__()

Hash method.