Documentation changes. We have barely begun.....
This commit is contained in:
Salvatore Filippone
2011-12-16 16:45:25 +00:00
parent c730f15b58
commit 844a942947
243 changed files with 14860 additions and 15182 deletions
+53 -29
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_is_local </TITLE>
<META NAME="description" CONTENT="psb_is_local ">
<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,44 +20,44 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="next" HREF="node67.html">
<LINK REL="previous" HREF="node65.html">
<LINK REL="up" HREF="node45.html">
<LINK REL="up" HREF="node44.html">
<LINK REL="next" HREF="node67.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1011"
<A NAME="tex2html1009"
HREF="node67.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1007"
HREF="node45.html">
<A NAME="tex2html1005"
HREF="node44.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1001"
<A NAME="tex2html999"
HREF="node65.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1009"
<A NAME="tex2html1007"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1012"
HREF="node67.html">psb_local_index</A>
<B> Up:</B> <A NAME="tex2html1008"
HREF="node45.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1002"
HREF="node65.html">psb_owned_index</A>
&nbsp; <B> <A NAME="tex2html1010"
<B> Next:</B> <A NAME="tex2html1010"
HREF="node67.html">psb_get_boundary Extract</A>
<B> Up:</B> <A NAME="tex2html1006"
HREF="node44.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1000"
HREF="node65.html">psb_is_local</A>
&nbsp; <B> <A NAME="tex2html1008"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000721000000000000000">
psb_is_local </A>
<H2><A NAME="SECTION000722000000000000000">
psb_local_index </A>
</H2>
<P>
<PRE>
call psb_is_local(x, desc_a)
call psb_local_index(y, x, desc_a, info)
</PRE>
<P>
@@ -69,15 +69,15 @@ call psb_is_local(x, desc_a)
<DD>
</DD>
<DT><STRONG>x</STRONG></DT>
<DD>Integer index.
<DD>Integer indices.
<BR>
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>in</B>.
Intent: <B>in, inout</B>.
<BR>
Specified as: a scalar integer.
Specified as: a scalar or a rank one integer array.
<BR></DD>
<DT><STRONG>desc_a</STRONG></DT>
<DD>the communication descriptor.
@@ -90,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>
@@ -97,27 +108,40 @@ 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>Function value</STRONG></DT>
<DD>A logical mask which is true if
<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="img28.png"
ALT="$x$"> is local to the current process
SRC="img27.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></DD>
<BR>
Specified as: a scalar or rank one logical array.
</DD>
<DT><STRONG>info</STRONG></DT>
<DD>Error code.
<BR>
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>out</B>.
<BR>
An integer value; 0 means no error has been detected.
</DD>
</DL>
<P>
<FONT SIZE="+1"><B>Notes</B></FONT>
<OL>
<LI>This routine returns a <code>.true.</code> value for an index
that is local to the current process, including the halo
indices
<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>