tidy3d.VerticalNaturalConvectionCoeffModel

class VerticalNaturalConvectionCoeffModel

Bases: Tidy3dBaseModel

Specification for natural convection from a vertical plate.

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

• medium (Optional[FluidMedium] = None) – The FluidMedium used for the heat transfer coefficient calculation. If None, the fluid is automatically deduced from the interface, which can be definedby either a MediumMediumInterface or a StructureStructureInterface.

• plate_length (NonNegativeFloat) – [units = um]. Characteristic length (L), defined as the height of the vertical plate.

• gravity (NonNegativeFloat = 9806650.0) – [units = um/s^2]. Gravitational acceleration (g).

Notes

This class calculates the heat transfer coefficient (h) based on fluid properties and an expected temperature difference, then provides these values as \(\text{base_l}\), \(\text{base_nl}\), and \(\text{exponent}\) for a generalized heat flux equation

\[q = \text{base_nl} * (T_\text{surf} - T_\text{fluid})^\text{exponent} + \text{base}_{l} * (T_\text{surf}- T_\text{fluid}).\]

Attributes

attrs

Methods

from_si_units([medium, gravity])

Create an instance from standard SI units.

Inherited Common Usage

medium

plate_length

gravity

from_si_units(medium=None, gravity=9.80665)

Create an instance from standard SI units.

Args:

plate_length: Plate characteristic length in [m]. gravity: Gravitational acceleration in [m/s**2].

Returns:

An instance of VerticalNaturalConvectionCoeffModel with all values converted to Tidy3D’s internal unit system.

__hash__()

Hash method.