Adding example output and parameters

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

1 files changed, 297 insertions, 0 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 2563c0b..013ff8e 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -46,9 +46,306 @@ 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.
+
+\section{Examples}
+
+In this section we include example output for different parameter combinations. 
+Note that all these examples were generated for just a couple of timesteps for an extremely small 3D grid.
+
+\subsection{One dimensional xgraph}
+
+These options produce data suitable for using with the xgraph visualization client 
+in the format 
+{\tt
+\begin{verbatim}
+x f(t=fixed,x,y=fixed,z=fixed)
+\end{verbatim}
+}
+
+
+{\tt
+\begin{verbatim}
+IOASCII::out1D_every = 1
+IOASCII::out1D_vars = "wavetoy::phi"
+IOASCII::out1D_style = "xgraph"
+\end{verbatim}
+}
+
+\noindent
+{\bf Output File: phi.xl}
+
+{\tt
+\begin{verbatim}
+"Parameter file wavetoy.par
+"Created Sun 19 Aug 2001 16:31:43
+"x-label x
+"y-label WAVETOY::phi (y = 0.0000000000000, z = 0.0000000000000), (yi = 1, zi = 1) 
+
+
+"Time = 0.0000000000000
+-0.5000000000000		0.0000000000139
+0.0000000000000		1.0000000000000
+0.5000000000000		0.0000000000139
+
+
+"Time = 0.2500000000000
+-0.5000000000000		0.0000000000000
+0.0000000000000		0.4980695458846
+0.5000000000000		0.0000000000000
+
+
+"Time = 0.5000000000000
+-0.5000000000000		0.0019304541362
+0.0000000000000		-0.7509652270577
+0.5000000000000		0.0019304541362
+\end{verbatim}
+}
+
+\subsection{One dimensional gnuplot}
+
+These options produce data suitable for using with the gnuplot visualization client in the format
+{\tt
+\begin{verbatim}
+x f(t,x,y=fixed,z=fixed)
+\end{verbatim}
+}
+
+
+{\tt
+\begin{verbatim}
+IOASCII::out1D_every = 1
+IOASCII::out1D_vars = "wavetoy::phi"
+IOASCII::out1D_style = "gnuplot f(x)"
+\end{verbatim}
+}
+
+\noindent
+{\bf Output File: phi.xl}
+
+{\tt
+\begin{verbatim}
+#Parameter file wavetoy.par
+#Created Sun 19 Aug 2001 16:33:07
+#x-label x
+#y-label WAVETOY::phi (y = 0.0000000000000, z = 0.0000000000000), (yi = 1, zi = 1) 
+
+#Time = 0.0000000000000
+-0.5000000000000		0.0000000000139
+0.0000000000000		1.0000000000000
+0.5000000000000		0.0000000000139
+
+#Time = 0.2500000000000
+-0.5000000000000		0.0000000000000
+0.0000000000000		0.4980695458846
+0.5000000000000		0.0000000000000
+
+#Time = 0.5000000000000
+-0.5000000000000		0.0019304541362
+0.0000000000000		-0.7509652270577
+0.5000000000000		0.0019304541362
+\end{verbatim}
+}
+
+
+\subsection{One dimensional gnuplot (including time)}
+
+These options produce data suitable for using with the gnuplot visualization client in the format
+{\tt
+\begin{verbatim}
+t x f(t,x,y=fixed,z=fixed)
+\end{verbatim}
+}
+
+{\tt
+\begin{verbatim}
+IOASCII::out1D_every = 1
+IOASCII::out1D_vars = "wavetoy::phi"
+IOASCII::out1D_style = "gnuplot f(t,x)"
+\end{verbatim}
+}
+
+\noindent
+{\bf Output file: phi.xl}
+{\tt
+\begin{verbatim}
+#Parameter file wavetoy.par
+#Created Sun 19 Aug 2001 16:34:48
+#x-label x
+#y-label WAVETOY::phi (y = 0.0000000000000, z = 0.0000000000000), (yi = 1, zi = 1) 
+
+#Time = 0.0000000000000
+0.0000000000000		-0.5000000000000		0.0000000000139
+0.0000000000000		0.0000000000000		1.0000000000000
+0.0000000000000		0.5000000000000		0.0000000000139
+
+#Time = 0.2500000000000
+0.2500000000000		-0.5000000000000		0.0000000000000
+0.2500000000000		0.0000000000000		0.4980695458846
+0.2500000000000		0.5000000000000		0.0000000000000
+
+#Time = 0.5000000000000
+0.5000000000000		-0.5000000000000		0.0019304541362
+0.5000000000000		0.0000000000000		-0.7509652270577
+0.5000000000000		0.5000000000000		0.0019304541362
+\end{verbatim}
+}
+
+\subsection{Two dimensional gnuplot}
+
+These options produce data suitable for using with the gnuplot visualization client in the format
+{\tt
+\begin{verbatim}
+x y f(t,x,y,z=fixed)
+\end{verbatim}
+}
+
+
+{\tt
+\begin{verbatim}
+IOASCII::out2D_every = 1
+IOASCII::out2D_vars = "wavetoy::phi"
+IOASCII::out2D_style = "gnuplot f(x,y)"
+\end{verbatim}
+}
+
+\noindent
+{\bf Output file: phi\_2d\_xy.gnuplot}
+{\tt
+\begin{verbatim}
+#Parameter file wavetoy.par
+#Created Sun 19 Aug 2001 16:31:43
+#x-label x
+#y-label y
+#z-label WAVETOY::phi (z = 0.0000000000000), (zi = 1)
+
+
+#Time = 0.0000000000000
+-0.5000000000000		-0.5000000000000		0.0000000000000
+0.0000000000000		-0.5000000000000		0.0000000000139
+0.5000000000000		-0.5000000000000		0.0000000000000
+
+-0.5000000000000		0.0000000000000		0.0000000000139
+0.0000000000000		0.0000000000000		1.0000000000000
+0.5000000000000		0.0000000000000		0.0000000000139
+
+-0.5000000000000		0.5000000000000		0.0000000000000
+0.0000000000000		0.5000000000000		0.0000000000139
+0.5000000000000		0.5000000000000		0.0000000000000
+
+
+
+#Time = 0.2500000000000
+-0.5000000000000		-0.5000000000000		0.0000000000000
+0.0000000000000		-0.5000000000000		0.0000000000000
+0.5000000000000		-0.5000000000000		0.0000000000000
+
+-0.5000000000000		0.0000000000000		0.0000000000000
+0.0000000000000		0.0000000000000		0.4980695458846
+0.5000000000000		0.0000000000000		0.0000000000000
+
+-0.5000000000000		0.5000000000000		0.0000000000000
+0.0000000000000		0.5000000000000		0.0000000000000
+0.5000000000000		0.5000000000000		0.0000000000000
+
+
+
+#Time = 0.5000000000000
+-0.5000000000000		-0.5000000000000		0.0000000008425
+0.0000000000000		-0.5000000000000		0.0019304541362
+0.5000000000000		-0.5000000000000		0.0000000008425
+
+-0.5000000000000		0.0000000000000		0.0019304541362
+0.0000000000000		0.0000000000000		-0.7509652270577
+0.5000000000000		0.0000000000000		0.0019304541362
+
+-0.5000000000000		0.5000000000000		0.0000000008425
+0.0000000000000		0.5000000000000		0.0019304541362
+0.5000000000000		0.5000000000000		0.0000000008425
+\end{verbatim}
+}
+
+\subsection{Two dimensional gnuplot (including time)}
+
+These options produce data suitable for using with the gnuplot visualization client in the format
+{\tt
+\begin{verbatim}
+t x y f(t,x,y,z=fixed)
+\end{verbatim}
+}
+
+
+
+{\tt
+\begin{verbatim}
+IOASCII::out2D_every = 1
+IOASCII::out2D_vars = "wavetoy::phi"
+IOASCII::out2D_style = "gnuplot f(t,x,y)"
+\end{verbatim}
+}
+
+\noindent
+{\bf Output file: phi\_2d\_xy.gnuplot}
+{\tt
+\begin{verbatim}
+#Parameter file wavetoy.par
+#Created Sun 19 Aug 2001 16:33:07
+#x-label x
+#y-label y
+#z-label WAVETOY::phi (z = 0.0000000000000), (zi = 1)
+
+
+#Time = 0.0000000000000
+0.0000000000000		-0.5000000000000		-0.5000000000000		0.0000000000000
+0.0000000000000		0.0000000000000		-0.5000000000000		0.0000000000139
+0.0000000000000		0.5000000000000		-0.5000000000000		0.0000000000000
+
+0.0000000000000		-0.5000000000000		0.0000000000000		0.0000000000139
+0.0000000000000		0.0000000000000		0.0000000000000		1.0000000000000
+0.0000000000000		0.5000000000000		0.0000000000000		0.0000000000139
+
+0.0000000000000		-0.5000000000000		0.5000000000000		0.0000000000000
+0.0000000000000		0.0000000000000		0.5000000000000		0.0000000000139
+0.0000000000000		0.5000000000000		0.5000000000000		0.0000000000000
+
+
+
+#Time = 0.2500000000000
+0.2500000000000		-0.5000000000000		-0.5000000000000		0.0000000000000
+0.2500000000000		0.0000000000000		-0.5000000000000		0.0000000000000
+0.2500000000000		0.5000000000000		-0.5000000000000		0.0000000000000
+
+0.2500000000000		-0.5000000000000		0.0000000000000		0.0000000000000
+0.2500000000000		0.0000000000000		0.0000000000000		0.4980695458846
+0.2500000000000		0.5000000000000		0.0000000000000		0.0000000000000
+
+0.2500000000000		-0.5000000000000		0.5000000000000		0.0000000000000
+0.2500000000000		0.0000000000000		0.5000000000000		0.0000000000000
+0.2500000000000		0.5000000000000		0.5000000000000		0.0000000000000
+
+
+
+#Time = 0.5000000000000
+0.5000000000000		-0.5000000000000		-0.5000000000000		0.0000000008425
+0.5000000000000		0.0000000000000		-0.5000000000000		0.0019304541362
+0.5000000000000		0.5000000000000		-0.5000000000000		0.0000000008425
+
+0.5000000000000		-0.5000000000000		0.0000000000000		0.0019304541362
+0.5000000000000		0.0000000000000		0.0000000000000		-0.7509652270577
+0.5000000000000		0.5000000000000		0.0000000000000		0.0019304541362
+
+0.5000000000000		-0.5000000000000		0.5000000000000		0.0000000008425
+0.5000000000000		0.0000000000000		0.5000000000000		0.0019304541362
+0.5000000000000		0.5000000000000		0.5000000000000		0.0000000008425
+\end{verbatim}
+}
+
 %
 % Automatically created from the ccl files 
 % Do not worry for now.