flow360.SurfaceIntegralOutput

class SurfaceIntegralOutput

Bases: _OutputBase

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.

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

---

name: Annotated[str, AfterValidator(func=_validate_filename_string)] = 'Surface integral output'

Name of integral. Must be a valid Linux filename (no slashes or null bytes).

Constraints:

• func = <function _validate_filename_string at 0x7d1145700e50>

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

List of boundaries where the surface integral will be calculated.

output_fields: UniqueItemList[Union] [Required]

List of output variables, only the UserDefinedField is allowed.

moving_statistic: MovingStatistic | None = None

When specified, report moving statistics of the fields instead.

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