SurfaceProbeOutput

SurfaceProbeOutput#

class SurfaceProbeOutput[source]#

Bases: _OutputBase

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. The projection is executed at the start of the simulation. If the surface that the point was projected to is moving (mesh motion), the point moves with it (it remains stationary in the reference frame of the target surface).

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

Attributes

output_fields: UniqueItemList[Union]#

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

name: str#

Name of the surface monitor group.

Default:

'Surface probe output'

entities: EntityList[Point, PointArray]#

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, MirroredSurface, WindTunnelGhostSurface]#

List of Surface entities belonging to this monitor group.

moving_statistic: MovingStatistic, optional#

When specified, report moving statistics of the fields instead.

Default:

None

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