Document non-blocking collectives.

This commit is contained in:
Salvatore Filippone
2022-03-28 14:04:52 +02:00
parent 1fe2c71163
commit 9c6bb4da99
13 changed files with 3493 additions and 2751 deletions
+54 -14
View File
@@ -10,7 +10,7 @@
<link rel="stylesheet" type="text/css" href="userhtml.css">
</head><body
>
<!--l. 591--><div class="crosslinks"><p class="noindent">[<a
<!--l. 711--><div class="crosslinks"><p class="noindent">[<a
href="userhtmlsu74.html" >next</a>] [<a
href="userhtmlsu70.html" >prev</a>] [<a
href="userhtmlsu70.html#tailuserhtmlsu70.html" >prev-tail</a>] [<a
@@ -22,10 +22,10 @@ href="userhtmlsu59.html#userhtmlse8.html" >up</a>] </p></div>
<pre class="verbatim" id="verbatim-75">
call&#x00A0;psb_nrm2(ctxt,&#x00A0;dat,&#x00A0;root)
call&#x00A0;psb_nrm2(ctxt,&#x00A0;dat,&#x00A0;root&#x00A0;[,&#x00A0;mode,&#x00A0;request])
</pre>
<!--l. 595--><p class="nopar" >
<!--l. 597--><p class="indent" > This subroutine implements a 2-norm value reduction operation based on the
<!--l. 715--><p class="nopar" >
<!--l. 717--><p class="indent" > This subroutine implements a 2-norm value reduction operation based on the
underlying communication library.
<dl class="description"><dt class="description">
<span
@@ -75,8 +75,38 @@ class="cmmi-10">&#x003C;</span>= <span
class="cmmi-10">root &#x003C;</span>= <span
class="cmmi-10">np </span><span
class="cmsy-10">- </span>1, default -1. <br
class="newline" /></dd></dl>
<!--l. 624--><p class="indent" >
class="newline" />
</dd><dt class="description">
<span
class="cmbx-10">mode</span> </dt><dd
class="description">Whether the call is started in non-blocking mode and completed later,
or is executed fully.<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, with the value determined by the bitwise OR of
<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">psb_collective_start_</span></span></span>, <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">psb_collective_end_</span></span></span>. Default: both fields are
selected.<br
class="newline" />
</dd><dt class="description">
<span
class="cmbx-10">request</span> </dt><dd
class="description">A request variable to check for operation completion.<br
class="newline" />Scope: <span
class="cmbx-10">local</span>.<br
class="newline" />Type: <span
class="cmbx-10">optional</span>.<br
class="newline" />Intent: <span
class="cmbx-10">inout</span>.<br
class="newline" />If <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">mode</span></span></span> does not specifies immediate completion, then this variable must
be present.</dd></dl>
<!--l. 758--><p class="indent" >
<dl class="description"><dt class="description">
<span
class="cmbx-10">On Return</span> </dt><dd
@@ -92,12 +122,22 @@ class="cmbx-10">required</span>.<br
class="newline" />Intent: <span
class="cmbx-10">inout</span>.<br
class="newline" />Specified as: a real variable, which may be a scalar, or a rank 1 array. <br
class="newline" />Kind, rank and size must agree on all processes.</dd></dl>
<!--l. 636--><p class="noindent" ><span
class="newline" />Kind, rank and size must agree on all processes.
</dd><dt class="description">
<span
class="cmbx-10">request</span> </dt><dd
class="description">A request variable to check for operation completion.<br
class="newline" />Scope: <span
class="cmbx-10">local</span>.<br
class="newline" />Type: <span
class="cmbx-10">optional</span>.<br
class="newline" />Intent: <span
class="cmbx-10">inout</span>.<br
class="newline" />If <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">mode</span></span></span> does not specifies immediate completion, then this variable must
be present.</dd></dl>
<!--l. 776--><p class="noindent" ><span
class="cmbx-12">Notes</span>
<ol class="enumerate1" >
<li
class="enumerate" id="x83-120002x1">This reduction is appropriate to compute the results of multiple (local)
@@ -118,7 +158,7 @@ src="userhtml29x.png" alt=" &#x2218; -------
res = dati,
i
" class="math-display" ></center>
<!--l. 642--><p class="nopar" > with care taken to avoid unnecessary overflow.
<!--l. 782--><p class="nopar" > with care taken to avoid unnecessary overflow.
</li>
<li
class="enumerate" id="x83-120006x3">The <span class="obeylines-h"><span class="verb"><span
@@ -130,12 +170,12 @@ class="cmtt-10">dat</span></span></span> argument is both input and output, and
<!--l. 651--><div class="crosslinks"><p class="noindent">[<a
<!--l. 791--><div class="crosslinks"><p class="noindent">[<a
href="userhtmlsu74.html" >next</a>] [<a
href="userhtmlsu70.html" >prev</a>] [<a
href="userhtmlsu70.html#tailuserhtmlsu70.html" >prev-tail</a>] [<a
href="userhtmlsu71.html" >front</a>] [<a
href="userhtmlsu59.html#userhtmlse8.html" >up</a>] </p></div>
<!--l. 651--><p class="indent" > <a
<!--l. 791--><p class="indent" > <a
id="tailuserhtmlsu71.html"></a>
</body></html>