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

Attributes

output_fields: UniqueItemList[str | flow360_schema.framework.expression.variable.UserVariable]

List of output variables, only the UserDefinedField is allowed.

name: str

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

Default:

'Surface integral output'

entities: EntityList[Surface, MirroredSurface, GhostSurface, WindTunnelGhostSurface, GhostCircularPlane, GhostSphere, ImportedSurface]

List of boundaries where the surface integral will be calculated.

moving_statistic: MovingStatistic, optional

When specified, report moving statistics of the fields instead.

Default:

None

Methods

classmethod ensure_surface_existence(value)

Ensure all boundaries will be present after mesher

classmethod allow_only_simulation_surfaces_or_imported_surfaces(value)

Support only simulation surfaces or imported surfaces in each SurfaceIntegralOutput

validate_imported_surface_output_fields()

Validate output fields when using imported surfaces