HTML doc fixes.

2026-10-06 22:55:12 +00:00 · 2017-07-25 14:13:43 +01:00
parent 1e00bb73f5
commit 79922b5939
34 changed files with 4163 additions and 3785 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>Subroutine build</TITLE>
-<META NAME="description" CONTENT="Subroutine build">
+<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">
@@ -20,50 +20,49 @@ original version by:  Nikos Drakos, CBLU, University of Leeds

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

 <BODY >
 <!--Navigation Panel-->
-<A NAME="tex2html299"
+<A NAME="tex2html306"
  HREF="node19.html">
 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
-<A NAME="tex2html295"
-  HREF="node15.html">
+<A NAME="tex2html302"
+  HREF="node17.html">
 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
-<A NAME="tex2html289"
+<A NAME="tex2html296"
  HREF="node17.html">
 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
-<A NAME="tex2html297"
+<A NAME="tex2html304"
  HREF="node2.html">
 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>  
 <BR>
-<B> Next:</B> <A NAME="tex2html300"
-  HREF="node19.html">Subroutine hierarchy_build</A>
-<B> Up:</B> <A NAME="tex2html296"
-  HREF="node15.html">User Interface</A>
-<B> Previous:</B> <A NAME="tex2html290"
-  HREF="node17.html">Subroutine set</A>
- &nbsp; <B>  <A NAME="tex2html298"
+<B> Next:</B> <A NAME="tex2html307"
+  HREF="node19.html">Subroutine set</A>
+<B> Up:</B> <A NAME="tex2html303"
+  HREF="node17.html">User Interface</A>
+<B> Previous:</B> <A NAME="tex2html297"
+  HREF="node17.html">User Interface</A>
+ &nbsp; <B>  <A NAME="tex2html305"
  HREF="node2.html">Contents</A></B> 
 <BR>
 <BR>
 <!--End of Navigation Panel-->

-<H2><A NAME="SECTION00083000000000000000"></A><A NAME="sec:precbld"></A>
+<H2><A NAME="SECTION00081000000000000000"></A><A NAME="sec:precinit"></A>
 <BR>
-Subroutine build
+Subroutine init
 </H2><FONT SIZE="+1"><FONT SIZE="+1"></FONT></FONT>
 <P>
 <FONT SIZE="+1"><FONT SIZE="+1"></FONT></FONT>
-<DIV ALIGN="CENTER"><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"><code>call p%build(a,desc_a,info)</code>
-<BR></FONT></FONT></FONT></DIV><FONT SIZE="+1"><FONT SIZE="+1"></FONT></FONT>
+<DIV ALIGN="CENTER"><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"><code>call p%init(ptype,info)</code>
+</FONT></FONT></FONT></DIV><FONT SIZE="+1"><FONT SIZE="+1"></FONT></FONT>
 <P>
 <FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1">
-This routine builds the one-level preconditioner <code>p</code> according to the requirements
-made by the user through the routines <code>init</code> and <code>set</code>
-(see Sections&nbsp;<A HREF="node19.html#sec:hier_bld">6.4</A> and&nbsp;<A HREF="node20.html#sec:smooth_bld">6.5</A> for multi-level preconditioners).
+This routine allocates and initializes the preconditioner
+<code>p</code>, according to the preconditioner type chosen by the user.
 </FONT></FONT></FONT>
 <P>
 <FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"><B>Arguments</B></FONT> </FONT></FONT></FONT>
@@ -71,34 +70,25 @@ made by the user through the routines <code>init</code> and <code>set</code>
 <FONT SIZE="+1"><FONT SIZE="+1"></FONT></FONT>
 <P>
 <FONT SIZE="+1"><FONT SIZE="+1"></FONT></FONT><TABLE CELLPADDING=3>
-<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=34><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1">
-<code>a</code>  </FONT></FONT></FONT></TD>
-<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> <code>type(psb_</code><I>x</I><code>spmat_type), intent(in)</code>. </FONT></FONT></FONT></TD>
+<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=34><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"><code>ptype</code>  </FONT></FONT></FONT></TD>
+<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> <code>character(len=*), intent(in)</code>.</FONT></FONT></FONT></TD>
 </TR>
 <TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=34><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> 
              </FONT></FONT></FONT></TD>
