Provide an aliased function IO_TruncateOutputFiles() for other I/O thorns

to check whether or not to truncate existing output files.
The default is to not truncate after recovering. This can be overwritten by
the new boolean parameter IO::truncate_files_after_recovering.


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

1 files changed, 11 insertions, 0 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 3ce359f..bbf1dad 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -423,6 +423,8 @@ parameters. The most important ones are:
     method used to recover from the recovery file.
   \item {\tt IO::recover\_dir}\\
     directory where the recovery file is located
+  \item {\tt IO::truncate\_files\_after\_recovering}\\
+    whether or not to truncate already existing output files after recovering
 \end{itemize}
 
 To checkpoint your simulation, you need to enable checkpointing by setting
@@ -463,6 +465,15 @@ file(s) to create a single file with unchunked data.
 Note that Cactus checkpoint files are platform independent so you can restart
 from your checkpoint file on a different machine/architecture.
 
+By default, existing output files will be appended to rather than truncated after
+successful recovery. If you don't want this, you can force I/O methods to
+always truncate existing output files. Thorn {\bf IOUtil} provides an aliased
+function for other I/O thorns to call:
+\begin{verbatim}
+  CCTK_INT FUNCTION IO_TruncateOutputFiles (CCTK_POINTER_TO_CONST IN cctkGH)
+\end{verbatim}
+This function simply returns 1 or 0 if output files should or should not be truncated.
+
 \vskip .5cm
 \noindent{\bf WARNING:}