mld2p4:
docs/pdf/Makefile docs/pdf/abstract.tex docs/pdf/advanced.tex docs/pdf/background.tex docs/pdf/bibliography.tex docs/pdf/listofroutines.tex docs/pdf/methods.tex docs/pdf/overview.tex docs/pdf/userguide.tex docs/pdf/userinterface.tex docs/userguide.pdf mlprec/mld_caggrmap_bld.f90 mlprec/mld_cprecset.f90 mlprec/mld_daggrmap_bld.f90 mlprec/mld_dprecset.f90 mlprec/mld_prec_type.f90 mlprec/mld_saggrmap_bld.f90 mlprec/mld_sprecset.f90 mlprec/mld_zaggrmap_bld.f90 mlprec/mld_zprecset.f90 test/fileread/cf_sample.f90 test/fileread/df_sample.f90 test/fileread/sf_sample.f90 test/fileread/zf_sample.f90 test/pargen/Makefile test/pargen/ppde.f90 test/pargen/spde.f90 Merged docs and minor fixes from Daniela.stopcriterion
Salvatore Filippone
17 years ago
parent
2241c6af30
commit
fc0b2cfbbe
@ -1,12 +0,0 @@
|
||||
\section{Advanced Use}\label{sec:advanced}
|
||||
|
||||
- MLD2P4 software architecture \\
|
||||
- preconditioner data structure (descrizione "dettagliata") + possibilita' di settare singolarmente
|
||||
i vari livelli (possibilita' accennata solamente nella precedente descrizione di precset) \\
|
||||
- descrizione routine medium level (con introduzione sulle potenzialita' di ampliamento (?), offerte
|
||||
da queto strato software) \\
|
||||
|
||||
%%% Local Variables:
|
||||
%%% mode: latex
|
||||
%%% TeX-master: "userguide"
|
||||
%%% End:
|
||||
@ -1,10 +0,0 @@
|
||||
\section{List of Routines}\label{sec:routines}
|
||||
|
||||
Elenco (ordine alfabetico) di tutte le routine, con rinvio (ipertestuale e num. pag.) alla descrizione
|
||||
di ciascuna in qualche paragrafo precedente
|
||||
(una specie di indice analitico, che rimanda alle routine descritte precedentemente nei rispettivi paragrafi)
|
||||
|
||||
%%% Local Variables:
|
||||
%%% mode: latex
|
||||
%%% TeX-master: "userguide"
|
||||
%%% End:
|
||||
@ -1,607 +0,0 @@
|
||||
\section{Iterative Methods}
|
||||
\label{sec:methods}
|
||||
\markboth{\underline{MLD2P4 User's and Reference Guide}}
|
||||
{\underline{\ref{sec:methods} Iterative Methods}}
|
||||
|
||||
In this chapter we provide routines for preconditioners and iterative
|
||||
methods. The interfaces for Krylov subspace methods are available in
|
||||
the module \verb|mld_krylov_mod|. The installation process of MLD2P4
|
||||
ensures that these may be used as a drop-in replacement for the PSBLAS
|
||||
methods; they are accessible under the PSBLAS names (see the PSBLAS
|
||||
documentation),
|
||||
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
%
|
||||
% Krylov Methods driver routine
|
||||
%
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
\subroutine{mld\_krylov \label{krylov}}{Krylov Methods Driver Routine}
|
||||
|
||||
This subroutine is a driver that provides a general interface for all
|
||||
the Krylov-Subspace family methods.
|
||||
|
||||
The stopping criterion is the normwise backward error, in the infinity
|
||||
norm, i.e. the iteration is stopped when
|
||||
\[ err = \frac{\|r_i\|}{(\|A\|\|x_i\|+\|b\|)} < eps \]
|
||||
or the 2-norm residual reduction
|
||||
\[ err = \frac{\|r_i\|}{\|b\|_2} < eps \]
|
||||
according to the value passed through 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.
|
||||
|
||||
|
||||
\syntax{call psb\_krylov}{method,a,prec,b,x,eps,desc\_a,info,itmax,iter,err,itrace,irst,istop}
|
||||
|
||||
\begin{description}
|
||||
\item[Type:] Synchronous.
|
||||
\item[\bf On Entry]
|
||||
\item[method] a string that defines the iterative method to be
|
||||
used. Supported values are:
|
||||
\begin{description}
|
||||
\item[CG]: the Conjugate Gradient method;
|
||||
\item[CGS]:the Conjugate Gradient Stabilized method;
|
||||
|
||||
\item[BICG]: the Bi-Conjugate Gradient method;
|
||||
\item[BICGSTAB]: the Bi-Conjugate Gradient Stabilized method;
|
||||
\item[BICGSTABL]: the Bi-Conjugate Gradient Stabilized method with restarting;
|
||||
\item[RGMRES]: the Generalized Minimal Residual method with restarting.
|
||||
\end{description}
|
||||
\item[a] the local portion of global sparse matrix
|
||||
$A$. \\
|
||||
Scope: {\bf local} \\
|
||||
Type: {\bf required}\\
|
||||
Intent: {\bf in}.\\
|
||||
Specified as: a structured data of type \spdata.
|
||||
\item[prec] The data structure containing the preconditioner.\\
|
||||
Scope: {\bf local} \\
|
||||
Type: {\bf required}\\
|
||||
Intent: {\bf in}.\\
|
||||
Specified as: a structured data of type \precdata.
|
||||
\item[b] The RHS vector. \\
|
||||
Scope: {\bf local} \\
|
||||
Type: {\bf required}\\
|
||||
Intent: {\bf in}.\\
|
||||
Specified as: a rank one array.
|
||||
\item[x] The initial guess. \\
|
||||
Scope: {\bf local} \\
|
||||
Type: {\bf required}\\
|
||||
Intent: {\bf inout}.\\
|
||||
Specified as: a rank one array.
|
||||
\item[eps] The stopping tolerance. \\
|
||||
Scope: {\bf global} \\
|
||||
Type: {\bf required}\\
|
||||
Intent: {\bf in}.\\
|
||||
Specified as: a real number.
|
||||
\item[desc\_a] contains data structures for communications.\\
|
||||
Scope: {\bf local} \\
|
||||
Type: {\bf required}\\
|
||||
Intent: {\bf in}.\\
|
||||
Specified as: a structured data of type \descdata.
|
||||
\item[itmax] The maximum number of iterations to perform.\\
|
||||
Scope: {\bf global} \\
|
||||
Type: {\bf optional}\\
|
||||
Intent: {\bf in}.\\
|
||||
Default: $itmax = 1000$.\\
|
||||
Specified as: an integer variable $itmax \ge 1$.
|
||||
\item[itrace] If $>0$ print out an informational message about
|
||||
convergence every $itrace$ iterations.\\
|
||||
Scope: {\bf global} \\
|
||||
Type: {\bf optional}\\
|
||||
Intent: {\bf in}.\\
|
||||
\item[irst] An integer specifying the restart parameter.\\
|
||||
Scope: {\bf global} \\
|
||||
Type: {\bf optional}.\\
|
||||
Intent: {\bf in}.\\
|
||||
Values: $irst>0$. This is employed for the BiCGSTABL or RGMRES
|
||||
methods, otherwise it is ignored.
|
||||
|
||||
\item[istop] An integer specifying the stopping criterion.\\
|
||||
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: 1.
|
||||
\item[\bf On Return]
|
||||
\item[x] The computed solution. \\
|
||||
Scope: {\bf local} \\
|
||||
Type: {\bf required}\\
|
||||
Intent: {\bf inout}.\\
|
||||
Specified as: a rank one array.
|
||||
\item[iter] The number of iterations performed.\\
|
||||
Scope: {\bf global} \\
|
||||
Type: {\bf optional}\\
|
||||
Intent: {\bf out}.\\
|
||||
Returned as: an integer variable.
|
||||
\item[err] The convergence estimate on exit.\\
|
||||
Scope: {\bf global} \\
|
||||
Type: {\bf optional}\\
|
||||
Intent: {\bf out}.\\
|
||||
Returned as: a real number.
|
||||
\item[info] Error code.\\
|
||||
Scope: {\bf local} \\
|
||||
Type: {\bf required} \\
|
||||
Intent: {\bf out}.\\
|
||||
An integer value; 0 means no error has been detected.
|
||||
\end{description}
|
||||
|
||||
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
%% %
|
||||
%% % CG
|
||||
%% %
|
||||
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
%% \subroutine{psb\_cg \label{cg}}{CG Iterative Method}
|
||||
|
||||
%% This subroutine implements the CG method with restarting. The
|
||||
%% stopping criterion is the normwise backward error, in the infinity
|
||||
%% norm, i.e. the iteration is stopped when
|
||||
%% \[ \frac{\|r\|}{(\|A\|\|x\|+\|b\|)} < eps \]
|
||||
%% or
|
||||
%% \[ \frac{\|r_i\|}{\|b\|_2} < eps \]
|
||||
%% according to the value passed through the istop argument (see later).
|
||||
|
||||
|
||||
%% \syntax{call psb\_cg}{a,prec,b,x,eps,desc\_a,info,itmax,iter,err,itrace,istop}
|
||||
|
||||
%% \begin{description}
|
||||
%% \item[\bf On Entry]
|
||||
%% \item[a] the local portion of global sparse matrix
|
||||
%% $A$. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \spdata.
|
||||
%% \item[prec] The data structure containing the preconditioner.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \precdata.
|
||||
%% \item[b] The RHS vector. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[x] The initial guess. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[eps] The stopping tolerance. \\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a real number.
|
||||
%% \item[desc\_a] contains data structures for communications.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \descdata.
|
||||
%% \item[itmax] The maximum number of iterations to perform.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Default: $itmax = 1000$.\\
|
||||
%% Specified as: an integer variable $itmax \ge 1$.
|
||||
%% \item[itrace] If $>0$ print out an informational message about
|
||||
%% convergence every $itrace$ iterations.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% \item[istop] An integer specifying the stopping criterion.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
|
||||
%% \item[\bf On Return]
|
||||
%% \item[x] The computed solution. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[iter] The number of iterations performed.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Returned as: an integer variable.
|
||||
%% \item[err] The error estimate on exit.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Returned as: a real number.
|
||||
%% \item[info] Error code.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required} \\
|
||||
%% An integer value; 0 means no error has been detected.
|
||||
%% \end{description}
|
||||
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
%% %
|
||||
%% % CGS
|
||||
%% %
|
||||
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
%% \subroutine{psb\_cgs \label{cgs}}{CGS Iterative Method}
|
||||
|
||||
%% This subroutine implements the CGS method with restarting. The
|
||||
%% stopping criterion is the normwise backward error, in the infinity
|
||||
%% norm, i.e. the iteration is stopped when
|
||||
%% \[ \frac{\|r\|}{(\|A\|\|x\|+\|b\|)} < eps \]
|
||||
%% or
|
||||
%% \[ \frac{\|r_i\|}{\|b\|_2} < eps \]
|
||||
%% according to the value passed through the istop argument (see later).
|
||||
|
||||
|
||||
%% \syntax{call psb\_cgs}{a,prec,b,x,eps,desc\_a,info,itmax,iter,err,itrace,istop}
|
||||
|
||||
%% \begin{description}
|
||||
%% \item[\bf On Entry]
|
||||
%% \item[a] the local portion of global sparse matrix
|
||||
%% $A$. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \spdata.
|
||||
%% \item[prec] The data structure containing the preconditioner.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \precdata.
|
||||
%% \item[b] The RHS vector. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[x] The initial guess. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[eps] The stopping tolerance. \\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a real number.
|
||||
%% \item[desc\_a] contains data structures for communications.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \descdata.
|
||||
%% \item[itmax] The maximum number of iterations to perform.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Default: $itmax = 1000$.\\
|
||||
%% Specified as: an integer variable $itmax \ge 1$.
|
||||
%% \item[itrace] If $>0$ print out an informational message about
|
||||
%% convergence every $itrace$ iterations.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% \item[istop] An integer specifying the stopping criterion.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
|
||||
%% \item[\bf On Return]
|
||||
%% \item[x] The computed solution. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[iter] The number of iterations performed.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Returned as: an integer variable.
|
||||
%% \item[err] The error estimate on exit.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Returned as: a real number.
|
||||
%% \item[info] Error code.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required} \\
|
||||
%% An integer value; 0 means no error has been detected.
|
||||
%% \end{description}
|
||||
|
||||
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
%% %
|
||||
%% % BiCG
|
||||
%% %
|
||||
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
%% \subroutine{psb\_bicg \label{bicg}}{BiCG Iterative Method}
|
||||
|
||||
%% This subroutine implements the BiCG method with restarting. The
|
||||
%% stopping criterion is the normwise backward error, in the infinity
|
||||
%% norm, i.e. the iteration is stopped when
|
||||
%% \[ \frac{\|r\|}{(\|A\|\|x\|+\|b\|)} < eps \]
|
||||
%% or
|
||||
%% \[ \frac{\|r_i\|}{\|b\|_2} < eps \]
|
||||
%% according to the value passed through the istop argument (see later).
|
||||
|
||||
|
||||
%% \syntax{call psb\_bicg}{a,prec,b,x,eps,desc\_a,info,itmax,iter,err,itrace,istop}
|
||||
|
||||
%% \begin{description}
|
||||
%% \item[\bf On Entry]
|
||||
%% \item[a] the local portion of global sparse matrix
|
||||
%% $A$. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \spdata.
|
||||
%% \item[prec] The data structure containing the preconditioner.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \precdata.
|
||||
%% \item[b] The RHS vector. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[x] The initial guess. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[eps] The stopping tolerance. \\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a real number.
|
||||
%% \item[desc\_a] contains data structures for communications.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \descdata.
|
||||
%% \item[itmax] The maximum number of iterations to perform.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Default: $itmax = 1000$.\\
|
||||
%% Specified as: an integer variable $itmax \ge 1$.
|
||||
%% \item[itrace] If $>0$ print out an informational message about
|
||||
%% convergence every $itrace$ iterations.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% \item[istop] An integer specifying the stopping criterion.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
|
||||
%% \item[\bf On Return]
|
||||
%% \item[x] The computed solution. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[iter] The number of iterations performed.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Returned as: an integer variable.
|
||||
%% \item[err] The error estimate on exit.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Returned as: a real number.
|
||||
%% \item[info] Error code.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required} \\
|
||||
%% An integer value; 0 means no error has been detected.
|
||||
%% \end{description}
|
||||
|
||||
|
||||
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
%% %
|
||||
%% % BiCGSTAB
|
||||
%% %
|
||||
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
%% \subroutine{psb\_bicgstab \label{bicgstab}}{BiCGSTAB Iterative Method}
|
||||
|
||||
%% This subroutine implements the BiCGSTAB method with restarting. The
|
||||
%% stopping criterion is the normwise backward error, in the infinity
|
||||
%% norm, i.e. the iteration is stopped when
|
||||
%% \[ \frac{\|r\|}{(\|A\|\|x\|+\|b\|)} < eps \]
|
||||
%% or
|
||||
%% \[ \frac{\|r_i\|}{\|b\|_2} < eps \]
|
||||
%% according to the value passed through the istop argument (see later).
|
||||
|
||||
|
||||
%% \syntax{call psb\_bicgstab}{a,prec,b,x,eps,desc\_a,info,itmax,iter,err,itrace,istop}
|
||||
|
||||
%% \begin{description}
|
||||
%% \item[\bf On Entry]
|
||||
%% \item[a] the local portion of global sparse matrix
|
||||
%% $A$. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \spdata.
|
||||
%% \item[prec] The data structure containing the preconditioner.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \precdata.
|
||||
%% \item[b] The RHS vector. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[x] The initial guess. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[eps] The stopping tolerance. \\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a real number.
|
||||
%% \item[desc\_a] contains data structures for communications.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \descdata.
|
||||
%% \item[itmax] The maximum number of iterations to perform.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Default: $itmax = 1000$.\\
|
||||
%% Specified as: an integer variable $itmax \ge 1$.
|
||||
%% \item[itrace] If $>0$ print out an informational message about
|
||||
%% convergence every $itrace$ iterations.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% \item[istop] An integer specifying the stopping criterion.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
|
||||
%% \item[\bf On Return]
|
||||
%% \item[x] The computed solution. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[iter] The number of iterations performed.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Returned as: an integer variable.
|
||||
%% \item[err] The error estimate on exit.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Returned as: a real number.
|
||||
%% \item[info] Error code.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required} \\
|
||||
%% An integer value; 0 means no error has been detected.
|
||||
%% \end{description}
|
||||
|
||||
|
||||
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
%% %
|
||||
%% % BiCGSTAB(L)
|
||||
%% %
|
||||
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
%% \subroutine{psb\_bicgstabl \label{bicgstabl}}{BiCGSTAB-$l$ Iterative Method}
|
||||
|
||||
%% This subroutine implements the BiCGSTAB-$l$ method with restarting. The
|
||||
%% stopping criterion is the normwise backward error, in the infinity
|
||||
%% norm, i.e. the iteration is stopped when
|
||||
%% \[ \frac{\|r\|}{(\|A\|\|x\|+\|b\|)} < eps \]
|
||||
%% or
|
||||
%% \[ \frac{\|r_i\|}{\|b\|_2} < eps \]
|
||||
%% according to the value passed through the istop argument (see later).
|
||||
|
||||
|
||||
%% \syntax{call psb\_bicgstab}{a,prec,b,x,eps,desc\_a,info,itmax,iter,err,itrace,irst,istop}
|
||||
|
||||
%% \begin{description}
|
||||
%% \item[\bf On Entry]
|
||||
%% \item[a] the local portion of global sparse matrix
|
||||
%% $A$. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \spdata.
|
||||
%% \item[prec] The data structure containing the preconditioner.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \precdata.
|
||||
%% \item[b] The RHS vector. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[x] The initial guess. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[eps] The stopping tolerance. \\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a real number.
|
||||
%% \item[desc\_a] contains data structures for communications.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \descdata.
|
||||
%% \item[itmax] The maximum number of iterations to perform.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Default: $itmax = 1000$.\\
|
||||
%% Specified as: an integer variable $itmax \ge 1$.
|
||||
%% \item[itrace] If $>0$ print out an informational message about
|
||||
%% convergence every $itrace$ iterations.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% \item[irst] An integer specifying the restarting iteration.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% \item[istop] An integer specifying the stopping criterion.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
|
||||
%% \item[\bf On Return]
|
||||
%% \item[x] The computed solution. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[iter] The number of iterations performed.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Returned as: an integer variable.
|
||||
%% \item[err] The error estimate on exit.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Returned as: a real number.
|
||||
%% \item[info] Error code.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required} \\
|
||||
%% An integer value; 0 means no error has been detected.
|
||||
%% \end{description}
|
||||
|
||||
|
||||
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
%% %
|
||||
%% % GMRES
|
||||
%% %
|
||||
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
%% \subroutine{psb\_gmres \label{gmres}}{GMRES Iterative Method}
|
||||
|
||||
%% This subroutine implements the GMRES method with restarting. The
|
||||
%% stopping criterion is the normwise backward error, in the infinity
|
||||
%% norm, i.e. the iteration is stopped when
|
||||
%% \[ \frac{\|r\|}{(\|A\|\|x\|+\|b\|)} < eps \]
|
||||
%% or
|
||||
%% \[ \frac{\|r_i\|}{\|b\|_2} < eps \]
|
||||
%% according to the value passed through the istop argument (see later).
|
||||
|
||||
|
||||
%% \syntax{call psb\_gmres}{a,prec,b,x,eps,desc\_a,info,itmax,iter,err,itrace,irst,istop}
|
||||
|
||||
%% \begin{description}
|
||||
%% \item[\bf On Entry]
|
||||
%% \item[a] the local portion of global sparse matrix
|
||||
%% $A$. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \spdata.
|
||||
%% \item[prec] The data structure containing the preconditioner.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \precdata.
|
||||
%% \item[b] The RHS vector. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[x] The initial guess. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[eps] The stopping tolerance. \\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a real number.
|
||||
%% \item[desc\_a] contains data structures for communications.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a structured data of type \descdata.
|
||||
%% \item[itmax] The maximum number of iterations to perform.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Default: $itmax = 1000$.\\
|
||||
%% Specified as: an integer variable $itmax \ge 1$.
|
||||
%% \item[itrace] If $>0$ print out an informational message about
|
||||
%% convergence every $itrace$ iterations.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% \item[irst] An integer specifying the restart iteration.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% \item[istop] An integer specifying the stopping criterion.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
|
||||
%% \item[\bf On Return]
|
||||
%% \item[x] The computed solution. \\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required}\\
|
||||
%% Specified as: a rank one array.
|
||||
%% \item[iter] The number of iterations performed.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Returned as: an integer variable.
|
||||
%% \item[err] The error estimate on exit.\\
|
||||
%% Scope: {\bf global} \\
|
||||
%% Type: {\bf optional}\\
|
||||
%% Returned as: a real number.
|
||||
%% \item[info] Error code.\\
|
||||
%% Scope: {\bf local} \\
|
||||
%% Type: {\bf required} \\
|
||||
%% An integer value; 0 means no error has been detected.
|
||||
%% \end{description}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
%%% Local Variables:
|
||||
%%% mode: latex
|
||||
%%% TeX-master: "userguide"
|
||||
%%% End:
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue