Add description to explain the use of tolerance window size in stopping criterion check

angranl-flex · angranl-flex · commit 1c5d40e2b4ab · 2025-11-18T20:10:10.000Z
diff --git a/flow360/component/simulation/run_control/stopping_criterion.py b/flow360/component/simulation/run_control/stopping_criterion.py
@@ -76,8 +76,8 @@ class StoppingCriterion(Flow360BaseModel):
     )
     tolerance_window_size: Optional[int] = pd.Field(
         None,
-        description="The number of data points from the monitor_output to be used "
-        "to check whether the deviation of the monitored field is below tolerance or not. "
+        description="The number of data points from the monitor_output to be used to check whether "
+        "the :math:`|max-min|/2` of the monitored field within this window is below tolerance or not. "
         "If not set, the criterion will directly compare the latest value with tolerance.",
         ge=2,
     )

Original file line number	Diff line number	Diff line change
`@@ -76,8 +76,8 @@ class StoppingCriterion(Flow360BaseModel):`
`76`	`76`	`)`
`77`	`77`	`tolerance_window_size: Optional[int] = pd.Field(`
`78`	`78`	`None,`
`79`		`- description="The number of data points from the monitor_output to be used "`
`80`		`- "to check whether the deviation of the monitored field is below tolerance or not. "`
	`79`	`+ description="The number of data points from the monitor_output to be used to check whether "`
	`80`	+ "the :math:`\|max-min\|/2` of the monitored field within this window is below tolerance or not. "
`81`	`81`	`"If not set, the criterion will directly compare the latest value with tolerance.",`
`82`	`82`	`ge=2,`
`83`	`83`	`)`