Hopefully added all the new changes to IOASCII

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

1 files changed, 75 insertions, 25 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 85f070e..b78a39b 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -3,39 +3,89 @@
 \begin{document}
 
 \title{IOASCII}
-\author{Paul Walker}
-\date{1998-1999}
+\author{Thomas Radke, Gabrielle Allen}
+\date{December 2001}
 \maketitle
 
 \abstract{Thorn IOASCII provides I/O methods for 1D, 2D, and 3D output of
-grid arrays into files in ASCII format.}
+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
 {\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}
+\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.
+
+\end{itemize}
 %
 You obtain output by an I/O method by either
 %