flow360.SurfaceIntegralOutput

class SurfaceIntegralOutput

Bases: Flow360BaseModel

SurfaceIntegralOutput class for surface integral output settings.

Note

SurfaceIntegralOutput can only be used with UserDefinedField. See User Defined Postprocessing Tutorial for more details about how to set up UserDefinedField.

Example

Define SurfaceIntegralOutput of PressureForce as set up in this User Defined Postprocessing Tutorial Case.

>>> fl.SurfaceIntegralOutput(
...     name="surface_integral",
...     output_fields=["PressureForce"],
...     entities=[volume_mesh["wing1"], volume_mesh["wing2"]],
... )

---

name: str [Required]

Name of integral.

entities: EntityList[Surface, GhostSurface, GhostCircularPlane, GhostSphere] [Required] (alias 'surfaces')

List of boundaries where the surface integral will be calculated.

output_fields: UniqueItemList[str] [Required]

List of output variables, only the UserDefinedField is allowed.

output_type: Literal['SurfaceIntegralOutput'] = 'SurfaceIntegralOutput'