fdurastante/psblas3
1
0
Fork 0
mirror of https://github.com/sfilippone/psblas3.git synced 2026-10-06 22:55:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

psblas3:

Browse Source 
Updated docs with CLONE method.
This commit is contained in:
Salvatore Filippone
2013-04-01 14:34:41 +00:00
parent db2daa7ab9
commit 8ba8f2b213
260 changed files with 21161 additions and 21017 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/html/node56.html
+225 -89
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>Data management routines</TITLE>
<META NAME="description" CONTENT="Data management routines">
<TITLE>psb_gather -- Gather Global Dense Matrix</TITLE>
<META NAME="description" CONTENT="psb_gather -- Gather Global Dense Matrix">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -18,114 +18,250 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="STYLESHEET" HREF="userhtml.css">
<LINK REL="next" HREF="node84.html">
<LINK REL="previous" HREF="node51.html">
<LINK REL="up" HREF="userhtml.html">
<LINK REL="next" HREF="node57.html">
<LINK REL="previous" HREF="node55.html">
<LINK REL="up" HREF="node53.html">
<LINK REL="next" HREF="node57.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html897"
<A NAME="tex2html901"
HREF="node57.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html893"
HREF="userhtml.html">
<A NAME="tex2html897"
HREF="node53.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html887"
<A NAME="tex2html891"
HREF="node55.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html895"
<A NAME="tex2html899"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html898"
HREF="node57.html">psb_cdall Allocates</A>
<B> Up:</B> <A NAME="tex2html894"
HREF="userhtml.html">userhtml</A>
<B> Previous:</B> <A NAME="tex2html888"
HREF="node55.html">psb_scatter Scatter</A>
&nbsp; <B> <A NAME="tex2html896"
<B> Next:</B> <A NAME="tex2html902"
HREF="node57.html">psb_scatter Scatter</A>
<B> Up:</B> <A NAME="tex2html898"
HREF="node53.html">Communication routines</A>
<B> Previous:</B> <A NAME="tex2html892"
HREF="node55.html">psb_ovrl Overlap</A>
&nbsp; <B> <A NAME="tex2html900"
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="SECTION00063000000000000000">
psb_gather -- Gather Global Dense Matrix</A>
</H2>
<P>
<BR><HR>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
These subroutines collect the portions of global dense matrix
distributed over all process into one single array stored on one
process.
<UL>
<LI><A NAME="tex2html899"
HREF="node57.html">psb_cdall -- Allocates a communication descriptor</A>
<LI><A NAME="tex2html900"
HREF="node58.html">psb_cdins -- Communication descriptor insert routine</A>
<LI><A NAME="tex2html901"
HREF="node59.html">psb_cdasb -- Communication descriptor assembly routine</A>
<LI><A NAME="tex2html902"
HREF="node60.html">psb_cdcpy -- Copies a communication descriptor</A>
<LI><A NAME="tex2html903"
HREF="node61.html">psb_cdfree -- Frees a communication descriptor</A>
<LI><A NAME="tex2html904"
HREF="node62.html">psb_cdbldext -- Build an extended communication
descriptor</A>
<LI><A NAME="tex2html905"
HREF="node63.html">psb_spall -- Allocates a sparse matrix</A>
<LI><A NAME="tex2html906"
HREF="node64.html">psb_spins -- Insert a cloud of elements into a sparse
matrix</A>
<LI><A NAME="tex2html907"
HREF="node65.html">psb_spasb -- Sparse matrix assembly routine</A>
<LI><A NAME="tex2html908"
HREF="node66.html">psb_spfree -- Frees a sparse matrix</A>
<LI><A NAME="tex2html909"
HREF="node67.html">psb_sprn -- Reinit sparse matrix structure for psblas
routines.</A>
<LI><A NAME="tex2html910"
HREF="node68.html">psb_geall -- Allocates a dense matrix</A>
<LI><A NAME="tex2html911"
HREF="node69.html">psb_geins -- Dense matrix insertion routine</A>
<LI><A NAME="tex2html912"
HREF="node70.html">psb_geasb -- Assembly a dense matrix</A>
<LI><A NAME="tex2html913"
HREF="node71.html">psb_gefree -- Frees a dense matrix</A>
<LI><A NAME="tex2html914"
HREF="node72.html">psb_gelp -- Applies a left permutation to a dense
matrix</A>
<LI><A NAME="tex2html915"
HREF="node73.html">psb_glob_to_loc -- Global to local indices
convertion</A>
<LI><A NAME="tex2html916"
HREF="node74.html">psb_loc_to_glob -- Local to global indices
conversion</A>
<LI><A NAME="tex2html917"
HREF="node75.html">psb_is_owned </A>
<LI><A NAME="tex2html918"
HREF="node76.html">psb_owned_index </A>
<LI><A NAME="tex2html919"
HREF="node77.html">psb_is_local </A>
<LI><A NAME="tex2html920"
HREF="node78.html">psb_local_index </A>
<LI><A NAME="tex2html921"
HREF="node79.html">psb_get_boundary -- Extract list of boundary elements</A>
<LI><A NAME="tex2html922"
HREF="node80.html">psb_get_overlap -- Extract list of overlap elements</A>
<LI><A NAME="tex2html923"
HREF="node81.html">psb_sp_getrow -- Extract row(s) from a sparse matrix</A>
<LI><A NAME="tex2html924"
HREF="node82.html">psb_sizeof -- Memory occupation</A>
<LI><A NAME="tex2html925"
HREF="node83.html">Sorting utilities</A>
</UL>
<!--End of Table of Child-Links-->
<BR><HR>
<P>
<BR><P></P>
<DIV ALIGN="CENTER">
<!-- MATH
\begin{displaymath}
glob\_x \leftarrow collect(loc\_x_i)
\end{displaymath}
-->
<IMG
WIDTH="163" HEIGHT="28" BORDER="0"
SRC="img68.png"
ALT="\begin{displaymath}glob\_x \leftarrow collect(loc\_x_i) \end{displaymath}">
</DIV>
<BR CLEAR="ALL">
<P></P>
where:
<DL>
<DT><STRONG><IMG
WIDTH="47" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img69.png"
ALT="$glob\_x$"></STRONG></DT>
<DD>is the global submatrix <!-- MATH
$glob\_x_{1:m,1:n}$
-->
<IMG
WIDTH="90" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img70.png"
ALT="$glob\_x_{1:m,1:n}$">
</DD>
<DT><STRONG><IMG
WIDTH="44" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img71.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="48" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
SRC="img72.png"
ALT="$collect$"></STRONG></DT>
<DD>is the collect function.
</DD>
</DL>
<P>
<BR><P></P>
<DIV ALIGN="CENTER"><A NAME="3037"></A>
<TABLE>
<CAPTION><STRONG>Table 16:</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="img73.png"
ALT="$x_i, y$"></TD>
<TD ALIGN="LEFT"><B>Subroutine</B></TD>
</TR>
<TR><TD ALIGN="LEFT">Integer</TD>
<TD ALIGN="LEFT">psb_gather</TD>
</TR>
<TR><TD ALIGN="LEFT">Short Precision Real</TD>
<TD ALIGN="LEFT">psb_gather</TD>
</TR>
<TR><TD ALIGN="LEFT">Long Precision Real</TD>
<TD ALIGN="LEFT">psb_gather</TD>
</TR>
<TR><TD ALIGN="LEFT">Short Precision Complex</TD>
<TD ALIGN="LEFT">psb_gather</TD>
</TR>
<TR><TD ALIGN="LEFT">Long Precision Complex</TD>
<TD ALIGN="LEFT">psb_gather</TD>
</TR>
</TABLE>
</DIV>
</TD></TR>
</TABLE>
</DIV><P></P>
<BR>
<P>
<PRE>
call psb_gather(glob_x, loc_x, desc_a, info, root)
call psb_gather(glob_x, loc_x, desc_a, info, root)
</PRE>
<P>
<DL>
<DT><STRONG>Type:</STRONG></DT>
<DD>Synchronous.
</DD>
<DT><STRONG><B>On Entry</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="img69.png"
ALT="$glob\_x$">.
<BR>
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: a rank one or two array or an object of type vdata<TT>psb_T_vect_type</TT>
indicated in Table&nbsp;<A HREF="#tab:gather">16</A>.
</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="74" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img74.png"
ALT="$root=-1$"> all
the processes will 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="141" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img75.png"
ALT="$-1\le root\le np-1$">, default <IMG
WIDTH="24" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img76.png"
ALT="$-1$">.
</DD>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>glob_x</STRONG></DT>
<DD>The array where the local parts must be gathered.
<BR>
Scope: <B>global</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>out</B>.
<BR>
Specified as: a rank one or two array with the <code>ALLOCATABLE</code> attribute.
</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="tex2html901"
HREF="node57.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html897"
HREF="node53.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html891"
HREF="node55.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html899"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html902"
HREF="node57.html">psb_scatter Scatter</A>
<B> Up:</B> <A NAME="tex2html898"
HREF="node53.html">Communication routines</A>
<B> Previous:</B> <A NAME="tex2html892"
HREF="node55.html">psb_ovrl Overlap</A>
&nbsp; <B> <A NAME="tex2html900"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->
</BODY>
</HTML>