ActuatorDisk

ActuatorDisk#

class ActuatorDisk[source]#

Bases: Flow360BaseModel

ActuatorDisk class for setting up the inputs for an Actuator Disk. Please refer to the actuator disk knowledge base for further information.

Note

Cylinder.center, Cylinder.axis and Cylinder.height are taken as the center, thrust axis, and thickness of the Actuator Disk, respectively.

Example

>>> fl.ActuatorDisk(
...     entities = fl.Cylinder(
...         name="actuator_disk",
...         center=(0,0,0)*fl.u.mm,
...         axis=(-1,0,0),
...         height = 30 * fl.u.mm,
...         outer_radius=5.0 * fl.u.mm,
...     ),
...     force_per_area = fl.ForcePerArea(
...          radius=[0, 1] * fl.u.mm,
...          thrust=[4.1, 5.5] * fl.u.Pa,
...          circumferential=[4.1, 5.5] * fl.u.Pa,
...     )
... )

Attributes

entities: EntityList[Cylinder]#

The list of Cylinder entities for the ActuatorDisk model

force_per_area: ForcePerArea#

The force per area input for the ActuatorDisk model. See ForcePerArea documentation.

reference_velocity: Any, optional#

Reference velocity [Vx, Vy, Vz] for power calculation. When provided, uses this velocity instead of local flow velocity for the actuator disk power output.

Default:

None

name: str, optional#

Name of the ActuatorDisk model.

Default:

'Actuator disk'

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