You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
psblas3/docs/html/userhtmlsu35.html

164 lines
7.0 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html >
<head><title>psb_cdbldext &#8212; Build an extended communication descriptor</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. 413--><div class="crosslinks"><p class="noindent">[<a
href="userhtmlsu39.html" >next</a>] [<a
href="userhtmlsu34.html" >prev</a>] [<a
href="userhtmlsu34.html#tailuserhtmlsu34.html" >prev-tail</a>] [<a
href="userhtmlsu32.html#tailuserhtmlsu35.html">tail</a>] [<a
href="userhtmlsu32.html#userhtmlsu38.html" >up</a>] </p></div>
<h4 class="subsectionHead"><span class="titlemark">6.6 </span> <a
id="x46-830006.6"></a>psb_cdbldext &#8212; Build an extended communication descriptor</h4>
<pre class="verbatim" id="verbatim-39">
call&#x00A0;psb_cdbldext(a,desc_a,nl,desc_out,&#x00A0;info,&#x00A0;extype)
</pre>
<!--l. 417--><p class="nopar" >
<!--l. 419--><p class="indent" > This subroutine builds an extended communication descriptor, based on the input
descriptor <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">desc_a</span></span></span> and on the stencil specified through the input sparse matrix
<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">a</span></span></span>.
<dl class="description"><dt class="description">
<span
class="cmbx-10">Type:</span> </dt><dd
class="description">Synchronous.
</dd><dt class="description">
<span
class="cmbx-10">On Entry</span> </dt><dd
class="description">
</dd><dt class="description">
<span
class="cmbx-10">a</span> </dt><dd
class="description">A sparse matrix Scope:<span
class="cmbx-10">local</span>.<br
class="newline" />Type:<span
class="cmbx-10">required</span>.<br
class="newline" />Intent: <span
class="cmbx-10">in</span>.<br
class="newline" />Specified as: a structured data type.
</dd><dt class="description">
<span
class="cmbx-10">desc</span><span
class="cmbx-10">_a</span> </dt><dd
class="description">the communication descriptor.<br
class="newline" />Scope:<span
class="cmbx-10">local</span>.<br
class="newline" />Type:<span
class="cmbx-10">required</span>.<br
class="newline" />Intent: <span
class="cmbx-10">in</span>.<br
class="newline" />Specified as: a structured data of type <a
href="userhtmlsu6.html#spdata"><span
class="cmtt-10">psb</span><span
class="cmtt-10">_Tspmat</span><span
class="cmtt-10">_type</span></a>.
</dd><dt class="description">
<span
class="cmbx-10">nl</span> </dt><dd
class="description">the number of additional layers desired.<br
class="newline" />Scope:<span
class="cmbx-10">global</span>.<br
class="newline" />Type:<span
class="cmbx-10">required</span>.<br
class="newline" />Intent: <span
class="cmbx-10">in</span>.<br
class="newline" />Specified as: an integer value <span
class="cmmi-10">nl </span><span
class="cmsy-10">&#x2265; </span>0.
</dd><dt class="description">
<span
class="cmbx-10">extype</span> </dt><dd
class="description">the kind of estension required.<br
class="newline" />Scope:<span
class="cmbx-10">global</span>.<br
class="newline" />Type:<span
class="cmbx-10">optional </span>.<br
class="newline" />Intent: <span
class="cmbx-10">in</span>.<br
class="newline" />Specified as: an integer value <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">psb_ovt_xhal_</span></span></span>, <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">psb_ovt_asov_</span></span></span>, default:
<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">psb_ovt_xhal_</span></span></span>
</dd></dl>
<!--l. 449--><p class="indent" >
<dl class="description"><dt class="description">
<span
class="cmbx-10">On Return</span> </dt><dd
class="description">
</dd><dt class="description">
<span
class="cmbx-10">desc</span><span
class="cmbx-10">_out</span> </dt><dd
class="description">the extended communication descriptor.<br
class="newline" />Scope:<span
class="cmbx-10">local</span>.<br
class="newline" />Type:<span
class="cmbx-10">required</span>.<br
class="newline" />Intent: <span
class="cmbx-10">inout</span>.<br
class="newline" />Specified as: a structured data of type <a
href="userhtmlsu5.html#descdata"><span
class="cmtt-10">psb</span><span
class="cmtt-10">_desc</span><span
class="cmtt-10">_type</span></a>.
</dd><dt class="description">
<span
class="cmbx-10">info</span> </dt><dd
class="description">Error code.<br
class="newline" />Scope: <span
class="cmbx-10">local </span><br
class="newline" />Type: <span
class="cmbx-10">required </span><br
class="newline" />Intent: <span
class="cmbx-10">out</span>.<br
class="newline" />An integer value; 0 means no error has been detected.</dd></dl>
<!--l. 463--><p class="noindent" ><span
class="cmbx-12">Notes</span>
<ol class="enumerate1" >
<li
class="enumerate" id="x46-83002x1">Specifying <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">psb_ovt_xhal_</span></span></span> for the <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">extype</span></span></span> argument the user will obtain a
descriptor for a domain partition in which the additional layers are fetched
as part of an (extended) halo; however the index-to-process mapping is
identical to that of the base descriptor;
</li>
<li
class="enumerate" id="x46-83004x2">Specifying <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">psb_ovt_asov_</span></span></span> for the <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">extype</span></span></span> argument the user will obtain
a descriptor with an overlapped decomposition: the additional layer is
aggregated to the local subdomain (and thus is an overlap), and a new
halo extending beyond the last additional layer is formed.</li></ol>
<!--l. 547--><div class="crosslinks"><p class="noindent">[<a
href="userhtmlsu39.html" >next</a>] [<a
href="userhtmlsu34.html" >prev</a>] [<a
href="userhtmlsu34.html#tailuserhtmlsu34.html" >prev-tail</a>] [<a
href="userhtmlsu35.html" >front</a>] [<a
href="userhtmlsu32.html#userhtmlsu38.html" >up</a>] </p></div>
<!--l. 547--><p class="indent" > <a
id="tailuserhtmlsu35.html"></a>
</body></html>