fdurastante/psblas3
1
0
Fork 0
mirror of https://github.com/sfilippone/psblas3.git synced 2026-10-07 15:14:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

psblas3:

Browse Source 
fix documentation bug for NRM2
This commit is contained in:
Salvatore Filippone
2010-06-22 12:42:39 +00:00
parent 591166264b
commit e4452fe0a6
214 changed files with 8663 additions and 8784 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/html/node50.html
+61 -130
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>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">
<TITLE>psb_spall -- Allocates a sparse matrix</TITLE>
<META NAME="description" CONTENT="psb_spall -- Allocates a sparse matrix">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -20,123 +20,77 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="next" HREF="node51.html">
<LINK REL="previous" HREF="node49.html">
<LINK REL="up" HREF="node42.html">
<LINK REL="up" HREF="node43.html">
<LINK REL="next" HREF="node51.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html812"
<A NAME="tex2html814"
HREF="node51.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html808"
HREF="node42.html">
<A NAME="tex2html810"
HREF="node43.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html802"
<A NAME="tex2html804"
HREF="node49.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html810"
<A NAME="tex2html812"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html813"
HREF="node51.html">psb_spasb Sparse</A>
<B> Up:</B> <A NAME="tex2html809"
HREF="node42.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html803"
HREF="node49.html">psb_spall Allocates</A>
&nbsp; <B> <A NAME="tex2html811"
<B> Next:</B> <A NAME="tex2html815"
HREF="node51.html">psb_spins Insert</A>
<B> Up:</B> <A NAME="tex2html811"
HREF="node43.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html805"
HREF="node49.html">psb_cdbldext Build</A>
&nbsp; <B> <A NAME="tex2html813"
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><A NAME="SECTION00077000000000000000">
psb_spall -- Allocates a sparse matrix</A>
</H2>
<P>
<PRE>
call psb_spins(nz, ia, ja, val, a, desc_a, info)
call psb_spall(a, desc_a, info, nnz)
</PRE>
<P>
<DL>
<DT><STRONG>Type:</STRONG></DT>
<DD>Asynchronous.
<DD>Synchronous.
</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="22" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img100.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="22" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img100.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="22" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img100.png"
ALT="$nz$">. Must be of the same type and kind
of the <code>aspk</code> component of the sparse matrix <IMG
WIDTH="12" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img103.png"
ALT="$a$">.
</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>inout</B>.
Intent: <B>in</B>.
<BR>
Specified as: a variable of type descdata<TT>psb_desc_type</TT>.
<BR></DD>
Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
</DD>
<DT><STRONG>nnz</STRONG></DT>
<DD>An estimate of the number of nonzeroes in the local
part of the assembled matrix.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer value.
</DD>
</DL>
<P>
@@ -145,27 +99,16 @@ Specified as: a variable of type descdata<TT>psb_desc_type</TT>.
<DD>
</DD>
<DT><STRONG>a</STRONG></DT>
<DD>the matrix into which elements will be inserted.
<DD>the matrix to be allocated.
<BR>
Scope:<B>local</B>
<BR>
Type:<B>required</B>
<BR>
Intent: <B>inout</B>.
Intent: <B>out</B>.
<BR>
Specified as: a structured data of type spdata<TT>psb_spmat_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>
@@ -178,59 +121,47 @@ Intent: <B>out</B>.
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>On exit from this routine the sparse matrix is in the build
state.
</LI>
<LI>On entry to this routine the sparse matrix may be in either the
build or update state.
<LI>The descriptor may be in either the build or assembled 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>Any coefficients from matrix rows not assigned to 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 will be ignored;
</LI>
<LI>If the matrix is in the update state, any entries in positions
that were not present in the original matrix will be ignored.
<LI>Providing a good estimate for the number of nonzeroes <IMG
WIDTH="32" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img101.png"
ALT="$nnz$"> in
the assembled matrix may substantially improve performance in the
matrix build phase, as it will reduce or eliminate the need for
(potentially multiple) data reallocations.
</LI>
</OL>
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html812"
<A NAME="tex2html814"
HREF="node51.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html808"
HREF="node42.html">
<A NAME="tex2html810"
HREF="node43.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html802"
<A NAME="tex2html804"
HREF="node49.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html810"
<A NAME="tex2html812"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html813"
HREF="node51.html">psb_spasb Sparse</A>
<B> Up:</B> <A NAME="tex2html809"
HREF="node42.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html803"
HREF="node49.html">psb_spall Allocates</A>
&nbsp; <B> <A NAME="tex2html811"
<B> Next:</B> <A NAME="tex2html815"
HREF="node51.html">psb_spins Insert</A>
<B> Up:</B> <A NAME="tex2html811"
HREF="node43.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html805"
HREF="node49.html">psb_cdbldext Build</A>
&nbsp; <B> <A NAME="tex2html813"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->