aboutsummaryrefslogtreecommitdiff
path: root/doc/documentation.tex
blob: 2563c0b56cf45bdd2966bf19624025b05d39c8c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
% 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}

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.
%
% Automatically created from the ccl files 
% Do not worry for now.
\include{interface}
\include{param}
\include{schedule}

\end{document}