doc:user:integration:general:stopcriterion
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
doc:user:integration:general:stopcriterion [2019/06/13 18:58] – [Introduction] boemer | doc:user:integration:general:stopcriterion [2019/06/17 14:13] (current) – papeleux | ||
---|---|---|---|
Line 5: | Line 5: | ||
The stop criterion allows to stop a computation when a given criterion becomes greater than a given value. | The stop criterion allows to stop a computation when a given criterion becomes greater than a given value. | ||
- | It is useful 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, | While stopping cleanly the computation, | ||
===== General Commands ===== | ===== General Commands ===== | ||
+ | |||
For a given criterion ('' | For a given criterion ('' | ||
- | * setStopValue(double) | + | * '' |
- | * setWriteTSC(bool) | + | * '' |
- | * setRunObjFuncSet(bool) : force (remove) the computation/ | + | * '' |
- | * setStopAtNextFac(bool) : compute the criterion at each timeStep, but stop the computation only after the next fac write (default : False) | + | * '' |
- | * checkAtFac(bool) | + | * '' |
- | The criterion is finaly | + | The criterion is finally |
< | < | ||
Line 24: | Line 25: | ||
crit.setRunObjFuncSet(True) # (default : True) | crit.setRunObjFuncSet(True) # (default : True) | ||
crit.setStopAtNextFac(True) # (default : False) | crit.setStopAtNextFac(True) # (default : False) | ||
- | crit.checkAtFac(True) | + | crit.setCheckAtFac(True) |
metafor.setStopCriterion(crit) | metafor.setStopCriterion(crit) | ||
</ | </ | ||
Line 35: | Line 36: | ||
===== ValueExtractorStopCriterion ===== | ===== ValueExtractorStopCriterion ===== | ||
- | If you want do define a given ValueExtractor (eventually | + | If you want do define a given ValueExtractor (possibly |
* ValueExtractorStopCriterion(ValueExtractor & | * ValueExtractorStopCriterion(ValueExtractor & | ||
===== ValueManagerStopCriterion ===== | ===== ValueManagerStopCriterion ===== | ||
- | If you want to use a value allready | + | If you want to use a value, which is already |
* ValueManagerStopCriterion(ValuesStruct *_valueStruct, | * ValueManagerStopCriterion(ValuesStruct *_valueStruct, | ||
doc/user/integration/general/stopcriterion.1560445108.txt.gz · Last modified: 2019/06/13 18:58 by boemer