flow360.TimeAverageSliceOutput

class TimeAverageSliceOutput

Bases: SliceOutput

TimeAverageSliceOutput class for time average slice 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.TimeAverageSliceOutput(
...     entities=[
...         fl.Slice(name="Slice_1",
...             origin=(0, 0, 0) * fl.u.m,
...             normal=(0, 0, 1),
...         )
...     ],
...     output_fields=["s", "T"],
...     start_step=4,
...     frequency=10,
...     frequency_offset=14,
... )

---

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

Name of the TimeAverageSliceOutput.

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

Physical time step to start calculating averaging.

output_type: Literal['TimeAverageSliceOutput'] = 'TimeAverageSliceOutput'

entities: EntityList[Slice] [Required] (alias 'slices')

List of output Slice entities.

output_fields: UniqueItemList[SliceFieldNames | str] [Required]

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