Differences

This shows you the differences between two versions of the page.

--- doc:user:integration:general:stopcriterion [2019/06/13 12:46] – created papeleux
+++ doc:user:integration:general:stopcriterion [2019/06/17 14:13] (current) – papeleux
@@ Line 3: / Line 3: @@
 ===== Introduction =====
-The stop criterion allow to stop a computation when a given criterion is above a given value.
+The stop criterion allows to stop a computation when a given criterion becomes greater than a given value.
-It is usefull to avoid consuming CPU when a computation has no meaning anymore, or to chain operations (remeshing, chained operation based on a criterion, ...)
+It is useful to avoid consuming CPU time when a computation has no meaning anymore, or to chain operations (remeshing, chained operation based on a criterion, ...)
-While stopping cleanly the computation, a fac is written at the stop time and the valuesManager are cleanly closed and ascii export is done.
+While stopping cleanly the computation, a fac is written at the stop time, the ValuesManager is properly closed and the ascii export is done.
 ===== General Commands =====
 For a given criterion (''crit'') (see below),
-  * setStopValue(double)   : define the value to overpass  (default : 0.0)
+  * ''setStopValue(double)''   : define the value to exceed (default : 0.0)
-  * setWriteTSC(bool)      : force (remove) the write of TSC (not needed if remeshing) (default : True)
+  * ''setWriteTSC(bool)''      : force (remove) the writing of TSC (not required, if remeshing) (default : True)
-  * setRunObjFuncSet(bool) : force (remove) the computation/write of ObjectiveFunctions (not needed if remeshing) (default : True)
+  * ''setRunObjFuncSet(bool)'' : force (remove) the computation/writing of ObjectiveFunctions (not required, if remeshing) (default : True)
-  * setStopAtNextFac(bool) : compute the criterion at each timeStep, but stop the computation only after the next fac write (default : False)
+  * ''setStopAtNextFac(bool)'' : compute the criterion at each timeStep, but stop the computation only after the next fac writing (default : False)
-  * checkAtFac(bool)    : compute the criterion at fac time write (default : False)
+  * ''setCheckAtFac(bool)''    : compute the criterion at fac writing time (default : False)
-The criterion is finaly added in the Metafor Object :
+The criterion is finally added in the Metafor object :
 <code>
@@ Line 24: / Line 25: @@
         crit.setRunObjFuncSet(True) # (default : True)
         crit.setStopAtNextFac(True) # (default : False)
-        crit.checkAtFac(True)       # (default : False)
+        crit.setCheckAtFac(True)       # (default : False)
         metafor.setStopCriterion(crit)
 </code>
@@ Line 35: / Line 36: @@
 ===== ValueExtractorStopCriterion =====
-If you want do define a given ValueExtractor (eventually with a Vector2ScalarOperator) to stop the computation
+If you want do define a given ValueExtractor (possibly with a Vector2ScalarOperator) to stop the computation
   * ValueExtractorStopCriterion(ValueExtractor &_valueExt, VectorToScalarOperator *_v2sOp=NULL)
 ===== ValueManagerStopCriterion =====
-If you want to use a value allready extracted in the ValuesManager :
+If you want to use a value, which is already extracted in the ValuesManager :
   * ValueManagerStopCriterion(ValuesStruct *_valueStruct, int _comp=0)