Added entrywise inversion and documentation for vec-vec operation

This commit is contained in:
cirdans-home
2019-11-21 13:56:22 +01:00
parent db7b882e9c
commit b3c4971146
340 changed files with 24932 additions and 20314 deletions
+60 -115
View File
@@ -3,8 +3,8 @@
<!--Converted with LaTeX2HTML 2018 (Released Feb 1, 2018) -->
<HTML>
<HEAD>
<TITLE>apply -- Preconditioner application routine</TITLE>
<META NAME="description" CONTENT="apply -- Preconditioner application routine">
<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">
@@ -14,139 +14,84 @@
<LINK REL="STYLESHEET" HREF="userhtml.css">
<LINK REL="next" HREF="node129.html">
<LINK REL="previous" HREF="node127.html">
<LINK REL="up" HREF="node125.html">
<LINK REL="next" HREF="node135.html">
<LINK REL="previous" HREF="node121.html">
<LINK REL="up" HREF="userhtml.html">
<LINK REL="next" HREF="node129.html">
</HEAD>
<BODY >
<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html1861"
<A NAME="tex2html1864"
HREF="node129.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1857"
HREF="node125.html">
<A NAME="tex2html1860"
HREF="userhtml.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1851"
<A NAME="tex2html1854"
HREF="node127.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1859"
<A NAME="tex2html1862"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1862"
HREF="node129.html">descr Prints</A>
<B> Up:</B> <A NAME="tex2html1858"
HREF="node125.html">Preconditioner routines</A>
<B> Previous:</B> <A NAME="tex2html1852"
HREF="node127.html">build Builds</A>
&nbsp; <B> <A NAME="tex2html1860"
<B> Next:</B> <A NAME="tex2html1865"
HREF="node129.html">init Initialize</A>
<B> Up:</B> <A NAME="tex2html1861"
HREF="userhtml.html">userhtml</A>
<B> Previous:</B> <A NAME="tex2html1855"
HREF="node127.html">mm_array_write Write</A>
&nbsp; <B> <A NAME="tex2html1863"
HREF="node1.html">Contents</A></B>
<BR>
<BR></DIV>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000113000000000000000">
apply -- Preconditioner application
<H1><A NAME="SECTION000110000000000000000"></A>
<A NAME="sec:precs"></A>
<BR>
Preconditioner routines
</H1>
<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>.
The old interfaces <code>psb_precinit</code> and <code>psb_precbld</code> are still supported for
backward compatibility
<P>
<BR><HR>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<UL CLASS="ChildLinks">
<LI><A NAME="tex2html1866"
HREF="node129.html">init -- Initialize a preconditioner</A>
<LI><A NAME="tex2html1867"
HREF="node130.html">build -- Builds a preconditioner</A>
<LI><A NAME="tex2html1868"
HREF="node131.html">apply -- Preconditioner application
routine</A>
</H2>
<P>
<PRE>
call prec%apply(x,y,desc_a,info,trans,work)
call prec%apply(x,desc_a,info,trans)
</PRE>
<P>
<DL>
<DT><STRONG>Type:</STRONG></DT>
<DD>Synchronous.
</DD>
<DT><STRONG><B>On Entry</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>prec</STRONG></DT>
<DD>the preconditioner.
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: a preconditioner data structure precdata<TT>psb_prec_type</TT>.
</DD>
<DT><STRONG>x</STRONG></DT>
<DD>the source vector.
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>inout</B>.
<BR>
Specified as: a rank one array or an object of type vdata<TT>psb_T_vect_type</TT>.
</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>.
<BR>
Specified as: a communication data structure descdata<TT>psb_desc_type</TT>.
</DD>
<DT><STRONG>trans</STRONG></DT>
<DD>Scope:
<BR>
Type: <B>optional</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: a character.
</DD>
<DT><STRONG>work</STRONG></DT>
<DD>an optional work space
Scope: <B>local</B>
<BR>
Type: <B>optional</B>
<BR>
Intent: <B>inout</B>.
<BR>
Specified as: a double precision array.
</DD>
</DL>
<P>
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>y</STRONG></DT>
<DD>the destination vector.
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>inout</B>.
<BR>
Specified as: a rank one array or an object of type vdata<TT>psb_T_vect_type</TT>.
</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>
<LI><A NAME="tex2html1869"
HREF="node132.html">descr -- Prints a description of current
preconditioner</A>
<LI><A NAME="tex2html1870"
HREF="node133.html">clone -- clone current
preconditioner</A>
<LI><A NAME="tex2html1871"
HREF="node134.html">free -- Free a preconditioner</A>
</UL>
<!--End of Table of Child-Links-->
<BR><HR>
</BODY>