Minor doc changes

mergeparmatch
Salvatore Filippone 4 years ago
parent 6bf1b33e4d
commit 2b60afe6c3

Binary file not shown.

@ -136,7 +136,7 @@ class="cmr-12">routine; if the</span>
<span <span
class="cmr-12">library code does not recognize a keyword, it passes it down the composition hierarchy</span> class="cmr-12">library code does not recognize a keyword, it passes it down the composition hierarchy</span>
<span <span
class="cmr-12">(levels containing smoothers containing in turn solvers), so that it can be eventually</span> class="cmr-12">(levels containing smoothers containing in turn solvers), so that it can eventually be</span>
<span <span
class="cmr-12">caught by the new solver. By the same token, any keyword/value pair that does not</span> class="cmr-12">caught by the new solver. By the same token, any keyword/value pair that does not</span>
<span <span

@ -454,13 +454,13 @@ class="cmr-12">).</span>
class="newline" /> class="newline" />
<!--l. 178--><p class="indent" > <span <!--l. 178--><p class="indent" > <span
class="cmbx-12">Remark 3. </span><span class="cmbx-12">Remark 3. </span><span
class="cmr-12">Many of the coarsest-level solvers cannot be used with both the</span> class="cmr-12">Many of the coarsest-level solvers cannot be used with both replicated</span>
<span <span
class="cmr-12">replicated and distributed coarsest-matrix layout; therefore, setting the solver after the</span> class="cmr-12">and distributed coarsest-matrix layouts; therefore, setting the solver after the layout</span>
<span <span
class="cmr-12">layout may change the layout. Similarly, setting the layout after the solver may change</span> class="cmr-12">may change the layout. Similarly, setting the layout after the solver may change the</span>
<span <span
class="cmr-12">the solver.</span> class="cmr-12">solver.</span>
<!--l. 183--><p class="indent" > <span <!--l. 183--><p class="indent" > <span
class="cmr-12">More precisely, UMFPACK and SuperLU require the coarsest-level matrix to be</span> class="cmr-12">More precisely, UMFPACK and SuperLU require the coarsest-level matrix to be</span>
<span <span
@ -1652,10 +1652,15 @@ class="cmtt-10x-x-109">&#8217;</span><span
class="cmtt-10x-x-109">FCG</span><span class="cmtt-10x-x-109">FCG</span><span
class="cmtt-10x-x-109">&#8217;</span> </td><td style="white-space:normal; text-align:left;" id="TBL-8-7-5" class="cmtt-10x-x-109">&#8217;</span> </td><td style="white-space:normal; text-align:left;" id="TBL-8-7-5"
class="td11"><!--l. 504--><p class="noindent" >A string that defines the iterative method to class="td11"><!--l. 504--><p class="noindent" >A string that defines the iterative method to
be used. <span be used when employing a Krylov method
class="cmtt-10x-x-109">CG </span>the Conjugate Gradient method; <span class="lstinline"></span><span
<span class="cmtt-10x-x-109">&#8217;</span><span
class="cmtt-10x-x-109">CGS </span>the Conjugate Gradient Stabilized class="cmtt-10x-x-109">KRM</span><span
class="cmtt-10x-x-109">&#8217;</span> as a coarse solver. <span
class="cmtt-10x-x-109">CG </span>the Conjugate
Gradient method; <span
class="cmtt-10x-x-109">CGS </span>the Conjugate Gradient
Stabilized
method; <span method; <span
class="cmtt-10x-x-109">GCR </span>the Generalized Conjugate class="cmtt-10x-x-109">GCR </span>the Generalized Conjugate
Residual method; <span Residual method; <span

@ -37,7 +37,7 @@ been modified to account for this new development.
It is possible to define new values for the keyword \verb|WHAT| in the It is possible to define new values for the keyword \verb|WHAT| in the
\verb|set| routine; if the library code does not recognize a keyword, \verb|set| routine; if the library code does not recognize a keyword,
it passes it down the composition hierarchy (levels containing it passes it down the composition hierarchy (levels containing
smoothers containing in turn solvers), so that it can be eventually caught by smoothers containing in turn solvers), so that it can eventually be caught by
the new solver. By the same token, any keyword/value pair that does not pertain to the new solver. By the same token, any keyword/value pair that does not pertain to
a given smoother should be passed down to the contained solver, and a given smoother should be passed down to the contained solver, and
any keyword/value pair that does not pertain to a given solver is by any keyword/value pair that does not pertain to a given solver is by

