Add more detail to how parameter recovery works, explaining the

meaning of the return value.


git-svn-id: http://svn.cactuscode.org/flesh/trunk@4227 17b73243-c579-4c4c-a9d2-2d5706c11dac

1 files changed, 11 insertions, 8 deletions

diff --git a/doc/UsersGuide/Infrastructure.tex b/doc/UsersGuide/Infrastructure.tex
index 3843a497..362b8480 100644
--- a/doc/UsersGuide/Infrastructure.tex
+++ b/doc/UsersGuide/Infrastructure.tex
@@ -552,21 +552,24 @@ Recovering from a checkpoint is a two-phase operation for which the Flesh
 provides distinct timebins for recovery routines to be scheduled at:
 %
 \begin{Lentry}
-  \item[{\t CCTK\_RECOVER\_PARAMETERS}] This time bin is scheduled right after
-    {\t CCTK\_STARTUP} when the parameter file was parsed. From these parameter
-    settings, the recovery routines should decided whether recovery was
+  \item[{\t CCTK\_RECOVER\_PARAMETERS}] This time bin is executed before
+    {\t CCTK\_STARTUP}, when the parameter file was parsed. From these parameter
+    settings, the recovery routines should decide whether recovery was
     requested, and if so, restore all parameters the checkpoint file and
     overwrite those which aren't steerable.\\
-    The Flesh scheduler loops over all registered recovery routines to find out
+    The Flesh loops over all registered recovery routines to find out
     whether recovery was requested. Each recovery routine should therefore
     return a positive integer value for successful parameter recovery (causing
-    the scheduler to shortcut its loop over all registered recovery routines),
+    a shortcut of the loop over all registered recovery routines),
     zero for no recovery, or a negative value to flag an error.\\
     If recovery was requested but no routine could successfully recover
-    parameters, the Flesh will abort the run with an error message.\\
+    parameters, the Flesh will abort the run with an error message.
+    If no routine recovered any parameters, i.e., if all parameter
+    recovery routines returned zero, then this indicates that this run
+    is not a recovery run.\\
     If parameter recovery was performed successfully, the scheduler will set the
-    {\tt recovered} flag which -- in combination with the setting of the {\tt
-    Cactus::recovery\_mode} parameter -- decides whether any thorn routine
+    {\tt recovered} flag which --- in combination with the setting of the {\tt
+    Cactus::recovery\_mode} parameter --- decides whether any thorn routine
     scheduled for {\t CCTK\_INITIAL} and {\t CCTK\_POSTINITIAL} will be called.
     The default is not to execute these initial time bins during recovery
     because the initial data will be set up from the checkpoint file during the