Updated docs.
This commit is contained in:
Salvatore Filippone
2017-02-12 18:19:15 +00:00
parent 9ab0539881
commit 001aa819fa
147 changed files with 22648 additions and 22177 deletions
+52 -32
View File
@@ -7,8 +7,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>psb_get_overlap -- Extract list of overlap elements</TITLE>
<META NAME="description" CONTENT="psb_get_overlap -- Extract list of overlap elements">
<TITLE>psb_local_index -- </TITLE>
<META NAME="description" CONTENT="psb_local_index -- ">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -20,45 +20,44 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="next" HREF="node93.html">
<LINK REL="previous" HREF="node91.html">
<LINK REL="up" HREF="node68.html">
<LINK REL="up" HREF="node70.html">
<LINK REL="next" HREF="node93.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1394"
<A NAME="tex2html1400"
HREF="node93.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1390"
HREF="node68.html">
<A NAME="tex2html1396"
HREF="node70.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1384"
<A NAME="tex2html1390"
HREF="node91.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1392"
<A NAME="tex2html1398"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1395"
HREF="node93.html">psb_sp_getrow Extract</A>
<B> Up:</B> <A NAME="tex2html1391"
HREF="node68.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1385"
HREF="node91.html">psb_get_boundary Extract</A>
&nbsp; <B> <A NAME="tex2html1393"
<B> Next:</B> <A NAME="tex2html1401"
HREF="node93.html">psb_get_boundary Extract</A>
<B> Up:</B> <A NAME="tex2html1397"
HREF="node70.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1391"
HREF="node91.html">psb_is_local</A>
&nbsp; <B> <A NAME="tex2html1399"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000724000000000000000">
psb_get_overlap -- Extract list of overlap
elements</A>
<H2><A NAME="SECTION000722000000000000000">
psb_local_index -- </A>
</H2>
<P>
<PRE>
call psb_get_overlap(ovrel, desc, info)
call psb_local_index(y, x, desc_a, info)
</PRE>
<P>
@@ -69,7 +68,18 @@ call psb_get_overlap(ovrel, desc, info)
<DT><STRONG><B>On Entry</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>desc</STRONG></DT>
<DT><STRONG>x</STRONG></DT>
<DD>Integer indices.
<BR>
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>in, inout</B>.
<BR>
Specified as: a scalar or a rank one integer array.
<BR></DD>
<DT><STRONG>desc_a</STRONG></DT>
<DD>the communication descriptor.
<BR>
Scope:<B>local</B>.
@@ -80,6 +90,17 @@ Intent: <B>in</B>.
<BR>
Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
</DD>
<DT><STRONG>iact</STRONG></DT>
<DD>specifies action to be taken in case of range errors.
Scope: <B>global</B>
<BR>
Type: <B>optional</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: a character variable <code>I</code>gnore, <code>W</code>arning or
<code>A</code>bort, default <code>I</code>gnore.
</DD>
</DL>
<P>
@@ -87,19 +108,20 @@ Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>ovrel</STRONG></DT>
<DD>The list of overlap elements on the calling process, in
local numbering.
<BR>
<DT><STRONG>y</STRONG></DT>
<DD>A logical mask which is true for all corresponding entries of
<IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"> that are local to the current process
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>out</B>.
<BR>
Specified as: a rank one array with the ALLOCATABLE
attribute, of type integer.
<BR></DD>
Specified as: a scalar or rank one logical array.
</DD>
<DT><STRONG>info</STRONG></DT>
<DD>Error code.
<BR>
@@ -117,11 +139,9 @@ An integer value; 0 means no error has been detected.
<FONT SIZE="+1"><B>Notes</B></FONT>
<OL>
<LI>If there are no overlap elements the output vector is set
to the ``not allocated'' state.
</LI>
<LI>Otherwise the size of <code>ovrel</code> will be exactly equal to the
number of overlap elements.
<LI>This routine returns a <code>.true.</code> value for those indices
that are local to the current process, including the halo
indices.
</LI>
</OL>