Added new recovery mode "autoprobe" which is like "auto" but lets the user

continue with the simulation if no checkpoint file was found.
Closes PR Cactus/300.


git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOUtil/trunk@139 b32723a9-ab3a-4a60-88e2-2e5d99d7c17a

1 files changed, 15 insertions, 3 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 9be2e93..8a7cb24 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -285,7 +285,7 @@ parameters. The most important ones are:
     boolean flag for checkpointing only initial data
   \item {\tt IO::recover}\\
     keyword parameter telling if/how to recover.\\
-    Choices are {\tt "auto"}, {\tt "manual"}, and {\tt "no"}.
+    Choices are {\tt "no"}, {\tt "manual"}, {\tt "auto"}, and {\tt "autoprobe"}.
   \item {\tt IO::recover\_file}\\
     filename of the recovery file
   \item {\tt IO::recovery\_dir}\\
@@ -300,11 +300,23 @@ Checkpoint filenames consist of a basename (as specified in
 plus the file extension indicating the file format ({\tt ".ieee"} for IEEEIO
 data from {\tt CactusPUGHIO/IOFlexIO}, or {\tt ".h5} for HDF5 data from
 {\tt CactusPUGHIO/IOHDF5}).\\
+Use the {\tt "manual"} mode to recover from a specific checkpoint file
+by adding the iteration number to the basename parameter.
+
 The {\tt "auto"} recovery mode will automatically
 recover from the latest checkpoint file found in the recovery directory.
 In this case {\tt IO::recover\_file} should contain the basename only.
-Use the {\tt "manual"} mode to recover from a specific checkpoint file
-by adding the iteration number to the basename parameter.\\
+
+The {\tt "autoprobe"} recovery mode is similar to the {\tt "auto"} mode
+except that it would not stop the code if no checkpoint file was
+found but only print a warning message and then continue with the
+simulation. This mode allows you to enable checkpointing and recovery
+in the same parameter file and use that without any changes to restart your
+simulation. On the other hand, you are responsible now for making the
+checkpoint/recovery directory/file parameters match -- a mismatch will not
+be detected by Cactus in order to terminate it. Instead the simulation would
+always start from initial data without any recovery.\\
+
 Because the same I/O methods implement both output of 3D data and
 checkpoint files, the same I/O modes are used (see Section~\ref{iomodes}). 
 Note that the recovery routines in Cactus can process both chunked and