flow360.TurbulenceModelControls#

class TurbulenceModelControls[source]#

Bases: Flow360BaseModel

TurbulenceModelControls class specifies modeling constants and enforces turbulence model behavior on a zonal basis, as defined by mesh entities or boxes in space. These controls supersede the global turbulence model solver settings.

Example

>>> fl.TurbulenceModelControls(
...     modeling_constants=fl.SpalartAllmarasConstants(C_w2=2.718),
...     enforcement="RANS",
...     entities=[
...         volume_mesh["block-1"],
...         fl.Box.from_principal_axes(
...             name="box",
...             axes=[(0, 1, 0), (0, 0, 1)],
...             center=(0, 0, 0) * fl.u.m,
...             size=(0.2, 0.3, 2) * fl.u.m,
...         ),
...     ],
... )
modeling_constants: TurbulenceModelConstants | None = None#

A class of SpalartAllmarasModelConstants or KOmegaSSTModelConstants used to specify constants in specific regions of the domain.

enforcement: Literal['RANS', 'LES'] | None = None#

Force RANS or LES mode in a specific control region.

entities: EntityList[GenericVolume, Box] [Required] (alias 'volumes')#

The entity in which to apply the TurbulenceMOdelControls`. The entity should be defined by Box or zones from the geometry/volume mesh.The axes of entity must be specified to serve as the the principle axes of the TurbulenceModelControls region.