flow360.ProbeOutput

class ProbeOutput

Bases: Flow360BaseModel

ProbeOutput class for setting output data probed at monitor points.

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

---

name: str [Required]

Name of the monitor group.

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[Union] [Required]

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

output_type: Literal['ProbeOutput'] = 'ProbeOutput'

classmethod load_point_location_from_file(file_path)

Load probe point locations from a file. (Not implemented yet)

Parameters:

file_path (str)