flow360.ForceOutput

class ForceOutput

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"]
... )

---

name: str = 'Force output'

Name of the force output.

output_fields: UniqueItemList[Literal] [Required]

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.

models: List[Annotated[Wall | BETDisk | ActuatorDisk | PorousMedium, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | str] [Required]

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

moving_statistic: MovingStatistic | None = None

When specified, report moving statistics of the fields instead.

output_type: Literal['ForceOutput'] = 'ForceOutput'