flow360.TimeAverageVolumeOutput

class TimeAverageVolumeOutput

Bases: VolumeOutput

TimeAverageVolumeOutput class for time average volume 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.TimeAverageVolumeOutput(
...     output_format="paraview",
...     output_fields=["primitiveVars"],
...     start_step=4,
...     frequency=10,
...     frequency_offset=14,
... )

---

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

Name of the TimeAverageVolumeOutput.

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

Physical time step to start calculating averaging.

output_type: Literal['TimeAverageVolumeOutput'] = 'TimeAverageVolumeOutput'

output_fields: UniqueItemList[VolumeFieldNames | str] [Required]

List of output variables. Including universal output variables, variables specific to VolumeOutput 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