Added 3D ASCII output for 3D variables.

Closes PR BetaThorns/742 (??).


git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOASCII/trunk@87 94b1c47f-dcfd-45ef-a468-0854c0e9e350

1 files changed, 32 insertions, 27 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 013ff8e..85f070e 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -7,40 +7,45 @@
 \date{1998-1999}
 \maketitle
 
-\abstract{Thorn IOASCII provides an IO method for 1D and 2D output of
+\abstract{Thorn IOASCII provides I/O methods for 1D, 2D, and 3D output of
 grid arrays into files in ASCII format.}
 
 \section{Purpose}
-Thorn IOASCII registers two IO methods named {\tt IOASCII\_1D} and
-{\tt IOASCII\_2D} with the IO interface in the flesh.\\
-{\tt IOASCII\_1D} creates one-dimensional output of 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 x, y, and z directions.
-If your grid is cubed it will also slice in the diagonal direction.
-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]l"}. These files can be processed directly by either
-xgraph or gnuplot (you can select the style of output via parameter
-settings).\\\\
+Thorn 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{enumerate}
+  \item {\tt IOASCII\_1D} creates one-dimensional output of 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 x, y, and z directions.
+    If your grid is cubed it will also slice in the diagonal direction.
+    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]l"}. 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 as xy, xz, and yz 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"}. 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>\_2D.asc"}. These files can be visualized by gnuplot using
+    its {\it splot} command.
+\end{enumerate}
 %
-{\tt IOASCII\_2D} outputs two-dimensional slices of grid functions and arrays
-as xy, xz, and yz 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"}. These files can be visualized
-by gnuplot using its {\it splot} command.
-%
-\newline
-%
-You obtain output by an IO method by either
+You obtain output by an I/O method by either
 %
 \begin{itemize}
-  \item setting the appropriate IO parameters
-  \item calling one the routines of the IO function interface provided by the flesh
+  \item setting the appropriate I/O parameters
+  \item calling one the routines of the I/O function interface provided by the flesh
 \end{itemize}
 %
-For a description of basic IO parameters and the IO function interface to
-invoke IO methods by application thorns please see the documentation of thorn
+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.
 %
 \section{Comments}
@@ -52,7 +57,7 @@ IMPORTANT: Must select data to output AFTER spatial coordinates are set up
 
 %
 Since IOASCII uses parameters from IOUtil
-it also needs this IO skeleton thorn be compiled into Cactus and activated.
+it also needs this I/O utility thorn be compiled into Cactus and activated.
 
 \section{Examples}