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

psblas3:

Browse Source 
Updated docs with CLONE method.
This commit is contained in:
Salvatore Filippone
2013-04-01 14:34:41 +00:00
parent db2daa7ab9
commit 8ba8f2b213
260 changed files with 21161 additions and 21017 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/html/node114.html
+51 -116
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_precbld -- Builds a preconditioner</TITLE>
<META NAME="description" CONTENT="psb_precbld -- Builds a preconditioner">
<TITLE>Preconditioner routines</TITLE>
<META NAME="description" CONTENT="Preconditioner routines">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -18,143 +18,78 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="STYLESHEET" HREF="userhtml.css">
<LINK REL="next" HREF="node115.html">
<LINK REL="previous" HREF="node113.html">
<LINK REL="up" HREF="node112.html">
<LINK REL="next" HREF="node120.html">
<LINK REL="previous" HREF="node108.html">
<LINK REL="up" HREF="userhtml.html">
<LINK REL="next" HREF="node115.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1641"
<A NAME="tex2html1639"
HREF="node115.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1637"
HREF="node112.html">
<A NAME="tex2html1635"
HREF="userhtml.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1631"
<A NAME="tex2html1629"
HREF="node113.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1639"
<A NAME="tex2html1637"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1642"
HREF="node115.html">psb_precaply Preconditioner</A>
<B> Up:</B> <A NAME="tex2html1638"
HREF="node112.html">Preconditioner routines</A>
<B> Previous:</B> <A NAME="tex2html1632"
HREF="node113.html">psb_precinit Initialize</A>
&nbsp; <B> <A NAME="tex2html1640"
<B> Next:</B> <A NAME="tex2html1640"
HREF="node115.html">psb_precinit Initialize</A>
<B> Up:</B> <A NAME="tex2html1636"
HREF="userhtml.html">userhtml</A>
<B> Previous:</B> <A NAME="tex2html1630"
HREF="node113.html">mm_mat_write Write</A>
&nbsp; <B> <A NAME="tex2html1638"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000112000000000000000">
psb_precbld -- Builds a preconditioner</A>
</H2>
<H1><A NAME="SECTION000110000000000000000"></A>
<A NAME="sec:precs"></A>
<BR>
Preconditioner routines
</H1>
<P>
<PRE>
call psb_precbld(a, desc_a, prec, info,amold,vmold)
</PRE>
<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>.
<P>
<DL>
<DT><STRONG>Type:</STRONG></DT>
<DD>Synchronous.
</DD>
<DT><STRONG><B>On Entry</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>a</STRONG></DT>
<DD>the system sparse matrix.
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>in</B>, target.
<BR>
Specified as: a sparse matrix data structure spdata<TT>psb_Tspmat_type</TT>.
</DD>
<DT><STRONG>prec</STRONG></DT>
<DD>the preconditioner.
<BR>
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>inout</B>.
<BR>
Specified as: an already initialized precondtioner data structure precdata<TT>psb_prec_type</TT>
<BR></DD>
<DT><STRONG>desc_a</STRONG></DT>
<DD>the problem communication descriptor.
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>in</B>, target.
<BR>
Specified as: a communication descriptor data structure descdata<TT>psb_desc_type</TT>.
</DD>
<DT><STRONG>amold</STRONG></DT>
<DD>The desired dynamic type for the internal matrix storage.
<BR>
Scope: <B>local</B>.
<BR>
Type: <B>optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an object of a class derived from spbasedata<TT>psb_T_base_sparse_mat</TT>.
</DD>
<DT><STRONG>vmold</STRONG></DT>
<DD>The desired dynamic type for the internal vector storage.
<BR>
Scope: <B>local</B>.
<BR>
Type: <B>optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an object of a class derived from vbasedata<TT>psb_T_base_vect_type</TT>.
<BR><HR>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<P>
</DD>
</DL>
<P>
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>prec</STRONG></DT>
<DD>the preconditioner.
<BR>
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>inout</B>.
<BR>
Specified as: a precondtioner data structure precdata<TT>psb_prec_type</TT>
<BR></DD>
<DT><STRONG>info</STRONG></DT>
<DD>Error code.
<BR>
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>out</B>.
<BR>
An integer value; 0 means no error has been detected.
</DD>
</DL>
<P>
<UL>
<LI><A NAME="tex2html1641"
HREF="node115.html">psb_precinit -- Initialize a preconditioner</A>
<LI><A NAME="tex2html1642"
HREF="node116.html">psb_precbld -- Builds a preconditioner</A>
<LI><A NAME="tex2html1643"
HREF="node117.html">psb_precaply -- Preconditioner application routine</A>
<LI><A NAME="tex2html1644"
HREF="node118.html">psb_precdescr -- Prints a description of current
preconditioner</A>
<LI><A NAME="tex2html1645"
HREF="node119.html">clone -- clone current
preconditioner</A>
</UL>
<!--End of Table of Child-Links-->
<BR><HR>
</BODY>