|
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
|
|
|
|
|
|
|
|
|
<!--Converted with LaTeX2HTML 2008 (1.71)
|
|
|
|
|
original version by: Nikos Drakos, CBLU, University of Leeds
|
|
|
|
|
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
|
|
|
|
|
* with significant contributions from:
|
|
|
|
|
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
|
|
|
|
|
<HTML>
|
|
|
|
|
<HEAD>
|
|
|
|
|
<TITLE>psb_spins -- Insert a cloud of elements into a sparse matrix</TITLE>
|
|
|
|
|
<META NAME="description" CONTENT="psb_spins -- Insert a cloud of elements into a sparse matrix">
|
|
|
|
|
<META NAME="keywords" CONTENT="userhtml">
|
|
|
|
|
<META NAME="resource-type" CONTENT="document">
|
|
|
|
|
<META NAME="distribution" CONTENT="global">
|
|
|
|
|
|
|
|
|
|
<META NAME="Generator" CONTENT="LaTeX2HTML v2008">
|
|
|
|
|
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
|
|
|
|
|
|
|
|
|
|
<LINK REL="STYLESHEET" HREF="userhtml.css">
|
|
|
|
|
|
|
|
|
|
<LINK REL="next" HREF="node75.html">
|
|
|
|
|
<LINK REL="previous" HREF="node73.html">
|
|
|
|
|
<LINK REL="up" HREF="node66.html">
|
|
|
|
|
<LINK REL="next" HREF="node75.html">
|
|
|
|
|
</HEAD>
|
|
|
|
|
|
|
|
|
|
<BODY >
|
|
|
|
|
<!--Navigation Panel-->
|
|
|
|
|
<A NAME="tex2html1171"
|
|
|
|
|
HREF="node75.html">
|
|
|
|
|
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
|
|
|
|
<A NAME="tex2html1167"
|
|
|
|
|
HREF="node66.html">
|
|
|
|
|
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
|
|
|
|
<A NAME="tex2html1161"
|
|
|
|
|
HREF="node73.html">
|
|
|
|
|
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
|
|
|
|
<A NAME="tex2html1169"
|
|
|
|
|
HREF="node1.html">
|
|
|
|
|
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
|
|
|
|
<BR>
|
|
|
|
|
<B> Next:</B> <A NAME="tex2html1172"
|
|
|
|
|
HREF="node75.html">psb_spasb Sparse</A>
|
|
|
|
|
<B> Up:</B> <A NAME="tex2html1168"
|
|
|
|
|
HREF="node66.html">Data management routines</A>
|
|
|
|
|
<B> Previous:</B> <A NAME="tex2html1162"
|
|
|
|
|
HREF="node73.html">psb_spall Allocates</A>
|
|
|
|
|
<B> <A NAME="tex2html1170"
|
|
|
|
|
HREF="node1.html">Contents</A></B>
|
|
|
|
|
<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
<!--End of Navigation Panel-->
|
|
|
|
|
|
|
|
|
|
<H2><A NAME="SECTION00078000000000000000">
|
|
|
|
|
psb_spins -- Insert a cloud of elements into a sparse
|
|
|
|
|
matrix</A>
|
|
|
|
|
</H2>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
<PRE>
|
|
|
|
|
call psb_spins(nz, ia, ja, val, a, desc_a, info [,local])
|
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
<DL>
|
|
|
|
|
<DT><STRONG>Type:</STRONG></DT>
|
|
|
|
|
<DD>Asynchronous.
|
|
|
|
|
</DD>
|
|
|
|
|
<DT><STRONG><B>On Entry</B></STRONG></DT>
|
|
|
|
|
<DD>
|
|
|
|
|
</DD>
|
|
|
|
|
<DT><STRONG>nz</STRONG></DT>
|
|
|
|
|
<DD>the number of elements to be inserted.
|
|
|
|
|
<BR>
|
|
|
|
|
Scope:<B>local</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Type:<B>required</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Intent: <B>in</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Specified as: an integer scalar.
|
|
|
|
|
</DD>
|
|
|
|
|
<DT><STRONG>ia</STRONG></DT>
|
|
|
|
|
<DD>the row indices of the elements to be inserted.
|
|
|
|
|
<BR>
|
|
|
|
|
Scope:<B>local</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Type:<B>required</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Intent: <B>in</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Specified as: an integer array of size <IMG
|
|
|
|
|
WIDTH="21" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
|
|
|
|
|
SRC="img102.png"
|
|
|
|
|
ALT="$nz$">.
|
|
|
|
|
</DD>
|
|
|
|
|
<DT><STRONG>ja</STRONG></DT>
|
|
|
|
|
<DD>the column indices of the elements to be inserted.
|
|
|
|
|
<BR>
|
|
|
|
|
Scope:<B>local</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Type:<B>required</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Intent: <B>in</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Specified as: an integer array of size <IMG
|
|
|
|
|
WIDTH="21" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
|
|
|
|
|
SRC="img102.png"
|
|
|
|
|
ALT="$nz$">.
|
|
|
|
|
</DD>
|
|
|
|
|
<DT><STRONG>val</STRONG></DT>
|
|
|
|
|
<DD>the elements to be inserted.
|
|
|
|
|
<BR>
|
|
|
|
|
Scope:<B>local</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Type:<B>required</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Intent: <B>in</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Specified as: an array of size <IMG
|
|
|
|
|
WIDTH="21" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
|
|
|
|
|
SRC="img102.png"
|
|
|
|
|
ALT="$nz$">. Must be of the same type and kind
|
|
|
|
|
of the coefficients of the sparse matrix <IMG
|
|
|
|
|
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
|
|
|
|
|
SRC="img105.png"
|
|
|
|
|
ALT="$a$">.
|
|
|
|
|
</DD>
|
|
|
|
|
<DT><STRONG>desc_a</STRONG></DT>
|
|
|
|
|
<DD>The communication descriptor.
|
|
|
|
|
<BR>
|
|
|
|
|
Scope: <B>local</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Type: <B>required</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Intent: <B>inout</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Specified as: a variable of type descdata<TT>psb_desc_type</TT>.
|
|
|
|
|
<BR></DD>
|
|
|
|
|
<DT><STRONG>local</STRONG></DT>
|
|
|
|
|
<DD>Whether the entries in the indices vectors <code>ia</code>,
|
|
|
|
|
<code>ja</code> are already in local numbering.
|
|
|
|
|
<BR>
|
|
|
|
|
Scope:<B>local</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Type:<B>optional</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Specified as: a logical value; default: <code>.false.</code>.
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
<DL>
|
|
|
|
|
<DT><STRONG><B>On Return</B></STRONG></DT>
|
|
|
|
|
<DD>
|
|
|
|
|
</DD>
|
|
|
|
|
<DT><STRONG>a</STRONG></DT>
|
|
|
|
|
<DD>the matrix into which elements will be inserted.
|
|
|
|
|
<BR>
|
|
|
|
|
Scope:<B>local</B>
|
|
|
|
|
<BR>
|
|
|
|
|
Type:<B>required</B>
|
|
|
|
|
<BR>
|
|
|
|
|
Intent: <B>inout</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Specified as: a structured data of type spdata<TT>psb_Tspmat_type</TT>.
|
|
|
|
|
</DD>
|
|
|
|
|
<DT><STRONG>desc_a</STRONG></DT>
|
|
|
|
|
<DD>The communication descriptor.
|
|
|
|
|
<BR>
|
|
|
|
|
Scope: <B>local</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Type: <B>required</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Intent: <B>inout</B>.
|
|
|
|
|
<BR>
|
|
|
|
|
Specified as: a variable of type descdata<TT>psb_desc_type</TT>.
|
|
|
|
|
<BR></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>
|
|
|
|
|
<FONT SIZE="+1"><B>Notes</B></FONT>
|
|
|
|
|
|
|
|
|
|
<OL>
|
|
|
|
|
<LI>On entry to this routine the descriptor may be in either the
|
|
|
|
|
build or assembled state.
|
|
|
|
|
</LI>
|
|
|
|
|
<LI>On entry to this routine the sparse matrix may be in either the
|
|
|
|
|
build or update state.
|
|
|
|
|
</LI>
|
|
|
|
|
<LI>If the descriptor is in the build state, then the sparse matrix
|
|
|
|
|
must also be in the build state; the action of the routine is to
|
|
|
|
|
(implicitly) call <code>psb_cdins</code> to add entries to the sparsity
|
|
|
|
|
pattern; each sparse matrix entry implicitly defines a graph edge,
|
|
|
|
|
that is passed to the descriptor routine for the appropriate
|
|
|
|
|
processing;
|
|
|
|
|
</LI>
|
|
|
|
|
<LI>The coefficients to be inserted are represented by the ordered
|
|
|
|
|
triples <!-- MATH
|
|
|
|
|
$ia(i),ja(i),val(i)$
|
|
|
|
|
-->
|
|
|
|
|
<IMG
|
|
|
|
|
WIDTH="123" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
|
|
|
|
|
SRC="img106.png"
|
|
|
|
|
ALT="$ia(i),ja(i),val(i)$">, for <IMG
|
|
|
|
|
WIDTH="92" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
|
|
|
|
|
SRC="img107.png"
|
|
|
|
|
ALT="$i=1,\dots,nz$">; these triples
|
|
|
|
|
should belong to the current process, i.e. <IMG
|
|
|
|
|
WIDTH="35" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
|
|
|
|
|
SRC="img100.png"
|
|
|
|
|
ALT="$ia(i)$"> should be one of
|
|
|
|
|
the local indices, but are otherwise arbitrary;
|
|
|
|
|
</LI>
|
|
|
|
|
<LI>There is no
|
|
|
|
|
requirement that a given row must be passed in its entirety to a
|
|
|
|
|
single call to this routine: the buildup of a row may be split into
|
|
|
|
|
as many calls as desired;
|
|
|
|
|
</LI>
|
|
|
|
|
<LI>Coefficients from different rows may also be mixed up freely
|
|
|
|
|
in a single call, according to the application needs;
|
|
|
|
|
</LI>
|
|
|
|
|
<LI>Any coefficients from matrix rows not owned by the calling
|
|
|
|
|
process are silently ignored;
|
|
|
|
|
</LI>
|
|
|
|
|
<LI>If the descriptor is in the assembled state, then any entries in
|
|
|
|
|
the sparse matrix that would generate additional communication
|
|
|
|
|
requirements are ignored;
|
|
|
|
|
</LI>
|
|
|
|
|
<LI>If the matrix is in the update state, any entries in positions
|
|
|
|
|
that were not present in the original matrix are ignored.
|
|
|
|
|
</LI>
|
|
|
|
|
</OL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
<HR>
|
|
|
|
|
<!--Navigation Panel-->
|
|
|
|
|
<A NAME="tex2html1171"
|
|
|
|
|
HREF="node75.html">
|
|
|
|
|
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
|
|
|
|
<A NAME="tex2html1167"
|
|
|
|
|
HREF="node66.html">
|
|
|
|
|
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
|
|
|
|
<A NAME="tex2html1161"
|
|
|
|
|
HREF="node73.html">
|
|
|
|
|
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
|
|
|
|
<A NAME="tex2html1169"
|
|
|
|
|
HREF="node1.html">
|
|
|
|
|
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
|
|
|
|
<BR>
|
|
|
|
|
<B> Next:</B> <A NAME="tex2html1172"
|
|
|
|
|
HREF="node75.html">psb_spasb Sparse</A>
|
|
|
|
|
<B> Up:</B> <A NAME="tex2html1168"
|
|
|
|
|
HREF="node66.html">Data management routines</A>
|
|
|
|
|
<B> Previous:</B> <A NAME="tex2html1162"
|
|
|
|
|
HREF="node73.html">psb_spall Allocates</A>
|
|
|
|
|
<B> <A NAME="tex2html1170"
|
|
|
|
|
HREF="node1.html">Contents</A></B>
|
|
|
|
|
<!--End of Navigation Panel-->
|
|
|
|
|
|
|
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
