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. Important for child cases - this parameter refers to the global time step, which gets transferred from the parent case (see frequency parameter for an example).

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

entities: EntityList[Surface, MirroredSurface, GhostSurface, WindTunnelGhostSurface, GhostCircularPlane, GhostSphere, ImportedSurface] [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 | UserVariable] [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: pd.PositiveInt | Literal[-1] = -1

Frequency (in number of physical time steps) at which output is saved. -1 is at end of simulation. Important for child cases - this parameter refers to the global time step, which gets transferred from the parent case. Example: if the parent case finished at time_step=174, the child case will start from time_step=175. If frequency=100 (child case), the output will be saved at time steps 200 (25 time steps of the child simulation), 300 (125 time steps of the child simulation), etc. This setting is NOT applicable for steady cases.

frequency_offset: int = 0

Offset (in number of physical time steps) at which output is started to be saved. 0 is at beginning of simulation. Important for child cases - this parameter refers to the global time step, which gets transferred from the parent case (see frequency parameter for an example). Example: if an output has a frequency of 100 and a frequency_offset of 10, the output will be saved at global time step 10, 110, 210, etc. This setting is NOT applicable for steady cases.

Constraints:

• ge = 0