Doc fixes

This commit is contained in:
Salvatore Filippone
2021-03-29 14:12:56 +02:00
parent 859714ca70
commit 718b574519
34 changed files with 988 additions and 1500 deletions
+23 -23
View File
@@ -29,7 +29,7 @@ class="cmr-12">up</span></a><span
class="cmr-12">] </span></p></div>
<h3 class="sectionHead"><span class="titlemark"><span
class="cmr-12">4 </span></span> <a
id="x13-120004"></a><span
id="x14-130004"></a><span
class="cmr-12">Getting Started</span></h3>
<!--l. 5--><p class="noindent" ><span
class="cmr-12">This section describes the basics for building and applying AMG4PSBLAS one-level</span>
@@ -38,7 +38,7 @@ class="cmr-12">and multilevel (i.e., AMG) preconditioners with the Krylov solver
<span
class="cmr-12">PSBLAS </span><span class="cite"><span
class="cmr-12">[</span><a
href="userhtmlli4.html#XPSBLASGUIDE"><span
href="userhtmlli5.html#XPSBLASGUIDE"><span
class="cmr-12">17</span></a><span
class="cmr-12">]</span></span><span
class="cmr-12">.</span>
@@ -46,7 +46,7 @@ class="cmr-12">.</span>
class="cmr-12">The following steps are required:</span>
<ol class="enumerate1" >
<li
class="enumerate" id="x13-12002x1"><span
class="enumerate" id="x14-13002x1"><span
class="cmti-12">Declare the preconditioner data structure</span><span
class="cmr-12">. It is a derived data type,</span>
<span class="obeylines-h"><span class="verb"><span
@@ -82,7 +82,7 @@ class="cmr-12">structure is accessed by the user only through the AMG4PSBLAS rou
class="cmr-12">following an object-oriented approach.</span>
</li>
<li
class="enumerate" id="x13-12004x2"><span
class="enumerate" id="x14-13004x2"><span
class="cmti-12">Allocate and initialize the preconditioner data structure, according to a</span>
<span
class="cmti-12">preconditioner type chosen by the user</span><span
@@ -95,7 +95,7 @@ class="cmr-12">the user. The preconditioner types and the defaults associated wi
<span
class="cmr-12">are given in Table</span><span
class="cmr-12">&#x00A0;</span><a
href="#x13-12015r1"><span
href="#x14-13015r1"><span
class="cmr-12">1</span><!--tex4ht:ref: tab:precinit --></a><span
class="cmr-12">, where the strings used by </span><span class="lstinline"></span><span
class="cmtt-12">init</span> <span
@@ -106,7 +106,7 @@ class="cmr-12">preconditioner types are also given. Note that these strings are
class="cmr-12">uppercase letters are substituted by corresponding lowercase ones.</span>
</li>
<li
class="enumerate" id="x13-12006x3"><span
class="enumerate" id="x14-13006x3"><span
class="cmti-12">Modify the selected preconditioner type, by properly setting preconditioner</span>
<span
class="cmti-12">parameters. </span><span
@@ -122,7 +122,7 @@ class="cmr-12">preconditioner. Examples of use of </span><span class="lstinline"
class="cmtt-12">set</span> <span
class="cmr-12">are given in Section</span><span
class="cmr-12">&#x00A0;</span><a
href="userhtmlsu6.html#x14-130004.1"><span
href="userhtmlsu6.html#x15-140004.1"><span
class="cmr-12">4.1</span><!--tex4ht:ref: sec:examples --></a><span
class="cmr-12">; a complete</span>
<span
@@ -130,19 +130,19 @@ class="cmr-12">list of all the preconditioner parameters and their allowed and d
<span
class="cmr-12">is provided in Section</span><span
class="cmr-12">&#x00A0;</span><a
href="userhtmlse5.html#x15-140005"><span
href="userhtmlse5.html#x16-150005"><span
class="cmr-12">5</span><!--tex4ht:ref: sec:userinterface --></a><span
class="cmr-12">, Tables</span><span
class="cmr-12">&#x00A0;</span><a
href="userhtmlsu8.html#x17-16009r2"><span
href="userhtmlsu8.html#x18-17009r2"><span
class="cmr-12">2</span><!--tex4ht:ref: tab:p_cycle --></a><span
class="cmr-12">-</span><a
href="userhtmlsu8.html#x17-16014r7"><span
href="userhtmlsu8.html#x18-17014r7"><span
class="cmr-12">7</span><!--tex4ht:ref: tab:p_smoother_1 --></a><span
class="cmr-12">.</span>
</li>
<li
class="enumerate" id="x13-12008x4"><span
class="enumerate" id="x14-13008x4"><span
class="cmti-12">Build the preconditioner for a given matrix</span><span
class="cmr-12">. If the selected preconditioner is</span>
<span
@@ -152,7 +152,7 @@ class="cmr-12">multilevel, then two steps must be performed, as specified next.<
<ol class="enumerate2" >
<li
class="enumerate" id="x13-12009x0"><span
class="enumerate" id="x14-13009x0"><span
class="cmti-12">Build the AMG hierarchy for a given matrix. </span><span
class="cmr-12">This is performed by the</span>
<span
@@ -161,7 +161,7 @@ class="cmtt-12">hierarchy_build</span><span
class="cmr-12">.</span>
</li>
<li
class="enumerate" id="x13-12010x0"><span
class="enumerate" id="x14-13010x0"><span
class="cmti-12">Build the preconditioner for a given matrix. </span><span
class="cmr-12">This is performed by the</span>
<span
@@ -176,7 +176,7 @@ class="cmtt-12">bld</span><span
class="cmr-12">.</span>
</li>
<li
class="enumerate" id="x13-12012x5"><span
class="enumerate" id="x14-13012x5"><span
class="cmti-12">Apply the preconditioner at each iteration of a Krylov solver. </span><span
class="cmr-12">This is performed by</span>
<span
@@ -193,7 +193,7 @@ class="cmtt-12">psb_krylov</span><span
class="cmr-12">).</span>
</li>
<li
class="enumerate" id="x13-12014x6"><span
class="enumerate" id="x14-13014x6"><span
class="cmti-12">Free the preconditioner data structure</span><span
class="cmr-12">. This is performed by the routine </span><span class="lstinline"></span><span
class="cmtt-12">free</span><span
@@ -207,13 +207,13 @@ class="cmr-12">All the previous routines are available as methods of the precond
<span
class="cmr-12">detailed description of them is given in Section</span><span
class="cmr-12">&#x00A0;</span><a
href="userhtmlse5.html#x15-140005"><span
href="userhtmlse5.html#x16-150005"><span
class="cmr-12">5</span><!--tex4ht:ref: sec:userinterface --></a><span
class="cmr-12">. Examples showing the basic use of</span>
<span
class="cmr-12">AMG4PSBLAS are reported in Section</span><span
class="cmr-12">&#x00A0;</span><a
href="userhtmlsu6.html#x14-130004.1"><span
href="userhtmlsu6.html#x15-140004.1"><span
class="cmr-12">4.1</span><!--tex4ht:ref: sec:examples --></a><span
class="cmr-12">.</span>
<div class="table">
@@ -221,7 +221,7 @@ class="cmr-12">.</span>
<!--l. 63--><p class="indent" > <a
id="x13-12015r1"></a><hr class="float"><div class="float"
id="x14-13015r1"></a><hr class="float"><div class="float"
>
@@ -381,8 +381,8 @@ smoothed aggregation as coarsening
algorithm, and LU (plus triangular solve)
as coarsest-level solver. See the default
values in Tables&#x00A0;<a
href="userhtmlsu8.html#x17-16009r2">2<!--tex4ht:ref: tab:p_cycle --></a>-<a
href="userhtmlsu8.html#x17-16014r7">7<!--tex4ht:ref: tab:p_smoother_1 --></a> for further details of
href="userhtmlsu8.html#x18-17009r2">2<!--tex4ht:ref: tab:p_cycle --></a>-<a
href="userhtmlsu8.html#x18-17014r7">7<!--tex4ht:ref: tab:p_smoother_1 --></a> for further details of
the preconditioner. </td>
</tr><tr
class="hline"><td><hr></td><td><hr></td><td><hr></td></tr><tr
@@ -390,7 +390,7 @@ class="hline"><td><hr></td><td><hr></td><td><hr></td></tr><tr
class="td11"> </td></tr></table></div>
<br /> <div class="caption"
><span class="id">Table&#x00A0;1: </span><span
class="content">Preconditioner types, corresponding strings and default choices. </span></div><!--tex4ht:label?: x13-12015r1 -->
class="content">Preconditioner types, corresponding strings and default choices. </span></div><!--tex4ht:label?: x14-13015r1 -->
</div>
@@ -414,7 +414,7 @@ class="cmr-12">,</span>
<span
class="cmr-12">for interfacing with the Krylov solvers, must be also used (see Section</span><span
class="cmr-12">&#x00A0;</span><a
href="userhtmlsu6.html#x14-130004.1"><span
href="userhtmlsu6.html#x15-140004.1"><span
class="cmr-12">4.1</span><!--tex4ht:ref: sec:examples --></a><span
class="cmr-12">).</span>
<br
@@ -437,7 +437,7 @@ class="cmr-12">on parallel computers.</span>
<span
class="cmr-12">&#x00A0;</span><span class="subsectionToc" ><span
class="cmr-12">4.1 </span><a
href="userhtmlsu6.html#x14-130004.1"><span
href="userhtmlsu6.html#x15-140004.1"><span
class="cmr-12">Examples</span></a></span>
</div>