flow360.TimeAverageSurfaceOutput

class TimeAverageSurfaceOutput

Bases: SurfaceOutput

TimeAverageSurfaceOutput class for time average surface output settings.

Example

Calculate the average value starting from the \(4^{th}\) physical step. The results are output every 10 physical step starting from the \(14^{th}\) physical step (14, 24, 34 etc.).

>>> fl.TimeAverageSurfaceOutput(
...     output_format="paraview",
...     output_fields=["primitiveVars"],
...     entities=[
...         volume_mesh["VOLUME/LEFT"],
...         volume_mesh["VOLUME/RIGHT"],
...     ],
...     start_step=4,
...     frequency=10,
...     frequency_offset=14,
... )

---

name: str | None = 'Time average surface output'

Name of the TimeAverageSurfaceOutput.

start_step: Annotated[int, Ge(ge=0)] | Literal[-1] = -1

Physical time step to start calculating averaging.

output_type: Literal['TimeAverageSurfaceOutput'] = 'TimeAverageSurfaceOutput'

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

List of boundaries where output is generated.

write_single_file: bool = False

Enable writing all surface outputs into a single file instead of one file per surface.This option currently only supports Tecplot output format.Will choose the value of the last instance of this option of the same output type (SurfaceOutput or TimeAverageSurfaceOutput) in the output list.

output_fields: UniqueItemList[SurfaceFieldNames | str] [Required]

List of output variables. Including universal output variables, variables specific to SurfaceOutput and UserDefinedField.

output_format: Literal['paraview', 'tecplot', 'both'] = 'paraview'

paraview, tecplot or both.

frequency: int = -1

Frequency (in number of physical time steps) at which output is saved. -1 is at end of simulation.

Constraints:

• ge = -1

frequency_offset: int = 0

Offset (in number of physical time steps) at which output animation is started. 0 is at beginning of simulation.

Constraints:

• ge = 0