fdurastante/amg4psblas
1
0
Fork 0
mirror of https://github.com/sfilippone/amg4psblas.git synced 2026-10-06 14:44:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix docs for new samples

Browse Source
This commit is contained in:
Salvatore Filippone
2021-05-13 11:36:28 +02:00
parent 4bf009a1ab
commit 941ca6568a
3 changed files with 23 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/amg4psblas_1.0-guide.pdf
BIN
View File
Binary file not shown.
docs/html/userhtmlsu5.html
+19 -18
View File
@@ -29,40 +29,41 @@ class="cmr-12">3.5 </span></span> <a
id="x13-120003.5"></a><span
class="cmr-12">Example and test programs</span></h4>
<!--l. 200--><p class="noindent" ><span
class="cmr-12">The package contains the </span><span class="obeylines-h"><span class="verb"><span
class="cmtt-12">examples</span></span></span> <span
class="cmr-12">and </span><span class="obeylines-h"><span class="verb"><span
class="cmtt-12">tests</span></span></span> <span
class="cmr-12">directories; both of them are</span>
<span
class="cmr-12">further divided into </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">samples</span></span></span> <span
class="cmr-12">directory, divided in two subdirs </span><span class="obeylines-h"><span class="verb"><span
class="cmtt-12">simple</span></span></span> <span
class="cmr-12">and</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="cmr-12">and </span><span class="obeylines-h"><span class="verb"><span
class="cmtt-12">pdegen</span></span></span> <span
class="cmr-12">subdirectories. Their purpose is as</span>
class="cmr-12">subdirectories.</span>
<span
class="cmr-12">follows:</span>
class="cmr-12">Their purpose is as follows:</span>
<dl class="description"><dt class="description">
<span
class="cmtt-12">examples</span> </dt><dd
class="cmtt-12">simple</span> </dt><dd
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
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
class="cmr-12">acquainted with the multilevel preconditioners available in AMG4PSBLAS.</span>
</dd><dt class="description">
<span
class="cmtt-12">tests</span> </dt><dd
class="cmtt-12">advanced</span> </dt><dd
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
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="cmr-12">subdirectories, to experiment with the full range</span>
class="cmr-12">subdirectories, to experiment with the full</span>
<span
class="cmr-12">of preconditioners implemented in the package.</span></dd></dl>
<!--l. 213--><p class="noindent" ><span
class="cmr-12">range of preconditioners implemented in the package.</span></dd></dl>
<!--l. 214--><p class="noindent" ><span
class="cmr-12">The </span><span class="obeylines-h"><span class="verb"><span
class="cmtt-12">fileread</span></span></span> <span
class="cmr-12">directories contain sample programs that read sparse matrices from files,</span>
docs/src/building.tex
+4 -3
View File
@@ -197,15 +197,16 @@ application, the test conditions, and ideally a self-contained test
program reproducing the issue.
\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
\verb|pdegen| subdirectories. Their purpose is as follows:
\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
values. These are intended to get acquainted with the
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|
subdirectories, to experiment with the full range of preconditioners
implemented in the package.