diff --git a/Documentation/Tutorials/Solvers/Linear/tutorial_Linear_solvers.md b/Documentation/Tutorials/Solvers/Linear/tutorial_Linear_solvers.md index 0c2723aeebe32db6e41ce2cf5b0013787b6fc192..b79dbbe1b766954f63ecadd354b8cfd4d0cb6b1d 100644 --- a/Documentation/Tutorials/Solvers/Linear/tutorial_Linear_solvers.md +++ b/Documentation/Tutorials/Solvers/Linear/tutorial_Linear_solvers.md @@ -8,7 +8,7 @@ Solvers of linear systems are one of the most important algorithms in scientific 1. Stationary methods 1. [Jacobi method](https://en.wikipedia.org/wiki/Jacobi_method) (\ref TNL::Solvers::Linear::Jacobi) - 2. [Successive-overrelaxation method, SOR]([https://en.wikipedia.org/wiki/Successive_over-relaxation]) (\ref TNL::Solvers::Linear::SOR) - CPU only currently + 2. [Successive-overrelaxation method, SOR]([https://en.wikipedia.org/wiki/Successive_over-relaxation]) (\ref TNL::Solvers::Linear::SOR) 2. Krylov subspace methods 1. [Conjugate gradient method, CG](https://en.wikipedia.org/wiki/Conjugate_gradient_method) (\ref TNL::Solvers::Linear::CG) 2. [Biconjugate gradient stabilized method, BICGStab](https://en.wikipedia.org/wiki/Biconjugate_gradient_stabilized_method) (\ref TNL::Solvers::Linear::BICGStab) diff --git a/src/TNL/Solvers/Linear/BICGStabL.h b/src/TNL/Solvers/Linear/BICGStabL.h index 1814ac3148b5d90db54b9271566767ec558f1756..44f4f2264fff25518f0f498ea2672234d65acea8 100644 --- a/src/TNL/Solvers/Linear/BICGStabL.h +++ b/src/TNL/Solvers/Linear/BICGStabL.h @@ -9,27 +9,6 @@ /* See Copyright Notice in tnl/Copyright */ /* - * BICGStabL implements an iterative solver for non-symmetric linear systems, - * using the BiCGstab(l) algorithm described in [1] and [2]. It is a - * generalization of the stabilized biconjugate-gradient (BiCGstab) algorithm - * proposed by van der Vorst [3]. BiCGstab(1) is equivalent to BiCGstab, and - * BiCGstab(2) is a slightly more efficient version of the BiCGstab2 algorithm - * by Gutknecht [4], while BiCGstab(l>2) is a further generalization. - * - * This code was implemented by: Jakub Klinkovsky <klinkjak@fjfi.cvut.cz> - * - * [1] Gerard L. G. Sleijpen and Diederik R. Fokkema, "BiCGstab(l) for linear - * equations involving unsymmetric matrices with complex spectrum", - * Electronic Trans. on Numerical Analysis 1, 11-32 (1993). - * [2] Gerard L. G. Sleijpen, Henk A. van der Vorst, and Diederik R. Fokkema, - * "BiCGstab(l) and other Hybrid Bi-CG Methods", Numerical Algorithms 7, - * 75-109 (1994). - * [3] Henk A. van der Vorst, "Bi-CGSTAB: A fast and smoothly converging variant - * of Bi-CG for the solution of nonsymmetric linear systems, SIAM Journal on - * scientific and Statistical Computing 13.2, 631-644 (1992). - * [4] Martin H. Gutknecht, "Variants of BiCGStab for matrices with complex - * spectrum", IPS Research Report No. 91-14 (1991). - * * TODO: further variations to explore: * * [5] Gerard L. G. Sleijpen and Henk A. van der Vorst, "Reliable updated @@ -119,7 +98,7 @@ class BICGStabL * defines the following: * * \e bicgstab-ell - number of Bi-CG iterations before the MR part starts. - * + * * \e bicgstab-exact-residue - says whether the BiCGstab should compute the exact residue in * each step (true) or to use a cheap approximation (false). * diff --git a/src/TNL/Solvers/Linear/Preconditioners/Diagonal.h b/src/TNL/Solvers/Linear/Preconditioners/Diagonal.h index 2e27624067bfd45b367eb47f26d4c74ab8d177c5..a8775ca5f005c7381ce7c99189f1b7511bffe8ed 100644 --- a/src/TNL/Solvers/Linear/Preconditioners/Diagonal.h +++ b/src/TNL/Solvers/Linear/Preconditioners/Diagonal.h @@ -14,6 +14,7 @@ #include "Preconditioner.h" + namespace TNL { namespace Solvers { namespace Linear { @@ -72,14 +73,14 @@ class Diagonal using typename Preconditioner< Matrix >::MatrixPointer; /** - * \brief This methods update the preconditione with respect to given matrix. + * \brief This method updates the preconditioner with respect to given matrix. * * \param matrixPointer smart pointer (\ref std::shared_ptr) to matrix the preconditioner is related to. */ virtual void update( const MatrixPointer& matrixPointer ) override; /** - * \brief This methods applies the preconditioner. + * \brief This method applies the preconditioner. * * \param b is the input vector the preconditioner is applied on. * \param x is the result of the preconditioning. @@ -139,21 +140,19 @@ class Diagonal< Matrices::DistributedMatrix< Matrix > > using typename Preconditioner< MatrixType >::ConstVectorViewType; /** - * \brief This methods update the preconditione with respect to given matrix. - * - * \param matrixPointer smart pointer (\ref std::shared_ptr) to matrix the preconditioner is related to. + * \brief Type of shared pointer to the matrix. */ using typename Preconditioner< MatrixType >::MatrixPointer; /** - * \brief This methods update the preconditione with respect to given matrix. + * \brief This method updates the preconditioner with respect to given matrix. * * \param matrixPointer smart pointer (\ref std::shared_ptr) to matrix the preconditioner is related to. */ virtual void update( const MatrixPointer& matrixPointer ) override; /** - * \brief This methods applies the preconditioner. + * \brief This method applies the preconditioner. * * \param b is the input vector the preconditioner is applied on. * \param x is the result of the preconditioning. diff --git a/src/TNL/Solvers/Linear/Preconditioners/ILU0.h b/src/TNL/Solvers/Linear/Preconditioners/ILU0.h index d38357c0e97e28adb4fa53d971d4e2d0fd765605..a6d128c394a2040d1ba9ac664736892d1c01b0c5 100644 --- a/src/TNL/Solvers/Linear/Preconditioners/ILU0.h +++ b/src/TNL/Solvers/Linear/Preconditioners/ILU0.h @@ -110,14 +110,14 @@ class ILU0_impl< Matrix, Real, Devices::Host, Index > using typename Preconditioner< Matrix >::MatrixPointer; /** - * \brief This methods update the preconditione with respect to given matrix. + * \brief This method updates the preconditioner with respect to given matrix. * * \param matrixPointer smart pointer (\ref std::shared_ptr) to matrix the preconditioner is related to. */ virtual void update( const MatrixPointer& matrixPointer ) override; /** - * \brief This methods applies the preconditioner. + * \brief This method applies the preconditioner. * * \param b is the input vector the preconditioner is applied on. * \param x is the result of the preconditioning. diff --git a/src/TNL/Solvers/Linear/Preconditioners/ILUT.h b/src/TNL/Solvers/Linear/Preconditioners/ILUT.h index f2060038927293d9e8b8b090ad90e590b12d1707..5e09147f98165a93b49712966279bd71c22fc275 100644 --- a/src/TNL/Solvers/Linear/Preconditioners/ILUT.h +++ b/src/TNL/Solvers/Linear/Preconditioners/ILUT.h @@ -87,14 +87,14 @@ class ILUT } /** - * \brief This methods update the preconditione with respect to given matrix. + * \brief This method updates the preconditioner with respect to given matrix. * * \param matrixPointer smart pointer (\ref std::shared_ptr) to matrix the preconditioner is related to. */ using Base::update; /** - * \brief This methods applies the preconditioner. + * \brief This method applies the preconditioner. * * \param b is the input vector the preconditioner is applied on. * \param x is the result of the preconditioning. diff --git a/src/TNL/Solvers/Linear/Preconditioners/Preconditioner.h b/src/TNL/Solvers/Linear/Preconditioners/Preconditioner.h index e0dc721e362e361d983e4bdaa68e56104d4b7ebd..4357dcf63ec0e4a2eff9233420cde8d82ac32497 100644 --- a/src/TNL/Solvers/Linear/Preconditioners/Preconditioner.h +++ b/src/TNL/Solvers/Linear/Preconditioners/Preconditioner.h @@ -101,7 +101,7 @@ class Preconditioner } /** - * \brief This methods update the preconditione with respect to given matrix. + * \brief This method updates the preconditioner with respect to given matrix. * * \param matrixPointer smart pointer (\ref std::shared_ptr) to matrix the preconditioner is related to. */ @@ -109,7 +109,7 @@ class Preconditioner {} /** - * \brief This methods applies the preconditioner. + * \brief This method applies the preconditioner. * * \param b is the input vector the preconditioner is applied on. * \param x is the result of the preconditioning.