From 97c8567e5aa4e21cdb326b6c7fbf8a0f86ba14ad Mon Sep 17 00:00:00 2001 From: tradke Date: Sat, 16 Mar 2002 22:32:37 +0000 Subject: Updated documentation. git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOBasic/trunk@118 b589c3ab-70e8-4b4d-a09f-cba2dd200880 --- doc/documentation.tex | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/doc/documentation.tex b/doc/documentation.tex index 91cb04c..5b45783 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -40,14 +40,14 @@ The I/O methods differ in the destination the output is written to: Parameters to control the {\tt Scalar} I/O method are: \begin{itemize} \item {\tt IOBasic::outScalar\_every} (steerable)\\ - How often to do info output. If this parameter is set in the + How often to do {\tt Scalar} output. If this parameter is set in the parameter file, it will override the setting of the shared {\tt IO::out\_every} parameter. - \item {\tt IOBasic::outdirScalar}\\ - The directory in which to place the ASCII output files.\\ + \item {\tt IOBasic::outdir}\\ + The directory in which to place the {\tt Scalar} ASCII output files.\\ If the directory doesn't exist at startup it will be created. \item {\tt IOBasic::outScalar\_style}\\ - How to start comments in the ASCII output files.\\ + How to start comments in the {\tt Scalar} ASCII output files.\\ Possible choices for this keywork parameter are {\it xgraph} and {\it gnuplot}. \item {\tt IOBasic::out\_format} (steerable)\\ @@ -59,11 +59,18 @@ Parameters to control the {\tt Scalar} I/O method are: \item {\tt IOBasic::outScalar\_vars} (steerable)\\ The list of variables to output into individual ASCII files.\\ The variables must be given by their fully qualified variable or group - name. The special keyword {\it all} requests info output for all + name. The special keyword {\it all} requests {\tt Scalar} output for all variables. Multiple variables must be separated by spaces. + For CCTK\_GF and CCTK\_ARRAY variables, an option string can be appended + in square brackets to the name of the variable. The only option + supported so far is an individual list of reductions for that variable + which would take precedence over the default reduction operations to + perform. \item {\tt IOBasic::outScalar\_reductions} (steerable)\\ The list of global reduction operations to perform on - CCTK\_GF and CCTK\_ARRAY variables for {\tt Scalar} output.\\ + CCTK\_GF and CCTK\_ARRAY variables for {\tt Scalar} output. + This setting can be overridden for individual variables using an + option string.\\ Multiple reduction names must be separated by spaces. \end{itemize} % @@ -71,13 +78,13 @@ Parameters to control the {\tt Scalar} I/O method are: Parameters to control the {\tt Info} I/O method are: \begin{itemize} \item {\tt IOBasic::outInfo\_every} (steerable)\\ - How often to do info output. If this parameter is set in the + How often to do {\tt Info} output. If this parameter is set in the parameter file, it will override the setting of the shared {\tt IO::out\_every} parameter. \item {\tt IOBasic::outInfo\_vars} (steerable)\\ The list of variables to output to screen.\\ The variables must be given by their fully qualified variable or group - name. The special keyword {\it all} requests info output for all + name. The special keyword {\it all} requests {\tt Info} output for all variables. Multiple variables must be separated by spaces.\\ For CCTK\_GF and CCTK\_ARRAY variables, an option string can be appended in square brackets to the name of the variable. The only option @@ -144,7 +151,7 @@ IOBasic::outScalar_every = 10 IOBasic::outScalar_vars = "grid::coordinates grid::coarse_dx" IOBasic::outScalar_reductions = "minimum maximum" IOBasic::outScalar_style = "gnuplot" -IOBasic::outdirScalar = "scalar_output" +IOBasic::outdir = "scalar_output" \end{verbatim} \vspace*{2ex} This would create the following ASCII files: -- cgit v1.2.3