Doc fixes

This commit is contained in:
Salvatore Filippone
2024-11-16 12:03:28 +01:00
parent eefc67bbdd
commit 9c4f4c4d15
64 changed files with 18806 additions and 17588 deletions
+96
View File
@@ -84,6 +84,102 @@ $ptype$ string as follows\footnote{The string is case-insensitive}:
\end{description}
\clearpage
\subsection{Set\label{sec:precset} --- set preconditioner parameters}
\begin{center}
\fortinline|call p%set(what,val,info)|
\end{center}
\noindent
This method sets the parameters defining the subdomain solver when the
preconditioner type is \verb|BJAC|. More precisely, the parameter
identified by \fortinline|what| is assigned the value
contained in \fortinline|val|.
{\vskip1.5\baselineskip\noindent\large\bfseries Arguments} \smallskip
\begin{tabular}{p{1.2cm}p{12cm}}
\fortinline|what| & \fortinline|character(len=*)|. \\
& The parameter to be set. It can be specified through its name;
the string is case-insensitive. See
Tables~\ref{tab:p_cycle}-\ref{tab:p_smoother_1}.\\
\fortinline|val | & \fortinline|integer| \emph{or} \fortinline|character(len=*)| \emph{or}
\fortinline|real(psb_spk_)| \emph{or} \fortinline|real(psb_dpk_)|,
\fortinline|intent(in)|.\\
& The value of the parameter to be set. The list of allowed
values and the corresponding data types is given in
Tables~\ref{tab:p_cycle}-\ref{tab:p_smoother_1}.
When the value is of type \fortinline|character(len=*)|,
it is also treated as case insensitive.\\
\fortinline|info| & \fortinline|integer, intent(out)|.\\
& Error code. If no error, 0 is returned. See Section~\ref{sec:errors}
for details.
\end{tabular}
\noindent
A number of subdomain solvers can be chosen with this method;
a list of the parameters that can be set, along with their allowed and
default values, is given in Tables~\ref{tab:p_cycle}-\ref{tab:p_smoother_1}.\\
\bsideways
\begin{center}
\small
\begin{tabular}{|p{3.6cm}|l|p{1.9cm}|p{3.6cm}|p{6.5cm}|}
\hline
\fortinline|what| & \textsc{data type} & \fortinline|val| & \textsc{default} &
\textsc{comments} \\ \hline
\fortinline|'SUB_SOLVE'| & \fortinline|character(len=*)|
& \fortinline|'ILU'| \par
\fortinline|'ILUT'| \par
\par \fortinline|'INVT'| \par \fortinline|'INVK'| \par \fortinline|'AINV'|
&
& The local solver to be used with the smoother or one-level
preconditioner ILU($p$), ILU($p,t$),
Approximate Inverses INVK($p,q$),
INVT($p_1,p2,t_1,t_2$) and
AINV($t$); note that approximate inverses
are specifically suited for GPUs since they
do not employ triangular system solve
kernels,
see~\cite{BERTACCINIFILIPPONE}.\\ \hline
\hline
\end{tabular}
\end{center}
\caption{Parameters defining the solver or the details of the one-level preconditioner.
\label{tab:p_smoother}}
\esideways
\bsideways
\begin{center}
\small
\begin{tabular}{|p{3.2cm}|l|p{2.6cm}|p{2.6cm}|p{6.7cm}|}
\hline
\fortinline|what| & \textsc{data type} & \fortinline|val| & \textsc{default} &
\textsc{comments} \\ \hline
\fortinline|'SUB_FILLIN'| & \fortinline|integer|
& Any integer \par number~$\ge 0$
& 0
& Fill-in level $p$ of the incomplete LU factorizations. \\ \hline
\fortinline|'SUB_ILUTHRS'| & \fortinline|real(kind_parameter)|
& Any real number~$\ge 0$
& 0
& Drop tolerance $t$ in the ILU($p,t$) factorization. \\ \hline
\hline
\end{tabular}
\end{center}
\caption{Parameters defining the smoother or the details of the one-level preconditioner
(continued).\label{tab:p_smoother_1}}
\esideways
\clearpage\subsection{build --- Builds a preconditioner}
\begin{verbatim}
+4
View File
@@ -17,6 +17,8 @@
\newtheorem{theorem}{Theorem}
\newtheorem{corollary}{Corollary}
\usepackage{listings}
\usepackage{rotating}
\usepackage{microtype}
\usepackage{algorithm2e}
\usepackage{minted}
\usemintedstyle{friendly}
@@ -97,6 +99,8 @@
\newcommand{\vdata}{\hyperlink{vdata}{{\tt psb\_T\_vect\_type}}}
\newcommand{\spbasedata}{\hypertarget{spbasedata}{{\tt psb\_T\_base\_sparse\_mat}}}
\newcommand{\vbasedata}{\hypertarget{vbasedata}{{\tt psb\_T\_base\_vect\_type}}}
\def\bsideways{\begin{sidewaystable}}
\def\esideways{\end{sidewaystable}}
\begin{document}
{
+9 -1
View File
@@ -17,8 +17,14 @@
\newtheorem{theorem}{Theorem}
\newtheorem{corollary}{Corollary}
\usepackage{listings}
\usepackage{algorithm2e}
\usepackage{rotating}
\usepackage{microtype}
\usepackage{algorithm2e}
\definecolor{bg}{rgb}{0.95,0.95,0.95}
\usepackage{breakurl}
\usepackage{mathpazo}
\usepackage[english]{babel}
\ifpdf
\newmintinline[fortinline]{fortran}{}
\else%
@@ -84,6 +90,8 @@
\newcommand{\vdata}{\hyperlink{vdata}{{\tt psb\_T\_vect\_type}}}
\newcommand{\spbasedata}{\hypertarget{spbasedata}{{\tt psb\_T\_base\_sparse\_mat}}}
\newcommand{\vbasedata}{\hypertarget{vbasedata}{{\tt psb\_T\_base\_vect\_type}}}
\def\bsideways{\begin{table}}
\def\esideways{\end{table}}
\begin{document}
\lstset{language=Fortran}