W3cubDocs

/Eigen3

Eigen::DGMRES

template<typename _MatrixType, typename _Preconditioner>
class Eigen::DGMRES< _MatrixType, _Preconditioner >

A Restarted GMRES with deflation. This class implements a modification of the GMRES solver for sparse linear systems. The basis is built with modified Gram-Schmidt. At each restart, a few approximated eigenvectors corresponding to the smallest eigenvalues are used to build a preconditioner for the next cycle. This preconditioner for deflation can be combined with any other preconditioner, the IncompleteLUT for instance. The preconditioner is applied at right of the matrix and the combination is multiplicative.

Template Parameters
_MatrixType the type of the sparse matrix A, can be a dense or a sparse matrix.
_Preconditioner the type of the preconditioner. Default is DiagonalPreconditioner Typical usage :
SparseMatrix<double> A;
VectorXd x, b; 
//Fill A and b ...
DGMRES<SparseMatrix<double> > solver;
solver.set_restart(30); // Set restarting value
solver.setEigenv(1); // Set the number of eigenvalues to deflate
solver.compute(A);
x = solver.solve(b);

DGMRES can also be used in a matrix-free context, see the following example .

References : [1] D. NUENTSA WAKAM and F. PACULL, Memory Efficient Hybrid Algebraic Solvers for Linear Systems Arising from Compressible Flows, Computers and Fluids, In Press, https://doi.org/10.1016/j.compfluid.2012.03.023
[2] K. Burrage and J. Erhel, On the performance of various adaptive preconditioned GMRES strategies, 5(1998), 101-121. [3] J. Erhel, K. Burrage and B. Pohl, Restarted GMRES preconditioned by deflation,J. Computational and Applied Mathematics, 69(1996), 303-318.

Index deflSize ()
DGMRES ()
template<typename MatrixDerived >
DGMRES (const EigenBase< MatrixDerived > &A)
Index restart ()
void set_restart (const Index restart)
void setEigenv (const Index neig)
void setMaxEigenv (const Index maxNeig)
template<typename Rhs , typename Dest >
void dgmres (const MatrixType &mat, const Rhs &rhs, Dest &x, const Preconditioner &precond) const
Perform several cycles of restarted GMRES with modified Gram Schmidt,. More...
template<typename Dest >
Index dgmresCycle (const MatrixType &mat, const Preconditioner &precond, Dest &x, DenseVector &r0, RealScalar &beta, const RealScalar &normRhs, Index &nbIts) const
Perform one restart cycle of DGMRES. More...

DGMRES() [1/2]

template<typename _MatrixType , typename _Preconditioner >
Eigen::DGMRES< _MatrixType, _Preconditioner >::DGMRES ( )
inline

Default constructor.

DGMRES() [2/2]

template<typename _MatrixType , typename _Preconditioner >
template<typename MatrixDerived >
Eigen::DGMRES< _MatrixType, _Preconditioner >::DGMRES ( const EigenBase< MatrixDerived > & A )
inlineexplicit

Initialize the solver with matrix A for further Ax=b solving.

This constructor is a shortcut for the default constructor followed by a call to compute().

Warning
this class stores a reference to the matrix A as well as some precomputed values that depend on it. Therefore, if A is changed this class becomes invalid. Call compute() to update it with the new matrix A, or modify a copy of A.

deflSize()

template<typename _MatrixType , typename _Preconditioner >
Index Eigen::DGMRES< _MatrixType, _Preconditioner >::deflSize ( )
inline

Get the size of the deflation subspace size

dgmres()

template<typename _MatrixType , typename _Preconditioner >
template<typename Rhs , typename Dest >
void Eigen::DGMRES< _MatrixType, _Preconditioner >::dgmres ( const MatrixType & mat,
const Rhs & rhs,
Dest & x,
const Preconditioner & precond
) const
protected

Perform several cycles of restarted GMRES with modified Gram Schmidt,.

A right preconditioner is used combined with deflation.

dgmresCycle()

template<typename _MatrixType , typename _Preconditioner >
template<typename Dest >
Index Eigen::DGMRES< _MatrixType, _Preconditioner >::dgmresCycle ( const MatrixType & mat,
const Preconditioner & precond,
Dest & x,
DenseVector & r0,
RealScalar & beta,
const RealScalar & normRhs,
Index & nbIts
) const
protected

Perform one restart cycle of DGMRES.

Parameters
mat The coefficient matrix
precond The preconditioner
x the new approximated solution
r0 The initial residual vector
beta The norm of the residual computed so far
normRhs The norm of the right hand side vector
nbIts The number of iterations

restart()

template<typename _MatrixType , typename _Preconditioner >
Index Eigen::DGMRES< _MatrixType, _Preconditioner >::restart ( )
inline

Get the restart value

set_restart()

template<typename _MatrixType , typename _Preconditioner >
void Eigen::DGMRES< _MatrixType, _Preconditioner >::set_restart ( const Index restart )
inline

Set the restart value (default is 30)

setEigenv()

template<typename _MatrixType , typename _Preconditioner >
void Eigen::DGMRES< _MatrixType, _Preconditioner >::setEigenv ( const Index neig )
inline

Set the number of eigenvalues to deflate at each restart

setMaxEigenv()

template<typename _MatrixType , typename _Preconditioner >
void Eigen::DGMRES< _MatrixType, _Preconditioner >::setMaxEigenv ( const Index maxNeig )
inline

Set the maximum size of the deflation subspace


The documentation for this class was generated from the following file: