ActuatorDisk

class ActuatorDisk

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: VelocityType.Vector, 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)

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