fdurastante/psblas3
1
0
Fork 0
mirror of https://github.com/sfilippone/psblas3.git synced 2026-10-07 07:04: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/node98.html
+74 -48
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>Preconditioner routines</TITLE>
<META NAME="description" CONTENT="Preconditioner routines">
<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">
@@ -18,76 +18,102 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="STYLESHEET" HREF="userhtml.css">
<LINK REL="next" HREF="node103.html">
<LINK REL="previous" HREF="node92.html">
<LINK REL="up" HREF="userhtml.html">
<LINK REL="previous" HREF="node97.html">
<LINK REL="up" HREF="node93.html">
<LINK REL="next" HREF="node99.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1405"
<A NAME="tex2html1407"
HREF="node99.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1401"
HREF="userhtml.html">
<A NAME="tex2html1403"
HREF="node93.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1395"
<A NAME="tex2html1399"
HREF="node97.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1403"
<A NAME="tex2html1405"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1406"
HREF="node99.html">psb_precinit Initialize</A>
<B> Up:</B> <A NAME="tex2html1402"
HREF="userhtml.html">userhtml</A>
<B> Previous:</B> <A NAME="tex2html1396"
HREF="node97.html">mm_mat_write Write</A>
&nbsp; <B> <A NAME="tex2html1404"
<B> Next:</B> <A NAME="tex2html1408"
HREF="node99.html">Preconditioner routines</A>
<B> Up:</B> <A NAME="tex2html1404"
HREF="node93.html">Utilities</A>
<B> Previous:</B> <A NAME="tex2html1400"
HREF="node97.html">mm_vet_read Read</A>
&nbsp; <B> <A NAME="tex2html1406"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H1><A NAME="SECTION000110000000000000000"></A>
<A NAME="sec:precs"></A>
<H2><A NAME="SECTION000105000000000000000">
mm_mat_write -- Write a sparse matrix to a
file in the MatrixMarket format</A>
</H2>
<PRE>
call mm_mat_write(a, mtitle, iret, iunit, filename)
</PRE>
<DL>
<DT><STRONG>Type:</STRONG></DT>
<DD>Asynchronous.
</DD>
<DT><STRONG><B>On Entry </B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>a</STRONG></DT>
<DD>the sparse matrix to be written.
<BR>
Preconditioner routines
</H1>
Type:<B>required</B>.
<BR>
Specified as: a structured data of type spdata<TT>psb_spmat_type</TT>.
</DD>
<DT><STRONG>mtitle</STRONG></DT>
<DD>Matrix title.
<BR>
Type: <B>required</B>
<BR>
A charachter variable holding a descriptive title for the matrix to be
written to file.
</DD>
<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>iunit</STRONG></DT>
<DD>The Fortran file unit number.
<BR>
Type:<B>optional</B>.
<BR>
Specified as: an integer value. Only meaningful if filename is not <code>-</code>.
</DD>
</DL>
<P>
<A NAME="sec:psprecs"></A>The base PSBLAS library contains the implementation of two simple
preconditioning techniques:
<UL>
<LI>Diagonal Scaling
</LI>
<LI>Block Jacobi with ILU(0) factorization
</LI>
</UL>
The supporting data type and subroutine interfaces are defined in the
module <code>psb_prec_mod</code>.
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<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>
<P>
<BR><HR>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<UL>
<LI><A NAME="tex2html1407"
HREF="node99.html">psb_precinit -- Initialize a preconditioner</A>
<LI><A NAME="tex2html1408"
HREF="node100.html">psb_precbld -- Builds a preconditioner</A>
<LI><A NAME="tex2html1409"
HREF="node101.html">psb_precaply -- Preconditioner application routine</A>
<LI><A NAME="tex2html1410"
HREF="node102.html">psb_precdescr -- Prints a description of current
preconditioner</A>
</UL>
<!--End of Table of Child-Links-->
<BR><HR>
</BODY>
</HTML>