mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-06 22:55:08 +00:00
psblas3:
Updated docs.
This commit is contained in:
Salvatore Filippone
+228
-94
@@ -7,8 +7,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>Data management routines</TITLE>
|
||||
<META NAME="description" CONTENT="Data management routines">
|
||||
<TITLE>psb_scatter -- Scatter Global Dense Matrix</TITLE>
|
||||
<META NAME="description" CONTENT="psb_scatter -- Scatter Global Dense Matrix">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -18,119 +18,253 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
|
||||
<LINK REL="STYLESHEET" HREF="userhtml.css">
|
||||
|
||||
<LINK REL="next" HREF="node93.html">
|
||||
<LINK REL="previous" HREF="node60.html">
|
||||
<LINK REL="up" HREF="userhtml.html">
|
||||
<LINK REL="previous" HREF="node64.html">
|
||||
<LINK REL="up" HREF="node61.html">
|
||||
<LINK REL="next" HREF="node66.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html1027"
|
||||
<A NAME="tex2html1030"
|
||||
HREF="node66.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1023"
|
||||
HREF="userhtml.html">
|
||||
<A NAME="tex2html1026"
|
||||
HREF="node61.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1017"
|
||||
<A NAME="tex2html1022"
|
||||
HREF="node64.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1025"
|
||||
<A NAME="tex2html1028"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1028"
|
||||
HREF="node66.html">psb_cdall Allocates</A>
|
||||
<B> Up:</B> <A NAME="tex2html1024"
|
||||
HREF="userhtml.html">userhtml</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1018"
|
||||
HREF="node64.html">psb_scatter Scatter</A>
|
||||
<B> <A NAME="tex2html1026"
|
||||
<B> Next:</B> <A NAME="tex2html1031"
|
||||
HREF="node66.html">Data management routines</A>
|
||||
<B> Up:</B> <A NAME="tex2html1027"
|
||||
HREF="node61.html">Communication routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1023"
|
||||
HREF="node64.html">psb_gather Gather</A>
|
||||
<B> <A NAME="tex2html1029"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H1><A NAME="SECTION00070000000000000000"></A>
|
||||
<A NAME="sec:toolsrout"></A>
|
||||
<BR>
|
||||
Data management routines
|
||||
</H1>
|
||||
<H2><A NAME="SECTION00064000000000000000">
|
||||
psb_scatter -- Scatter Global Dense Matrix</A>
|
||||
</H2>
|
||||
|
||||
<P>
|
||||
<BR><HR>
|
||||
<!--Table of Child-Links-->
|
||||
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
|
||||
These subroutines scatters the portions of global dense matrix owned
|
||||
by a process to all the processes in the processes grid.
|
||||
|
||||
<UL>
|
||||
<LI><A NAME="tex2html1029"
|
||||
HREF="node66.html">psb_cdall -- Allocates a communication descriptor</A>
|
||||
<LI><A NAME="tex2html1030"
|
||||
HREF="node67.html">psb_cdins -- Communication descriptor insert
|
||||
routine</A>
|
||||
<LI><A NAME="tex2html1031"
|
||||
HREF="node68.html">psb_cdasb -- Communication descriptor assembly
|
||||
routine</A>
|
||||
<LI><A NAME="tex2html1032"
|
||||
HREF="node69.html">psb_cdcpy -- Copies a communication descriptor</A>
|
||||
<LI><A NAME="tex2html1033"
|
||||
HREF="node70.html">psb_cdfree -- Frees a communication descriptor</A>
|
||||
<LI><A NAME="tex2html1034"
|
||||
HREF="node71.html">psb_cdbldext -- Build an extended communication
|
||||
descriptor</A>
|
||||
<LI><A NAME="tex2html1035"
|
||||
HREF="node72.html">psb_spall -- Allocates a sparse matrix</A>
|
||||
<LI><A NAME="tex2html1036"
|
||||
HREF="node73.html">psb_spins -- Insert a cloud of elements into a sparse
|
||||
matrix</A>
|
||||
<LI><A NAME="tex2html1037"
|
||||
HREF="node74.html">psb_spasb -- Sparse matrix assembly routine</A>
|
||||
<LI><A NAME="tex2html1038"
|
||||
HREF="node75.html">psb_spfree -- Frees a sparse matrix</A>
|
||||
<LI><A NAME="tex2html1039"
|
||||
HREF="node76.html">psb_sprn -- Reinit sparse matrix structure for psblas
|
||||
routines.</A>
|
||||
<LI><A NAME="tex2html1040"
|
||||
HREF="node77.html">psb_geall -- Allocates a dense matrix</A>
|
||||
<LI><A NAME="tex2html1041"
|
||||
HREF="node78.html">psb_geins -- Dense matrix insertion routine</A>
|
||||
<LI><A NAME="tex2html1042"
|
||||
HREF="node79.html">psb_geasb -- Assembly a dense matrix</A>
|
||||
<LI><A NAME="tex2html1043"
|
||||
HREF="node80.html">psb_gefree -- Frees a dense matrix</A>
|
||||
<LI><A NAME="tex2html1044"
|
||||
HREF="node81.html">psb_gelp -- Applies a left permutation to a dense
|
||||
matrix</A>
|
||||
<LI><A NAME="tex2html1045"
|
||||
HREF="node82.html">psb_glob_to_loc -- Global to local indices
|
||||
convertion</A>
|
||||
<LI><A NAME="tex2html1046"
|
||||
HREF="node83.html">psb_loc_to_glob -- Local to global indices
|
||||
conversion</A>
|
||||
<LI><A NAME="tex2html1047"
|
||||
HREF="node84.html">psb_is_owned -- </A>
|
||||
<LI><A NAME="tex2html1048"
|
||||
HREF="node85.html">psb_owned_index -- </A>
|
||||
<LI><A NAME="tex2html1049"
|
||||
HREF="node86.html">psb_is_local -- </A>
|
||||
<LI><A NAME="tex2html1050"
|
||||
HREF="node87.html">psb_local_index -- </A>
|
||||
<LI><A NAME="tex2html1051"
|
||||
HREF="node88.html">psb_get_boundary -- Extract list of boundary
|
||||
elements</A>
|
||||
<LI><A NAME="tex2html1052"
|
||||
HREF="node89.html">psb_get_overlap -- Extract list of overlap
|
||||
elements</A>
|
||||
<LI><A NAME="tex2html1053"
|
||||
HREF="node90.html">psb_sp_getrow -- Extract row(s) from a sparse
|
||||
matrix</A>
|
||||
<LI><A NAME="tex2html1054"
|
||||
HREF="node91.html">psb_sizeof -- Memory occupation</A>
|
||||
<LI><A NAME="tex2html1055"
|
||||
HREF="node92.html">Sorting utilities -- </A>
|
||||
</UL>
|
||||
<!--End of Table of Child-Links-->
|
||||
<BR><HR>
|
||||
<P>
|
||||
<BR><P></P>
|
||||
<DIV ALIGN="CENTER">
|
||||
<!-- MATH
|
||||
\begin{displaymath}
|
||||
loc\_x_i \leftarrow scatter(glob\_x)
|
||||
\end{displaymath}
|
||||
-->
|
||||
|
||||
<IMG
|
||||
WIDTH="167" HEIGHT="28" BORDER="0"
|
||||
SRC="img80.png"
|
||||
ALT="\begin{displaymath}loc\_x_i \leftarrow scatter(glob\_x) \end{displaymath}">
|
||||
</DIV>
|
||||
<BR CLEAR="ALL">
|
||||
<P></P>
|
||||
where:
|
||||
<DL>
|
||||
<DT><STRONG><IMG
|
||||
WIDTH="47" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img71.png"
|
||||
ALT="$glob\_x$"></STRONG></DT>
|
||||
<DD>is the global matrix <!-- MATH
|
||||
$glob\_x_{1:m,1:n}$
|
||||
-->
|
||||
<IMG
|
||||
WIDTH="90" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img72.png"
|
||||
ALT="$glob\_x_{1:m,1:n}$">
|
||||
</DD>
|
||||
<DT><STRONG><IMG
|
||||
WIDTH="44" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img73.png"
|
||||
ALT="$loc\_x_i$"></STRONG></DT>
|
||||
<DD>is the local portion of global dense matrix on
|
||||
process <IMG
|
||||
WIDTH="9" HEIGHT="17" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img4.png"
|
||||
ALT="$i$">.
|
||||
</DD>
|
||||
<DT><STRONG><IMG
|
||||
WIDTH="54" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img81.png"
|
||||
ALT="$scatter$"></STRONG></DT>
|
||||
<DD>is the scatter function.
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR><P></P>
|
||||
<DIV ALIGN="CENTER"><A NAME="3213"></A>
|
||||
<TABLE>
|
||||
<CAPTION><STRONG>Table 17:</STRONG>
|
||||
Data types</CAPTION>
|
||||
<TR><TD>
|
||||
<DIV ALIGN="CENTER">
|
||||
<TABLE CELLPADDING=3 BORDER="1" ALIGN="CENTER">
|
||||
<TR><TD ALIGN="LEFT"><IMG
|
||||
WIDTH="34" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img75.png"
|
||||
ALT="$x_i, y$"></TD>
|
||||
<TD ALIGN="LEFT"><B>Subroutine</B></TD>
|
||||
</TR>
|
||||
<TR><TD ALIGN="LEFT">Integer</TD>
|
||||
<TD ALIGN="LEFT">psb_scatter</TD>
|
||||
</TR>
|
||||
<TR><TD ALIGN="LEFT">Short Precision Real</TD>
|
||||
<TD ALIGN="LEFT">psb_scatter</TD>
|
||||
</TR>
|
||||
<TR><TD ALIGN="LEFT">Long Precision Real</TD>
|
||||
<TD ALIGN="LEFT">psb_scatter</TD>
|
||||
</TR>
|
||||
<TR><TD ALIGN="LEFT">Short Precision Complex</TD>
|
||||
<TD ALIGN="LEFT">psb_scatter</TD>
|
||||
</TR>
|
||||
<TR><TD ALIGN="LEFT">Long Precision Complex</TD>
|
||||
<TD ALIGN="LEFT">psb_scatter</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</DIV>
|
||||
</TD></TR>
|
||||
</TABLE>
|
||||
</DIV><P></P>
|
||||
<BR>
|
||||
|
||||
<P>
|
||||
<BR>
|
||||
<IMG
|
||||
WIDTH="480" HEIGHT="35" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img82.png"
|
||||
ALT="\begin{lstlisting}
|
||||
call psb_scatter(glob_x, loc_x, desc_a, info, root)
|
||||
call psb_scatter(glob_x, loc_x, desc_a, info, root)
|
||||
\end{lstlisting}">
|
||||
<BR>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG>Type:</STRONG></DT>
|
||||
<DD>Synchronous.
|
||||
</DD>
|
||||
<DT><STRONG><B>On Entry</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>glob_x</STRONG></DT>
|
||||
<DD>The array that must be scattered into local pieces.
|
||||
<BR>
|
||||
Scope: <B>global</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a rank one or two array.
|
||||
</DD>
|
||||
<DT><STRONG>desc_a</STRONG></DT>
|
||||
<DD>contains data structures for communications.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
|
||||
</DD>
|
||||
<DT><STRONG>root</STRONG></DT>
|
||||
<DD>The process that holds the global copy. If <IMG
|
||||
WIDTH="75" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img77.png"
|
||||
ALT="$root=-1$"> all
|
||||
the processes have a copy of the global vector.
|
||||
<BR>
|
||||
Scope: <B>global</B>
|
||||
<BR>
|
||||
Type: <B>optional</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: an integer variable <!-- MATH
|
||||
$-1\le root\le np-1$
|
||||
-->
|
||||
<IMG
|
||||
WIDTH="140" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img78.png"
|
||||
ALT="$-1\le root\le np-1$">, default <IMG
|
||||
WIDTH="25" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img79.png"
|
||||
ALT="$-1$">.
|
||||
</DD>
|
||||
<DT><STRONG><B>On Return</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>loc_x</STRONG></DT>
|
||||
<DD>the local portion of global dense matrix
|
||||
<IMG
|
||||
WIDTH="47" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img71.png"
|
||||
ALT="$glob\_x$">.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>out</B>.
|
||||
<BR>
|
||||
Specified as: a rank one or two array containing numbers of the type
|
||||
indicated in Table <A HREF="#tab:scatter">17</A>.
|
||||
</DD>
|
||||
<DT><STRONG>info</STRONG></DT>
|
||||
<DD>Error code.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>out</B>.
|
||||
<BR>
|
||||
An integer value; 0 means no error has been detected.
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html1030"
|
||||
HREF="node66.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1026"
|
||||
HREF="node61.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1022"
|
||||
HREF="node64.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1028"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1031"
|
||||
HREF="node66.html">Data management routines</A>
|
||||
<B> Up:</B> <A NAME="tex2html1027"
|
||||
HREF="node61.html">Communication routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1023"
|
||||
HREF="node64.html">psb_gather Gather</A>
|
||||
<B> <A NAME="tex2html1029"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
|
||||
Reference in New Issue
Block a user