Updated docs.
This commit is contained in:
Salvatore Filippone
2014-03-25 11:24:42 +00:00
parent 38b70b287f
commit fdaa0f5d74
127 changed files with 14415 additions and 14395 deletions
+67 -139
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_init -- Initializes PSBLAS parallel environment</TITLE>
<META NAME="description" CONTENT="psb_init -- Initializes PSBLAS parallel environment">
<TITLE>Parallel environment routines</TITLE>
<META NAME="description" CONTENT="Parallel environment routines">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -18,162 +18,90 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="STYLESHEET" HREF="userhtml.css">
<LINK REL="next" HREF="node95.html">
<LINK REL="previous" HREF="node93.html">
<LINK REL="up" HREF="node93.html">
<LINK REL="next" HREF="node111.html">
<LINK REL="previous" HREF="node66.html">
<LINK REL="up" HREF="userhtml.html">
<LINK REL="next" HREF="node95.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1416"
<A NAME="tex2html1403"
HREF="node95.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1412"
HREF="node93.html">
<A NAME="tex2html1399"
HREF="userhtml.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1406"
<A NAME="tex2html1393"
HREF="node93.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1414"
<A NAME="tex2html1401"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1417"
HREF="node95.html">psb_info Return</A>
<B> Up:</B> <A NAME="tex2html1413"
HREF="node93.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1407"
HREF="node93.html">Parallel environment routines</A>
&nbsp; <B> <A NAME="tex2html1415"
<B> Next:</B> <A NAME="tex2html1404"
HREF="node95.html">psb_init Initializes</A>
<B> Up:</B> <A NAME="tex2html1400"
HREF="userhtml.html">userhtml</A>
<B> Previous:</B> <A NAME="tex2html1394"
HREF="node93.html">Sorting utilities</A>
&nbsp; <B> <A NAME="tex2html1402"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION00081000000000000000">
psb_init -- Initializes PSBLAS parallel
<H1><A NAME="SECTION00080000000000000000"></A>
<A NAME="sec:parenv"></A>
<BR>
Parallel environment routines
</H1>
<P>
<BR><HR>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<UL>
<LI><A NAME="tex2html1405"
HREF="node95.html">psb_init -- Initializes PSBLAS parallel
environment</A>
</H2>
<P>
<PRE>
call psb_init(icontxt, np, basectxt, ids)
</PRE>
<P>
This subroutine initializes the PSBLAS parallel environment, defining
a virtual parallel machine.
<DL>
<DT><STRONG>Type:</STRONG></DT>
<DD>Synchronous.
</DD>
<DT><STRONG><B>On Entry </B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>np</STRONG></DT>
<DD>Number of processes in the PSBLAS virtual parallel machine.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer value. Default: use all available processes.
</DD>
<DT><STRONG>basectxt</STRONG></DT>
<DD>the initial communication context. The new context
will be defined from the processes participating in the initial one.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer value. Default: use MPI_COMM_WORLD.
</DD>
<DT><STRONG>ids</STRONG></DT>
<DD>Identities of the processes to use for the new context; the
argument is ignored when <code>np</code> is not specified. This allows the
processes in the new environment to be in an order different from the
original one.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer array. Default: use the indices <IMG
WIDTH="94" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
SRC="img93.png"
ALT="$(0\dots np-1)$">.
</DD>
</DL>
<P>
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>icontxt</STRONG></DT>
<DD>the communication context identifying the virtual
parallel machine. Note that this is always a duplicate of
<code>basectxt</code>, so that library communications are completely
separated from other communication operations.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>required</B>.
<BR>
Intent: <B>out</B>.
<BR>
Specified as: an integer variable.
</DD>
</DL>
<P>
<FONT SIZE="+1"><B>Notes</B></FONT>
<OL>
<LI>A call to this routine must precede any other PSBLAS call.
</LI>
<LI>It is an error to specify a value for <IMG
WIDTH="21" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img126.png"
ALT="$np$"> greater than the
number of processes available in the underlying base parallel
environment.
</LI>
</OL>
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html1416"
HREF="node95.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1412"
HREF="node93.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1406"
HREF="node93.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1414"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1417"
HREF="node95.html">psb_info Return</A>
<B> Up:</B> <A NAME="tex2html1413"
HREF="node93.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1407"
HREF="node93.html">Parallel environment routines</A>
&nbsp; <B> <A NAME="tex2html1415"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->
<LI><A NAME="tex2html1406"
HREF="node96.html">psb_info -- Return information about PSBLAS parallel
environment</A>
<LI><A NAME="tex2html1407"
HREF="node97.html">psb_exit -- Exit from PSBLAS parallel
environment</A>
<LI><A NAME="tex2html1408"
HREF="node98.html">psb_get_mpicomm -- Get the MPI communicator</A>
<LI><A NAME="tex2html1409"
HREF="node99.html">psb_get_rank -- Get the MPI rank</A>
<LI><A NAME="tex2html1410"
HREF="node100.html">psb_wtime -- Wall clock timing</A>
<LI><A NAME="tex2html1411"
HREF="node101.html">psb_barrier -- Sinchronization point parallel
environment</A>
<LI><A NAME="tex2html1412"
HREF="node102.html">psb_abort -- Abort a computation</A>
<LI><A NAME="tex2html1413"
HREF="node103.html">psb_bcast -- Broadcast data</A>
<LI><A NAME="tex2html1414"
HREF="node104.html">psb_sum -- Global sum</A>
<LI><A NAME="tex2html1415"
HREF="node105.html">psb_max -- Global maximum</A>
<LI><A NAME="tex2html1416"
HREF="node106.html">psb_min -- Global minimum</A>
<LI><A NAME="tex2html1417"
HREF="node107.html">psb_amx -- Global maximum absolute value</A>
<LI><A NAME="tex2html1418"
HREF="node108.html">psb_amn -- Global minimum absolute value</A>
<LI><A NAME="tex2html1419"
HREF="node109.html">psb_snd -- Send data</A>
<LI><A NAME="tex2html1420"
HREF="node110.html">psb_rcv -- Receive data</A>
</UL>
<!--End of Table of Child-Links-->
<BR><HR>
</BODY>
</HTML>