TimeAverageSurfaceOutput

TimeAverageSurfaceOutput#

class TimeAverageSurfaceOutput[source]#

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

name: str, optional#

Name of the TimeAverageSurfaceOutput.

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

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

Additional Constructors

classmethod from_file(filename)#

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:: filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.
Returns:: An instance of the component class calling load.
Return type:: Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)#

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:: methods (bool = False) – Whether to also print out information about object’s methods.
Return type:: None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)#

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:: filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.
Return type:: None

Example

>>> params.to_file(filename='folder/flow360.json') 

TimeAverageSurfaceOutput

Contents

TimeAverageSurfaceOutput#