mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-16 10:52:08 +00:00
psblas3:
Documentation changes. We have barely begun.....
This commit is contained in:
+32
-52
@@ -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_local_index </TITLE>
|
||||
<META NAME="description" CONTENT="psb_local_index ">
|
||||
<TITLE>psb_get_boundary -- Extract list of boundary elements</TITLE>
|
||||
<META NAME="description" CONTENT="psb_get_boundary -- Extract list of boundary elements">
|
||||
<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="node68.html">
|
||||
<LINK REL="previous" HREF="node66.html">
|
||||
<LINK REL="up" HREF="node45.html">
|
||||
<LINK REL="up" HREF="node44.html">
|
||||
<LINK REL="next" HREF="node68.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html1023"
|
||||
<A NAME="tex2html1021"
|
||||
HREF="node68.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1019"
|
||||
HREF="node45.html">
|
||||
<A NAME="tex2html1017"
|
||||
HREF="node44.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1013"
|
||||
<A NAME="tex2html1011"
|
||||
HREF="node66.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1021"
|
||||
<A NAME="tex2html1019"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1024"
|
||||
HREF="node68.html">psb_get_boundary Extract</A>
|
||||
<B> Up:</B> <A NAME="tex2html1020"
|
||||
HREF="node45.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1014"
|
||||
HREF="node66.html">psb_is_local</A>
|
||||
<B> <A NAME="tex2html1022"
|
||||
<B> Next:</B> <A NAME="tex2html1022"
|
||||
HREF="node68.html">psb_get_overlap Extract</A>
|
||||
<B> Up:</B> <A NAME="tex2html1018"
|
||||
HREF="node44.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1012"
|
||||
HREF="node66.html">psb_local_index</A>
|
||||
<B> <A NAME="tex2html1020"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION000722000000000000000">
|
||||
psb_local_index </A>
|
||||
<H2><A NAME="SECTION000723000000000000000">
|
||||
psb_get_boundary -- Extract list of boundary elements</A>
|
||||
</H2>
|
||||
|
||||
<P>
|
||||
<PRE>
|
||||
call psb_local_index(y, x, desc_a, info)
|
||||
call psb_get_boundary(bndel, desc, info)
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
@@ -68,18 +68,7 @@ call psb_local_index(y, x, desc_a, info)
|
||||
<DT><STRONG><B>On Entry</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<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>
|
||||
<DT><STRONG>desc</STRONG></DT>
|
||||
<DD>the communication descriptor.
|
||||
<BR>
|
||||
Scope:<B>local</B>.
|
||||
@@ -90,17 +79,6 @@ 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>
|
||||
@@ -108,20 +86,19 @@ 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
|
||||
<IMG
|
||||
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img28.png"
|
||||
ALT="$x$"> that are local to the current process
|
||||
<DT><STRONG>bndel</STRONG></DT>
|
||||
<DD>The list of boundary elements on the calling process, in
|
||||
local numbering.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>out</B>.
|
||||
<BR>
|
||||
Specified as: a scalar or rank one logical array.
|
||||
</DD>
|
||||
Specified as: a rank one array with the ALLOCATABLE
|
||||
attribute, of type integer.
|
||||
<BR></DD>
|
||||
<DT><STRONG>info</STRONG></DT>
|
||||
<DD>Error code.
|
||||
<BR>
|
||||
@@ -139,9 +116,12 @@ An integer value; 0 means no error has been detected.
|
||||
<FONT SIZE="+1"><B>Notes</B></FONT>
|
||||
|
||||
<OL>
|
||||
<LI>This routine returns a <code>.true.</code> value for those indices
|
||||
that are local to the current process, including the halo
|
||||
indices.
|
||||
<LI>If there are no boundary elements (i.e., if the local part of
|
||||
the connectivity graph is self-contained) the output vector is set
|
||||
to the ``not allocated'' state.
|
||||
</LI>
|
||||
<LI>Otherwise the size of <code>bndel</code> will be exactly equal to the
|
||||
number of boundary elements.
|
||||
</LI>
|
||||
</OL>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user