- "description": "Convective thermal boundary conditions.\n\nParameters\n----------\nattrs : dict = {}\n 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()``.\nambient_temperature : PositiveFloat\n [units = K]. Ambient temperature value in units of K.\ntransfer_coeff : Union[NonNegativeFloat, VerticalNaturalConvectionCoeffModel]\n [units = W/(um^2*K)]. Heat flux value in units of W/(um^2*K).\n\nExample\n-------\n>>> import tidy3d as td\n>>> bc = td.ConvectionBC(ambient_temperature=300, transfer_coeff=1)\n\n>>> # Convection with a natural convection model.\n>>> # First, define the fluid medium (e.g. air at 300 K).\n>>> air = td.FluidMedium.from_si_units(\n... thermal_conductivity=0.0257, # Unit: W/(m*K)\n... viscosity=1.81e-5, # Unit: Pa*s\n... specific_heat=1005, # Unit: J/(kg*K)\n... density=1.204, # Unit: kg/m^3\n... expansivity=1/293.15 # Unit: 1/K\n... )\n>>>\n>>> # Next, create the model, which requires the fluid and a characteristic length.\n>>> natural_conv_model = td.VerticalNaturalConvectionCoeffModel.from_si_units(\n... medium=air, plate_length=1e-5\n... )\n>>>\n>>> # Finally, create the boundary condition using this model.\n>>> bc_natural = td.ConvectionBC(\n... ambient_temperature=300, transfer_coeff=natural_conv_model\n... )\n\n>>> # If the fluid medium is not provided to the coefficient model, it is automatically retrieved from\n>>> # the interface.\n>>> natural_conv_model_nom = td.VerticalNaturalConvectionCoeffModel.from_si_units(plate_length=1e-5)\n>>> bc_natural_nom = td.ConvectionBC(\n... ambient_temperature=300, transfer_coeff=natural_conv_model_nom\n... )",
0 commit comments