diff options
| author | tradke <tradke@ff385933-4943-42dc-877b-ffc776028de6> | 2003-06-17 10:47:23 +0000 |
|---|---|---|
| committer | tradke <tradke@ff385933-4943-42dc-877b-ffc776028de6> | 2003-06-17 10:47:23 +0000 |
| commit | a1b2cf0343152ad1240d27ff9265f78b8c323852 (patch) | |
| tree | 4cc00e65df3166db439689b9365f2ac877a76754 /doc | |
| parent | c78af4d3724f4ee7fe7a8442e8aae8095e83da96 (diff) | |
Added steerable INTEGER parameter NaNChecker::check_after to specify an
iteration number when to start checking for NaNs.
git-svn-id: http://svn.cactuscode.org/arrangements/CactusUtils/NaNChecker/trunk@41 ff385933-4943-42dc-877b-ffc776028de6
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/documentation.tex | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index 4dd7a8e..c2383d0 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -51,15 +51,16 @@ Periodic testing of variables can easily be achieved by adding NaNChecker to the {\tt ActiveThorns} parameter, and setting the parameters \noindent -{\tt NaNChecker::check\_every} and {\tt NaNChecker::check\_vars} +{\tt NaNChecker::check\_every, NaNChecker::check\_after,} and {\tt NaNChecker::check\_vars} \noindent to the required -values. (For most testing purposes these can be set to {\tt 1} and {"all"} +values. (For most testing purposes these can be set to {\tt 1, 0,} and {"all"} respectively). The NaNChecker then registers a routine at {\bf CCTK\_POSTSTEP} which checks -at every {\tt NanChecker::check\_every} iteration all the variables listed in +at every {\tt NanChecker::check\_every} iteration -- starting at iteration +number {\tt NaNChecker::check\_after} -- all the variables listed in {\tt NaNChecker::check\_vars} for NaN or infinite values (depending on {\tt NaNChecker::check\_for}) and --- if such a value is found --- performs an action as specified in {\tt NaNChecker::action\_if\_found}.\\ |