From 89725a801685d2fb33cdf08ddc24f4dc9d9c64d2 Mon Sep 17 00:00:00 2001 From: tradke Date: Tue, 28 May 2002 14:48:25 +0000 Subject: Given an example of using the 'out_every' option in option strings. git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOASCII/trunk@119 94b1c47f-dcfd-45ef-a468-0854c0e9e350 --- doc/documentation.tex | 81 +++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 72 insertions(+), 9 deletions(-) diff --git a/doc/documentation.tex b/doc/documentation.tex index 99813d9..ef87a53 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -43,10 +43,73 @@ Thorn {\bf IOASCII} registers three I/O methods named {\tt IOASCII\_1D}, {\tt IO \item {\tt IOASCII\_3D} outputs three-dimensional grid functions and arrays as a whole.\\ Data is written in ASCII format and goes into files named - {\tt .\{asc|xg\}}.\\ + {\tt \_3D.\{asc|xg\}}.\\ These files can be visualized by gnuplot using its {\it splot} command. \end{itemize} % +% +\section{{\bf IOASCII} Parameters} +% +General parameters to control all {\bf IOASCII}'s I/O methods are: +\begin{itemize} + \item {\tt IOASCII::out[123]D\_every} (steerable)\\ + How often to do periodic {\tt IOASCII} output. If this parameter is set in the + parameter file, it will override the setting of the shared + {\tt IO::out\_every} parameter. The output frequency can also be set + for individual variables using the {\tt out\_every} option in an option string appended to the {\tt IOASCII::out[123]D\_vars} parameter. + \item {\tt IOASCII::out[123]D\_vars} (steerable)\\ + The list of variables to output using an {\bf IOASCII} I/O method. + The variables must be given by their fully qualified variable or group + name. The special keyword {\it all} requests {\tt IOASCII} output for + all variables. Multiple names must be separated by whitespaces.\\ + An option string can be appended in square brackets to the + group/variable name. The only option supported so far is {\tt out\_every} + which sets the output frequency for an individual variable (overriding + {\tt IOASCII::out[123]D\_every} and {\tt IO::out\_every}). + \item {\tt IOASCII::out[123]D\_dir}\\ + The directory in which to place the {\tt IOASCII} output files. + If the directory doesn't exist at startup it will be created.\\ + If this parameter is set to an empty string {\tt IOASCII} output will go + to the standard output directory as specified in {\tt IO::out\_dir}. + \item {\tt IOASCII::out\_format} (steerable)\\ + The output format for floating-point numbers in {\tt IOASCII} output.\\ + This parameter conforms to the format modifier of the C library routine + {\it fprintf(3)}. You can set the format for outputting floating-point + numbers (fixed or exponential) as well as their precision (number of + digits). + \item {\tt IOASCII::out[123]D\_style}\\ + The output style for {\tt IOASCII} output.\\ + This parameter chooses between {\tt gnuplot}- and {\tt xgraph}-suitable + output style, and -- for {\tt gnuplot} -- determines whether to also + plot the physical time in the output data or not. +\end{itemize} +% +Additional parameters to control the {\tt IOASCII\_1D} I/O method are: +\begin{itemize} + \item {\tt IOASCII::out1D\_[xyzd]} (steerable)\\ + Chooses the directions to output in 1D {\tt IOASCII} format ({\tt d} + stands for diagonal direction). + \item {\tt IOASCII::out1D\_[xyz]line\_[xyz], IOASCII::out1D\_[xyz]line\_[xyz]i}\\ + Chooses the slice centers for 1D lines from {\tt IOASCII\_1D}. These + can be set either in physical or index coordinates. If they are set + these parameters will override the default slice center parameters + {\tt IO::out\_[xyz]line[xyz], IO::out\_[xyz]line[xyz]i}. +\end{itemize} +% +Additional parameters to control the {\tt IOASCII\_2D} I/O method are: +\begin{itemize} + \item {\tt IOASCII::out2D\_[{xy}{xz}{yz}]plane\_[xyz], IOASCII::out2D\_[{xy}{xz}{yz}]plane\_[xyz]i}\\ + Chooses the slice centers for 2D planes from {\tt IOASCII\_2D}. These + can be set either in physical or index coordinates. If they are set + these parameters will override the default slice center parameters + {\tt IO::out\_[{xy}{xz}{yz}]plane[xyz], IO::out\_[{xy}{xz}{yz}]plane[xyz]i}. +\end{itemize} +% +% +\section{Comments} +% +{\bf Getting Output from {\bf IOBasic}'s I/O Mehtods}\\ +% You obtain output by an I/O method by either % \begin{itemize} @@ -56,15 +119,15 @@ You obtain output by an I/O method by either % For a description of basic I/O parameters and the I/O function interface to invoke I/O methods by application thorns please see the documentation of thorn -{\bf IOUtil} and the flesh. +{\bf IOUtil} and the flesh.\\[3ex] +% +{\bf Building Cactus configurations with {\bf IOBasic}}\\ +% +Since {\bf IOASCII} uses parameters from {\bf 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. +% % -\section{Comments} - -IMPORTANT: Must select data to output AFTER spatial coordinates are set up - -Since {\bf IOASCII} uses parameters from {\bf IOUtil} -it also needs this I/O utility thorn be compiled into Cactus and activated. - \section{Examples} In this section we include example output for different parameter combinations. -- cgit v1.2.3