diff options
author | tradke <tradke@94b1c47f-dcfd-45ef-a468-0854c0e9e350> | 2002-05-06 09:11:42 +0000 |
---|---|---|
committer | tradke <tradke@94b1c47f-dcfd-45ef-a468-0854c0e9e350> | 2002-05-06 09:11:42 +0000 |
commit | 84df6a1831d14dcd7a80b7c65758919a78732df0 (patch) | |
tree | b66b71102d27bfaf0b90d5dd5918292041b092d0 /doc | |
parent | 76d4e575a9901080e16d0558e9d65f7a1ec8fe22 (diff) |
Parameter names changes as announced in today's mail to users@cactuscode.org.
You must also update thorn IOUtil now.
git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOASCII/trunk@113 94b1c47f-dcfd-45ef-a468-0854c0e9e350
Diffstat (limited to 'doc')
-rw-r--r-- | doc/documentation.tex | 475 |
1 files changed, 194 insertions, 281 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index b78a39b..99813d9 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -7,84 +7,44 @@ \date{December 2001} \maketitle -\abstract{Thorn IOASCII provides I/O methods for 1D, 2D, and 3D output of +\abstract{Thorn {\bf IOASCII} provides I/O methods for 1D, 2D, and 3D output of grid arrays into files in ASCII format. The precise format is designed for visualisation using the clients {\tt xgraph} or {\tt gnuplot}.} \section{Purpose} -Thorn IOASCII registers three I/O methods named {\tt IOASCII\_1D}, {\tt IOASCII\_2D}, and +Thorn {\bf IOASCII} registers three I/O methods named {\tt IOASCII\_1D}, {\tt IOASCII\_2D}, and {\tt IOASCII\_3D} with the I/O interface in the flesh. \begin{itemize} - - \item {\tt IOASCII\_1D} - - creates one-dimensional output of 1D, 2D and - 3D grid functions and arrays by slicing through the edge (in the - octant case) or center (in all origin centered cases) of the grid in - the coordinate directions. In addition, output is provided - along a diagonal of the grid, in this case the diagonal always starts - at the first grid point (that is, in Fortran notation {\tt var(1,1,1)}) - and the line taken uses grid points increasing by 1 in each direction. - [NOTE: The diagonal output is not yet available for staggered variables]. - - Output for each direction can be - selected individually via parameters. - - Data is written in ASCII format and goes into files named - - {\tt <GF\_name>.[xyzd]} - - with the default behaviour in each grid dimension being to create - the following files: - - \begin{center} - \begin{tabular}{cc} - Array dimension & Default output \\ - 3D & {\tt xl yl zl dl} \\ - 2D & {\tt xl yl dl} \\ - 1D & {\tt xl} - \end{tabular} - \end{center} - - These files can be processed directly by either xgraph or gnuplot - (you can select the style of output via parameter settings). - - \item {\tt IOASCII\_2D} - - outputs two-dimensional slices of grid functions and arrays planes. - Again, slicing is done through the edge (in the - octant case) or center (in all origin centered cases).\\ Data is - written in ASCII format and goes into files named - - {\tt <varname>\_2d\_[\{xy\}\{xz\}\{yz\}].gnuplot} - - The default behaviour in each grid dimension is to create - the following files: - - \begin{center} - \begin{tabular}{cc} - Array dimension & Default output \\ - 3D & {\tt xy yz xz} \\ - 2D & {\tt xy} - \end{tabular} - \end{center} - - These files can be - visualized by gnuplot using its {\it splot} command. - - \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 <varname>\_3D.asc} - - These files can be visualized by gnuplot - using its {\it splot} command. - + \item {\tt IOASCII\_1D}\\ + creates one-dimensional output of 1D, 2D and + 3D grid functions and arrays by slicing through the edge (in the + octant case) or center (in all origin centered cases) of the grid in + the coordinate directions. In addition, output is provided + along a diagonal of the grid, in this case the diagonal always starts + at the first grid point (that is, in Fortran notation {\tt var(1,1,1)}) + and the line taken uses grid points increasing by 1 in each direction. + [NOTE: The diagonal output is not available for staggered variables].\\ + Output for each direction can be selected individually via parameters.\\ + Data is written in ASCII format and goes into files named + {\tt <variable\_name>\_<slice>\_[<center\_i>][<center\_j>].\{asc|xg\}} + and {\tt <variable\_name>\_3D\_diagonal.\{asc|xg\}} for diagonals.\\ + These files can be processed directly by either xgraph or gnuplot + (you can select the style of output via parameter settings). + + \item {\tt IOASCII\_2D} + outputs two-dimensional slices of grid functions and arrays planes. + Again, slicing is done through the edge (in the octant case) or center + (in all origin centered cases).\\ + Data is written in ASCII format and goes into files named + {\tt <variable\_name>\_<plane>\_[<center>].\{asc|xg\}}.\\ + These files can be visualized by gnuplot using its {\it splot} command. + + \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 <variable\_name>.\{asc|xg\}}.\\ + These files can be visualized by gnuplot using its {\it splot} command. \end{itemize} % You obtain output by an I/O method by either @@ -96,313 +56,266 @@ 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 -IOUtil and the flesh. +{\bf IOUtil} and the flesh. % \section{Comments} IMPORTANT: Must select data to output AFTER spatial coordinates are set up - - - -% -Since IOASCII uses parameters from IOUtil +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. +In this section we include example output for different parameter combinations. Note that all these examples were generated for just a couple of timesteps for an extremely small 3D grid. -\subsection{One dimensional xgraph} - -These options produce data suitable for using with the xgraph visualization client -in the format -{\tt -\begin{verbatim} -x f(t=fixed,x,y=fixed,z=fixed) -\end{verbatim} -} +\subsection{One-dimensional xgraph} +These options produce data suitable for using with the xgraph visualization client in the format {\tt x f(t=fixed,x,y=fixed,z=fixed)}: -{\tt \begin{verbatim} -IOASCII::out1D_every = 1 -IOASCII::out1D_vars = "wavetoy::phi" -IOASCII::out1D_style = "xgraph" + IOASCII::out1D_every = 1 + IOASCII::out1D_vars = "wavetoy::phi" + IOASCII::out1D_style = "xgraph" \end{verbatim} -} \noindent -{\bf Output File: phi.xl} +{\bf Output File: phi\_x\_[1][1].xg} -{\tt \begin{verbatim} -"Parameter file wavetoy.par -"Created Sun 19 Aug 2001 16:31:43 -"x-label x -"y-label WAVETOY::phi (y = 0.0000000000000, z = 0.0000000000000), (yi = 1, zi = 1) + "Parameter file wavetoy.par + "Created Sun 19 Aug 2001 16:31:43 + "x-label x + "y-label WAVETOY::phi (y = 0.0000000000000, z = 0.0000000000000), (yi = 1, zi = 1) -"Time = 0.0000000000000 --0.5000000000000 0.0000000000139 -0.0000000000000 1.0000000000000 -0.5000000000000 0.0000000000139 + "Time = 0.0000000000000 + -0.5000000000000 0.0000000000139 + 0.0000000000000 1.0000000000000 + 0.5000000000000 0.0000000000139 -"Time = 0.2500000000000 --0.5000000000000 0.0000000000000 -0.0000000000000 0.4980695458846 -0.5000000000000 0.0000000000000 + "Time = 0.2500000000000 + -0.5000000000000 0.0000000000000 + 0.0000000000000 0.4980695458846 + 0.5000000000000 0.0000000000000 -"Time = 0.5000000000000 --0.5000000000000 0.0019304541362 -0.0000000000000 -0.7509652270577 -0.5000000000000 0.0019304541362 + "Time = 0.5000000000000 + -0.5000000000000 0.0019304541362 + 0.0000000000000 -0.7509652270577 + 0.5000000000000 0.0019304541362 \end{verbatim} -} -\subsection{One dimensional gnuplot} -These options produce data suitable for using with the gnuplot visualization client in the format -{\tt -\begin{verbatim} -x f(t,x,y=fixed,z=fixed) -\end{verbatim} -} +\subsection{One-dimensional gnuplot} +These options produce data suitable for using with the gnuplot visualization client in the format {\tt x f(t,x,y=fixed,z=fixed)}: -{\tt \begin{verbatim} -IOASCII::out1D_every = 1 -IOASCII::out1D_vars = "wavetoy::phi" -IOASCII::out1D_style = "gnuplot f(x)" + IOASCII::out1D_every = 1 + IOASCII::out1D_vars = "wavetoy::phi" + IOASCII::out1D_style = "gnuplot f(x)" \end{verbatim} -} \noindent -{\bf Output File: phi.xl} +{\bf Output File: phi\_x\_[1][1].asc} -{\tt \begin{verbatim} -#Parameter file wavetoy.par -#Created Sun 19 Aug 2001 16:33:07 -#x-label x -#y-label WAVETOY::phi (y = 0.0000000000000, z = 0.0000000000000), (yi = 1, zi = 1) - -#Time = 0.0000000000000 --0.5000000000000 0.0000000000139 -0.0000000000000 1.0000000000000 -0.5000000000000 0.0000000000139 - -#Time = 0.2500000000000 --0.5000000000000 0.0000000000000 -0.0000000000000 0.4980695458846 -0.5000000000000 0.0000000000000 - -#Time = 0.5000000000000 --0.5000000000000 0.0019304541362 -0.0000000000000 -0.7509652270577 -0.5000000000000 0.0019304541362 + #Parameter file wavetoy.par + #Created Sun 19 Aug 2001 16:33:07 + #x-label x + #y-label WAVETOY::phi (y = 0.0000000000000, z = 0.0000000000000), (yi = 1, zi = 1) + + #Time = 0.0000000000000 + -0.5000000000000 0.0000000000139 + 0.0000000000000 1.0000000000000 + 0.5000000000000 0.0000000000139 + + #Time = 0.2500000000000 + -0.5000000000000 0.0000000000000 + 0.0000000000000 0.4980695458846 + 0.5000000000000 0.0000000000000 + + #Time = 0.5000000000000 + -0.5000000000000 0.0019304541362 + 0.0000000000000 -0.7509652270577 + 0.5000000000000 0.0019304541362 \end{verbatim} -} -\subsection{One dimensional gnuplot (including time)} +\subsection{One-dimensional gnuplot (including time)} -These options produce data suitable for using with the gnuplot visualization client in the format -{\tt -\begin{verbatim} -t x f(t,x,y=fixed,z=fixed) -\end{verbatim} -} +These options produce data suitable for using with the gnuplot visualization client in the format {\tt t x f(t,x,y=fixed,z=fixed)}: -{\tt \begin{verbatim} -IOASCII::out1D_every = 1 -IOASCII::out1D_vars = "wavetoy::phi" -IOASCII::out1D_style = "gnuplot f(t,x)" + IOASCII::out1D_every = 1 + IOASCII::out1D_vars = "wavetoy::phi" + IOASCII::out1D_style = "gnuplot f(t,x)" \end{verbatim} -} \noindent -{\bf Output file: phi.xl} -{\tt +{\bf Output file: phi\_x\_[1][1].asc} + \begin{verbatim} -#Parameter file wavetoy.par -#Created Sun 19 Aug 2001 16:34:48 -#x-label x -#y-label WAVETOY::phi (y = 0.0000000000000, z = 0.0000000000000), (yi = 1, zi = 1) - -#Time = 0.0000000000000 -0.0000000000000 -0.5000000000000 0.0000000000139 -0.0000000000000 0.0000000000000 1.0000000000000 -0.0000000000000 0.5000000000000 0.0000000000139 - -#Time = 0.2500000000000 -0.2500000000000 -0.5000000000000 0.0000000000000 -0.2500000000000 0.0000000000000 0.4980695458846 -0.2500000000000 0.5000000000000 0.0000000000000 - -#Time = 0.5000000000000 -0.5000000000000 -0.5000000000000 0.0019304541362 -0.5000000000000 0.0000000000000 -0.7509652270577 -0.5000000000000 0.5000000000000 0.0019304541362 + #Parameter file wavetoy.par + #Created Sun 19 Aug 2001 16:34:48 + #x-label x + #y-label WAVETOY::phi (y = 0.0000000000000, z = 0.0000000000000), (yi = 1, zi = 1) + + #Time = 0.0000000000000 + 0.0000000000000 -0.5000000000000 0.0000000000139 + 0.0000000000000 0.0000000000000 1.0000000000000 + 0.0000000000000 0.5000000000000 0.0000000000139 + + #Time = 0.2500000000000 + 0.2500000000000 -0.5000000000000 0.0000000000000 + 0.2500000000000 0.0000000000000 0.4980695458846 + 0.2500000000000 0.5000000000000 0.0000000000000 + + #Time = 0.5000000000000 + 0.5000000000000 -0.5000000000000 0.0019304541362 + 0.5000000000000 0.0000000000000 -0.7509652270577 + 0.5000000000000 0.5000000000000 0.0019304541362 \end{verbatim} -} -\subsection{Two dimensional gnuplot} -These options produce data suitable for using with the gnuplot visualization client in the format -{\tt -\begin{verbatim} -x y f(t,x,y,z=fixed) -\end{verbatim} -} +\subsection{Two-dimensional gnuplot} +These options produce data suitable for using with the gnuplot visualization client in the format {\tt x y f(t,x,y,z=fixed)}: -{\tt \begin{verbatim} -IOASCII::out2D_every = 1 -IOASCII::out2D_vars = "wavetoy::phi" -IOASCII::out2D_style = "gnuplot f(x,y)" + IOASCII::out2D_every = 1 + IOASCII::out2D_vars = "wavetoy::phi" + IOASCII::out2D_style = "gnuplot f(x,y)" \end{verbatim} -} \noindent -{\bf Output file: phi\_2d\_xy.gnuplot} -{\tt +{\bf Output file: phi\_xy\_[1].asc} + \begin{verbatim} -#Parameter file wavetoy.par -#Created Sun 19 Aug 2001 16:31:43 -#x-label x -#y-label y -#z-label WAVETOY::phi (z = 0.0000000000000), (zi = 1) + #Parameter file wavetoy.par + #Created Sun 19 Aug 2001 16:31:43 + #x-label x + #y-label y + #z-label WAVETOY::phi (z = 0.0000000000000), (zi = 1) -#Time = 0.0000000000000 --0.5000000000000 -0.5000000000000 0.0000000000000 -0.0000000000000 -0.5000000000000 0.0000000000139 -0.5000000000000 -0.5000000000000 0.0000000000000 + #Time = 0.0000000000000 + -0.5000000000000 -0.5000000000000 0.0000000000000 + 0.0000000000000 -0.5000000000000 0.0000000000139 + 0.5000000000000 -0.5000000000000 0.0000000000000 --0.5000000000000 0.0000000000000 0.0000000000139 -0.0000000000000 0.0000000000000 1.0000000000000 -0.5000000000000 0.0000000000000 0.0000000000139 + -0.5000000000000 0.0000000000000 0.0000000000139 + 0.0000000000000 0.0000000000000 1.0000000000000 + 0.5000000000000 0.0000000000000 0.0000000000139 --0.5000000000000 0.5000000000000 0.0000000000000 -0.0000000000000 0.5000000000000 0.0000000000139 -0.5000000000000 0.5000000000000 0.0000000000000 + -0.5000000000000 0.5000000000000 0.0000000000000 + 0.0000000000000 0.5000000000000 0.0000000000139 + 0.5000000000000 0.5000000000000 0.0000000000000 -#Time = 0.2500000000000 --0.5000000000000 -0.5000000000000 0.0000000000000 -0.0000000000000 -0.5000000000000 0.0000000000000 -0.5000000000000 -0.5000000000000 0.0000000000000 + #Time = 0.2500000000000 + -0.5000000000000 -0.5000000000000 0.0000000000000 + 0.0000000000000 -0.5000000000000 0.0000000000000 + 0.5000000000000 -0.5000000000000 0.0000000000000 --0.5000000000000 0.0000000000000 0.0000000000000 -0.0000000000000 0.0000000000000 0.4980695458846 -0.5000000000000 0.0000000000000 0.0000000000000 + -0.5000000000000 0.0000000000000 0.0000000000000 + 0.0000000000000 0.0000000000000 0.4980695458846 + 0.5000000000000 0.0000000000000 0.0000000000000 --0.5000000000000 0.5000000000000 0.0000000000000 -0.0000000000000 0.5000000000000 0.0000000000000 -0.5000000000000 0.5000000000000 0.0000000000000 + -0.5000000000000 0.5000000000000 0.0000000000000 + 0.0000000000000 0.5000000000000 0.0000000000000 + 0.5000000000000 0.5000000000000 0.0000000000000 -#Time = 0.5000000000000 --0.5000000000000 -0.5000000000000 0.0000000008425 -0.0000000000000 -0.5000000000000 0.0019304541362 -0.5000000000000 -0.5000000000000 0.0000000008425 + #Time = 0.5000000000000 + -0.5000000000000 -0.5000000000000 0.0000000008425 + 0.0000000000000 -0.5000000000000 0.0019304541362 + 0.5000000000000 -0.5000000000000 0.0000000008425 --0.5000000000000 0.0000000000000 0.0019304541362 -0.0000000000000 0.0000000000000 -0.7509652270577 -0.5000000000000 0.0000000000000 0.0019304541362 + -0.5000000000000 0.0000000000000 0.0019304541362 + 0.0000000000000 0.0000000000000 -0.7509652270577 + 0.5000000000000 0.0000000000000 0.0019304541362 --0.5000000000000 0.5000000000000 0.0000000008425 -0.0000000000000 0.5000000000000 0.0019304541362 -0.5000000000000 0.5000000000000 0.0000000008425 + -0.5000000000000 0.5000000000000 0.0000000008425 + 0.0000000000000 0.5000000000000 0.0019304541362 + 0.5000000000000 0.5000000000000 0.0000000008425 \end{verbatim} -} -\subsection{Two dimensional gnuplot (including time)} -These options produce data suitable for using with the gnuplot visualization client in the format -{\tt -\begin{verbatim} -t x y f(t,x,y,z=fixed) -\end{verbatim} -} +\subsection{Two-dimensional gnuplot (including time)} +These options produce data suitable for using with the gnuplot visualization client in the format {\tt t x y f(t,x,y,z=fixed)}: - -{\tt \begin{verbatim} -IOASCII::out2D_every = 1 -IOASCII::out2D_vars = "wavetoy::phi" -IOASCII::out2D_style = "gnuplot f(t,x,y)" + IOASCII::out2D_every = 1 + IOASCII::out2D_vars = "wavetoy::phi" + IOASCII::out2D_style = "gnuplot f(t,x,y)" \end{verbatim} -} + \noindent -{\bf Output file: phi\_2d\_xy.gnuplot} -{\tt +{\bf Output file: phi\_xy\_[1].asc} + \begin{verbatim} -#Parameter file wavetoy.par -#Created Sun 19 Aug 2001 16:33:07 -#x-label x -#y-label y -#z-label WAVETOY::phi (z = 0.0000000000000), (zi = 1) + #Parameter file wavetoy.par + #Created Sun 19 Aug 2001 16:33:07 + #x-label x + #y-label y + #z-label WAVETOY::phi (z = 0.0000000000000), (zi = 1) -#Time = 0.0000000000000 -0.0000000000000 -0.5000000000000 -0.5000000000000 0.0000000000000 -0.0000000000000 0.0000000000000 -0.5000000000000 0.0000000000139 -0.0000000000000 0.5000000000000 -0.5000000000000 0.0000000000000 + #Time = 0.0000000000000 + 0.0000000000000 -0.5000000000000 -0.5000000000000 0.0000000000000 + 0.0000000000000 0.0000000000000 -0.5000000000000 0.0000000000139 + 0.0000000000000 0.5000000000000 -0.5000000000000 0.0000000000000 -0.0000000000000 -0.5000000000000 0.0000000000000 0.0000000000139 -0.0000000000000 0.0000000000000 0.0000000000000 1.0000000000000 -0.0000000000000 0.5000000000000 0.0000000000000 0.0000000000139 + 0.0000000000000 -0.5000000000000 0.0000000000000 0.0000000000139 + 0.0000000000000 0.0000000000000 0.0000000000000 1.0000000000000 + 0.0000000000000 0.5000000000000 0.0000000000000 0.0000000000139 -0.0000000000000 -0.5000000000000 0.5000000000000 0.0000000000000 -0.0000000000000 0.0000000000000 0.5000000000000 0.0000000000139 -0.0000000000000 0.5000000000000 0.5000000000000 0.0000000000000 + 0.0000000000000 -0.5000000000000 0.5000000000000 0.0000000000000 + 0.0000000000000 0.0000000000000 0.5000000000000 0.0000000000139 + 0.0000000000000 0.5000000000000 0.5000000000000 0.0000000000000 -#Time = 0.2500000000000 -0.2500000000000 -0.5000000000000 -0.5000000000000 0.0000000000000 -0.2500000000000 0.0000000000000 -0.5000000000000 0.0000000000000 -0.2500000000000 0.5000000000000 -0.5000000000000 0.0000000000000 + #Time = 0.2500000000000 + 0.2500000000000 -0.5000000000000 -0.5000000000000 0.0000000000000 + 0.2500000000000 0.0000000000000 -0.5000000000000 0.0000000000000 + 0.2500000000000 0.5000000000000 -0.5000000000000 0.0000000000000 -0.2500000000000 -0.5000000000000 0.0000000000000 0.0000000000000 -0.2500000000000 0.0000000000000 0.0000000000000 0.4980695458846 -0.2500000000000 0.5000000000000 0.0000000000000 0.0000000000000 + 0.2500000000000 -0.5000000000000 0.0000000000000 0.0000000000000 + 0.2500000000000 0.0000000000000 0.0000000000000 0.4980695458846 + 0.2500000000000 0.5000000000000 0.0000000000000 0.0000000000000 -0.2500000000000 -0.5000000000000 0.5000000000000 0.0000000000000 -0.2500000000000 0.0000000000000 0.5000000000000 0.0000000000000 -0.2500000000000 0.5000000000000 0.5000000000000 0.0000000000000 + 0.2500000000000 -0.5000000000000 0.5000000000000 0.0000000000000 + 0.2500000000000 0.0000000000000 0.5000000000000 0.0000000000000 + 0.2500000000000 0.5000000000000 0.5000000000000 0.0000000000000 -#Time = 0.5000000000000 -0.5000000000000 -0.5000000000000 -0.5000000000000 0.0000000008425 -0.5000000000000 0.0000000000000 -0.5000000000000 0.0019304541362 -0.5000000000000 0.5000000000000 -0.5000000000000 0.0000000008425 + #Time = 0.5000000000000 + 0.5000000000000 -0.5000000000000 -0.5000000000000 0.0000000008425 + 0.5000000000000 0.0000000000000 -0.5000000000000 0.0019304541362 + 0.5000000000000 0.5000000000000 -0.5000000000000 0.0000000008425 -0.5000000000000 -0.5000000000000 0.0000000000000 0.0019304541362 -0.5000000000000 0.0000000000000 0.0000000000000 -0.7509652270577 -0.5000000000000 0.5000000000000 0.0000000000000 0.0019304541362 + 0.5000000000000 -0.5000000000000 0.0000000000000 0.0019304541362 + 0.5000000000000 0.0000000000000 0.0000000000000 -0.7509652270577 + 0.5000000000000 0.5000000000000 0.0000000000000 0.0019304541362 -0.5000000000000 -0.5000000000000 0.5000000000000 0.0000000008425 -0.5000000000000 0.0000000000000 0.5000000000000 0.0019304541362 -0.5000000000000 0.5000000000000 0.5000000000000 0.0000000008425 + 0.5000000000000 -0.5000000000000 0.5000000000000 0.0000000008425 + 0.5000000000000 0.0000000000000 0.5000000000000 0.0019304541362 + 0.5000000000000 0.5000000000000 0.5000000000000 0.0000000008425 \end{verbatim} -} + % -% Automatically created from the ccl files +% Automatically created from the ccl files % Do not worry for now. \include{interface} \include{param} |