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
+76 -53
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_rank -- Get the MPI rank</TITLE>
<META NAME="description" CONTENT="psb_get_rank -- Get the MPI rank">
<TITLE>psb_exit -- Exit from PSBLAS parallel environment</TITLE>
<META NAME="description" CONTENT="psb_exit -- Exit from PSBLAS parallel environment">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -20,54 +20,53 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="next" HREF="node102.html">
<LINK REL="previous" HREF="node100.html">
<LINK REL="up" HREF="node96.html">
<LINK REL="up" HREF="node98.html">
<LINK REL="next" HREF="node102.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1516"
<A NAME="tex2html1522"
HREF="node102.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1512"
HREF="node96.html">
<A NAME="tex2html1518"
HREF="node98.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1506"
<A NAME="tex2html1512"
HREF="node100.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1514"
<A NAME="tex2html1520"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1517"
HREF="node102.html">psb_wtime Wall</A>
<B> Up:</B> <A NAME="tex2html1513"
HREF="node96.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1507"
HREF="node100.html">psb_get_mpicomm Get</A>
&nbsp; <B> <A NAME="tex2html1515"
<B> Next:</B> <A NAME="tex2html1523"
HREF="node102.html">psb_get_mpicomm Get</A>
<B> Up:</B> <A NAME="tex2html1519"
HREF="node98.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1513"
HREF="node100.html">psb_info Return</A>
&nbsp; <B> <A NAME="tex2html1521"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION00085000000000000000">
psb_get_rank -- Get the MPI rank</A>
<H2><A NAME="SECTION00083000000000000000">
psb_exit -- Exit from PSBLAS parallel
environment</A>
</H2>
<P>
<PRE>
call psb_get_rank(rank, icontxt, id)
call psb_exit(icontxt)
call psb_exit(icontxt,close)
</PRE>
<P>
This subroutine returns the MPI rank of the PSBLAS process <IMG
WIDTH="18" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
SRC="img129.png"
ALT="$id$">
This subroutine exits from the PSBLAS parallel virtual machine.
<DL>
<DT><STRONG>Type:</STRONG></DT>
<DD>Asynchronous.
<DD>Synchronous.
</DD>
<DT><STRONG><B>On Entry </B></STRONG></DT>
<DD>
@@ -84,45 +83,69 @@ Intent: <B>in</B>.
<BR>
Specified as: an integer variable.
</DD>
<DT><STRONG>id</STRONG></DT>
<DD>Identifier of a process in the PSBLAS virtual parallel machine.
<DT><STRONG>close</STRONG></DT>
<DD>Whether to close all data structures related to the
virtual parallel machine, besides those associated with icontxt.
<BR>
Scope: <B>local</B>.
Scope: <B>global</B>.
<BR>
Type: <B>required</B>.
Type: <B>optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer value. <!-- MATH
$0 \le id \le np-1$
-->
<IMG
WIDTH="113" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img130.png"
ALT="$0 \le id \le np-1$"> </DD>
</DL>
<P>
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
Specified as: a logical variable, default value: true.
</DD>
<DT><STRONG>rank</STRONG></DT>
<DD>The MPI rank associated with the PSBLAS process <IMG
WIDTH="18" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
SRC="img129.png"
ALT="$id$">.
<BR>
Scope: <B>local</B>.
<BR>
Type: <B>required</B>.
<BR>
Intent: <B>out</B>.
<BR></DD>
</DL>
<P>
<BR><HR>
<FONT SIZE="+1"><B>Notes</B></FONT>
<OL>
<LI>This routine may be called even if a previous call to
<code>psb_info</code> has returned with <IMG
WIDTH="73" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
SRC="img128.png"
ALT="$iam=-1$">; indeed, it it is the only
routine that may be called with argument <code>icontxt</code> in this
situation.
</LI>
<LI>A call to this routine with <code>close=.true.</code> implies a call
to <code>MPI_Finalize</code>, after which no parallel routine may be called.
</LI>
<LI>If the user whishes to use multiple communication contexts in the
same program, or to enter and exit multiple times into the parallel
environment, this routine may be called to
selectively close the contexts with <code>close=.false.</code>, while on
the last call it should be called with <code>close=.true.</code> to
shutdown in a clean way the entire parallel environment.
</LI>
</OL>
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html1522"
HREF="node102.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1518"
HREF="node98.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1512"
HREF="node100.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1520"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1523"
HREF="node102.html">psb_get_mpicomm Get</A>
<B> Up:</B> <A NAME="tex2html1519"
HREF="node98.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1513"
HREF="node100.html">psb_info Return</A>
&nbsp; <B> <A NAME="tex2html1521"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->
</BODY>
</HTML>