Updated docs with fnd_owner adn set_p_adjcncy

This commit is contained in:
Salvatore Filippone
2019-12-12 17:37:31 +00:00
parent acae5f9278
commit db2458dd29
327 changed files with 25044 additions and 24405 deletions
+95 -31
View File
@@ -3,8 +3,8 @@
<!--Converted with LaTeX2HTML 2018 (Released Feb 1, 2018) -->
<HTML>
<HEAD>
<TITLE>psb_owned_index -- </TITLE>
<META NAME="description" CONTENT="psb_owned_index -- ">
<TITLE>psb_glob_to_loc -- Global to local indices convertion</TITLE>
<META NAME="description" CONTENT="psb_glob_to_loc -- Global to local indices convertion">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -16,45 +16,47 @@
<LINK REL="next" HREF="node92.html">
<LINK REL="previous" HREF="node90.html">
<LINK REL="up" HREF="node71.html">
<LINK REL="up" HREF="node74.html">
<LINK REL="next" HREF="node92.html">
</HEAD>
<BODY >
<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html1394"
<A NAME="tex2html1403"
HREF="node92.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1390"
HREF="node71.html">
<A NAME="tex2html1399"
HREF="node74.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1384"
<A NAME="tex2html1393"
HREF="node90.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1392"
<A NAME="tex2html1401"
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="node92.html">psb_is_local</A>
<B> Up:</B> <A NAME="tex2html1391"
HREF="node71.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1385"
HREF="node90.html">psb_is_owned</A>
&nbsp; <B> <A NAME="tex2html1393"
<B> Next:</B> <A NAME="tex2html1404"
HREF="node92.html">psb_loc_to_glob Local</A>
<B> Up:</B> <A NAME="tex2html1400"
HREF="node74.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1394"
HREF="node90.html">psb_gelp Applies</A>
&nbsp; <B> <A NAME="tex2html1402"
HREF="node1.html">Contents</A></B>
<BR>
<BR></DIV>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000720000000000000000">
psb_owned_index -- </A>
<H2><A NAME="SECTION000717000000000000000">
psb_glob_to_loc -- Global to local indices
convertion</A>
</H2>
<P>
<PRE>
call psb_owned_index(y, x, desc_a, info)
call psb_glob_to_loc(x, y, desc_a, info, iact,owned)
call psb_glob_to_loc(x, desc_a, info, iact,owned)
</PRE>
<P>
@@ -66,7 +68,7 @@ call psb_owned_index(y, x, desc_a, info)
<DD>
</DD>
<DT><STRONG>x</STRONG></DT>
<DD>Integer indices.
<DD>An integer vector of indices to be converted.
<BR>
Scope: <B>local</B>
<BR>
@@ -74,7 +76,7 @@ Type: <B>required</B>
<BR>
Intent: <B>in, inout</B>.
<BR>
Specified as: a scalar or a rank one integer array.
Specified as: a rank one integer array.
<BR></DD>
<DT><STRONG>desc_a</STRONG></DT>
<DD>the communication descriptor.
@@ -98,6 +100,18 @@ Intent: <B>in</B>.
Specified as: a character variable <code>I</code>gnore, <code>W</code>arning or
<code>A</code>bort, default <code>I</code>gnore.
</DD>
<DT><STRONG>owned</STRONG></DT>
<DD>Specfies valid range of input
Scope: <B>global</B>
<BR>
Type: <B>optional</B>
<BR>
Intent: <B>in</B>.
<BR>
If true, then only indices strictly owned by the current process are
considered valid, if false then halo indices are also
accepted. Default: false.
</DD>
</DL>
<P>
@@ -105,19 +119,43 @@ Specified as: a character variable <code>I</code>gnore, <code>W</code>arning or
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>y</STRONG></DT>
<DD>A logical mask which is true for all corresponding entries of
<SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
<DT><STRONG>x</STRONG></DT>
<DD>If <SPAN CLASS="MATH"><IMG
WIDTH="12" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
SRC="img21.png"
ALT="$y$"></SPAN> is not present,
then <SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"></SPAN> that are owned by the current process
Scope: <B>local</B>
ALT="$x$"></SPAN> is overwritten with the translated integer indices.
Scope: <B>global</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>inout</B>.
<BR>
Specified as: a rank one integer array.
</DD>
<DT><STRONG>y</STRONG></DT>
<DD>If <SPAN CLASS="MATH"><IMG
WIDTH="12" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
SRC="img21.png"
ALT="$y$"></SPAN> is present,
then <SPAN CLASS="MATH"><IMG
WIDTH="12" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
SRC="img21.png"
ALT="$y$"></SPAN> is overwritten with the translated integer indices, and <SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"></SPAN>
is left unchanged.
Scope: <B>global</B>
<BR>
Type: <B>optional</B>
<BR>
Intent: <B>out</B>.
<BR>
Specified as: a scalar or rank one logical array.
Specified as: a rank one integer array.
</DD>
<DT><STRONG>info</STRONG></DT>
<DD>Error code.
@@ -136,14 +174,40 @@ An integer value; 0 means no error has been detected.
<BIG CLASS="LARGE"><B>Notes</B></BIG>
<OL>
<LI>This routine returns a <code>.true.</code> value for those indices
that are strictly owned by the current process, excluding the halo
indices
<LI>If an input index is out of range, then the corresponding output
index is set to a negative number;
</LI>
<LI>The default <code>I</code>gnore means that the negative output is the
only action taken on an out-of-range input.
</LI>
</OL>
<P>
<BR><HR>
<DIV CLASS="navigation"><HR>
<!--Navigation Panel-->
<A NAME="tex2html1403"
HREF="node92.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1399"
HREF="node74.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1393"
HREF="node90.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1401"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1404"
HREF="node92.html">psb_loc_to_glob Local</A>
<B> Up:</B> <A NAME="tex2html1400"
HREF="node74.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1394"
HREF="node90.html">psb_gelp Applies</A>
&nbsp; <B> <A NAME="tex2html1402"
HREF="node1.html">Contents</A></B> </DIV>
<!--End of Navigation Panel-->
</BODY>
</HTML>