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

Attributes

output_fields: UniqueItemList[Union]

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

frequency: int | Literal[-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.

Default:

-1

frequency_offset: int

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.

Default:

0

output_format: Union[list[Literal['paraview', 'tecplot', 'vtkhdf', 'ensight']], Literal['paraview', 'tecplot', 'both']]

List of output formats, Supported formats: paraview, tecplot, vtkhdf, ensight. A single string is accepted for backward compatibility but deprecated.

Default:

['paraview']

name: str

Name of the TimeAverageSurfaceOutput. Used as a suffix in output filenames to disambiguate when multiple TimeAverageSurfaceOutput`s share the same surface entity. Must be unique across all `TimeAverageSurfaceOutput instances that share the same surface (uniqueness is not required against SurfaceOutput instances, which write to separate files).

Default:

'Time average surface output'

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

List of boundaries where output is generated.

write_single_file: bool

Enable writing all surface outputs into a single file instead of one file per surface. Supported by Tecplot, Paraview, and VTK-HDF output formats.

Default:

False

start_step: int | Literal[-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).

Default:

-1

Methods

classmethod ensure_surface_existence(value)

Ensure all boundaries will be present after mesher

validate_imported_surface_output_fields()

Validate output fields when using imported surfaces

classmethod disable_frequency_settings_in_steady_simulation(value, info)

Disable frequency settings in a steady simulation

Parameters:

info (ValidationInfo)