aboutsummaryrefslogtreecommitdiff
path: root/doc/documentation.tex
blob: b78a39b896217dcda27a45b7a45979ac84a79ee1 (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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
% Thorn documentation template
\documentclass{article}
\begin{document}

\title{IOASCII}
\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. 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{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
%
\begin{itemize}
  \item setting the appropriate I/O parameters
  \item calling one the routines of the I/O function interface provided by the flesh
\end{itemize}
%
For a description of basic I/O parameters and the I/O function interface to
invoke I/O 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 I/O utility 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.
\include{interface}
\include{param}
\include{schedule}

\end{document}