diff options
author | tradke <tradke@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2000-12-01 14:46:33 +0000 |
---|---|---|
committer | tradke <tradke@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2000-12-01 14:46:33 +0000 |
commit | bec62fd8c43bcbb453dfb54a546a0a82a03b59c0 (patch) | |
tree | 6bc49b0e720844ad9b30c5e0de9eac9f671e9fa5 /doc/UsersGuide | |
parent | 76403b3f5d0a0e2d41dd815ec4adddd1ff308c37 (diff) |
Small changes/updates to the IO section.
git-svn-id: http://svn.cactuscode.org/flesh/trunk@1908 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc/UsersGuide')
-rw-r--r-- | doc/UsersGuide/ThornWriters.tex | 67 |
1 files changed, 36 insertions, 31 deletions
diff --git a/doc/UsersGuide/ThornWriters.tex b/doc/UsersGuide/ThornWriters.tex index 2004bf62..7d424033 100644 --- a/doc/UsersGuide/ThornWriters.tex +++ b/doc/UsersGuide/ThornWriters.tex @@ -1950,55 +1950,60 @@ Provides the local range of a coordinate on a processor for To allow flexible IO, the flesh itself does not provide any output routines, however it provides a mechanism for -thorns to register different routines as IO methods. Application thorns -can interact with the different IO methods through the following -function calls: +thorns to register different routines as IO methods (see chapter \ref{chap:io_methods}). +Application thorns can interact with the different IO methods through the +following function calls: -\begin{description} +\begin{Lentry} -\item[CCTK\_OutputGH] +\item[{\tt CCTK\_OutputGH (cGH *GH)}] This call loops over all registered IO methods, calling the routine that each method has registered for {\t OutputGH}. -The expected behaviour of any methods {\t OutputGH} is to -loop over all GH variables outputting them if the method +The expected behaviour of any {\t OutputGH} routine is to +loop over all GH variables outputting them if the IO method contains appropriate routines (that is, not all methods will supply routines to output all different types of variables) and if the method decides it is an appropriate time to output. -\item[CCTK\_OutputVarAsByMethod] +\item[{\tt CCTK\_OutputVar (cGH *GH, const char *varname)}] -Output a variable {\t varname} using the method {\t methodname} if it is -registered. Uses {\t alias} as the name of the variable for the purpose -of constructing a filename. The output should take place if at all possible, -if the appropriate file exists the data is appended, otheriwise a new -file is created. +Output a variable {\t varname} looping over all registered IO methods. +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. +\item[{\tt CCTK\_OutputVarAs (cGH *GH, const char *varname, const char *alias)}] -\item[CCTK\_OutputVarByMethod] +Output a variable {\t varname} looping over all registered IO methods. +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 {\t alias} as the name of the variable for the purpose +of constructing a filename. -Output a variable {\t varname} using the method {\t methodname} if it is -registered. The output should take place if at all possible, -if the appropriate file exists the data is appended, otherwise a new -file is created. +\item[{\tt CCTK\_OutputVarByMethod (cGH *GH, const char *varname, const char *methodname)}] -\item[CCTK\_OutputVarAs] +Output a variable {\t varname} using the IO method {\t methodname} if it is +registered. 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. -Output a variable {\t varname} looping over all registered methods. -The output should take place if at all possible, -if the appropriate file exists the data is appended, otherwise a new -file is created. Uses {\t alias} as the name of the variable for the purpose -of constructing a filename. +\item[{\tt CCTK\_OutputVarAsByMethod (cGH *GH, + const char *varname, + const char *methodname, + const char *alias)}] -\item[CCTK\_OutputVar] +Output a variable {\t varname} using the IO method {\t methodname} if it is +registered. +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 {\t alias} as the name of the variable for the purpose +of constructing a filename. -Output a variable {\t varname} looping over all registered methods. -The output should take place if at all possible, -if the appropriate file exists the data is appended, otherwise a new -file is created. - -\end{description} +\end{Lentry} \subsection{Reduction Operators} \label{sec:reop} |