Updated docs.
This commit is contained in:
Salvatore Filippone
2017-02-12 18:19:15 +00:00
parent 9ab0539881
commit 001aa819fa
147 changed files with 22648 additions and 22177 deletions
+1 -1
View File
@@ -158,7 +158,7 @@ TEXLNFIL = $(addprefix $(PWD)/,$(TEXFILES))
#============================================================================
all: pdf
all: pdf html
pdf: $(PDF) copypdf
html: $(HTML)
+62
View File
@@ -755,6 +755,30 @@ A variable of type \verb|psb_Tspmat_type|.
\item[info] Return code.
\end{description}
\subsubsection*{clean\_zeros --- Eliminate zero coefficients}
\addcontentsline{toc}{paragraph}{clean\_zeros}
\begin{verbatim}
call a%clean_zeros(info)
\end{verbatim}
Eliminates zero coefficients in the input matrix. Note that depending
on the internal storage format, there may still be some amount of
zero padding in the output.
\begin{description}
\item[Type:] Asynchronous.
\item[\bf On Entry]
\item[a] the sparse matrix.\\
A variable of type \verb|psb_Tspmat_type|.\\
Scope: {\bf local}.\\
\end{description}
\begin{description}
\item[\bf On Return]
\item[a] The matrix \verb|a| without zero coefficients.\\
A variable of type \verb|psb_Tspmat_type|.
\item[info] Return code.
\end{description}
\subsubsection*{get\_diag --- Get main diagonal}
\addcontentsline{toc}{paragraph}{get\_diag}
\begin{verbatim}
@@ -1028,6 +1052,44 @@ Scope: {\bf local}\\
\end{description}
\subsubsection*{set --- Set contents of the vector}
\addcontentsline{toc}{paragraph}{set }
\begin{verbatim}
call v%set(alpha[,first,last])
call v%set(vect[,first,last])
call v%zero()
\end{verbatim}
\begin{description}
\item[Type:] Asynchronous.
\item[\bf On Entry]
\item[v] the dense vector\\
Scope: {\bf local}\\
% Type: {\bf required}\\
% Intent: {\bf in}.\\
% Specified as: a object of type \spdata.
\item[alpha] A scalar value. \\ Scope: {\bf local} \\ Type: {\bf
required} \\ Intent: {\bf in}.\\ Specified as: a number of the data
type indicated in Table~\ref{tab:f90axpby}.
\item[first,last] Boundaries for setting in the vector.\\ Scope: {\bf
local} \\ Type: {\bf optional} \\ Intent: {\bf in}.\\ Specified
as: integers.
\item[vect] An array \\ Scope: {\bf local} \\ Type: {\bf
required} \\ Intent: {\bf in}.\\ Specified as: a number of the data
type indicated in Table~\ref{tab:f90axpby}.
\end{description}
Note that a call to \verb|v%zero()| is provided as a shorthand, but
is equivalent to a call to \verb|v%set(zero)| with the \verb|zero|
constant having the appropriate type and kind.
\begin{description}
\item[\bf On Return]
\item[v] the dense vector, with updated entries\\
Scope: {\bf local}\\
\end{description}
\subsubsection*{get\_vect --- Get a copy of the vector contents}
\addcontentsline{toc}{paragraph}{get\_vect }
+12 -5
View File
@@ -18,12 +18,19 @@ the module \verb|psb_krylov_mod|.
This subroutine is a driver that provides a general interface for all
the Krylov-Subspace family methods implemented in PSBLAS version 2.
The stopping criterion is the normwise backward error, in the infinity
norm, i.e. the iteration is stopped when
The stopping criterion can take the following values:
\begin{description}
\item[1] normwise backward error in the infinity
norm; the iteration is stopped when
\[ err = \frac{\|r_i\|}{(\|A\|\|x_i\|+\|b\|)} < eps \]
or the 2-norm residual reduction
\item[2] Relative residual in the 2-norm; the iteration is stopped
when
\[ err = \frac{\|r_i\|}{\|b\|_2} < eps \]
according to the value passed through the istop argument (see
\item[3] Relative residual reduction in the 2-norm; the iteration is stopped
when
\[ err = \frac{\|r_i\|}{\|r_0\|_2} < eps \]
\end{description}
The behaviour is controlled by the istop argument (see
later). In the above formulae, $x_i$ is the tentative solution and
$r_i=b-Ax_i$ the corresponding residual at the $i$-th iteration.
@@ -105,7 +112,7 @@ Scope: {\bf global} \\
Type: {\bf optional}.\\
Intent: {\bf in}.\\
Values: 1: use the normwise backward error, 2: use the scaled 2-norm
of the residual. Default: 2.
of the residual, 3: use the residual reduction in the 2-norm. Default: 2.
\item[\bf On Return]
\item[x] The computed solution. \\
Scope: {\bf local} \\
+3 -5
View File
@@ -42,11 +42,9 @@ Long Precision Complex & psb\_geaxpby \\
\begin{description}
\item[Type:] Synchronous.
\item[\bf On Entry]
\item[alpha] the scalar $\alpha$.\\
Scope: {\bf global} \\
Type: {\bf required} \\
Intent: {\bf in}.\\
Specified as: a number of the data type indicated in Table~\ref{tab:f90axpby}.
\item[alpha] the scalar $\alpha$.\\ Scope: {\bf global} \\ Type: {\bf
required} \\ Intent: {\bf in}.\\ Specified as: a number of the data
type indicated in Table~\ref{tab:f90axpby}.
\item[x] the local portion of global dense matrix
$x$.\\
Scope: {\bf local} \\