Fix docs for new samples

maint-1.0
Salvatore Filippone 4 years ago
parent 4bf009a1ab
commit 941ca6568a

Binary file not shown.

@ -29,40 +29,41 @@ class="cmr-12">3.5 </span></span> <a
id="x13-120003.5"></a><span id="x13-120003.5"></a><span
class="cmr-12">Example and test programs</span></h4> class="cmr-12">Example and test programs</span></h4>
<!--l. 200--><p class="noindent" ><span <!--l. 200--><p class="noindent" ><span
class="cmr-12">The package contains the </span><span class="obeylines-h"><span class="verb"><span class="cmr-12">The package contains a </span><span class="obeylines-h"><span class="verb"><span
class="cmtt-12">examples</span></span></span> <span class="cmtt-12">samples</span></span></span> <span
class="cmr-12">and </span><span class="obeylines-h"><span class="verb"><span class="cmr-12">directory, divided in two subdirs </span><span class="obeylines-h"><span class="verb"><span
class="cmtt-12">tests</span></span></span> <span class="cmtt-12">simple</span></span></span> <span
class="cmr-12">directories; both of them are</span> class="cmr-12">and</span>
<span <span class="obeylines-h"><span class="verb"><span
class="cmr-12">further divided into </span><span class="obeylines-h"><span class="verb"><span class="cmtt-12">advanced</span></span></span><span
class="cmr-12">; both of them are further divided into </span><span class="obeylines-h"><span class="verb"><span
class="cmtt-12">fileread</span></span></span> <span class="cmtt-12">fileread</span></span></span> <span
class="cmr-12">and </span><span class="obeylines-h"><span class="verb"><span class="cmr-12">and </span><span class="obeylines-h"><span class="verb"><span
class="cmtt-12">pdegen</span></span></span> <span class="cmtt-12">pdegen</span></span></span> <span
class="cmr-12">subdirectories. Their purpose is as</span> class="cmr-12">subdirectories.</span>
<span <span
class="cmr-12">follows:</span> class="cmr-12">Their purpose is as follows:</span>
<dl class="description"><dt class="description"> <dl class="description"><dt class="description">
<span <span
class="cmtt-12">examples</span> </dt><dd class="cmtt-12">simple</span> </dt><dd
class="description"><span class="description"><span
class="cmr-12">contains a set of simple example programs with a predefined choice</span> class="cmr-12">contains a set of simple example programs with a predefined choice of</span>
<span <span
class="cmr-12">of preconditioners, selectable via integer values. These are intended to get</span> class="cmr-12">preconditioners, selectable via integer values. These are intended to get</span>
<span <span
class="cmr-12">acquainted with the multilevel preconditioners available in AMG4PSBLAS.</span> class="cmr-12">acquainted with the multilevel preconditioners available in AMG4PSBLAS.</span>
</dd><dt class="description"> </dd><dt class="description">
<span <span
class="cmtt-12">tests</span> </dt><dd class="cmtt-12">advanced</span> </dt><dd
class="description"><span class="description"><span
class="cmr-12">contains a set of more sophisticated examples that will allow the user, via</span> class="cmr-12">contains a set of more sophisticated examples that will allow the user,</span>
<span <span
class="cmr-12">the input files in the </span><span class="obeylines-h"><span class="verb"><span class="cmr-12">via the input files in the </span><span class="obeylines-h"><span class="verb"><span
class="cmtt-12">runs</span></span></span> <span class="cmtt-12">runs</span></span></span> <span
class="cmr-12">subdirectories, to experiment with the full range</span> class="cmr-12">subdirectories, to experiment with the full</span>
<span <span
class="cmr-12">of preconditioners implemented in the package.</span></dd></dl> class="cmr-12">range of preconditioners implemented in the package.</span></dd></dl>
<!--l. 213--><p class="noindent" ><span <!--l. 214--><p class="noindent" ><span
class="cmr-12">The </span><span class="obeylines-h"><span class="verb"><span class="cmr-12">The </span><span class="obeylines-h"><span class="verb"><span
class="cmtt-12">fileread</span></span></span> <span class="cmtt-12">fileread</span></span></span> <span
class="cmr-12">directories contain sample programs that read sparse matrices from files,</span> class="cmr-12">directories contain sample programs that read sparse matrices from files,</span>

@ -197,15 +197,16 @@ application, the test conditions, and ideally a self-contained test
program reproducing the issue. program reproducing the issue.
\subsection{Example and test programs\label{sec:ex_and_test}} \subsection{Example and test programs\label{sec:ex_and_test}}
The package contains the \verb|examples| and \verb|tests| directories; The package contains a \verb|samples| directory, divided in two
subdirs \verb|simple| and \verb|advanced|;
both of them are further divided into \verb|fileread| and both of them are further divided into \verb|fileread| and
\verb|pdegen| subdirectories. Their purpose is as follows: \verb|pdegen| subdirectories. Their purpose is as follows:
\begin{description} \begin{description}
\item[\tt examples] contains a set of simple example programs with a \item[\tt simple] contains a set of simple example programs with a
predefined choice of preconditioners, selectable via integer predefined choice of preconditioners, selectable via integer
values. These are intended to get acquainted with the values. These are intended to get acquainted with the
multilevel preconditioners available in AMG4PSBLAS. multilevel preconditioners available in AMG4PSBLAS.
\item[\tt tests] contains a set of more sophisticated examples that \item[\tt advanced] contains a set of more sophisticated examples that
will allow the user, via the input files in the \verb|runs| will allow the user, via the input files in the \verb|runs|
subdirectories, to experiment with the full range of preconditioners subdirectories, to experiment with the full range of preconditioners
implemented in the package. implemented in the package.

Loading…
Cancel
Save