[FXC-2064] Add point motion info to probe output docstrings (#1694)

Co-authored-by: Jim Bungener <[email protected]>

Author: piotrkluba

flow360/component/simulation/outputs/outputs.py

@@ -926,17 +926,19 @@ def check_has_output_groups(cls, value):
 
 class ProbeOutput(_OutputBase):
     """
-    :class:`ProbeOutput` class for setting output data probed at monitor points.
+    :class:`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 :class:`ProbeOutput` on multiple specific monitor points and monitor points along the line.
 
     - :code:`Point_1` and :code:`Point_2` are two specific points we want to monitor in this probe output group.
-    - :code:`Line_1` is from (1,0,0) * fl.u,m to (1.5,0,0) * fl.u,m and has 6 monitor points.
-    - :code:`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.
+    - :code:`Line_1` is from (1,0,0) * fl.u.m to (1.5,0,0) * fl.u.m and has 6 monitor points.
+    - :code:`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",
@@ -991,6 +993,9 @@ class SurfaceProbeOutput(_OutputBase):
     :class:`SurfaceProbeOutput` class for setting surface output data probed at monitor points.
     The specified monitor point will be projected to the :py:attr:`~SurfaceProbeOutput.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
     -------
@@ -1091,6 +1096,8 @@ def ensure_surface_existence(cls, value, param_info: ParamsValidationInfo):
 class TimeAverageProbeOutput(ProbeOutput):
     """
     :class:`TimeAverageProbeOutput` class for time average probe monitor output settings.
+    Regardless of the motion of the mesh, the points retain their positions in the
+    global reference frame during the simulation.
 
     Example
     -------
@@ -1121,9 +1128,9 @@ class TimeAverageProbeOutput(ProbeOutput):
       The results are output every 10 physical step starting from the :math:`14^{th}` physical step
       (14, 24, 34 etc.).
 
-      - :code:`Line_1` is from (1,0,0) * fl.u,m to (1.5,0,0) * fl.u,m and has 6 monitor points.
-      - :code:`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.
+      - :code:`Line_1` is from (1,0,0) * fl.u.m to (1.5,0,0) * fl.u.m and has 6 monitor points.
+      - :code:`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",
@@ -1178,6 +1185,9 @@ class TimeAverageSurfaceProbeOutput(SurfaceProbeOutput):
     :class:`TimeAverageSurfaceProbeOutput` class for time average surface probe monitor output settings.
     The specified monitor point will be projected to the :py:attr:`~TimeAverageSurfaceProbeOutput.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
     -------
@@ -1209,9 +1219,9 @@ class TimeAverageSurfaceProbeOutput(SurfaceProbeOutput):
       The results are output every 10 physical step starting from the :math:`14^{th}` physical step
       (14, 24, 34 etc.).
 
-      - :code:`Line_1` is from (1,0,0) * fl.u,m to (1.5,0,0) * fl.u,m and has 6 monitor points.
-      - :code:`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.
+      - :code:`Line_1` is from (1,0,0) * fl.u.m to (1.5,0,0) * fl.u.m and has 6 monitor points.
+      - :code:`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.
 
       >>> TimeAverageSurfaceProbeOutput(
       ...     name="time_average_surface_probe_group_points",