ProbeOutput

ProbeOutput#

class ProbeOutput[source]#

Bases: _OutputBase

ProbeOutput class for setting output data probed at monitor points in the voulume of the domain. Regardless of the motion of the mesh, the points retain their positions in the global reference frame during the simulation.

Example

Define ProbeOutput on multiple specific monitor points and monitor points along the line.

  • Point_1 and Point_2 are two specific points we want to monitor in this probe output group.

  • 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.ProbeOutput(
...     name="probe_group_points_and_lines",
...     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,
...         ),
...         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"],
... )

Attributes

output_fields: UniqueItemList[Union]#

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

name: str#

Name of the monitor group.

Default:

'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

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