mld2p4-2:

Docs updates.
2026-10-07 07:04:59 +00:00 · 2017-04-21 13:29:28 +00:00
parent f47513eb80
commit 05ab5f4d55
79 changed files with 6788 additions and 8368 deletions
@@ -7,8 +7,8 @@ original version by:  Nikos Drakos, CBLU, University of Leeds
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
 <HTML>
 <HEAD>
-<TITLE>User Interface</TITLE>
-<META NAME="description" CONTENT="User Interface">
+<TITLE>Subroutine init</TITLE>
+<META NAME="description" CONTENT="Subroutine init">
 <META NAME="keywords" CONTENT="userhtml">
 <META NAME="resource-type" CONTENT="document">
 <META NAME="distribution" CONTENT="global">
@@ -18,145 +18,92 @@ original version by:  Nikos Drakos, CBLU, University of Leeds

 <LINK REL="STYLESHEET" HREF="userhtml.css">

-<LINK REL="next" HREF="node25.html">
-<LINK REL="previous" HREF="node14.html">
-<LINK REL="up" HREF="userhtml.html">
+<LINK REL="next" HREF="node17.html">
+<LINK REL="previous" HREF="node15.html">
+<LINK REL="up" HREF="node15.html">
 <LINK REL="next" HREF="node17.html">
 </HEAD>

 <BODY >
 <!--Navigation Panel-->
-<A NAME="tex2html271"
+<A NAME="tex2html275"
  HREF="node17.html">
 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
-<A NAME="tex2html267"
-  HREF="userhtml.html">
+<A NAME="tex2html271"
+  HREF="node15.html">
 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
-<A NAME="tex2html261"
+<A NAME="tex2html265"
  HREF="node15.html">
 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
-<A NAME="tex2html269"
+<A NAME="tex2html273"
  HREF="node2.html">
 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>  
 <BR>
-<B> Next:</B> <A NAME="tex2html272"
-  HREF="node17.html">Subroutine init</A>
-<B> Up:</B> <A NAME="tex2html268"
-  HREF="userhtml.html">userhtml</A>
-<B> Previous:</B> <A NAME="tex2html262"
-  HREF="node15.html">Examples</A>
- &nbsp; <B>  <A NAME="tex2html270"
+<B> Next:</B> <A NAME="tex2html276"
+  HREF="node17.html">Subroutine set</A>
+<B> Up:</B> <A NAME="tex2html272"
+  HREF="node15.html">User Interface</A>
+<B> Previous:</B> <A NAME="tex2html266"
+  HREF="node15.html">User Interface</A>
+ &nbsp; <B>  <A NAME="tex2html274"
  HREF="node2.html">Contents</A></B> 
 <BR>
 <BR>
 <!--End of Navigation Panel-->

-<H1><A NAME="SECTION00080000000000000000"></A><A NAME="sec:userinterface"></A>
+<H2><A NAME="SECTION00081000000000000000"></A><A NAME="sec:precinit"></A>
 <BR>
-User Interface
-</H1>
+Subroutine init
+</H2>

 <P>
-The basic user interface of MLD2P4 consists of eight routines. The six
-routines <code>init</code>, <code>set</code>,
-<code>hierarchy_bld</code>, <code>smoothers_bld</code>,
-<code>bld</code>, and <code>apply</code> encapsulate all the
-functionalities for the setup and the application of any multi-level and one-level
-preconditioner implemented in the package. 
-The routine <code>free</code> deallocates the preconditioner data structure, while
-<code>descr</code> prints a description of the preconditioner setup by the user.
+<DIV ALIGN="CENTER">
+<code>call p%init(ptype,info)</code>
+
+</DIV>

 <P>
-All the routines are available as methods of the preconditioner object.
-For each routine, the same user interface is overloaded with
-respect to the real/ complex case and the single/double precision;
-arguments with appropriate data types must be passed to the routine,
-i.e.,
+This routine allocates and initializes the preconditioner
+<code>p</code>, according to the preconditioner type chosen by the user.

