mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-16 19:02:09 +00:00
psblas3:
Updated docs.
This commit is contained in:
+48
-45
@@ -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 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">
|
||||
@@ -18,70 +18,73 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
|
||||
<LINK REL="STYLESHEET" HREF="userhtml.css">
|
||||
|
||||
<LINK REL="previous" HREF="node39.html">
|
||||
<LINK REL="up" HREF="node9.html">
|
||||
<LINK REL="previous" HREF="node44.html">
|
||||
<LINK REL="up" HREF="node40.html">
|
||||
<LINK REL="next" HREF="node46.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html774"
|
||||
<A NAME="tex2html779"
|
||||
HREF="node46.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html770"
|
||||
HREF="node9.html">
|
||||
<A NAME="tex2html775"
|
||||
HREF="node40.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html766"
|
||||
<A NAME="tex2html771"
|
||||
HREF="node44.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html772"
|
||||
<A NAME="tex2html777"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html775"
|
||||
HREF="node46.html">Computational routines</A>
|
||||
<B> Up:</B> <A NAME="tex2html771"
|
||||
HREF="node9.html">Data Structures and Classes</A>
|
||||
<B> Previous:</B> <A NAME="tex2html767"
|
||||
HREF="node44.html">clone Clone</A>
|
||||
<B> <A NAME="tex2html773"
|
||||
<B> Next:</B> <A NAME="tex2html780"
|
||||
HREF="node46.html">Preconditioner data structure</A>
|
||||
<B> Up:</B> <A NAME="tex2html776"
|
||||
HREF="node40.html">Dense Vector Data Structure</A>
|
||||
<B> Previous:</B> <A NAME="tex2html772"
|
||||
HREF="node44.html">get_vect Get</A>
|
||||
<B> <A NAME="tex2html778"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR>
|
||||
<!--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="SECTION00043500000000000000">
|
||||
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 <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="855"></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>
|
||||
|
||||
Reference in New Issue
Block a user