Document DESC%CNV method and MOLD arguments to CDASB and PREC%BUILD

This commit is contained in:
Salvatore Filippone
2017-12-14 17:09:59 +00:00
parent 4beef03aec
commit c3633b6fb2
140 changed files with 24695 additions and 24798 deletions
+54 -56
View File
@@ -1,89 +1,87 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<!--Converted with LaTeX2HTML 2017.2 (Released Jan 23, 2017) -->
<HTML>
<HEAD>
<TITLE>Preconditioner data structure</TITLE>
<META NAME="description" CONTENT="Preconditioner data structure">
<TITLE>clone -- Clone current object</TITLE>
<META NAME="description" CONTENT="clone -- Clone current object">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META NAME="Generator" CONTENT="LaTeX2HTML v2017.2">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="userhtml.css">
<LINK REL="next" HREF="node50.html">
<LINK REL="previous" HREF="node42.html">
<LINK REL="up" HREF="node9.html">
<LINK REL="previous" HREF="node48.html">
<LINK REL="up" HREF="node43.html">
<LINK REL="next" HREF="node50.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html848"
<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html851"
HREF="node50.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html844"
HREF="node9.html">
<A NAME="tex2html847"
HREF="node43.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html838"
<A NAME="tex2html843"
HREF="node48.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html846"
<A NAME="tex2html849"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html849"
HREF="node50.html">Heap data structure</A>
<B> Up:</B> <A NAME="tex2html845"
HREF="node9.html">Data Structures and Classes</A>
<B> Previous:</B> <A NAME="tex2html839"
HREF="node48.html">clone Clone</A>
&nbsp; <B> <A NAME="tex2html847"
<B> Next:</B> <A NAME="tex2html852"
HREF="node50.html">Preconditioner data structure</A>
<B> Up:</B> <A NAME="tex2html848"
HREF="node43.html">Dense Vector Data Structure</A>
<B> Previous:</B> <A NAME="tex2html844"
HREF="node48.html">get_vect Get</A>
&nbsp; <B> <A NAME="tex2html850"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<BR></DIV>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION00044000000000000000"></A>
<A NAME="sec:prec"></A>
<BR>
Preconditioner data structure
</H2>
Our base library offers support for simple well known preconditioners
like Diagonal Scaling or Block Jacobi with incomplete
factorization ILU(0).
<H3><A NAME="SECTION00043600000000000000">
clone -- Clone current object</A>
</H3>
<PRE>
call x%clone(y,info)
</PRE>
<P>
A preconditioner is held in the precdata<TT> psb_prec_type</TT> data structure reported in
figure&nbsp;<A HREF="#fig:prectype">6</A>. The <code>psb_prec_type</code>
data type may contain a simple preconditioning matrix with the
associated communication descriptor.The internal preconditioner is allocated appropriately with the
dynamic type corresponding to the desired preconditioner.
<DL>
<DT><STRONG>Type:</STRONG></DT>
<DD>Asynchronous.
</DD>
<DT><STRONG><B>On Entry</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>x</STRONG></DT>
<DD>the dense vector.
<BR>
Scope: <B>local</B>.
<BR></DD>
</DL>
<DIV ALIGN="CENTER"><A NAME="fig:prectype"></A><A NAME="925"></A>
<TABLE>
<CAPTION ALIGN="BOTTOM"><STRONG>Figure 6:</STRONG>
The PSBLAS defined data type that contains a preconditioner.</CAPTION>
<TR><TD><FONT SIZE="-1">
</FONT>
<DIV ALIGN="CENTER"></DIV><TABLE WIDTH="90%">
<TR><TD>
<PRE>
type psb_Tprec_type
class(psb_T_base_prec_type), allocatable :: prec
end type psb_Tprec_type
</PRE></TD></TR>
</TABLE>
<DIV ALIGN="CENTER"></DIV></TD></TR>
</TABLE>
</DIV>
<P>
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>y</STRONG></DT>
<DD>A copy of the input object.
</DD>
<DT><STRONG>info</STRONG></DT>
<DD>Return code.
</DD>
</DL>
<P>
<BR><HR>