-<UL>
-<LI>the sparse matrix data structure, containing the matrix to be
-  preconditioned, must be of type <code>psb_</code><I>x</I><code>spmat_type</code>
-	with <I>x</I> = <code>s</code> for real single precision, <I>x</I> = <code>d</code>
-	for real double precision, <I>x</I> = <code>c</code> for complex single precision,
-	<I>x</I> = <code>z</code> for complex double precision;
-</LI>
-<LI>the preconditioner data structure must be of type
-  <code>mld_</code><I>x</I><code>prec_type</code>, with <I>x</I> =    
-  <code>s</code>, <code>d</code>, <code>c</code>, <code>z</code>, according to the sparse
-  matrix data structure;
-</LI>
-<LI>the arrays containing the vectors <IMG
- WIDTH="14" HEIGHT="18" ALIGN="BOTTOM" BORDER="0"
- SRC="img22.png"
- ALT="$v$"> and <IMG
- WIDTH="18" HEIGHT="18" ALIGN="BOTTOM" BORDER="0"
- SRC="img88.png"
- ALT="$w$"> involved in
-  the preconditioner application <IMG
- WIDTH="86" HEIGHT="21" ALIGN="BOTTOM" BORDER="0"
- SRC="img61.png"
- ALT="$w=M^{-1}v$"> must be of type   
-  <code>psb_</code><I>x</I><code>vect_type</code> with <I>x</I> =    
-  <code>s</code>, <code>d</code>, <code>c</code>, <code>z</code>, in a manner completely
-  analogous to the sparse matrix type;
-</LI>
-<LI>real parameters defining the preconditioner must be declared
-  according to the precision of the sparse matrix and preconditioner
-  data structures (see Section&nbsp;<A HREF="node18.html#sec:precset">6.2</A>).
-</LI>
-</UL>
-A description of each routine is given in the remainder of this section.
+<P>
+<FONT SIZE="+1"><B>Arguments</B></FONT> 
+<P></P>
+
+<P>
+<TABLE CELLPADDING=3>
+<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=34><code>ptype</code></TD>
+<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340><code>character(len=*), intent(in)</code>.</TD>
+</TR>
+<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=34>&nbsp;</TD>
+<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340>The type of preconditioner. Its values are specified
+              in Table&nbsp;<A HREF="#tab:precinit">1</A>.</TD>
+</TR>
+<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=34>&nbsp;</TD>
+<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340>Note that the strings are case insensitive.</TD>
+</TR>
+<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=34><code>info</code></TD>
+<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340><code>integer, intent(out)</code>.</TD>
+</TR>
+<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=34>&nbsp;</TD>
+<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340>Error code. If no error, 0 is returned. See Section&nbsp;<A HREF="node25.html#sec:errors">8</A> for details.</TD>
+</TR>
+</TABLE>
+
+<P>
+For compatibility with the previous versions of MLD2P4, this routine can be also invoked
+as follows:
+
+<P>
+<DIV ALIGN="CENTER">
+<code>call mld_precinit(p,ptype,info)</code>
+
+</DIV>

 <P>

 <P>
 <BR><HR>
-<!--Table of Child-Links-->
-<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
-
-<UL>
-<LI><A NAME="tex2html273"
-  HREF="node17.html">Subroutine init</A>
-<LI><A NAME="tex2html274"
-  HREF="node18.html">Subroutine set</A>
-<LI><A NAME="tex2html275"
-  HREF="node19.html">Subroutine bld</A>
-<LI><A NAME="tex2html276"
-  HREF="node20.html">Subroutine hierarchy_bld</A>
-<LI><A NAME="tex2html277"
-  HREF="node21.html">Subroutine smoothers_bld</A>
-<LI><A NAME="tex2html278"
-  HREF="node22.html">Subroutine apply</A>
-<LI><A NAME="tex2html279"
-  HREF="node23.html">Subroutine free</A>
-<LI><A NAME="tex2html280"
-  HREF="node24.html">Subroutine descr</A>
-</UL>
-<!--End of Table of Child-Links-->
-<HR>
-<!--Navigation Panel-->
-<A NAME="tex2html271"
-  HREF="node17.html">
-<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
-<A NAME="tex2html267"
-  HREF="userhtml.html">
-<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
-<A NAME="tex2html261"
-  HREF="node15.html">
-<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
-<A NAME="tex2html269"
-  HREF="node2.html">
-<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>  
-<BR>
-<B> Next:</B> <A NAME="tex2html272"
-  HREF="node17.html">Subroutine init</A>
-<B> Up:</B> <A NAME="tex2html268"
-  HREF="userhtml.html">userhtml</A>
-<B> Previous:</B> <A NAME="tex2html262"
-  HREF="node15.html">Examples</A>
- &nbsp; <B>  <A NAME="tex2html270"
-  HREF="node2.html">Contents</A></B> 
-<!--End of Navigation Panel-->

 </BODY>
 </HTML>