From 991d75f905257ee1ce66a13585d528d6786beb75 Mon Sep 17 00:00:00 2001 From: tradke Date: Tue, 24 Apr 2001 17:41:31 +0000 Subject: This commit was generated by cvs2svn to compensate for changes in r2, which included commits to RCS files with non-trunk default branches. git-svn-id: http://svn.cactuscode.org/arrangements/CactusUtils/NaNChecker/trunk@3 ff385933-4943-42dc-877b-ffc776028de6 --- README | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..2c9882a --- /dev/null +++ b/README @@ -0,0 +1,30 @@ +Cactus Code Thorn NaNChecker +Authors : Thomas Radke (tradke@aei.mpg.de) +CVS info : $Header$ +-------------------------------------------------------------------------- + +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 the NaN occurred, + + * 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 and immediately terminate Cactus by a call to CCTK_Abort() -- cgit v1.2.3