From e84210459cfbed430d8dfd0f1b4d04e76c1b0f6f Mon Sep 17 00:00:00 2001
From: tradke <tradke@94b1c47f-dcfd-45ef-a468-0854c0e9e350>
Date: Fri, 2 Jun 2000 15:17:55 +0000
Subject: IOASCII using thorn Hyperslab. No PUGH in here anymore ! Also changed
 the output format to use tabs rather than spaces which reduces the output
 filesize by 1/3. Should still pass all testsuites (tested for the WaveToys).
 If everything else is okay we can move IOASCII into the IOBasic/ arrangement
 and remove CactusPUGHIO/IOASCII.

Also finally removed all the http stuff.



git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOASCII/trunk@2 94b1c47f-dcfd-45ef-a468-0854c0e9e350
---
 doc/documentation.tex | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 doc/documentation.tex

(limited to 'doc')

diff --git a/doc/documentation.tex b/doc/documentation.tex
new file mode 100644
index 0000000..cfd5919
--- /dev/null
+++ b/doc/documentation.tex
@@ -0,0 +1,57 @@
+% Thorn documentation template
+\documentclass{article}
+\begin{document}
+
+\title{IOASCII}
+\author{Paul Walker}
+\date{1998-1999}
+\maketitle
+
+\abstract{Thorn IOASCII provides an IO method for 1D and 2D 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).\\\\
+%
+{\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
+%
+\begin{itemize}
+  \item setting the appropriate IO parameters
+  \item calling one the routines of the IO 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
+IOUtil and the flesh.
+%
+\section{Comments}
+%
+Since IOASCII uses parameters from IOUtil
+it also needs this IO skeleton thorn be compiled into Cactus and activated.
+%
+% Automatically created from the ccl files 
+% Do not worry for now.
+\include{interface}
+\include{param}
+\include{schedule}
+
+\end{document}
-- 
cgit v1.2.3