SlipWall#

class SlipWall[source]#

Bases: BoundaryBase

SlipWall class defines the SlipWall boundary condition.

Example

Define SlipWall boundary condition for entities with the naming pattern:

"*/slipWall" in the volume mesh.

>>> fl.SlipWall(entities=volume_mesh["*/slipWall"]
  • Define SlipWall boundary condition with automated farfield symmetry plane boundaries:

    >>> auto_farfield = fl.AutomatedFarfield()
    >>> fl.SlipWall(
    ...     entities=[auto_farfield.symmetry_planes],
    ...     turbulence_quantities= fl.TurbulenceQuantities(
    ...         modified_viscosity_ratio=10,
    ...     )
    ... )
    

Attributes

entities: EntityList[Surface, MirroredSurface, GhostSurface, WindTunnelGhostSurface, GhostCircularPlane]#

List of boundaries with the SlipWall boundary condition imposed.

name: str, optional#

Name of the SlipWall boundary condition.

Default:

'Slip wall'

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')