Moved NanChecker documentation from README into doc/documentation.tex

so that it appears in the ThornGuide.
Also added description of NaNChecker API.


git-svn-id: http://svn.cactuscode.org/arrangements/CactusUtils/NaNChecker/trunk@17 ff385933-4943-42dc-877b-ffc776028de6

1 files changed, 1 insertions, 25 deletions

diff --git a/README b/README
index e6d75c2..b452302 100644
--- a/README
+++ b/README
@@ -7,29 +7,5 @@ Purpose of the thorn:
 
 This thorn can be used to analyze CCTK variables of real or complex data type
 for NaN (Not-a-Number) and (on availability of finite(3)) infinite values.
-It does this by registering a routine at CCTK_POSTSTEP which checks at every
 
-  NanChecker::check_every
-
-iteration all the variables listed in
-
-  NaNChecker::check_vars
-
-and - in case a NaN was found - performs an action as specified in
-
-  NaNChecker::action_if_found
-
-Currently these actions can be to
-
- * just print a level 1 warning message telling you where NaNs were found
-   and how many (for grid array variables).
-   For grid arrays it will also print level 2 warnings with the array index
-   (in fortran order) for all NaN elements. You can limit the number of
-   such warnings by setting the 'NanChecker::report_max' parameter.
-
- * also set the CCTK termination flag so that Cactus will stop the evolution
-   loop and gracefully terminate at the next time possible (giving you the
-   choice of outputting the data from the last evolution timestep),
-
- * print the warning message(s) and immediately terminate Cactus
-   by a call to CCTK_Abort()
+For details see the NaNChecker section in the Cactus ThornGuide.