Updated docs with fnd_owner adn set_p_adjcncy

docs/html/node126.html

@@ -3,8 +3,8 @@
 <!--Converted with LaTeX2HTML 2018 (Released Feb 1, 2018) -->
 <HTML>
 <HEAD>
-<TITLE>init -- Initialize a preconditioner</TITLE>
-<META NAME="description" CONTENT="init -- Initialize a preconditioner">
+<TITLE>mm_mat_write -- Write a sparse matrix to a file in the MatrixMarket format</TITLE>
+<META NAME="description" CONTENT="mm_mat_write -- Write a sparse matrix to a file in the MatrixMarket format">
 <META NAME="keywords" CONTENT="userhtml">
 <META NAME="resource-type" CONTENT="document">
 <META NAME="distribution" CONTENT="global">
@@ -16,130 +16,103 @@
 
 <LINK REL="next" HREF="node127.html">
 <LINK REL="previous" HREF="node125.html">
-<LINK REL="up" HREF="node125.html">
+<LINK REL="up" HREF="node121.html">
 <LINK REL="next" HREF="node127.html">
 </HEAD>
 
 <BODY >
 
 <DIV CLASS="navigation"><!--Navigation Panel-->
-<A NAME="tex2html1837"
+<A NAME="tex2html1842"
   HREF="node127.html">
 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
-<A NAME="tex2html1833"
-  HREF="node125.html">
+<A NAME="tex2html1838"
+  HREF="node121.html">
 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
-<A NAME="tex2html1827"
+<A NAME="tex2html1832"
   HREF="node125.html">
 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
-<A NAME="tex2html1835"
+<A NAME="tex2html1840"
   HREF="node1.html">
 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>  
 <BR>
-<B> Next:</B> <A NAME="tex2html1838"
-  HREF="node127.html">build   Builds</A>
-<B> Up:</B> <A NAME="tex2html1834"
-  HREF="node125.html">Preconditioner routines</A>
-<B> Previous:</B> <A NAME="tex2html1828"
-  HREF="node125.html">Preconditioner routines</A>
- &nbsp; <B>  <A NAME="tex2html1836"
+<B> Next:</B> <A NAME="tex2html1843"
+  HREF="node127.html">mm_array_write   Write</A>
+<B> Up:</B> <A NAME="tex2html1839"
+  HREF="node121.html">Utilities</A>
+<B> Previous:</B> <A NAME="tex2html1833"
+  HREF="node125.html">mm_array_read   Read</A>
+ &nbsp; <B>  <A NAME="tex2html1841"
   HREF="node1.html">Contents</A></B> 
 <BR>
 <BR></DIV>
 <!--End of Navigation Panel-->
 
-<H2><A NAME="SECTION000111000000000000000">
-init -- Initialize a  preconditioner</A>
+<H2><A NAME="SECTION000105000000000000000">
+mm_mat_write -- Write a sparse matrix to a
+  file in the MatrixMarket format</A>
 </H2>
 
 <P>
-<PRE>
-call prec%init(icontxt,ptype, info)
-</PRE>
-
-<P>
+<BR>
+<IMG
+ WIDTH="482" HEIGHT="16" ALIGN="BOTTOM" BORDER="0"
+ SRC="img163.png"
+ ALT="\begin{lstlisting}
+call mm_mat_write(a, mtitle, iret, iunit, filename)
+\end{lstlisting}">
+<BR>
 <DL>
 <DT><STRONG>Type:</STRONG></DT>
 <DD>Asynchronous.
 </DD>
-<DT><STRONG><B>On Entry</B></STRONG></DT>
+<DT><STRONG><B>On Entry </B></STRONG></DT>
 <DD>
 </DD>
-<DT><STRONG>icontxt</STRONG></DT>
-<DD>the communication context.
-<BR>
-Scope:<B>global</B>.
+<DT><STRONG>a</STRONG></DT>
+<DD>the sparse matrix to be written.
 <BR>
 Type:<B>required</B>.
 <BR>
