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

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
docs/html/node126.html
+96 -58
View File
@@ -1,65 +1,60 @@
<!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>apply -- Preconditioner application routine</TITLE>
<META NAME="description" CONTENT="apply -- Preconditioner application routine">
<TITLE>build -- Builds a preconditioner</TITLE>
<META NAME="description" CONTENT="build -- Builds a preconditioner">
<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="node127.html">
<LINK REL="previous" HREF="node125.html">
<LINK REL="up" HREF="node123.html">
<LINK REL="up" HREF="node124.html">
<LINK REL="next" HREF="node127.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1832"
<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html1835"
HREF="node127.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1828"
HREF="node123.html">
<A NAME="tex2html1831"
HREF="node124.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1822"
<A NAME="tex2html1825"
HREF="node125.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1830"
<A NAME="tex2html1833"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1833"
HREF="node127.html">descr Prints</A>
<B> Up:</B> <A NAME="tex2html1829"
HREF="node123.html">Preconditioner routines</A>
<B> Previous:</B> <A NAME="tex2html1823"
HREF="node125.html">build Builds</A>
&nbsp; <B> <A NAME="tex2html1831"
<B> Next:</B> <A NAME="tex2html1836"
HREF="node127.html">apply Preconditioner</A>
<B> Up:</B> <A NAME="tex2html1832"
HREF="node124.html">Preconditioner routines</A>
<B> Previous:</B> <A NAME="tex2html1826"
HREF="node125.html">init Initialize</A>
&nbsp; <B> <A NAME="tex2html1834"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<BR></DIV>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000113000000000000000">
apply -- Preconditioner application
routine</A>
<H2><A NAME="SECTION000112000000000000000">
build -- Builds a preconditioner</A>
</H2>
<P>
<PRE>
call prec%apply(x,y,desc_a,info,trans,work)
call prec%apply(x,desc_a,info,trans)
call prec%build(a, desc_a, info[,amold,vmold,imold])
</PRE>
<P>
@@ -70,54 +65,69 @@ call prec%apply(x,desc_a,info,trans)
<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.
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>
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.
<DD>the problem communication descriptor.
Scope: <B>local</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>in</B>.
Intent: <B>in</B>, target.
<BR>
Specified as: a communication data structure descdata<TT>psb_desc_type</TT>.
Specified as: a communication descriptor data structure descdata<TT>psb_desc_type</TT>.
</DD>
<DT><STRONG>trans</STRONG></DT>
<DD>Scope:
<DT><STRONG>amold</STRONG></DT>
<DD>The desired dynamic type for the internal matrix storage.
<BR>
Type: <B>optional</B>
Scope: <B>local</B>.
<BR>
Type: <B>optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: a character.
Specified as: an object of a class derived from spbasedata<TT>psb_T_base_sparse_mat</TT>.
</DD>
<DT><STRONG>work</STRONG></DT>
<DD>an optional work space
Scope: <B>local</B>
<DT><STRONG>vmold</STRONG></DT>
<DD>The desired dynamic type for the internal vector storage.
<BR>
Type: <B>optional</B>
Scope: <B>local</B>.
<BR>
Intent: <B>inout</B>.
Type: <B>optional</B>.
<BR>
Specified as: a double precision array.
Intent: <B>in</B>.
<BR>
Specified as: an object of a class derived from vbasedata<TT>psb_T_base_vect_type</TT>.
</DD>
<DT><STRONG>imold</STRONG></DT>
<DD>The desired dynamic type for the internal integer 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 (integer) vbasedata<TT>psb_T_base_vect_type</TT>.
</DD>
</DL>
@@ -126,16 +136,17 @@ Specified as: a double precision array.
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>y</STRONG></DT>
<DD>the destination vector.
<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 rank one array or an object of type vdata<TT>psb_T_vect_type</TT>.
</DD>
Specified as: a precondtioner data structure precdata<TT>psb_prec_type</TT>
<BR></DD>
<DT><STRONG>info</STRONG></DT>
<DD>Error code.
<BR>
@@ -148,9 +159,36 @@ Intent: <B>out</B>.
An integer value; 0 means no error has been detected.
</DD>
</DL>
The <code>amold</code>, <code>vmold</code> and <code>imold</code> arguments may be
employed to interface with special devices, such as GPUs and other
accelerators.
<P>
<BR><HR>
<DIV CLASS="navigation"><HR>
<!--Navigation Panel-->
<A NAME="tex2html1835"
HREF="node127.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1831"
HREF="node124.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1825"
HREF="node125.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1833"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1836"
HREF="node127.html">apply Preconditioner</A>
<B> Up:</B> <A NAME="tex2html1832"
HREF="node124.html">Preconditioner routines</A>
<B> Previous:</B> <A NAME="tex2html1826"
HREF="node125.html">init Initialize</A>
&nbsp; <B> <A NAME="tex2html1834"
HREF="node1.html">Contents</A></B> </DIV>
<!--End of Navigation Panel-->
</BODY>
</HTML>