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:
+91
-29
@@ -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_precdescr -- Prints a description of current preconditioner</TITLE>
|
||||
<META NAME="description" CONTENT="psb_precdescr -- Prints a description of current preconditioner">
|
||||
<TITLE>psb_precbld -- Builds a preconditioner</TITLE>
|
||||
<META NAME="description" CONTENT="psb_precbld -- Builds a preconditioner">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -20,75 +20,137 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
|
||||
<LINK REL="next" HREF="node126.html">
|
||||
<LINK REL="previous" HREF="node124.html">
|
||||
<LINK REL="up" HREF="node121.html">
|
||||
<LINK REL="up" HREF="node123.html">
|
||||
<LINK REL="next" HREF="node126.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html1811"
|
||||
<A NAME="tex2html1817"
|
||||
HREF="node126.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1807"
|
||||
HREF="node121.html">
|
||||
<A NAME="tex2html1813"
|
||||
HREF="node123.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1801"
|
||||
<A NAME="tex2html1807"
|
||||
HREF="node124.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1809"
|
||||
<A NAME="tex2html1815"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1812"
|
||||
HREF="node126.html">clone clone</A>
|
||||
<B> Up:</B> <A NAME="tex2html1808"
|
||||
HREF="node121.html">Preconditioner routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1802"
|
||||
HREF="node124.html">psb_precaply Preconditioner</A>
|
||||
<B> <A NAME="tex2html1810"
|
||||
<B> Next:</B> <A NAME="tex2html1818"
|
||||
HREF="node126.html">psb_precaply Preconditioner</A>
|
||||
<B> Up:</B> <A NAME="tex2html1814"
|
||||
HREF="node123.html">Preconditioner routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1808"
|
||||
HREF="node124.html">psb_precinit Initialize</A>
|
||||
<B> <A NAME="tex2html1816"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION000114000000000000000">
|
||||
psb_precdescr -- Prints a description of current
|
||||
preconditioner</A>
|
||||
<H2><A NAME="SECTION000112000000000000000">
|
||||
psb_precbld -- Builds a preconditioner</A>
|
||||
</H2>
|
||||
|
||||
<P>
|
||||
<PRE>
|
||||
call psb_precdescr(prec)
|
||||
call psb_precdescr(prec, iout)
|
||||
call psb_precbld(a, desc_a, prec, info,amold,vmold)
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG>Type:</STRONG></DT>
|
||||
<DD>Asynchronous.
|
||||
<DD>Synchronous.
|
||||
</DD>
|
||||
<DT><STRONG><B>On Entry</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>prec</STRONG></DT>
|
||||
<DD>the preconditioner.
|
||||
<DT><STRONG>a</STRONG></DT>
|
||||
<DD>the system sparse matrix.
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
Intent: <B>in</B>, target.
|
||||
<BR>
|
||||
Specified as: a preconditioner data structure precdata<TT>psb_prec_type</TT>.
|
||||
Specified as: a sparse matrix data structure spdata<TT>psb_Tspmat_type</TT>.
|
||||
</DD>
|
||||
<DT><STRONG>iout</STRONG></DT>
|
||||
<DD>output unit.
|
||||
<DT><STRONG>prec</STRONG></DT>
|
||||
<DD>the preconditioner.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>optiona</B>
|
||||
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 integer number.
|
||||
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>.
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user