diff options
Diffstat (limited to 'doc/documentation.tex')
| -rw-r--r-- | doc/documentation.tex | 43 |
1 files changed, 35 insertions, 8 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index a68b972..d5ff0a9 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -52,10 +52,20 @@ 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\_criterion} (steerable)\\ + The criterion that decides when to {\tt Scalar} output. If + this parameter is set in the parameter file, it will override + the setting of the shared {\tt IO::out\_criterion} parameter. \item {\tt IOBasic::outScalar\_every} (steerable)\\ - How often to do {\tt Scalar} output. If this parameter is set in the + How often, in terms of iterations, 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::outScalar\_dt} (steerable)\\ + How often, in terms of simulation time, 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\_dt} + parameter. \item {\tt IOBasic::out\_dir}\\ The directory in which to place the {\tt Scalar} ASCII output files. If the directory doesn't exist at startup it will be created.\\ @@ -74,9 +84,11 @@ 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 {\tt Scalar} 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 + 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 @@ -92,16 +104,27 @@ 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\_criterion} (steerable)\\ + The criterion that decides when to {\tt Info} output. If + this parameter is set in the parameter file, it will override + the setting of the shared {\tt IO::out\_criterion} parameter. \item {\tt IOBasic::outInfo\_every} (steerable)\\ - How often to do {\tt Info} output. If this parameter is set in the + How often, in terms of iterations, 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\_dt} (steerable)\\ + How often, in terms of simulation time, 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\_dt} + 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 {\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 + 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 @@ -120,15 +143,19 @@ All of the above parameters marked as steerable can be changed at runtime. \subsection {Example for {\tt Info} Output} % The following parameter settings request info output for variables {\tt -grid::r, wavetoy::phi} (both are CCTK grid functions) and {\tt mythorn::complex} +grid::r, wavetoy::phi} (both are CCTK grid functions) and {\tt +mythorn::complex} (a complex CCTK scalar) at every other iteration. The minimum and maximum of {\tt grid::r} is printed according to the list -of default reductions for info output (parameter {\tt IOBasic::outInfo\_reductions}). This list is overridden for {\tt wavetoy::phi} where only the L2 norm +of default reductions for info output (parameter {\tt +IOBasic::outInfo\_reductions}). This list is overridden for {\tt +wavetoy::phi} where only the L2 norm is output as specified in the option string for this variable. You can also add other reduction operators within the $<>$ braces. -For the scalar variable {\tt mythorn::complex} both the real and imaginary part are printed. +For the scalar variable {\tt mythorn::complex} both the real and +imaginary part are printed. \begin{verbatim} IOBasic::outInfo_every = 2 IOBasic::outInfo_vars = "grid::r |