WallFunction#

class WallFunction[source]#

Bases: Flow360BaseModel

WallFunction specifies the wall function model to use on a Wall boundary.

Example

  • Default boundary-layer wall function:

    >>> fl.Wall(
    ...     entities=volume_mesh["fluid/wall"],
    ...     use_wall_function=fl.WallFunction(),
    ... )
    
  • Inner-layer wall model:

    >>> fl.Wall(
    ...     entities=volume_mesh["fluid/wall"],
    ...     use_wall_function=fl.WallFunction(wall_function_type="InnerLayer"),
    ... )
    

Attributes

wall_function_type: Literal['BoundaryLayer', 'InnerLayer']#

Type of wall function model. ‘BoundaryLayer’ uses integral flat plate boundary layer theory to predict wall shear stress. It performs well across all y+ ranges. ‘InnerLayer’ uses the inner layer behavior of the turbulent boundary layer, offering better accuracy for y+ values in the log layer and below.

Default:

'BoundaryLayer'

Additional Constructors

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:

methods (bool)

Return type:

None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:
Return type:

None