diff options
Diffstat (limited to 'doc/documentation.tex')
| -rw-r--r-- | doc/documentation.tex | 63 |
1 files changed, 30 insertions, 33 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index 5b45783..6c886e8 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -6,11 +6,11 @@ \author{Gabrielle Allen, Thomas Radke} \maketitle -\abstract{Thorn IOBasic provides I/O methods for outputting scalar values in +\abstract{Thorn {\bf IOBasic} provides I/O methods for outputting scalar values in ASCII format into files and for printing them as runtime information to screen.} \section{Purpose} -Thorn IOBasic registers 2 I/O methods with the I/O interface in the flesh +Thorn {\bf IOBasic} registers 2 I/O methods with the I/O interface in the flesh which both output the same following information: % \begin{itemize} @@ -22,11 +22,11 @@ which both output the same following information: The I/O methods differ in the destination the output is written to: \begin{itemize} \item{\tt Scalar}\\ - This method outputs the information into ASCII files named {\tt "<scalar\_name>.tl"} (for CCTK\_SCALAR variables) and {\tt "<var\_name>\_<reduction>.tl"} + This method outputs the information into ASCII files named {\tt "<scalar\_name>.\{asc|xg\}"} (for CCTK\_SCALAR variables) and {\tt "<var\_name>\_<reduction>.\{asc|xg\}"} (for CCTK\_GF and CCTK\_ARRAY variables where {\tt reduction} would stand - for {\tt min, max, nm1, nm2} respectively).\\ - The output data can be plotted by using either {\it xgraph} or - {\it gnuplot}. The output style can be selected via parameter settings. + for the type of reduction value that is output).\\ + The output data can be plotted by using either {\it xgraph} (for {\tt "*.xg"} files) or + {\it gnuplot} (for {\tt "*.asc"} files). The output style can be selected via parameter settings. \item {\tt Info}\\ This method prints the data as runtime information to {\it stdout}.\\ The output occurs as a table with columns containing the current iteration @@ -35,7 +35,7 @@ The I/O methods differ in the destination the output is written to: \end{itemize} % % -\section{{\tt IOBasic} Parameters} +\section{{\bf IOBasic} Parameters} % Parameters to control the {\tt Scalar} I/O method are: \begin{itemize} @@ -43,9 +43,11 @@ Parameters to control the {\tt Scalar} I/O method are: 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::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::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.\\ + If this paraeter is set to an empty string {\tt Scalar} output will go + to the standard output directory as specified in {\tt IO::out\_dir}. \item {\tt IOBasic::outScalar\_style}\\ How to start comments in the {\tt Scalar} ASCII output files.\\ Possible choices for this keywork parameter are {\it xgraph} and @@ -102,7 +104,7 @@ All of the above parameters marked as steerable can be changed at runtime. % \section{Examples} % -{\bf Example for {\tt Info} Output}\\ +\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} @@ -115,15 +117,13 @@ add other reduction operators within the $<>$ braces. 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 - wavetoy::phi[reductions=<norm2>] - mythorn::complex" -IOBasic::outInfo_reductions = "minimum maximum" + IOBasic::outInfo_every = 2 + IOBasic::outInfo_vars = "grid::r + wavetoy::phi[reductions=<norm2>] + mythorn::complex" + IOBasic::outInfo_reductions = "minimum maximum" \end{verbatim} -\vspace*{2ex} The resulting screen output would look like this: -\begin{tiny} \begin{verbatim} --------------------------------------------------------------------------------------------- it | | GRID::r | WAVETOY::phi | MYTHORN::complex | @@ -136,10 +136,8 @@ The resulting screen output would look like this: 8 | 0.138 | 0.02986294 | 0.86602540 | 0.07351147 | 6.90359593 | 0.00000000 | 10 | 0.172 | 0.02986294 | 0.86602540 | 0.07781795 | 6.90359593 | 0.00000000 | \end{verbatim} -\end{tiny} % -\vspace*{3ex} -{\bf Example for {\tt Scalar} Output}\\ +\subsection {Example for {\tt Scalar} Output} % The following parameter settings request scalar output for all grid function variables in the group {\tt grid::coordinates} and for the scalar variable @@ -147,18 +145,17 @@ variables in the group {\tt grid::coordinates} and for the scalar variable Output occurs every 10th iteration. {\tt gnuplot} output style is selected for the ASCII files which are placed into a subdirectory {\tt scalar\_output}. \begin{verbatim} -IOBasic::outScalar_every = 10 -IOBasic::outScalar_vars = "grid::coordinates grid::coarse_dx" -IOBasic::outScalar_reductions = "minimum maximum" -IOBasic::outScalar_style = "gnuplot" -IOBasic::outdir = "scalar_output" + IOBasic::outScalar_every = 10 + IOBasic::outScalar_vars = "grid::coordinates grid::coarse_dx" + IOBasic::outScalar_reductions = "minimum maximum" + IOBasic::outScalar_style = "gnuplot" + IOBasic::out_dir = "scalar_output" \end{verbatim} -\vspace*{2ex} This would create the following ASCII files: \begin{verbatim} -~/Cactus/par> ls scalar_output -coarse_dx.tl r_min.tl x_min.tl y_min.tl z_min.tl -r_max.tl x_max.tl y_max.tl z_max.tl + ~/Cactus/par> ls scalar_output + coarse_dx.asc r_minimum.asc x_minimum.asc y_minimum.asc z_minimum.asc + r_maximum.asc x_maximum.asc y_maximum.asc z_maximum.asc \end{verbatim} % % @@ -172,7 +169,7 @@ reduction operators (eg. thorn {\tt PUGHSlab} in the {\tt CactusPUGH} arrangement). For a list of possible reduction operations please refer to the documention of this reduction thorn.\\[3ex] % -{\bf Getting Output from IOBasic's I/O Mehtods}\\ +{\bf Getting Output from {\bf IOBasic}'s I/O Mehtods}\\ % You obtain output by an I/O method by either % @@ -187,9 +184,9 @@ invoke I/O methods by application thorns please see the documentation of thorn {\tt IOUtil} and the flesh.\\[3ex] % % -{\bf Building Cactus configurations with IOBasic}\\ +{\bf Building Cactus configurations with {\bf IOBasic}}\\ % -Since {\tt IOBasic} uses parameters from {\tt IOUtil} it also needs this I/O +Since {\bf IOBasic} uses parameters from {\tt IOUtil} it also needs this I/O helper thorn be compiled into Cactus and activated at runtime in the {\tt ActiveThorns} parameter in your parameter file. % |