Document that the "varname" argument in the I/O method calls may have appended

an optional options string.


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

3 files changed, 20 insertions, 9 deletions

diff --git a/doc/ReferenceManual/CCTKReference.tex b/doc/ReferenceManual/CCTKReference.tex
index 39571fca..07ad6e6f 100644
--- a/doc/ReferenceManual/CCTKReference.tex
+++ b/doc/ReferenceManual/CCTKReference.tex
@@ -5978,7 +5978,9 @@ character*(*) variable
 \begin{ParameterSection}
 \begin{Parameter}{istat}return status\end{Parameter}
 \begin{Parameter}{cctkGH}pointer to CCTK grid hierarchy\end{Parameter}
-\begin{Parameter}{variable}full name of variable to output\end{Parameter}
+\begin{Parameter}{variable}full name of variable to output, with an optional
+options string in curly braces\end{Parameter}
+\end{Parameter}
 \end{ParameterSection}
 
 \begin{Discussion}
@@ -6026,7 +6028,8 @@ character*(*) alias
 \begin{ParameterSection}
 \begin{Parameter}{istat}return status\end{Parameter}
 \begin{Parameter}{cctkGH}pointer to CCTK grid hierarchy\end{Parameter}
-\begin{Parameter}{variable}full name of variable to output\end{Parameter}
+\begin{Parameter}{variable}full name of variable to output, with an optional
+options string in curly braces\end{Parameter}
 \begin{Parameter}{alias}alias name to base the output filename on\end{Parameter}
 \end{ParameterSection}
 
@@ -6074,7 +6077,8 @@ character*(*) alias
 \begin{ParameterSection}
 \begin{Parameter}{istat}return status\end{Parameter}
 \begin{Parameter}{cctkGH}pointer to CCTK grid hierarchy\end{Parameter}
-\begin{Parameter}{variable}full name of variable to output\end{Parameter}
+\begin{Parameter}{variable}full name of variable to output, with an optional
+options string in curly braces\end{Parameter}
 \begin{Parameter}{method}method to use for output\end{Parameter}
 \begin{Parameter}{alias}alias name to base the output filename on\end{Parameter}
 \end{ParameterSection}
@@ -6120,7 +6124,8 @@ character*(*) method
 \begin{ParameterSection}
 \begin{Parameter}{istat}return status\end{Parameter}
 \begin{Parameter}{cctkGH}pointer to CCTK grid hierarchy\end{Parameter}
-\begin{Parameter}{variable}full name of variable to output\end{Parameter}
+\begin{Parameter}{variable}full name of variable to output, with an optional
+options string in curly braces\end{Parameter}
 \begin{Parameter}{method}method to use for output\end{Parameter}
 \end{ParameterSection}
 
diff --git a/doc/UsersGuide/Infrastructure.tex b/doc/UsersGuide/Infrastructure.tex
index 3dd6a8e1..f628e20d 100644
--- a/doc/UsersGuide/Infrastructure.tex
+++ b/doc/UsersGuide/Infrastructure.tex
@@ -498,6 +498,8 @@ prototype:
 \end{alltt}
 %
 The variable to output, \var{varname}, is given by its full name.
+The full name may have appended an optional I/O options string enclosed in
+curly braces (with no space between the full name and the opening curly brace).
 In addition to that, an \var{alias} string can be passed which then serves
 the purpose of constructing a unique name for the output file.
 
@@ -560,7 +562,7 @@ provides distinct timebins for recovery routines to be scheduled at:
     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
     following {\t CCTK\_RECOVER\_VARIABLES} time bin.
-  \item[{\t CCTK\_RECOVER\_VARIABLES}] 
+  \item[{\t CCTK\_RECOVER\_VARIABLES}]
     Recovery routines scheduled for this time bin are responsible for restoring
     the contents of all grid variables with storage assigned from the
     checkpoint.\\
diff --git a/doc/UsersGuide/ThornWriters.tex b/doc/UsersGuide/ThornWriters.tex
index 8c8014b5..e392e2c6 100644
--- a/doc/UsersGuide/ThornWriters.tex
+++ b/doc/UsersGuide/ThornWriters.tex
@@ -2452,6 +2452,7 @@ appropriate time to output.
 \item {\tt CCTK\_OutputVar (const cGH *\var{GH}, const char *\var{varname})}
 
 Output a variable \var{varname} looping over all registered IO methods.
+\var{varname} may have an optional I/O options string appended.
 The output should take place if at all possible.  If output goes into
 a file and the appropriate file exists the data is appended, otherwise
 a new file is created.
@@ -2459,6 +2460,7 @@ a new file is created.
 \item {\tt CCTK\_OutputVarAs (const cGH *\var{GH}, const char *\var{varname}, const char *\var{alias})}
 
 Output a variable \var{varname} looping over all registered IO methods.
+\var{varname} may have an optional I/O options string appended.
 The output should take place if at all possible.  If output goes into
 a file and the appropriate file exists the data is appended, otherwise
 a new file is created.  Uses \var{alias} as the name of the variable
@@ -2466,8 +2468,9 @@ for the purpose of constructing a filename.
 
 \item {\tt CCTK\_OutputVarByMethod (const cGH *\var{GH}, const char *\var{varname}, const char *\var{methodname})}
 
-Output a variable \var{varname} using the IO method \var{methodname} if
-it is registered. The output should take place if at all possible.  If
+Output a variable \var{varname} using the IO method \var{methodname} if it is
+registered. \var{varname} may have an optional I/O options string appended.
+The output should take place if at all possible.  If
 output goes into a file and the appropriate file exists the data is
 appended, otherwise a new file is created.
 
@@ -2476,8 +2479,9 @@ appended, otherwise a new file is created.
                                      const char *\var{methodname},\\
                                      const char *\var{alias})}
 
-Output a variable \var{varname} using the IO method \var{methodname} if
-it is registered.  The output should take place if at all possible.
+Output a variable \var{varname} using the IO method \var{methodname} if it is
+registered. \var{varname} may have an optional I/O options string appended.
+The output should take place if at all possible.
 If output goes into a file and the appropriate file exists the data is
 appended, otherwise a new file is created.  Uses \var{alias} as the
 name of the variable for the purpose of constructing a filename.