TurbulenceModelControls

class TurbulenceModelControls

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,
...         ),
...     ],
... )

Attributes

modeling_constants: SpalartAllmarasModelConstants | KOmegaSSTModelConstants, optional

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

Default:

None

enforcement: Literal['RANS', 'LES'], optional

Force RANS or LES mode in a specific control region.

Default:

None

entities: EntityList[GenericVolume, CustomVolume, Box]

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.

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')