WallRotation

class WallRotation

Bases: Flow360BaseModel

WallRotation class to specify the rotational velocity model for the Wall boundary condition.

The wall rotation model prescribes a rotational motion at the wall by defining a center of rotation, an axis about which the wall rotates, and an angular velocity. This model can be used to simulate rotating components or surfaces in a flow simulation.

Example

>>> fl.Wall(
...     entities=volume_mesh["fluid/wall"],
...     velocity=fl.WallRotation(
...         axis=(0, 0, 1),
...         center=(1, 2, 3) * u.m,
...         angular_velocity=100 * u.rpm
...     ),
...     use_wall_function=True,
... )

---

Attributes

center: LengthType.Vector

The center of rotation

axis: Axis

The axis of rotation.

angular_velocity: AngularVelocityType

Default:

'The value of the angular velocity.'

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