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
+56 -13
View File
@@ -10,7 +10,7 @@
<link rel="stylesheet" type="text/css" href="userhtml.css">
</head><body
>
<!--l. 379--><div class="crosslinks"><p class="noindent">[<a
<!--l. 419--><div class="crosslinks"><p class="noindent">[<a
href="userhtmlsu71.html" >next</a>] [<a
href="userhtmlsu66.html" >prev</a>] [<a
href="userhtmlsu66.html#tailuserhtmlsu66.html" >prev-tail</a>] [<a
@@ -22,10 +22,10 @@ href="userhtmlsu59.html#userhtmlsu70.html" >up</a>] </p></div>
<pre class="verbatim" id="verbatim-71">
call&#x00A0;psb_max(ctxt,&#x00A0;dat,&#x00A0;root)
call&#x00A0;psb_max(ctxt,&#x00A0;dat,&#x00A0;root&#x00A0;[,&#x00A0;mode,&#x00A0;request])
</pre>
<!--l. 383--><p class="nopar" >
<!--l. 385--><p class="indent" > This subroutine implements a maximum valuereduction operation based on the
<!--l. 423--><p class="nopar" >
<!--l. 425--><p class="indent" > This subroutine implements a maximum valuereduction operation based on the
underlying communication library.
<dl class="description"><dt class="description">
<span
@@ -76,8 +76,41 @@ 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. 412--><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. 466--><p class="indent" >
<dl class="description"><dt class="description">
<span
class="cmbx-10">On Return</span> </dt><dd
@@ -93,12 +126,22 @@ class="cmbx-10">required</span>.<br
class="newline" />Intent: <span
class="cmbx-10">in</span>.<br
class="newline" />Specified as: an integer or real variable, which may be a scalar, or a rank
1 or 2 array. &#x00A0;Type, kind, rank and size must agree on all processes.</dd></dl>
<!--l. 424--><p class="noindent" ><span
1 or 2 array. &#x00A0;Type, 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. 484--><p class="noindent" ><span
class="cmbx-12">Notes</span>
<ol class="enumerate1" >
<li
class="enumerate" id="x79-116002x1">The <span class="obeylines-h"><span class="verb"><span
@@ -114,12 +157,12 @@ class="cmtt-10">dat</span></span></span> argument may also be a long integer sca
<!--l. 432--><div class="crosslinks"><p class="noindent">[<a
<!--l. 492--><div class="crosslinks"><p class="noindent">[<a
href="userhtmlsu71.html" >next</a>] [<a
href="userhtmlsu66.html" >prev</a>] [<a
href="userhtmlsu66.html#tailuserhtmlsu66.html" >prev-tail</a>] [<a
href="userhtmlsu67.html" >front</a>] [<a
href="userhtmlsu59.html#userhtmlsu70.html" >up</a>] </p></div>
<!--l. 432--><p class="indent" > <a
<!--l. 492--><p class="indent" > <a
id="tailuserhtmlsu67.html"></a>
</body></html>