-<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> The sparse matrix structure containing the local part of the
-                matrix to be preconditioned. Note that <I>x</I> must be chosen according
-                to the real/complex, single/double precision version of MLD2P4 under use.
-                See the PSBLAS User's Guide for details [<A
- HREF="node27.html#PSBLASGUIDE">13</A>].</FONT></FONT></FONT></TD>
-</TR>
-<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=34><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> 
-<code>desc_a</code> </FONT></FONT></FONT></TD>
-<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> <code>type(psb_desc_type), intent(in)</code>. </FONT></FONT></FONT></TD>
+<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> The type of preconditioner. Its values are specified
+              in Table&nbsp;<A HREF="#tab:precinit">1</A>.</FONT></FONT></FONT></TD>
 </TR>
 <TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=34><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> 
              </FONT></FONT></FONT></TD>
-<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> The communication descriptor of <code>a</code>. See the PSBLAS User's Guide for
-                details [<A
- HREF="node27.html#PSBLASGUIDE">13</A>].</FONT></FONT></FONT></TD>
+<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> Note that the strings are case insensitive.</FONT></FONT></FONT></TD>
 </TR>
-<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=34><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> <code>info</code>   </FONT></FONT></FONT></TD>
+<TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=34><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> 
+<code>info</code>   </FONT></FONT></FONT></TD>
 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> <code>integer, intent(out)</code>.</FONT></FONT></FONT></TD>
 </TR>
 <TR><TD ALIGN="LEFT" VALIGN="TOP" WIDTH=34><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> 
              </FONT></FONT></FONT></TD>
-<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> Error code. If no error, 0 is returned. See Section&nbsp;<A HREF="node25.html#sec:errors">8</A> for details.</FONT></FONT></FONT></TD>
+<TD ALIGN="LEFT" VALIGN="TOP" WIDTH=340><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"> Error code. If no error, 0 is returned. See Section&nbsp;<A HREF="node27.html#sec:errors">8</A> for details.</FONT></FONT></FONT></TD>
 </TR>
 </TABLE><FONT SIZE="+1"><FONT SIZE="+1"></FONT></FONT>
 <P>
@@ -107,37 +97,33 @@ as follows:
 </FONT></FONT></FONT>
 <P>
 <FONT SIZE="+1"><FONT SIZE="+1"></FONT></FONT>
-<DIV ALIGN="CENTER"><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"><code>call mld_precbld(p,what,val,info)</code>
+<DIV ALIGN="CENTER"><FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1"><code>call mld_precinit(p,ptype,info)</code>
 </FONT></FONT></FONT></DIV><FONT SIZE="+1"><FONT SIZE="+1"></FONT></FONT>
 <P>
-<FONT SIZE="+1"><FONT SIZE="+1"><FONT SIZE="+1">
-In this case, the routine can be used to build multi-level preconditioners too.
-</FONT></FONT></FONT>
-<P>
 <FONT SIZE="+1"><FONT SIZE="+1"></FONT></FONT>
 <P>
 <FONT SIZE="+1"><FONT SIZE="+1"></FONT></FONT><HR>
 <!--Navigation Panel-->
-<A NAME="tex2html299"
+<A NAME="tex2html306"
  HREF="node19.html">
 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
-<A NAME="tex2html295"
-  HREF="node15.html">
+<A NAME="tex2html302"
+  HREF="node17.html">
 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
-<A NAME="tex2html289"
+<A NAME="tex2html296"
  HREF="node17.html">
 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
-<A NAME="tex2html297"
+<A NAME="tex2html304"
  HREF="node2.html">
 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>  
 <BR>
-<B> Next:</B> <A NAME="tex2html300"
-  HREF="node19.html">Subroutine hierarchy_build</A>
-<B> Up:</B> <A NAME="tex2html296"
-  HREF="node15.html">User Interface</A>
-<B> Previous:</B> <A NAME="tex2html290"
-  HREF="node17.html">Subroutine set</A>
- &nbsp; <B>  <A NAME="tex2html298"
+<B> Next:</B> <A NAME="tex2html307"
+  HREF="node19.html">Subroutine set</A>
+<B> Up:</B> <A NAME="tex2html303"
+  HREF="node17.html">User Interface</A>
+<B> Previous:</B> <A NAME="tex2html297"
+  HREF="node17.html">User Interface</A>
+ &nbsp; <B>  <A NAME="tex2html305"
  HREF="node2.html">Contents</A></B> 
 <!--End of Navigation Panel-->