-Intent: <B>in</B>.
-<BR>
-Specified as: an integer value.
+Specified as: a structured data of type spdata<TT>psb_Tspmat_type</TT>.
 </DD>
-<DT><STRONG>ptype</STRONG></DT>
-<DD>the type of preconditioner. 
-Scope: <B>global</B> 
+<DT><STRONG>mtitle</STRONG></DT>
+<DD>Matrix title.
 <BR>
-Type: <B>required</B>
+Type: <B>required</B> 
 <BR>
-Intent: <B>in</B>.
-<BR>
-Specified as: a character string, see usage notes.
+A charachter variable holding a descriptive title for the matrix to be
+ written to file.
 </DD>
-<DT><STRONG><B>On Exit</B></STRONG></DT>
-<DD><P>
+<DT><STRONG>filename</STRONG></DT>
+<DD>The name of the file to be written to.
+<BR>
+Type:<B>optional</B>.
+<BR>
+Specified as: a character variable containing a valid file name, or
+<code>-</code>, in which case the default output unit  6 (i.e. standard output
+in Unix jargon) is used. Default: <code>-</code>. 
 </DD>
-<DT><STRONG>prec</STRONG></DT>
-<DD>Scope: <B>local</B> 
+<DT><STRONG>iunit</STRONG></DT>
+<DD>The Fortran file unit number.
 <BR>
-Type: <B>required</B>
+Type:<B>optional</B>.
 <BR>
-Intent: <B>inout</B>.
-<BR>
-Specified as: a preconditioner data structure precdata<TT>psb_prec_type</TT>.
-</DD>
-<DT><STRONG>info</STRONG></DT>
-<DD>Scope: <B>global</B> 
-<BR>
-Type: <B>required</B>
-<BR>
-Intent: <B>out</B>.
-<BR>
-Error code: if no error, 0 is returned.
+Specified as: an integer value. Only meaningful if filename is not <code>-</code>.
 </DD>
 </DL>
-<BIG CLASS="LARGE"><B>Notes</B></BIG>
-Legal inputs to this subroutine are interpreted depending on the
-<SPAN CLASS="MATH"><IMG
- WIDTH="41" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
- SRC="img165.png"
- ALT="$ptype$"></SPAN> string as follows<A NAME="tex2html31"
-  HREF="footnode.html#foot7881"><SUP><SPAN CLASS="arabic">4</SPAN></SUP></A>:
+
+<P>
 <DL>
-<DT><STRONG>NONE</STRONG></DT>
-<DD>No preconditioning, i.e. the preconditioner is just a copy
-  operator.
+<DT><STRONG><B>On Return</B></STRONG></DT>
+<DD>
 </DD>
-<DT><STRONG>DIAG</STRONG></DT>
-<DD>Diagonal scaling; each entry of the input vector is
-  multiplied by the reciprocal of the sum of the absolute values of
-  the coefficients in the corresponding row of matrix  <SPAN CLASS="MATH"><IMG
- WIDTH="16" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
- SRC="img1.png"
- ALT="$A$"></SPAN>;
-</DD>
-<DT><STRONG>BJAC</STRONG></DT>
-<DD>Precondition by a  factorization of the
-  block-diagonal of matrix <SPAN CLASS="MATH"><IMG
- WIDTH="16" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
- SRC="img1.png"
- ALT="$A$"></SPAN>, where block boundaries are determined
-  by the data allocation boundaries for each process; requires no
-  communication. Only the incomplete factorization <SPAN CLASS="MATH"><IMG
- WIDTH="56" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
- SRC="img166.png"
- ALT="$ILU(0)$"></SPAN> is
-  currently implemented.  
+<DT><STRONG>iret</STRONG></DT>
+<DD>Error code.
+<BR>
+Type: <B>required</B> 
+<BR>
+An integer value; 0 means no error has been detected. 
 </DD>
 </DL>