Make IO::checkpoint_keep steerable all the time.

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

2 files changed, 28 insertions, 10 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index bbf1dad..090142a 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -311,6 +311,14 @@ coordinate system's origin or the closest grid point to this (see figure
 \label{default_1D_output}
 \end{figure}
 
+If the coordinate values specified in {\tt IO::out\_[xyz]line\_[xyz]}
+or {\tt IO::out\_[\{xy\}\{xz\}\{yz\}]plane\_[xyz]} lie outside the physical
+grid, the slice center simply reverts to the center of the box in that
+direction. This fallback method method can be changed to using 0-slices instead
+by setting the corresponding {\tt IO::out\_[xyz]line\_[xyz]i}
+and {\tt IO::out\_[\{xy\}\{xz\}\{yz\}]plane\_[xyz]i} parameter(s) to the value
+{\tt -2}.
+
 Although they are not hyperslabs by the above definition, output of 1D diagonals
 for 3D grid arrays is also supported by I/O method {\tt IOASCII\_1D} but has the
 restriction that the line will always start in the bottom-left corner of the
@@ -399,21 +407,31 @@ from which each job can be started.
 Again, thorn {\bf IOUtil} provides general checkpoint \& recovery
 parameters. The most important ones are:
 \begin{itemize}
-  \item {\tt IO::checkpoint\_every}\\
-    specifies how often to write a periodic checkpoint in terms of iteration
+  \item {\tt IO::checkpoint\_every} (steerable)\\
+    specifies how often to write a evolution checkpoint in terms of iteration
     number
-  \item {\tt IO::checkpoint\_next}\\
-    triggers a checkpoint at the end of the current iteration
-  \item {\tt IO::checkpoint\_on\_terminate}\\
+  \item {\tt IO::checkpoint\_next} (steerable)\\
+    triggers a checkpoint at the end of the current iteration; This flag will be reset afterwards.
+  \item {\tt IO::checkpoint\_ID}\\
+    triggers a checkpoint of initial data
+  \item {\tt IO::checkpoint\_on\_terminate} (steerable)\\
     triggers a checkpoint at the end of the last iteration of a simulation run
-  \item {\tt IO::checkpoint\_file}\\
-    holds the basename for checkpoint file(s) to create\\
+  \item {\tt IO::checkpoint\_file} (steerable)\\
+    holds the basename for evolution checkpoint file(s) to create\\
+    Iteration number and file extension are appended by the individual I/O
+    method used to write the checkpoint.
+  \item {\tt IO::checkpoint\_ID\_file} (steerable)\\
+    holds the basename for initial data checkpoint file(s) to create\\
     Iteration number and file extension are appended by the individual I/O
     method used to write the checkpoint.
   \item {\tt IO::checkpoint\_dir}\\
     names the directory where checkpoint files are stored
-  \item {\tt IO::checkpoint\_ID}\\
-    boolean flag for checkpointing only initial data
+  \item {\tt IO::checkpoint\_keep} (steerable)\\
+    specifies how many checkpoints should be kept\\
+    The default value of $1$ means that only the latest checkpoint is kept
+    and older checkpoints are removed in order to save disk space.
+    Setting {\tt IO::checkpoint\_keep} to a positive value will keep so many
+    checkpoints around. A value of $-1$ will keep all (future) checkpoints.
   \item {\tt IO::recover}\\
     keyword parameter telling if/how to recover.\\
     Choices are {\tt "no"}, {\tt "manual"}, {\tt "auto"}, and {\tt "autoprobe"}.
diff --git a/param.ccl b/param.ccl
index da6fe30..53a4fdc 100644
--- a/param.ccl
+++ b/param.ccl
@@ -138,7 +138,7 @@ INT checkpoint_every "How often to checkpoint" STEERABLE = ALWAYS
 BOOLEAN checkpoint_on_terminate "Checkpoint after last iteration" STEERABLE = ALWAYS
 {
 } "no"
-INT checkpoint_keep "How many checkpoint files to keep" STEERABLE = RECOVER
+INT checkpoint_keep "How many checkpoint files to keep" STEERABLE = ALWAYS
 {
    1:* :: "1 overwrites the latest checkpoint file"
   -1:  :: "Keep all checkpoint files"