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
|
\par
\section{Driver programs for the {\tt EGraph} object}
\label{section:EGraph: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 writes {\tt EGraph} files, useful for
converting formatted files to binary files and vice versa.
One can also read in a {\tt EGraph} file and print out just the
header information (see the {\tt EGraph\_writeStats()} method).
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output ---
taking {\tt msglvl >= 3} means the {\tt EGraph} 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 EGraph}
object. It must be of the form {\tt *.egraphf} or {\tt *.egraphb}.
The {\tt EGraph} object is read from the file via the
{\tt EGraph\_readFromFile()} method.
\item
The {\tt outFile} parameter is the output file for the {\tt EGraph}
object.
If {\tt outFile} is {\tt none} then the {\tt EGraph} object is not
written to a file.
Otherwise, the {\tt EGraph\_writeToFile()} method is called to write
the object to
a formatted file (if {\tt outFile} is of the form {\tt *.egraphf}),
or
a binary file (if {\tt outFile} is of the form {\tt *.egraphb}).
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
mkGraph msglvl msgFile inEGraphFile outGraphFile
\end{verbatim}
This driver program reads in an {\tt EGraph} object and creates a
{\tt Graph} object, which is then optionally written out to a file.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output ---
taking {\tt msglvl >= 3} means the {\tt EGraph} 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 inEGraphFile} parameter is the input file for the {\tt EGraph}
object. It must be of the form {\tt *.egraphf} or {\tt *.egraphb}.
The {\tt EGraph} object is read from the file via the
{\tt EGraph\_readFromFile()} method.
\item
The {\tt outGraphFile} parameter is the output file for the
{\tt Graph} object.
If {\tt outGraphFile} is {\tt none} then the {\tt Graph} object is not
written to a file.
Otherwise, the {\tt Graph\_writeToFile()} method is called to write
the object to
a formatted file (if {\tt outGraphFile} is of the form
{\tt *.graphf}),
or
a binary file (if {\tt outGraphFile} is of the form {\tt *.graphb}).
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
mkGridEGraph msglvl msgFile n1 n2 n3 ncomp outEGraphFile
\end{verbatim}
This driver program creates an element graph for linear
quadrilateral elements if {\tt n3 = 1} or for linear hexahedral
elements if {\tt n3 > 1}.
There are {\tt ncomp} degrees of freedom at each grid point.
The {\tt EGraph} object is optionally written out 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
{\tt n1} is the number of grid points in the first direction,
must be greater than one.
\item
{\tt n2} is the number of grid points in the second direction,
must be greater than one.
\item
{\tt n3} is the number of grid points in the third direction,
must be greater than or equal to one.
\item
{\tt ncomp} is the number of components (i.e., the number of
degrees of freedom) at each grid point,
must be greater than or equal to one.
\item
The {\tt outEGraphFile} parameter
is the output file for the {\tt EGraph} object.
If {\tt outEGraphFile} is {\tt none} then
the {\tt EGraph} object is not written to a file.
Otherwise, the {\tt EGraph\_writeToFile()} method is called to write
the object to a formatted file (if {\tt outEGraphFile}
is of the form {\tt *.egraphf}), or
a binary file (if {\tt outEGraphFile} is of the form {\tt *.egraphb}).
\end{itemize}
%-----------------------------------------------------------------------
\end{enumerate}
|