mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-13 01:19:05 +00:00
psblas3:
Documentation changes. We have barely begun.....
This commit is contained in:
Salvatore Filippone
+56
-78
@@ -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_info -- Return information about PSBLAS parallel environment</TITLE>
|
||||
<META NAME="description" CONTENT="psb_info -- Return information about PSBLAS parallel environment">
|
||||
<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,53 +20,52 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
|
||||
<LINK REL="next" HREF="node76.html">
|
||||
<LINK REL="previous" HREF="node74.html">
|
||||
<LINK REL="up" HREF="node73.html">
|
||||
<LINK REL="up" HREF="node72.html">
|
||||
<LINK REL="next" HREF="node76.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html1133"
|
||||
<A NAME="tex2html1131"
|
||||
HREF="node76.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1129"
|
||||
HREF="node73.html">
|
||||
<A NAME="tex2html1127"
|
||||
HREF="node72.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1123"
|
||||
<A NAME="tex2html1121"
|
||||
HREF="node74.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1131"
|
||||
<A NAME="tex2html1129"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1134"
|
||||
HREF="node76.html">psb_exit Exit</A>
|
||||
<B> Up:</B> <A NAME="tex2html1130"
|
||||
HREF="node73.html">Parallel environment routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1124"
|
||||
HREF="node74.html">psb_init Initializes</A>
|
||||
<B> <A NAME="tex2html1132"
|
||||
<B> Next:</B> <A NAME="tex2html1132"
|
||||
HREF="node76.html">psb_get_mpicomm Get</A>
|
||||
<B> Up:</B> <A NAME="tex2html1128"
|
||||
HREF="node72.html">Parallel environment routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1122"
|
||||
HREF="node74.html">psb_info Return</A>
|
||||
<B> <A NAME="tex2html1130"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION00082000000000000000">
|
||||
psb_info -- Return information about PSBLAS parallel
|
||||
environment</A>
|
||||
<H2><A NAME="SECTION00083000000000000000">
|
||||
psb_exit -- Exit from PSBLAS parallel environment</A>
|
||||
</H2>
|
||||
|
||||
<P>
|
||||
<PRE>
|
||||
call psb_info(icontxt, iam, np)
|
||||
call psb_exit(icontxt)
|
||||
call psb_exit(icontxt,close)
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
This subroutine returns information about the PSBLAS parallel environment, defining
|
||||
a virtual parallel machine.
|
||||
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>
|
||||
@@ -83,88 +82,67 @@ Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: an integer variable.
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG><B>On Return</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>iam</STRONG></DT>
|
||||
<DD>Identifier of current process in the PSBLAS virtual parallel machine.
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
<BR>
|
||||
Type: <B>required</B>.
|
||||
<BR>
|
||||
Intent: <B>out</B>.
|
||||
<BR>
|
||||
Specified as: an integer value. <!-- MATH
|
||||
$-1 \le iam \le np-1$
|
||||
-->
|
||||
<IMG
|
||||
WIDTH="139" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img124.png"
|
||||
ALT="$-1 \le iam \le np-1$"> </DD>
|
||||
<DT><STRONG>np</STRONG></DT>
|
||||
<DD>Number of processes 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>global</B>.
|
||||
<BR>
|
||||
Type: <B>required</B>.
|
||||
Type: <B>optional</B>.
|
||||
<BR>
|
||||
Intent: <B>out</B>.
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: an integer variable. </DD>
|
||||
Specified as: a logical variable, default value: true.
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<FONT SIZE="+1"><B>Notes</B></FONT>
|
||||
|
||||
<OL>
|
||||
<LI>For processes in the virtual parallel machine the identifier
|
||||
will satisfy <!-- MATH
|
||||
$0 \le iam \le np-1$
|
||||
-->
|
||||
<IMG
|
||||
WIDTH="128" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img125.png"
|
||||
ALT="$0 \le iam \le np-1$">;
|
||||
</LI>
|
||||
<LI>If the user has requested on <code>psb_init</code> a number of
|
||||
processes less than the total available in the parallel execution
|
||||
environment, the remaining processes will have on return <IMG
|
||||
<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="img126.png"
|
||||
ALT="$iam=-1$">;
|
||||
the only call involving <code>icontxt</code> that any such process may
|
||||
execute is to <code>psb_exit</code>.
|
||||
SRC="img125.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="tex2html1133"
|
||||
<A NAME="tex2html1131"
|
||||
HREF="node76.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1129"
|
||||
HREF="node73.html">
|
||||
<A NAME="tex2html1127"
|
||||
HREF="node72.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1123"
|
||||
<A NAME="tex2html1121"
|
||||
HREF="node74.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1131"
|
||||
<A NAME="tex2html1129"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1134"
|
||||
HREF="node76.html">psb_exit Exit</A>
|
||||
<B> Up:</B> <A NAME="tex2html1130"
|
||||
HREF="node73.html">Parallel environment routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1124"
|
||||
HREF="node74.html">psb_init Initializes</A>
|
||||
<B> <A NAME="tex2html1132"
|
||||
<B> Next:</B> <A NAME="tex2html1132"
|
||||
HREF="node76.html">psb_get_mpicomm Get</A>
|
||||
<B> Up:</B> <A NAME="tex2html1128"
|
||||
HREF="node72.html">Parallel environment routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1122"
|
||||
HREF="node74.html">psb_info Return</A>
|
||||
<B> <A NAME="tex2html1130"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
|
||||
Reference in New Issue
Block a user