TimeAverageProbeOutput

TimeAverageProbeOutput#

class TimeAverageProbeOutput[source]#

Bases: ProbeOutput

TimeAverageProbeOutput class for time average probe monitor output settings. Regardless of the motion of the mesh, the points retain their positions in the global reference frame during the simulation.

Example

  • Calculate the average value on multiple monitor points 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.TimeAverageProbeOutput(
...     name="time_average_probe_group_points",
...     entities=[
...         fl.Point(
...             name="Point_1",
...             location=(0.0, 1.5, 0.0) * fl.u.m,
...         ),
...         fl.Point(
...             name="Point_2",
...             location=(0.0, -1.5, 0.0) * fl.u.m,
...         ),
...     ],
...     output_fields=["primitiveVars", "Mach"],
...     start_step=4,
...     frequency=10,
...     frequency_offset=14,
... )

  • Calculate the average value on multiple monitor points 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.).

    • Line_1 is from (1,0,0) * fl.u.m to (1.5,0,0) * fl.u.m and has 6 monitor points.

    • Line_2 is from (-1,0,0) * fl.u.m to (-1.5,0,0) * fl.u.m and has 3 monitor points, namely, (-1,0,0) * fl.u.m, (-1.25,0,0) * fl.u.m and (-1.5,0,0) * fl.u.m.

    >>> fl.TimeAverageProbeOutput(
...     name="time_average_probe_group_points",
...     entities=[
...         fl.PointArray(
...             name="Line_1",
...             start=(1.0, 0.0, 0.0) * fl.u.m,
...             end=(1.5, 0.0, 0.0) * fl.u.m,
...             number_of_points=6,
...         ),
...         fl.PointArray(
...             name="Line_2",
...             start=(-1.0, 0.0, 0.0) * fl.u.m,
...             end=(-1.5, 0.0, 0.0) * fl.u.m,
...             number_of_points=3,
...         ),
...     ],
...     output_fields=["primitiveVars", "Mach"],
...     start_step=4,
...     frequency=10,
...     frequency_offset=14,
... )

Attributes

output_fields: UniqueItemList[Union]#

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

name: str, optional#

Name of the TimeAverageProbeOutput.

Default:

'Time average probe output'

entities: EntityList[Point, PointArray]#

List of monitored Point/PointArray entities belonging to this monitor group. PointArray is used to define monitored points along a line.

moving_statistic: MovingStatistic, optional#

When specified, report moving statistics of the fields instead.

Default:

None

output_at_final_pseudo_step_only: bool#

When True, the result is only written at the final pseudo step of each physical step (or once at the end for steady simulations), suppressing intermediate pseudo-step writes.

Default:

False

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

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)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:

methods (bool)

Return type:

None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:
Return type:

None