Add a new appendix for full list and description of Cactus schedule bins.

The rest of the documentation now lists only a sample in each place and
refers to here for the complete list.

Fixes Cactus/1006


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

1 files changed, 3 insertions, 26 deletions

diff --git a/doc/UsersGuide/ThornWriters.tex b/doc/UsersGuide/ThornWriters.tex
index ed8eec30..2bf2b3e1 100644
--- a/doc/UsersGuide/ThornWriters.tex
+++ b/doc/UsersGuide/ThornWriters.tex
@@ -423,8 +423,9 @@ schedule <name> at <time bin> [other options]
   SYNC:     [group list]
 } "A description"
 \end{verbatim}
-where {\tt <name>} is the name of the routine, and {\tt <time bin>} is one of
-the following schedule bins (the {\tt CCTK\_} prefix is optional):
+where {\tt <name>} is the name of the routine, and {\tt <time bin>} is the
+name of a schedule bins (the {\tt CCTK\_} prefix is optional). A list of 
+the most useful schedule bins for application thorns is given here, a complete and more descriptive list is provided in Appendix~\ref{sec:scbi}:
 
 \begin{Lentry}
 
@@ -432,9 +433,6 @@ the following schedule bins (the {\tt CCTK\_} prefix is optional):
 For routines run before the grid hierachy is set up, for example function
 registration.
 
-\item [{\tt CCTK\_RECOVER\_PARAMETERS}]
-When restarting Cactus from a checkpoint, routines scheduled at {\tt CCTK\_RECOVER\_PARAMETERS} are called to recover the parameters from the checkpoint file.
-
 \item [{\tt CCTK\_PARAMCHECK}]
 For routines which check parameter combinations, routines registered here
 only have access to the grid size and the parameters.
@@ -448,15 +446,6 @@ For generating initial data.
 \item [{\tt CCTK\_POSTINITIAL}]
 Tasks which must be applied after initial data is created.
 
-\item [{\tt CCTK\_RECOVER\_VARIABLES}]
-For recovery of grid variables from a checkpoint.
-
-\item [{\tt CCTK\_POST\_RECOVER\_VARIABLES}]
-For functions which want to modify grid variables after recovery.
-
-\item [{\tt CCTK\_CPINITIAL}]
-For checkpointing initial data.
-
 \item [{\tt CCTK\_PRESTEP}]
 Stuff done before the evolution step.
 
@@ -466,21 +455,9 @@ The evolution step.
 \item [{\tt CCTK\_POSTSTEP}]
 Stuff done after the evolution step.
 
-\item [{\tt CCTK\_CHECKPOINT}]
-For checkpointing evolution data.
-
 \item [{\tt CCTK\_ANALYSIS}]
 For analysing data.
 
-\item [{\tt CCTK\_TERMINATE}]
-Called when Cactus terminates.
-
-\item [{\tt CCTK\_SHUTDOWN}]
-Cactus final shutdown routines.
-
-%\item [{\tt CCTK\_CONVERGENCE}]
-%Convergence stuff.
-%
 \end{Lentry}
 
 The {\tt other options} allow finer grained control of the scheduling.  It is