aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorallen <allen@94b1c47f-dcfd-45ef-a468-0854c0e9e350>2002-08-19 12:20:59 +0000
committerallen <allen@94b1c47f-dcfd-45ef-a468-0854c0e9e350>2002-08-19 12:20:59 +0000
commit24db0947e933975b5b0059632f1687ccb48511b2 (patch)
tree19919c43367dedac92dc52e8e17b09f20f14ad9e
parent9d575ec3c80e048917a3672f520b225b27db8470 (diff)
formatting changes
git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOASCII/trunk@130 94b1c47f-dcfd-45ef-a468-0854c0e9e350
-rw-r--r--doc/documentation.tex38
1 files changed, 29 insertions, 9 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 719132a..73ba4dc 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -8,7 +8,7 @@
\begin{document}
-\title{IOASCII}
+\title{Simple Plain Text Output with IOASCII}
\author{Thomas Radke, Gabrielle Allen}
\date{$ $Date$ $}
@@ -19,13 +19,16 @@
\begin{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}.
+grid arrays and grid functions into files in ASCII format. The precise
+format is designed for visualisation using the clients {\tt
+xgraph}~\cite{cactusbase_ioascii_xgraph} or {\tt
+gnuplot}~\cite{cactusbase_ioascii_gnuplot}.
\end{abstract}
\section{Purpose}
-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.
+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}\\
@@ -38,9 +41,13 @@ Thorn {\bf IOASCII} registers three I/O methods named {\tt IOASCII\_1D}, {\tt IO
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
+ Data is written in ASCII format and goes into files with the names:
+ \begin{center}
{\tt <variable\_name>\_<slice>\_[<center\_i>][<center\_j>].\{asc|xg\}}
- and {\tt <variable\_name>\_3D\_diagonal.\{asc|xg\}} for diagonals.\\
+ \end{center}
+ and for diagonals:
+ \begin{center}{\tt <variable\_name>\_3D\_diagonal.\{asc|xg\}}
+ \end{center}
These files can be processed directly by either xgraph or gnuplot
(you can select the style of output via parameter settings).
@@ -49,13 +56,17 @@ Thorn {\bf IOASCII} registers three I/O methods named {\tt IOASCII\_1D}, {\tt IO
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\}}.\\
+\begin{center}
+ {\tt <variable\_name>\_<plane>\_[<center>].\{asc|xg\}}
+\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 <variable\_name>\_3D.\{asc|xg\}}.\\
+\begin{center}
+ {\tt <variable\_name>\_3D.\{asc|xg\}}
+\end{center}
These files can be visualized by gnuplot using its {\it splot} command.
\end{itemize}
%
@@ -393,6 +404,15 @@ These options produce data suitable for using with the gnuplot visualization cli
0.5000000000000 0.5000000000000 0.5000000000000 0.0000000008425
\end{verbatim}
+\begin{thebibliography}{9}
+
+\bibitem{cactusbase_ioascii_xgraph}
+{\tt http://www.cactuscode.org/VizTools/xgraph.html}, {\tt http://jean-luc.aei.mpg.de/Codes/xgraph/}
+
+\bibitem{cactusbase_ioascii_gnuplot}
+{\tt http://www.cactuscode.org/VizTools/Gnuplot.html}, {\tt http://www.gnuplot.info}
+\end{thebibliography}
+
% Do not delete next line
% END CACTUS THORNGUIDE