|
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
|
|
|
|
|
"http://www.w3.org/TR/html4/loose.dtd">
|
|
|
|
|
<html >
|
|
|
|
|
<head><title>Method descr</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. 859--><div class="crosslinks"><p class="noindent"><span
|
|
|
|
|
class="cmr-12">[</span><a
|
|
|
|
|
href="userhtmlsu16.html" ><span
|
|
|
|
|
class="cmr-12">next</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlsu14.html" ><span
|
|
|
|
|
class="cmr-12">prev</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlsu14.html#tailuserhtmlsu14.html" ><span
|
|
|
|
|
class="cmr-12">prev-tail</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="#tailuserhtmlsu15.html"><span
|
|
|
|
|
class="cmr-12">tail</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlse5.html#userhtmlsu15.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.8 </span></span> <a
|
|
|
|
|
id="x25-240005.8"></a><span
|
|
|
|
|
class="cmr-12">Method descr</span></h4>
|
|
|
|
|
<div class="center"
|
|
|
|
|
>
|
|
|
|
|
<!--l. 861--><p class="noindent" >
|
|
|
|
|
<!--l. 862--><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">descr</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">info</span><span
|
|
|
|
|
class="cmtt-12">,</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">[</span><span
|
|
|
|
|
class="cmtt-12">iout</span><span
|
|
|
|
|
class="cmtt-12">,</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">root</span><span
|
|
|
|
|
class="cmtt-12">,</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">verbosity</span><span
|
|
|
|
|
class="cmtt-12">])</span><br />
|
|
|
|
|
</div>
|
|
|
|
|
<!--l. 865--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">This method prints a description of the preconditioner </span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">p</span> <span
|
|
|
|
|
class="cmr-12">to the standard output or to a</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">file. It must be called after </span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">hierachy_build</span> <span
|
|
|
|
|
class="cmr-12">and </span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">smoothers_build</span><span
|
|
|
|
|
class="cmr-12">, or </span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">build</span><span
|
|
|
|
|
class="cmr-12">, have</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">been called.</span>
|
|
|
|
|
<!--l. 870--><p class="noindent" ><span
|
|
|
|
|
class="cmbx-12">Arguments</span>
|
|
|
|
|
<div class="tabular"> <table id="TBL-16" class="tabular"
|
|
|
|
|
cellspacing="0" cellpadding="0"
|
|
|
|
|
<<<<<<< HEAD
|
|
|
|
|
><colgroup id="TBL-17-1g"><col
|
|
|
|
|
id="TBL-17-1"><col
|
|
|
|
|
id="TBL-17-2"></colgroup><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-17-1-"><td style="white-space:normal; text-align:left;" id="TBL-17-1-1"
|
|
|
|
|
class="td11"><!--l. 905--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">info</span> </td><td style="white-space:normal; text-align:left;" id="TBL-17-1-2"
|
|
|
|
|
class="td11"><!--l. 905--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
=======
|
|
|
|
|
><colgroup id="TBL-16-1g"><col
|
|
|
|
|
id="TBL-16-1"><col
|
|
|
|
|
id="TBL-16-2"></colgroup><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-16-1-"><td style="white-space:normal; text-align:left;" id="TBL-16-1-1"
|
|
|
|
|
class="td11"><!--l. 873--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">info</span> </td><td style="white-space:normal; text-align:left;" id="TBL-16-1-2"
|
|
|
|
|
class="td11"><!--l. 873--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
>>>>>>> development
|
|
|
|
|
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
|
|
|
|
|
<<<<<<< HEAD
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-17-2-"><td style="white-space:normal; text-align:left;" id="TBL-17-2-1"
|
|
|
|
|
class="td11"><!--l. 906--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-17-2-2"
|
|
|
|
|
class="td11"><!--l. 906--><p class="noindent" ><span
|
|
|
|
|
=======
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-16-2-"><td style="white-space:normal; text-align:left;" id="TBL-16-2-1"
|
|
|
|
|
class="td11"><!--l. 874--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-16-2-2"
|
|
|
|
|
class="td11"><!--l. 874--><p class="noindent" ><span
|
|
|
|
|
>>>>>>> development
|
|
|
|
|
class="cmr-12">Error code. If no error, 0 is returned. See Section</span><span
|
|
|
|
|
class="cmr-12"> </span><a
|
|
|
|
|
href="userhtmlse7.html#x28-320007"><span
|
|
|
|
|
class="cmr-12">7</span><!--tex4ht:ref: sec:errors --></a> <span
|
|
|
|
|
class="cmr-12">for details.</span></td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
<<<<<<< HEAD
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-17-3-"><td style="white-space:normal; text-align:left;" id="TBL-17-3-1"
|
|
|
|
|
class="td11"><!--l. 907--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">amold</span> </td><td style="white-space:normal; text-align:left;" id="TBL-17-3-2"
|
|
|
|
|
class="td11"><!--l. 907--><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
|
|
|
|
|
=======
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-16-3-"><td style="white-space:normal; text-align:left;" id="TBL-16-3-1"
|
|
|
|
|
class="td11"><!--l. 875--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">iout</span> </td><td style="white-space:normal; text-align:left;" id="TBL-16-3-2"
|
|
|
|
|
class="td11"><!--l. 875--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">integer</span><span
|
|
|
|
|
class="cmtt-12">,</span><span
|
|
|
|
|
>>>>>>> development
|
|
|
|
|
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
|
|
|
|
|
<<<<<<< HEAD
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-17-4-"><td style="white-space:normal; text-align:left;" id="TBL-17-4-1"
|
|
|
|
|
class="td11"><!--l. 908--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-17-4-2"
|
|
|
|
|
class="td11"><!--l. 908--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">The desired dynamic type for internal matrix components; this</span>
|
|
|
|
|
=======
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-16-4-"><td style="white-space:normal; text-align:left;" id="TBL-16-4-1"
|
|
|
|
|
class="td11"><!--l. 876--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-16-4-2"
|
|
|
|
|
class="td11"><!--l. 876--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">The id of the file where the preconditioner description will be</span>
|
|
|
|
|
>>>>>>> development
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">printed; the default is the standard output.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
<<<<<<< HEAD
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-17-5-"><td style="white-space:normal; text-align:left;" id="TBL-17-5-1"
|
|
|
|
|
class="td11"> </td> </tr></table></div>
|
|
|
|
|
<!--l. 915--><p class="noindent" >
|
|
|
|
|
<h5 class="subsubsectionHead"><span class="titlemark"><span
|
|
|
|
|
class="cmr-12">5.9.2 </span></span> <a
|
|
|
|
|
id="x25-260005.9.2"></a><span
|
|
|
|
|
class="cmr-12">Method: clone</span></h5>
|
|
|
|
|
<div class="center"
|
|
|
|
|
>
|
|
|
|
|
<!--l. 917--><p class="noindent" >
|
|
|
|
|
<!--l. 918--><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">clone</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">pout</span><span
|
|
|
|
|
class="cmtt-12">,</span><span
|
|
|
|
|
class="cmtt-12">info</span><span
|
|
|
|
|
class="cmtt-12">)</span><br />
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--l. 921--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">Create a (deep) copy of the preconditioner object.</span>
|
|
|
|
|
<!--l. 924--><p class="noindent" ><span
|
|
|
|
|
class="cmbx-12">Arguments</span>
|
|
|
|
|
<div class="tabular"> <table id="TBL-18" class="tabular"
|
|
|
|
|
cellspacing="0" cellpadding="0"
|
|
|
|
|
><colgroup id="TBL-18-1g"><col
|
|
|
|
|
id="TBL-18-1"><col
|
|
|
|
|
id="TBL-18-2"></colgroup><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-18-1-"><td style="white-space:normal; text-align:left;" id="TBL-18-1-1"
|
|
|
|
|
class="td11"><!--l. 927--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">pout</span> </td><td style="white-space:normal; text-align:left;" id="TBL-18-1-2"
|
|
|
|
|
class="td11"><!--l. 927--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">type</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">amg_</span><span
|
|
|
|
|
class="cmti-12">x</span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">prec_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">out</span><span
|
|
|
|
|
class="cmtt-12">)</span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-18-2-"><td style="white-space:normal; text-align:left;" id="TBL-18-2-1"
|
|
|
|
|
class="td11"><!--l. 928--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-18-2-2"
|
|
|
|
|
class="td11"><!--l. 928--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">The copy of the preconditioner data structure. Note that </span><span
|
|
|
|
|
class="cmti-12">x </span><span
|
|
|
|
|
class="cmr-12">must</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">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</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">version of AMG4PSBLAS under use.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-18-3-"><td style="white-space:normal; text-align:left;" id="TBL-18-3-1"
|
|
|
|
|
class="td11"><!--l. 931--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">info</span> </td><td style="white-space:normal; text-align:left;" id="TBL-18-3-2"
|
|
|
|
|
class="td11"><!--l. 931--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
=======
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-16-5-"><td style="white-space:normal; text-align:left;" id="TBL-16-5-1"
|
|
|
|
|
class="td11"><!--l. 878--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">root</span> </td><td style="white-space:normal; text-align:left;" id="TBL-16-5-2"
|
|
|
|
|
class="td11"><!--l. 878--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
>>>>>>> development
|
|
|
|
|
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
|
|
|
|
|
<<<<<<< HEAD
|
|
|
|
|
class="cmtt-12">out</span><span
|
|
|
|
|
class="cmtt-12">)</span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-18-4-"><td style="white-space:normal; text-align:left;" id="TBL-18-4-1"
|
|
|
|
|
class="td11"><!--l. 932--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-18-4-2"
|
|
|
|
|
class="td11"><!--l. 932--><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#x27-310007"><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-18-5-"><td style="white-space:normal; text-align:left;" id="TBL-18-5-1"
|
|
|
|
|
class="td11"> </td> </tr></table></div>
|
|
|
|
|
<!--l. 937--><p class="noindent" >
|
|
|
|
|
<h5 class="subsubsectionHead"><span class="titlemark"><span
|
|
|
|
|
class="cmr-12">5.9.3 </span></span> <a
|
|
|
|
|
id="x25-270005.9.3"></a><span
|
|
|
|
|
class="cmr-12">Method: sizeof</span></h5>
|
|
|
|
|
<div class="center"
|
|
|
|
|
>
|
|
|
|
|
<!--l. 939--><p class="noindent" >
|
|
|
|
|
<!--l. 940--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">sz</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">=</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">p</span><span
|
|
|
|
|
class="cmtt-12">%</span><span
|
|
|
|
|
class="cmtt-12">sizeof</span><span
|
|
|
|
|
class="cmtt-12">([</span><span
|
|
|
|
|
class="cmtt-12">global</span><span
|
|
|
|
|
class="cmtt-12">])</span><br />
|
|
|
|
|
</div>
|
|
|
|
|
<div class="tabular"> <table id="TBL-19" class="tabular"
|
|
|
|
|
cellspacing="0" cellpadding="0"
|
|
|
|
|
><colgroup id="TBL-19-1g"><col
|
|
|
|
|
id="TBL-19-1"><col
|
|
|
|
|
id="TBL-19-2"></colgroup><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-19-1-"><td style="white-space:normal; text-align:left;" id="TBL-19-1-1"
|
|
|
|
|
class="td11"><!--l. 944--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">global</span> </td> <td style="white-space:normal; text-align:left;" id="TBL-19-1-2"
|
|
|
|
|
class="td11"><!--l. 944--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">logical</span><span
|
|
|
|
|
class="cmtt-12">,</span><span
|
|
|
|
|
=======
|
|
|
|
|
class="cmtt-12">in</span><span
|
|
|
|
|
class="cmtt-12">),</span><span
|
|
|
|
|
>>>>>>> development
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">optional</span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
<<<<<<< HEAD
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-19-2-"><td style="white-space:normal; text-align:left;" id="TBL-19-2-1"
|
|
|
|
|
class="td11"><!--l. 945--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-19-2-2"
|
|
|
|
|
class="td11"><!--l. 945--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">Whether the global or local preconditioner memory occupation is</span>
|
|
|
|
|
=======
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-16-6-"><td style="white-space:normal; text-align:left;" id="TBL-16-6-1"
|
|
|
|
|
class="td11"><!--l. 879--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-16-6-2"
|
|
|
|
|
class="td11"><!--l. 879--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">The id of the process where the preconditioner description</span>
|
|
|
|
|
>>>>>>> development
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">will be printed; the default is </span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">psb_root_</span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
<<<<<<< HEAD
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-19-3-"><td style="white-space:normal; text-align:left;" id="TBL-19-3-1"
|
|
|
|
|
class="td11"> </td> </tr></table>
|
|
|
|
|
</div> <span
|
|
|
|
|
class="cmr-12">Return memory footprint in bytes.</span>
|
|
|
|
|
<!--l. 952--><p class="noindent" >
|
|
|
|
|
<h5 class="subsubsectionHead"><span class="titlemark"><span
|
|
|
|
|
class="cmr-12">5.9.4 </span></span> <a
|
|
|
|
|
id="x25-280005.9.4"></a><span
|
|
|
|
|
class="cmr-12">Method: allocate</span><span
|
|
|
|
|
class="cmr-12">_wrk</span></h5>
|
|
|
|
|
<div class="center"
|
|
|
|
|
>
|
|
|
|
|
<!--l. 954--><p class="noindent" >
|
|
|
|
|
<!--l. 955--><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">allocate_wrk</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">info</span><span
|
|
|
|
|
class="cmtt-12">[,</span><span
|
|
|
|
|
class="cmtt-12"> </span><span
|
|
|
|
|
class="cmtt-12">vmold</span><span
|
|
|
|
|
class="cmtt-12">])</span><br />
|
|
|
|
|
</div>
|
|
|
|
|
<!--l. 958--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">Allocate internal work vectors. Each application of the preconditioner uses a number of</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">work vectors which are allocated internally as necessary; therefore allocation and</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">deallocation of memory occurs multiple times during the execution of a Krylov method.</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">In most cases this strategy is perfectly acceptable, but on some platforms, most</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">notably GPUs, memory allocation is a slow operation, and the default behaviour would</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">lead to a slowdown. This method allows to trade space for time by preallocating</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">the internal workspace outside of the invocation of a Krylov method. When</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">using GPUs or other specialized devices, the </span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">vmold</span> <span
|
|
|
|
|
class="cmr-12">argument is also necessary</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">to ensure the internal work vectors are of the appropriate dynamic type to</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">exploit the accelerator hardware; when allocation occurs internally this is</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">taken care of based on the dynamic type of the </span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">x</span> <span
|
|
|
|
|
class="cmr-12">argument to the </span><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">apply</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">method.</span>
|
|
|
|
|
<!--l. 974--><p class="noindent" ><span
|
|
|
|
|
class="cmbx-12">Arguments</span>
|
|
|
|
|
<div class="tabular"> <table id="TBL-20" class="tabular"
|
|
|
|
|
cellspacing="0" cellpadding="0"
|
|
|
|
|
><colgroup id="TBL-20-1g"><col
|
|
|
|
|
id="TBL-20-1"><col
|
|
|
|
|
id="TBL-20-2"></colgroup><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-20-1-"><td style="white-space:normal; text-align:left;" id="TBL-20-1-1"
|
|
|
|
|
class="td11"><!--l. 977--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">info</span> </td><td style="white-space:normal; text-align:left;" id="TBL-20-1-2"
|
|
|
|
|
class="td11"><!--l. 977--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
=======
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-16-7-"><td style="white-space:normal; text-align:left;" id="TBL-16-7-1"
|
|
|
|
|
class="td11"><!--l. 881--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">verbosity</span> </td><td style="white-space:normal; text-align:left;" id="TBL-16-7-2"
|
|
|
|
|
class="td11"><!--l. 881--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
>>>>>>> development
|
|
|
|
|
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
|
|
|
|
|
<<<<<<< HEAD
|
|
|
|
|
class="cmtt-12">out</span><span
|
|
|
|
|
class="cmtt-12">)</span><span
|
|
|
|
|
class="cmr-12">.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-20-2-"><td style="white-space:normal; text-align:left;" id="TBL-20-2-1"
|
|
|
|
|
class="td11"><!--l. 978--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-20-2-2"
|
|
|
|
|
class="td11"><!--l. 978--><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#x27-310007"><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-20-3-"><td style="white-space:normal; text-align:left;" id="TBL-20-3-1"
|
|
|
|
|
class="td11"><!--l. 979--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">vmold</span> </td><td style="white-space:normal; text-align:left;" id="TBL-20-3-2"
|
|
|
|
|
class="td11"><!--l. 979--><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
|
|
|
|
|
=======
|
|
|
|
|
>>>>>>> development
|
|
|
|
|
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
|
|
|
|
|
<<<<<<< HEAD
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-20-4-"><td style="white-space:normal; text-align:left;" id="TBL-20-4-1"
|
|
|
|
|
class="td11"><!--l. 980--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-20-4-2"
|
|
|
|
|
class="td11"><!--l. 980--><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-20-5-"><td style="white-space:normal; text-align:left;" id="TBL-20-5-1"
|
|
|
|
|
class="td11"> </td> </tr></table></div>
|
|
|
|
|
<!--l. 986--><p class="noindent" >
|
|
|
|
|
<h5 class="subsubsectionHead"><span class="titlemark"><span
|
|
|
|
|
class="cmr-12">5.9.5 </span></span> <a
|
|
|
|
|
id="x25-290005.9.5"></a><span
|
|
|
|
|
class="cmr-12">Method: free</span><span
|
|
|
|
|
class="cmr-12">_wrk</span></h5>
|
|
|
|
|
<div class="center"
|
|
|
|
|
>
|
|
|
|
|
<!--l. 988--><p class="noindent" >
|
|
|
|
|
<!--l. 989--><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">free_wrk</span><span
|
|
|
|
|
class="cmtt-12">(</span><span
|
|
|
|
|
class="cmtt-12">info</span><span
|
|
|
|
|
class="cmtt-12">)</span><br />
|
|
|
|
|
</div>
|
|
|
|
|
<!--l. 992--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">Deallocate internal work vectors.</span>
|
|
|
|
|
<!--l. 995--><p class="noindent" ><span
|
|
|
|
|
class="cmbx-12">Arguments</span>
|
|
|
|
|
<div class="tabular"> <table id="TBL-21" class="tabular"
|
|
|
|
|
cellspacing="0" cellpadding="0"
|
|
|
|
|
><colgroup id="TBL-21-1g"><col
|
|
|
|
|
id="TBL-21-1"><col
|
|
|
|
|
id="TBL-21-2"></colgroup><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-21-1-"><td style="white-space:normal; text-align:left;" id="TBL-21-1-1"
|
|
|
|
|
class="td11"><!--l. 998--><p class="noindent" ><span class="lstinline"></span><span
|
|
|
|
|
class="cmtt-12">info</span> </td><td style="white-space:normal; text-align:left;" id="TBL-21-1-2"
|
|
|
|
|
class="td11"><!--l. 998--><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-21-2-"><td style="white-space:normal; text-align:left;" id="TBL-21-2-1"
|
|
|
|
|
class="td11"><!--l. 999--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-21-2-2"
|
|
|
|
|
class="td11"><!--l. 999--><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#x27-310007"><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-21-3-"><td style="white-space:normal; text-align:left;" id="TBL-21-3-1"
|
|
|
|
|
class="td11"> </td> </tr></table></div>
|
|
|
|
|
=======
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-16-8-"><td style="white-space:normal; text-align:left;" id="TBL-16-8-1"
|
|
|
|
|
class="td11"><!--l. 882--><p class="noindent" > </td><td style="white-space:normal; text-align:left;" id="TBL-16-8-2"
|
|
|
|
|
class="td11"><!--l. 882--><p class="noindent" ><span
|
|
|
|
|
class="cmr-12">The verbosity level of the description. Default value is 0. For</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">values higher than 0, it prints out further information, e.g., for</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">a distributed multilevel preconditioner the size of the coarse</span>
|
|
|
|
|
<span
|
|
|
|
|
class="cmr-12">matrices on every process.</span> </td>
|
|
|
|
|
</tr><tr
|
|
|
|
|
style="vertical-align:baseline;" id="TBL-16-9-"><td style="white-space:normal; text-align:left;" id="TBL-16-9-1"
|
|
|
|
|
class="td11"> </td> </tr></table></div>
|
|
|
|
|
>>>>>>> development
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--l. 889--><div class="crosslinks"><p class="noindent"><span
|
|
|
|
|
class="cmr-12">[</span><a
|
|
|
|
|
href="userhtmlsu16.html" ><span
|
|
|
|
|
class="cmr-12">next</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlsu14.html" ><span
|
|
|
|
|
class="cmr-12">prev</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlsu14.html#tailuserhtmlsu14.html" ><span
|
|
|
|
|
class="cmr-12">prev-tail</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlsu15.html" ><span
|
|
|
|
|
class="cmr-12">front</span></a><span
|
|
|
|
|
class="cmr-12">] [</span><a
|
|
|
|
|
href="userhtmlse5.html#userhtmlsu15.html" ><span
|
|
|
|
|
class="cmr-12">up</span></a><span
|
|
|
|
|
class="cmr-12">] </span></p></div>
|
|
|
|
|
<!--l. 889--><p class="indent" > <a
|
|
|
|
|
id="tailuserhtmlsu15.html"></a>
|
|
|
|
|
</body></html>
|
