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
+145 -48
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>Utilities</TITLE>
<META NAME="description" CONTENT="Utilities">
<TITLE>psb_rcv -- Receive data</TITLE>
<META NAME="description" CONTENT="psb_rcv -- Receive data">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -18,77 +18,174 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="STYLESHEET" HREF="userhtml.css">
<LINK REL="next" HREF="node121.html">
<LINK REL="previous" HREF="node113.html">
<LINK REL="up" HREF="userhtml.html">
<LINK REL="up" HREF="node98.html">
<LINK REL="next" HREF="node115.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1670"
<A NAME="tex2html1676"
HREF="node115.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1666"
HREF="userhtml.html">
<A NAME="tex2html1672"
HREF="node98.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1660"
<A NAME="tex2html1668"
HREF="node113.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1668"
<A NAME="tex2html1674"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1671"
HREF="node115.html">hb_read Read</A>
<B> Up:</B> <A NAME="tex2html1667"
HREF="userhtml.html">userhtml</A>
<B> Previous:</B> <A NAME="tex2html1661"
HREF="node113.html">Error handling</A>
&nbsp; <B> <A NAME="tex2html1669"
<B> Next:</B> <A NAME="tex2html1677"
HREF="node115.html">Error handling</A>
<B> Up:</B> <A NAME="tex2html1673"
HREF="node98.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1669"
HREF="node113.html">psb_snd Send</A>
&nbsp; <B> <A NAME="tex2html1675"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H1><A NAME="SECTION000100000000000000000"></A>
<A NAME="sec:util"></A>
<H2><A NAME="SECTION000816000000000000000">
psb_rcv -- Receive data</A>
</H2>
<P>
<PRE>
call psb_rcv(icontxt, dat, src, m)
</PRE>
<P>
This subroutine receives a packet of data to a destination.
<DL>
<DT><STRONG>Type:</STRONG></DT>
<DD>Synchronous: see usage notes.
</DD>
<DT><STRONG><B>On Entry </B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>icontxt</STRONG></DT>
<DD>the communication context identifying the virtual
parallel machine.
<BR>
Utilities
</H1>
Scope: <B>global</B>.
<BR>
Type: <B>required</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer variable.
</DD>
<DT><STRONG>src</STRONG></DT>
<DD>Source process.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>required</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer value <!-- MATH
$0<= src <= np-1$
-->
<IMG
WIDTH="147" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img139.png"
ALT="$0&lt;= src &lt;= np-1$">.
<BR></DD>
<DT><STRONG>m</STRONG></DT>
<DD>Number of rows.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>Optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer value <!-- MATH
$0<= m <= size(dat,1)$
-->
<IMG
WIDTH="172" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
SRC="img135.png"
ALT="$0&lt;= m &lt;= size(dat,1)$">.
<BR>
When <IMG
WIDTH="26" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
SRC="img136.png"
ALT="$dat$"> is a rank 2 array, specifies the number of rows to be sent
independently of the leading dimension <IMG
WIDTH="83" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
SRC="img137.png"
ALT="$size(dat,1)$">; must have the
same value on sending and receiving processes.
</DD>
</DL>
<P>
We have some utitlities available for input and output of
sparse matrices; the interfaces to these routines are available in the
module <code>psb_util_mod</code>.
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>dat</STRONG></DT>
<DD>The data to be received.
<BR>
Scope: <B>local</B>.
<BR>
Type: <B>required</B>.
<BR>
Intent: <B>inout</B>.
<BR>
Specified as: an integer, real or complex variable, which may be a
scalar, or a rank 1 or 2 array, or a character or logical scalar. Type, kind and rank must agree on sender and receiver process; if <IMG
WIDTH="18" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img133.png"
ALT="$m$"> is
not specified, size must agree as well.
</DD>
</DL>
<P>
<BR><HR>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<FONT SIZE="+1"><B>Notes</B></FONT>
<UL>
<LI><A NAME="tex2html1672"
HREF="node115.html">hb_read -- Read a sparse matrix from a file in the
Harwell-Boeing format</A>
<LI><A NAME="tex2html1673"
HREF="node116.html">hb_write -- Write a sparse matrix to a file
in the Harwell-Boeing format</A>
<LI><A NAME="tex2html1674"
HREF="node117.html">mm_mat_read -- Read a sparse matrix from a
file in the MatrixMarket format</A>
<LI><A NAME="tex2html1675"
HREF="node118.html">mm_array_read -- Read a dense array from a
file in the MatrixMarket format</A>
<LI><A NAME="tex2html1676"
HREF="node119.html">mm_mat_write -- Write a sparse matrix to a
file in the MatrixMarket format</A>
<LI><A NAME="tex2html1677"
HREF="node120.html">mm_array_write -- Write a dense array from a
file in the MatrixMarket format</A>
</UL>
<!--End of Table of Child-Links-->
<BR><HR>
<OL>
<LI>This subroutine implies a synchronization, but only between the
calling process and the source process <IMG
WIDTH="26" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img140.png"
ALT="$src$">.
</LI>
</OL>
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html1676"
HREF="node115.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1672"
HREF="node98.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1668"
HREF="node113.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1674"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1677"
HREF="node115.html">Error handling</A>
<B> Up:</B> <A NAME="tex2html1673"
HREF="node98.html">Parallel environment routines</A>
<B> Previous:</B> <A NAME="tex2html1669"
HREF="node113.html">psb_snd Send</A>
&nbsp; <B> <A NAME="tex2html1675"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->
</BODY>
</HTML>