Updated docs.
This commit is contained in:
Salvatore Filippone
2017-02-12 18:19:15 +00:00
parent 9ab0539881
commit 001aa819fa
147 changed files with 22648 additions and 22177 deletions
+34 -122
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_geins -- Dense matrix insertion routine</TITLE>
<META NAME="description" CONTENT="psb_geins -- Dense matrix insertion routine">
<TITLE>psb_sprn -- Reinit sparse matrix structure for psblas routines.</TITLE>
<META NAME="description" CONTENT="psb_sprn -- Reinit sparse matrix structure for psblas routines.">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -20,100 +20,65 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="next" HREF="node82.html">
<LINK REL="previous" HREF="node80.html">
<LINK REL="up" HREF="node68.html">
<LINK REL="up" HREF="node70.html">
<LINK REL="next" HREF="node82.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1262"
<A NAME="tex2html1268"
HREF="node82.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1258"
HREF="node68.html">
<A NAME="tex2html1264"
HREF="node70.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1252"
<A NAME="tex2html1258"
HREF="node80.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1260"
<A NAME="tex2html1266"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1263"
HREF="node82.html">psb_geasb Assembly</A>
<B> Up:</B> <A NAME="tex2html1259"
HREF="node68.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1253"
HREF="node80.html">psb_geall Allocates</A>
&nbsp; <B> <A NAME="tex2html1261"
<B> Next:</B> <A NAME="tex2html1269"
HREF="node82.html">psb_geall Allocates</A>
<B> Up:</B> <A NAME="tex2html1265"
HREF="node70.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1259"
HREF="node80.html">psb_spfree Frees</A>
&nbsp; <B> <A NAME="tex2html1267"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000713000000000000000">
psb_geins -- Dense matrix insertion routine</A>
<H2><A NAME="SECTION000711000000000000000">
psb_sprn -- Reinit sparse matrix structure for psblas
routines.</A>
</H2>
<P>
<PRE>
call psb_geins(m, irw, val, x, desc_a, info [,dupl,local])
call psb_sprn(a, decsc_a, info, clear)
</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>m</STRONG></DT>
<DD>Number of rows in <IMG
WIDTH="25" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
SRC="img108.png"
ALT="$val$"> to be inserted.
<DT><STRONG>a</STRONG></DT>
<DD>the matrix to be reinitialized.
<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: an integer value.
</DD>
<DT><STRONG>irw</STRONG></DT>
<DD>Indices of the rows to be inserted. Specifically, row <IMG
WIDTH="9" HEIGHT="17" ALIGN="BOTTOM" BORDER="0"
SRC="img4.png"
ALT="$i$">
of <IMG
WIDTH="25" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
SRC="img108.png"
ALT="$val$"> will be inserted into the local row corresponding to the
global row index <IMG
WIDTH="47" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
SRC="img109.png"
ALT="$irw(i)$">.
Scope:<B>local</B>.
<BR>
Type:<B>required</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer array.
</DD>
<DT><STRONG>val</STRONG></DT>
<DD>the dense submatrix to be inserted.
<BR>
Scope:<B>local</B>.
<BR>
Type:<B>required</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: a rank 1 or 2 array.
Specified as: an integer value.
Specified as: a structured data of type spdata<TT>psb_Tspmat_type</TT>.
</DD>
<DT><STRONG>desc_a</STRONG></DT>
<DD>the communication descriptor.
@@ -126,29 +91,16 @@ Intent: <B>in</B>.
<BR>
Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
</DD>
<DT><STRONG>dupl</STRONG></DT>
<DD>How to handle duplicate coefficients.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: integer, possible values: <code>psb_dupl_ovwrt_</code>,
<code>psb_dupl_add_</code>.
</DD>
<DT><STRONG>local</STRONG></DT>
<DD>Whether the entries in the index vector <code>irw</code>,
are already in local numbering.
<DT><STRONG>clear</STRONG></DT>
<DD>Choose whether to zero out matrix coefficients
<BR>
Scope:<B>local</B>.
<BR>
Type:<B>optional</B>.
<BR>
Specified as: a logical value; default: <code>.false.</code>.
<P>
Intent: <B>in</B>.
<BR>
Default: true.
</DD>
</DL>
@@ -157,18 +109,6 @@ Specified as: a logical value; default: <code>.false.</code>.
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>x</STRONG></DT>
<DD>the output dense matrix.
<BR>
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>inout</B>.
<BR>
Specified as: a rank one or two array or an object of type vdata<TT>psb_T_vect_type</TT>, of
type real, complex or integer.
<BR></DD>
<DT><STRONG>info</STRONG></DT>
<DD>Error code.
<BR>
@@ -181,43 +121,15 @@ 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>Dense vectors/matrices do not have an associated state;
</LI>
<LI>Duplicate entries are either overwritten or added, there is no
provision for raising an error condition.
<LI>On exit from this routine the sparse matrix is in the update
state.
</LI>
</OL>
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html1262"
HREF="node82.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1258"
HREF="node68.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1252"
HREF="node80.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1260"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1263"
HREF="node82.html">psb_geasb Assembly</A>
<B> Up:</B> <A NAME="tex2html1259"
HREF="node68.html">Data management routines</A>
<B> Previous:</B> <A NAME="tex2html1253"
HREF="node80.html">psb_geall Allocates</A>
&nbsp; <B> <A NAME="tex2html1261"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->
<BR><HR>
</BODY>
</HTML>