Document DESC%CNV method and MOLD arguments to CDASB and PREC%BUILD

This commit is contained in:
Salvatore Filippone
2017-12-14 17:09:59 +00:00
parent 4beef03aec
commit c3633b6fb2
140 changed files with 24695 additions and 24798 deletions
+59 -43
View File
@@ -1,64 +1,60 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<!--Converted with LaTeX2HTML 2017.2 (Released Jan 23, 2017) -->
<HTML>
<HEAD>
<TITLE>psb_get_boundary -- Extract list of boundary elements</TITLE>
<META NAME="description" CONTENT="psb_get_boundary -- Extract list of boundary 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">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META NAME="Generator" CONTENT="LaTeX2HTML v2017.2">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="userhtml.css">
<LINK REL="next" HREF="node94.html">
<LINK REL="previous" HREF="node92.html">
<LINK REL="up" HREF="node70.html">
<LINK REL="up" HREF="node71.html">
<LINK REL="next" HREF="node94.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1414"
<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html1417"
HREF="node94.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1410"
HREF="node70.html">
<A NAME="tex2html1413"
HREF="node71.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1404"
<A NAME="tex2html1407"
HREF="node92.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1412"
<A NAME="tex2html1415"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1415"
HREF="node94.html">psb_get_overlap Extract</A>
<B> Up:</B> <A NAME="tex2html1411"
HREF="node70.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1405"
HREF="node92.html">psb_local_index</A>
&nbsp; <B> <A NAME="tex2html1413"
<B> Next:</B> <A NAME="tex2html1418"
HREF="node94.html">psb_get_boundary Extract</A>
<B> Up:</B> <A NAME="tex2html1414"
HREF="node71.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1408"
HREF="node92.html">psb_is_local</A>
&nbsp; <B> <A NAME="tex2html1416"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<BR></DIV>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000723000000000000000">
psb_get_boundary -- Extract list of boundary
elements</A>
<H2><A NAME="SECTION000722000000000000000">
psb_local_index -- </A>
</H2>
<P>
<PRE>
call psb_get_boundary(bndel, desc, info)
call psb_local_index(y, x, desc_a, info)
</PRE>
<P>
@@ -69,7 +65,18 @@ call psb_get_boundary(bndel, 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 +87,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 +105,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>bndel</STRONG></DT>
<DD>The list of boundary 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
<SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"></SPAN> 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>
@@ -114,15 +133,12 @@ An integer value; 0 means no error has been detected.
</DL>
<P>
<FONT SIZE="+1"><B>Notes</B></FONT>
<BIG CLASS="LARGE"><B>Notes</B></BIG>
<OL>
<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>This routine returns a <code>.true.</code> value for those indices
that are local to the current process, including the halo
indices.
</LI>
</OL>