|
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
|
|
|
|
|
"http://www.w3.org/TR/html4/loose.dtd">
|
|
|
|
|
<html >
|
|
|
|
|
<head><title>Method build</title>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
|
|
|
<meta name="generator" content="TeX4ht (https://tug.org/tex4ht/)">
|
|
|
|
|
<meta name="originator" content="TeX4ht (https://tug.org/tex4ht/)">
|
|
|
|
|
<!-- html,3 -->
|
|
|
|
|
<meta name="src" content="userhtml.tex">
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="userhtml.css">
|
|
|
|
|
</head><body
|
|
|
|
|
>
|
|
|
|
|
<!--l. 667--><div class="crosslinks"><p class="noindent"><span
|
|
|
|
|
class="cmr-12">[</span><a
|
|
|
|
|
href="userhtmlsu12.html" ><span
|
|
|
|
|
class="cmr-12">next</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlsu10.html" ><span
|
|
|
|
|
class="cmr-12">prev</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlsu10.html#tailuserhtmlsu10.html" ><span
|
|
|
|
|
class="cmr-12">prev-tail</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="#tailuserhtmlsu11.html"><span
|
|
|
|
|
class="cmr-12">tail</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlse5.html#userhtmlsu11.html" ><span
|
|
|
|
|
class="cmr-12">up</span></a><span
|
|
|
|
|
class="cmr-12">] </span></p></div>
|
|
|
|
|
<h4 class="subsectionHead"><span class="titlemark"><span
|
|
|
|
|
class="cmr-12">5.5 </span></span> <a
|
|
|
|
|
id="x20-190005.5"></a><span
|
|
|
|
|
class="cmr-12">Method build</span></h4>
|
|
|
|
|
<div class="center"
|
|
|
|
|
>
|
|
|
|
|
<!--l. 669--><p class="noindent" >
|
|
|
|
|
<!--l. 670--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">call</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">p</span><span
|
|
|
|
|
class="cmtt-12">%</span><span
|
|
|
|
|
class="cmtt-12">build</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">a</span><span
|
|
|
|
|
class="cmtt-12">,</span><span
|
|
|
|
|
class="cmtt-12">desc_a</span><span
|
|
|
|
|
class="cmtt-12">,</span><span
|
|
|
|
|
class="cmtt-12">info</span><span
|
|
|
|
|
class="cmtt-12">[,</span><span
|
|
|
|
|
class="cmtt-12">amold</span><span
|
|
|
|
|
class="cmtt-12">,</span><span
|
|
|
|
|
class="cmtt-12">vmold</span><span
|
|
|
|
|
class="cmtt-12">,</span><span
|
|
|
|
|
class="cmtt-12">imold</span><span
|
|
|
|
|
class="cmtt-12">])</span><br />
|
|
|
|
|
</div>
|
|
|
|
|
<!--l. 673--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">This method builds the preconditioner </span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">p</span> <span
|
|
|
|
|
class="cmr-12">according to the requirements made by the</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">user through the methods </span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">init</span> <span
|
|
|
|
|
class="cmr-12">and </span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">set</span> <span
|
|
|
|
|
class="cmr-12">(see Sections</span><span
|
|
|
|
|
class="cmr-12"> </span><a
|
|
|
|
|
href="userhtmlsu9.html#x18-170005.3"><span
|
|
|
|
|
class="cmr-12">5.3</span><!--tex4ht:ref: sec:hier_bld --></a> <span
|
|
|
|
|
class="cmr-12">and</span><span
|
|
|
|
|
class="cmr-12"> </span><a
|
|
|
|
|
href="userhtmlsu10.html#x19-180005.4"><span
|
|
|
|
|
class="cmr-12">5.4</span><!--tex4ht:ref: sec:smooth_bld --></a> <span
|
|
|
|
|
class="cmr-12">for multilevel</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">preconditioners). It is mostly provided for backward compatibility; indeed, it is</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">internally implemented by invoking the two previous methods </span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">hierarchy_build</span> <span
|
|
|
|
|
class="cmr-12">and</span>
|
|
|
|
|
<span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">smoothers_build</span><span
|
|
|
|
|
class="cmr-12">, whose nomenclature would however be somewhat unnatural when</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">dealing with simple one-level preconditioners.</span>
|
|
|
|
|
<!--l. 683--><p class="noindent" ><span
|
|
|
|
|
class="cmbx-12">Arguments</span>
|
|
|
|
|
<div class="tabular"> <table id="TBL-12" class="tabular"
|
|
|
|
|
cellspacing="0" cellpadding="0"
|
|
|
|
|
><colgroup id="TBL-12-1g"><col
|
|
|
|
|
id="TBL-12-1"><col
|
|
|
|
|
id="TBL-12-2"></colgroup><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-12-1-"><td style="white-space:normal; text-align:left;" id="TBL-12-1-1"
|
|
|
|
|
class="td11"><!--l. 686--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">a</span> </td><td style="white-space:normal; text-align:left;" id="TBL-12-1-2"
|
|
|
|
|
class="td11"><!--l. 686--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">type</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">psb_</span><span
|
|
|
|
|
class="cmti-12">x</span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">spmat_type</span><span
|
|
|
|
|
class="cmtt-12">),</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">intent</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">in</span><span
|
|
|
|
|
class="cmtt-12">)</span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-12-2-"><td style="white-space:normal; text-align:left;" id="TBL-12-2-1"
|
|
|
|
|
class="td11"><!--l. 687--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-12-2-2"
|
|
|
|
|
class="td11"><!--l. 687--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">The sparse matrix structure containing the local part of the matrix</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">to be preconditioned. Note that </span><span
|
|
|
|
|
class="cmti-12">x </span><span
|
|
|
|
|
class="cmr-12">must be chosen according to the</span>
|
|
|
|
|
<span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">real</span><span
|
|
|
|
|
class="cmr-12">/</span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">complex</span><span
|
|
|
|
|
class="cmr-12">, single/double precision version of AMG4PSBLAS</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">under use. See the PSBLAS User’s Guide for details </span><span class="cite"><span
|
|
|
|
|
class="cmr-12">[</span><a
|
|
|
|
|
href="userhtmlli4.html#XPSBLASGUIDE"><span
|
|
|
|
|
class="cmr-12">17</span></a><span
|
|
|
|
|
class="cmr-12">]</span></span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-12-3-"><td style="white-space:normal; text-align:left;" id="TBL-12-3-1"
|
|
|
|
|
class="td11"><!--l. 691--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">desc_a</span></td><td style="white-space:normal; text-align:left;" id="TBL-12-3-2"
|
|
|
|
|
class="td11"><!--l. 691--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">type</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">psb_desc_type</span><span
|
|
|
|
|
class="cmtt-12">),</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">intent</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">in</span><span
|
|
|
|
|
class="cmtt-12">)</span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-12-4-"><td style="white-space:normal; text-align:left;" id="TBL-12-4-1"
|
|
|
|
|
class="td11"><!--l. 692--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-12-4-2"
|
|
|
|
|
class="td11"><!--l. 692--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">The communication descriptor of </span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">a</span><span
|
|
|
|
|
class="cmr-12">. See the PSBLAS User’s Guide</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">for details </span><span class="cite"><span
|
|
|
|
|
class="cmr-12">[</span><a
|
|
|
|
|
href="userhtmlli4.html#XPSBLASGUIDE"><span
|
|
|
|
|
class="cmr-12">17</span></a><span
|
|
|
|
|
class="cmr-12">]</span></span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-12-5-"><td style="white-space:normal; text-align:left;" id="TBL-12-5-1"
|
|
|
|
|
class="td11"><!--l. 694--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">info</span> </td><td style="white-space:normal; text-align:left;" id="TBL-12-5-2"
|
|
|
|
|
class="td11"><!--l. 694--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">integer</span><span
|
|
|
|
|
class="cmtt-12">,</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">intent</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">out</span><span
|
|
|
|
|
class="cmtt-12">)</span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-12-6-"><td style="white-space:normal; text-align:left;" id="TBL-12-6-1"
|
|
|
|
|
class="td11"><!--l. 695--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-12-6-2"
|
|
|
|
|
class="td11"><!--l. 695--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">Error code. If no error, 0 is returned. See Section</span><span
|
|
|
|
|
class="cmr-12"> </span><a
|
|
|
|
|
href="userhtmlse7.html#x26-300007"><span
|
|
|
|
|
class="cmr-12">7</span><!--tex4ht:ref: sec:errors --></a> <span
|
|
|
|
|
class="cmr-12">for details.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-12-7-"><td style="white-space:normal; text-align:left;" id="TBL-12-7-1"
|
|
|
|
|
class="td11"><!--l. 696--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">amold</span> </td><td style="white-space:normal; text-align:left;" id="TBL-12-7-2"
|
|
|
|
|
class="td11"><!--l. 696--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">class</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">psb_</span><span
|
|
|
|
|
class="cmti-12">x</span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">_base_sparse_mat</span><span
|
|
|
|
|
class="cmtt-12">),</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">intent</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">in</span><span
|
|
|
|
|
class="cmtt-12">),</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">optional</span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-12-8-"><td style="white-space:normal; text-align:left;" id="TBL-12-8-1"
|
|
|
|
|
class="td11"><!--l. 697--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-12-8-2"
|
|
|
|
|
class="td11"><!--l. 697--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">The desired dynamic type for internal matrix components; this</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">allows e.g. running on GPUs; it needs not be the same on all</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">processes. See the PSBLAS User’s Guide for details </span><span class="cite"><span
|
|
|
|
|
class="cmr-12">[</span><a
|
|
|
|
|
href="userhtmlli4.html#XPSBLASGUIDE"><span
|
|
|
|
|
class="cmr-12">17</span></a><span
|
|
|
|
|
class="cmr-12">]</span></span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-12-9-"><td style="white-space:normal; text-align:left;" id="TBL-12-9-1"
|
|
|
|
|
class="td11"><!--l. 701--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">vmold</span> </td><td style="white-space:normal; text-align:left;" id="TBL-12-9-2"
|
|
|
|
|
class="td11"><!--l. 701--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">class</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">psb_</span><span
|
|
|
|
|
class="cmti-12">x</span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">_base_vect_type</span><span
|
|
|
|
|
class="cmtt-12">),</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">intent</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">in</span><span
|
|
|
|
|
class="cmtt-12">),</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">optional</span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-12-10-"><td style="white-space:normal; text-align:left;" id="TBL-12-10-1"
|
|
|
|
|
class="td11"><!--l. 702--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-12-10-2"
|
|
|
|
|
class="td11"><!--l. 702--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">The desired dynamic type for internal vector components; this</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">allows e.g. running on GPUs.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-12-11-"><td style="white-space:normal; text-align:left;" id="TBL-12-11-1"
|
|
|
|
|
class="td11"><!--l. 704--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">imold</span> </td><td style="white-space:normal; text-align:left;" id="TBL-12-11-2"
|
|
|
|
|
class="td11"><!--l. 704--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">class</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">psb_i_base_vect_type</span><span
|
|
|
|
|
class="cmtt-12">),</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">intent</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">in</span><span
|
|
|
|
|
class="cmtt-12">),</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">optional</span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-12-12-"><td style="white-space:normal; text-align:left;" id="TBL-12-12-1"
|
|
|
|
|
class="td11"><!--l. 705--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-12-12-2"
|
|
|
|
|
class="td11"><!--l. 705--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">The desired dynamic type for internal integer vector components;</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">this allows e.g. running on GPUs.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-12-13-"><td style="white-space:normal; text-align:left;" id="TBL-12-13-1"
|
|
|
|
|
class="td11"> </td> </tr></table></div>
|
|
|
|
|
<!--l. 710--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">The method can be used to build multilevel preconditioners too.</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--l. 715--><div class="crosslinks"><p class="noindent"><span
|
|
|
|
|
class="cmr-12">[</span><a
|
|
|
|
|
href="userhtmlsu12.html" ><span
|
|
|
|
|
class="cmr-12">next</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlsu10.html" ><span
|
|
|
|
|
class="cmr-12">prev</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlsu10.html#tailuserhtmlsu10.html" ><span
|
|
|
|
|
class="cmr-12">prev-tail</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlsu11.html" ><span
|
|
|
|
|
class="cmr-12">front</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlse5.html#userhtmlsu11.html" ><span
|
|
|
|
|
class="cmr-12">up</span></a><span
|
|
|
|
|
class="cmr-12">] </span></p></div>
|
|
|
|
|
<!--l. 715--><p class="indent" > <a
|
|
|
|
|
id="tailuserhtmlsu11.html"></a>
|
|
|
|
|
</body></html>
|
