flow360.TimeAverageProbeOutput

class TimeAverageProbeOutput

Bases: ProbeOutput

TimeAverageProbeOutput class for time average probe monitor output settings.

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

---

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

Name of the TimeAverageProbeOutput.

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

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

Physical time step to start calculating averaging

output_type: Literal['TimeAverageProbeOutput'] = 'TimeAverageProbeOutput'

entities: EntityList[Point, PointArray] [Required] (alias 'probe_points')

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

output_fields: UniqueItemList[CommonFieldNames | str] [Required]

List of output fields. Including universal output variables and UserDefinedField.