ForcePerArea

class ForcePerArea

Bases: Flow360BaseModel

ForcePerArea class for setting up force per area for Actuator Disk.

Example

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

radius: LengthType.NonNegativeArray

Radius of the sampled locations in grid unit.

thrust: PressureType.Array

Dimensional force per area in the axial direction, positive means the axial force follows the same direction as the thrust axis.

circumferential: PressureType.Array

Dimensional force per area in the circumferential direction, positive means the circumferential force follows the same direction as the thrust axis with the right hand rule.

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