ForceOutput

ForceOutput#

class ForceOutput[source]#

Bases: _OutputBase

ForceOutput class for setting total force output of specific surfaces.

Example

Define ForceOutput to output total CL and CD on multiple wing surfaces and a BET disk.

>>> wall = fl.Wall(name = 'wing', surfaces=[volume_mesh['1'], volume_mesh["wing2"]])
>>> bet_disk = fl.BETDisk(...)
>>> fl.ForceOutput(
...     name="force_output",
...     models=[wall, bet_disk],
...     output_fields=["CL", "CD"]
... )

Attributes

output_fields: UniqueItemList[Literal]#

List of force coefficients. Including CL, CD, CFx, CFy, CFz, CMx, CMy, CMz. For surface forces, their SkinFriction/Pressure is also supported, such as CLSkinFriction and CLPressure.

name: str#

Name of the force output.

Default:

'Force output'

models: list[Union[Annotated[flow360_schema.models.simulation.models.surface_models.Wall | flow360_schema.models.simulation.models.volume_models.BETDisk | flow360_schema.models.simulation.models.volume_models.ActuatorDisk | flow360_schema.models.simulation.models.volume_models.PorousMedium, FieldInfo(annotation=NoneType, required=True, discriminator='type')], str]]#

List of surface/volume models (or model ids) whose force contribution will be calculated.

moving_statistic: MovingStatistic, optional#

When specified, report moving statistics of the fields instead.

Default:

None

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