flow360.SurfaceProbeOutput

class SurfaceProbeOutput

Bases: Flow360BaseModel

SurfaceProbeOutput class for setting surface output data probed at monitor points. The specified monitor point will be projected to the target_surfaces closest to the point. The probed results on the projected point will be dumped.

Example

Define SurfaceProbeOutput on the geometry["wall"] surface with 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_surface is from (1,0,0) * fl.u.m to (1,0,-10) * fl.u.m and has 11 monitor points, including both starting and end points.

>>> fl.SurfaceProbeOutput(
...     name="surface_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,
...         ),
...         fl.PointArray(
...             name="Line_surface",
...             start=(1.0, 0.0, 0.0) * fl.u.m,
...             end=(1.0, 0.0, -10.0) * fl.u.m,
...             number_of_points=11,
...         ),
...     ],
...     target_surfaces=[
...         geometry["wall"],
...     ],
...     output_fields=["heatFlux", "T"],
... )

---

name: str [Required]

Name of the surface monitor group.

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

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

target_surfaces: EntityList[Surface] [Required]

List of Surface entities belonging to this monitor group.

output_fields: UniqueItemList[Union] [Required]

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

output_type: Literal['SurfaceProbeOutput'] = 'SurfaceProbeOutput'