Update docs for collectives

This commit is contained in:
Salvatore Filippone
2022-04-04 10:51:56 +02:00
parent 7064777e2e
commit 040d619d08
20 changed files with 2267 additions and 1724 deletions
+36 -14
View File
@@ -10,7 +10,7 @@
<link rel="stylesheet" type="text/css" href="userhtml.css">
</head><body
>
<!--l. 711--><div class="crosslinks"><p class="noindent">[<a
<!--l. 846--><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
@@ -21,11 +21,11 @@ href="userhtmlsu59.html#userhtmlse8.html" >up</a>] </p></div>
<pre class="verbatim" id="verbatim-75">
<pre class="verbatim" id="verbatim-81">
call&#x00A0;psb_nrm2(ctxt,&#x00A0;dat&#x00A0;[,&#x00A0;root,&#x00A0;mode,&#x00A0;request])
</pre>
<!--l. 715--><p class="nopar" >
<!--l. 717--><p class="indent" > This subroutine implements a 2-norm value reduction operation based on the
<!--l. 850--><p class="nopar" >
<!--l. 852--><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
@@ -87,12 +87,17 @@ 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
class="newline" />Specified as: an integer value. The action to be taken is determined by
its bit fields, which can be set with bitwise <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">OR</span></span></span>. Basic action values are
<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 (i.e. require synchronous completion).<br
class="newline" />
</dd><dt class="description">
<span
class="cmbx-10">request</span> </dt><dd
@@ -106,7 +111,7 @@ 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 specify synchronous completion, then this variable must
be present.</dd></dl>
<!--l. 759--><p class="indent" >
<!--l. 894--><p class="indent" >
<dl class="description"><dt class="description">
<span
class="cmbx-10">On Return</span> </dt><dd
@@ -136,7 +141,7 @@ 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 specify synchronous completion, then this variable must
be present.</dd></dl>
<!--l. 777--><p class="noindent" ><span
<!--l. 912--><p class="noindent" ><span
class="cmbx-12">Notes</span>
<ol class="enumerate1" >
<li
@@ -153,29 +158,46 @@ class="cmmi-10">res</span>
is equivalent to the computation of
<center class="math-display" >
<img
src="userhtml29x.png" alt=" &#x2218; -------
&#x2211; 2
res = dati,
src="userhtml29x.png" alt=" &#x2218; &#x2211;------
res = dat2i,
i
" class="math-display" ></center>
<!--l. 783--><p class="nopar" > with care taken to avoid unnecessary overflow.
<!--l. 918--><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
class="cmtt-10">dat</span></span></span> argument is both input and output, and its value may be changed
even on processes different from the final result destination.</li></ol>
even on processes different from the final result destination.
</li>
<li
class="enumerate" id="x83-120008x4">When splitting the operation in two calls, the <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">dat</span></span></span> argument must not be
accessed between calls:
<div class="center"
>
<!--l. 934--><p class="noindent" >
<div class="minipage"><pre class="verbatim" id="verbatim-82">
&#x00A0;&#x00A0;call&#x00A0;psb_nrm2(ctxt,dat,mode=psb_collective_start_,request=nrm2_request)
&#x00A0;&#x00A0;.......
&#x00A0;&#x00A0;call&#x00A0;psb_nrm2(ctxt,dat,mode=psb_collective_end_,request=nrm2_request)
</pre>
<!--l. 940--><p class="nopar" ></div></div>
</li></ol>
<!--l. 792--><div class="crosslinks"><p class="noindent">[<a
<!--l. 948--><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. 792--><p class="indent" > <a
<!--l. 948--><p class="indent" > <a
id="tailuserhtmlsu71.html"></a>
</body></html>