@ -176,7 +176,7 @@ coarsest-level solvers, and shortcuts are available
in this case too (see Table~\ref{tab:p_coarse_1}). \\ in this case too (see Table~\ref{tab:p_coarse_1}). \\
\textbf{Remark 3.} Many of the coarsest-level solvers cannot be used \textbf{Remark 3.} Many of the coarsest-level solvers cannot be used
with both the replicated and distributed coarsest-matrix layout; with both replicated and distributed coarsest-matrix layouts;
therefore, setting the solver after the layout may change the layout. therefore, setting the solver after the layout may change the layout.
Similarly, setting the layout after the solver may change the solver. Similarly, setting the layout after the solver may change the solver.
@ -502,7 +502,7 @@ level (continued).\label{tab:p_coarse_1}}
\fortinline|'BJAC_RESCHECK'|& \fortinline|integer| & Any integer\par $>0$ & -1 & Number of iterations after which a residual is to be calculated. \\ \hline \fortinline|'BJAC_RESCHECK'|& \fortinline|integer| & Any integer\par $>0$ & -1 & Number of iterations after which a residual is to be calculated. \\ \hline
\fortinline|'BJAC_STOPTOL'| & \fortinline|real(kind_parameter)| & Any real\par $<1$ & 0 & Tolerance for the stopping criterion on the residual. \\ \hline \fortinline|'BJAC_STOPTOL'| & \fortinline|real(kind_parameter)| & Any real\par $<1$ & 0 & Tolerance for the stopping criterion on the residual. \\ \hline
\fortinline|'KRM_METHOD'| & \fortinline|character(len=*)| & \fortinline|'CG'| \par \fortinline|'FCG'| \par \fortinline|'CGS'| \par \fortinline|'CGR'| \par \fortinline|'BICG'| \par \fortinline|'BICGSTAB'| \par \fortinline|'BICGSTABL'| \par \fortinline|'RGMRES'| & \fortinline|'FCG'| & A string that defines the iterative method to be \fortinline|'KRM_METHOD'| & \fortinline|character(len=*)| & \fortinline|'CG'| \par \fortinline|'FCG'| \par \fortinline|'CGS'| \par \fortinline|'CGR'| \par \fortinline|'BICG'| \par \fortinline|'BICGSTAB'| \par \fortinline|'BICGSTABL'| \par \fortinline|'RGMRES'| & \fortinline|'FCG'| & A string that defines the iterative method to be
used. \texttt{CG} the Conjugate Gradient method; used when employing a Krylov method \fortinline|'KRM'| as a coarse solver. \texttt{CG} the Conjugate Gradient method;
\texttt{CGS} the Conjugate Gradient Stabilized method; \texttt{CGS} the Conjugate Gradient Stabilized method;
\texttt{GCR} the Generalized Conjugate Residual method; \texttt{GCR} the Generalized Conjugate Residual method;
\texttt{FCG} the Flexible Conjugate Gradient method; \texttt{FCG} the Flexible Conjugate Gradient method;
@ -940,7 +940,7 @@ Create a (deep) copy of the preconditioner object.
\begin{tabular}{p{1.2cm}p{12cm}} \begin{tabular}{p{1.2cm}p{12cm}}
\fortinline|global| & \fortinline|logical, optional|.\\ \fortinline|global| & \fortinline|logical, optional|.\\
& Whether the global or local preconditioner memory & Whether the global or local preconditioner memory
occupatio is occupation is
desired. Default: \fortinline|.false.|.\\ desired. Default: \fortinline|.false.|.\\
\end{tabular} \end{tabular}
\noindent \noindent
@ -951,7 +951,7 @@ Return memory footprint in bytes.
\begin{center} \begin{center}
\fortinline|call p%allocate_wrk(info[, vmold])|\\ \fortinline|call p%allocate_wrk(info[, vmold])|\\
\end{center} \end{center}
n
\noindent \noindent
Allocate internal work vectors. Each application of the preconditioner Allocate internal work vectors. Each application of the preconditioner
uses a number of work vectors which are allocated internally as uses a number of work vectors which are allocated internally as

Loading…
Cancel
Save