File: drivers.tex

package info (click to toggle)
spooles 2.2-5
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 18,824 kB
  • ctags: 3,665
  • sloc: ansic: 146,828; csh: 3,615; makefile: 2,045; perl: 70
file content (76 lines) | stat: -rw-r--r-- 2,926 bytes parent folder | download | duplicates (7)
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
\par
\section{Driver programs for the {\tt Coords} object}
\label{section:Coords:drivers}
\par
This section contains brief descriptions of the driver programs.
\par
%=======================================================================
\begin{enumerate}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testIO msglvl msgFile inFile outFile
\end{verbatim}
This driver program reads and write {\tt Coords} files, useful for
converting formatted files to binary files and vice versa.
One can also read in a {\tt Coords} file and print out just the 
header information (see the {\tt Coords\_writeStats()} method).
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output ---
taking {\tt msglvl >= 3} means the {\tt Coords} object is written
to the message file.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt inFile} parameter is the input file for the {\tt Coords}
object. It must be of the form {\tt *.coordsf} or {\tt *.coordsb}.
The {\tt Coords} object is read from the file via the
{\tt Coords\_readFromFile()} method.
\item
The {\tt outFile} parameter is the output file for the {\tt Coords}
object. 
If {\tt outFile} is {\tt none} then the {\tt Coords} object is not
written to a file. 
Otherwise, the {\tt Coords\_writeToFile()} method is called to write
the object to 
a formatted file (if {\tt outFile} is of the form {\tt *.coordsf}),
or
a binary file (if {\tt outFile} is of the form {\tt *.coordsb}).
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
mk9PCoords msglvl msgFile n1 n2 outCoordsFile
\end{verbatim}
This driver program creates a {\tt Coords} object 
for 9-point finite difference operator on 
a $\mbox{\tt n1} \times \mbox{\tt n2}$ grid
and optionally writes it to a file.
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output ---
taking {\tt msglvl >= 3} means that all objects are written
to the message file.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
message data.
\item
The {\tt outCoordsFile} parameter is the output file for the 
{\tt Coords} object. 
If {\tt outCoordsFile} is {\tt none} then the {\tt Coords} object 
is not written to a file. 
Otherwise, the {\tt Coords\_writeToFile()} method is called to write
the object to 
a formatted file (if {\tt outCoordsFile} 
is of the form {\tt *.coordsf}), or
a binary file (if {\tt outCoordsFile} is of the form {\tt *.coordsb}).
\end{itemize}
%-----------------------------------------------------------------------
\end{enumerate}