mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-16 10:52:08 +00:00
Updated docs with fnd_owner adn set_p_adjcncy
This commit is contained in:
Salvatore Filippone
+250
-48
@@ -3,8 +3,8 @@
|
||||
<!--Converted with LaTeX2HTML 2018 (Released Feb 1, 2018) -->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>psb_sprn -- Reinit sparse matrix structure for psblas routines.</TITLE>
|
||||
<META NAME="description" CONTENT="psb_sprn -- Reinit sparse matrix structure for psblas routines.">
|
||||
<TITLE>psb_spins -- Insert a set of coefficients into a sparse matrix</TITLE>
|
||||
<META NAME="description" CONTENT="psb_spins -- Insert a set of coefficients into a sparse matrix">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -16,58 +16,182 @@
|
||||
|
||||
<LINK REL="next" HREF="node83.html">
|
||||
<LINK REL="previous" HREF="node81.html">
|
||||
<LINK REL="up" HREF="node71.html">
|
||||
<LINK REL="up" HREF="node74.html">
|
||||
<LINK REL="next" HREF="node83.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
|
||||
<DIV CLASS="navigation"><!--Navigation Panel-->
|
||||
<A NAME="tex2html1286"
|
||||
<A NAME="tex2html1295"
|
||||
HREF="node83.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1282"
|
||||
HREF="node71.html">
|
||||
<A NAME="tex2html1291"
|
||||
HREF="node74.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1276"
|
||||
<A NAME="tex2html1285"
|
||||
HREF="node81.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1284"
|
||||
<A NAME="tex2html1293"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1287"
|
||||
HREF="node83.html">psb_geall Allocates</A>
|
||||
<B> Up:</B> <A NAME="tex2html1283"
|
||||
HREF="node71.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1277"
|
||||
HREF="node81.html">psb_spfree Frees</A>
|
||||
<B> <A NAME="tex2html1285"
|
||||
<B> Next:</B> <A NAME="tex2html1296"
|
||||
HREF="node83.html">psb_spasb Sparse</A>
|
||||
<B> Up:</B> <A NAME="tex2html1292"
|
||||
HREF="node74.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1286"
|
||||
HREF="node81.html">psb_spall Allocates</A>
|
||||
<B> <A NAME="tex2html1294"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR></DIV>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION000711000000000000000">
|
||||
psb_sprn -- Reinit sparse matrix structure for psblas
|
||||
routines.</A>
|
||||
<H2><A NAME="SECTION00078000000000000000">
|
||||
psb_spins -- Insert a set of coefficients into a sparse
|
||||
matrix</A>
|
||||
</H2>
|
||||
|
||||
<P>
|
||||
<PRE>
|
||||
call psb_sprn(a, decsc_a, info, clear)
|
||||
call psb_spins(nz, ia, ja, val, a, desc_a, info [,local])
|
||||
call psb_spins(nr, irw, irp, ja, val, a, desc_a, info [,local])
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG>Type:</STRONG></DT>
|
||||
<DD>Synchronous.
|
||||
<DD>Asynchronous.
|
||||
</DD>
|
||||
<DT><STRONG><B>On Entry</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>nz</STRONG></DT>
|
||||
<DD>the number of coefficients 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>nr</STRONG></DT>
|
||||
<DD>the number of rows 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>irw</STRONG></DT>
|
||||
<DD>the first row 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 coefficients 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 <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="21" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img105.png"
|
||||
ALT="$nz$"></SPAN>.
|
||||
</DD>
|
||||
<DT><STRONG>irp</STRONG></DT>
|
||||
<DD>the row pointers of the coefficients 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 <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="48" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img108.png"
|
||||
ALT="$nr+1$"></SPAN>.
|
||||
</DD>
|
||||
<DT><STRONG>ja</STRONG></DT>
|
||||
<DD>the column indices of the coefficients 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 <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="21" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img105.png"
|
||||
ALT="$nz$"></SPAN>.
|
||||
</DD>
|
||||
<DT><STRONG>val</STRONG></DT>
|
||||
<DD>the coefficients 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 <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="21" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img105.png"
|
||||
ALT="$nz$"></SPAN>. Must be of the same type and kind
|
||||
of the coefficients of the sparse matrix <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="12" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img109.png"
|
||||
ALT="$a$"></SPAN>.
|
||||
</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 to be reinitialized.
|
||||
<DD>the matrix into which coefficients will be inserted.
|
||||
<BR>
|
||||
Scope:<B>local</B>
|
||||
<BR>
|
||||
@@ -78,34 +202,16 @@ Intent: <B>inout</B>.
|
||||
Specified as: a structured data of type spdata<TT>psb_Tspmat_type</TT>.
|
||||
</DD>
|
||||
<DT><STRONG>desc_a</STRONG></DT>
|
||||
<DD>the communication descriptor.
|
||||
<DD>The communication descriptor.
|
||||
<BR>
|
||||
Scope:<B>local</B>.
|
||||
Scope: <B>local</B>.
|
||||
<BR>
|
||||
Type:<B>required</B>.
|
||||
Type: <B>required</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
Intent: <B>inout</B>.
|
||||
<BR>
|
||||
Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
|
||||
</DD>
|
||||
<DT><STRONG>clear</STRONG></DT>
|
||||
<DD>Choose whether to zero out matrix coefficients
|
||||
<BR>
|
||||
Scope:<B>local</B>.
|
||||
<BR>
|
||||
Type:<B>optional</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Default: true.
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG><B>On Return</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
Specified as: a variable of type descdata<TT>psb_desc_type</TT>.
|
||||
<BR></DD>
|
||||
<DT><STRONG>info</STRONG></DT>
|
||||
<DD>Error code.
|
||||
<BR>
|
||||
@@ -118,16 +224,112 @@ Intent: <B>out</B>.
|
||||
An integer value; 0 means no error has been detected.
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BIG CLASS="LARGE"><B>Notes</B></BIG>
|
||||
|
||||
<OL>
|
||||
<LI>On exit from this routine the sparse matrix is in the update
|
||||
state.
|
||||
<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 input data can be passed in either COO or CSR formats;
|
||||
</LI>
|
||||
<LI>In COO format the coefficients to be inserted are represented by
|
||||
the ordered triples <!-- MATH
|
||||
$ia(i),ja(i),val(i)$
|
||||
-->
|
||||
<SPAN CLASS="MATH"><IMG
|
||||
WIDTH="123" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img110.png"
|
||||
ALT="$ia(i),ja(i),val(i)$"></SPAN>, for <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="91" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img111.png"
|
||||
ALT="$i=1,\dots,nz$"></SPAN>;
|
||||
these triples should belong to the current process, i.e. <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="35" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img103.png"
|
||||
ALT="$ia(i)$"></SPAN>
|
||||
should be one of the local indices, but are otherwise arbitrary;
|
||||
</LI>
|
||||
<LI>In CSR format the coefficients to be inserted for each input row <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="63" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img112.png"
|
||||
ALT="$i=1,nr$"></SPAN>
|
||||
are represented by the ordered triples <!-- MATH
|
||||
$(i+irw-1),ja(j),val(j)$
|
||||
-->
|
||||
<SPAN CLASS="MATH"><IMG
|
||||
WIDTH="185" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img113.png"
|
||||
ALT="$(i+irw-1),ja(j),val(j)$"></SPAN>, for
|
||||
<!-- MATH
|
||||
$j=irp(i),\dots,irp(i+1)-1$
|
||||
-->
|
||||
<SPAN CLASS="MATH"><IMG
|
||||
WIDTH="201" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img114.png"
|
||||
ALT="$j=irp(i),\dots,irp(i+1)-1$"></SPAN>;
|
||||
these triples should belong to the current process, i.e. <SPAN CLASS="MATH"><IMG
|
||||
WIDTH="81" HEIGHT="31" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img115.png"
|
||||
ALT="$i+irw-1$"></SPAN>
|
||||
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 (even in the CSR format);
|
||||
</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>
|
||||
<BR><HR>
|
||||
|
||||
<DIV CLASS="navigation"><HR>
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html1295"
|
||||
HREF="node83.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1291"
|
||||
HREF="node74.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1285"
|
||||
HREF="node81.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1293"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1296"
|
||||
HREF="node83.html">psb_spasb Sparse</A>
|
||||
<B> Up:</B> <A NAME="tex2html1292"
|
||||
HREF="node74.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1286"
|
||||
HREF="node81.html">psb_spall Allocates</A>
|
||||
<B> <A NAME="tex2html1294"
|
||||
HREF="node1.html">Contents</A></B> </DIV>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
|
||||
Reference in New Issue
Block a user