Dune::RestartedGMResSolver< X, Y, F > Class Template Reference

implements the Generalized Minimal Residual (GMRes) method More...

#include <dune/istl/solvers.hh>

Public Types
typedef X	domain_type
	The domain type of the operator to be inverted.
typedef Y	range_type
	The range type of the operator to be inverted.
typedef X::field_type	field_type
	The field type of the operator to be inverted.
typedef FieldTraits< field_type >::real_type	real_type
	The real type of the field type (is the same of using real numbers, but differs for std::complex)
typedef F	basis_type
	The field type of the basis vectors.

Public Member Functions
template<class L , class P >
	RestartedGMResSolver (L &op, P &prec, double reduction, int restart, int maxit, int verbose, bool recalc_defect=false)
	Set up solver. More...
template<class L , class S , class P >
	RestartedGMResSolver (L &op, S &sp, P &prec, double reduction, int restart, int maxit, int verbose, bool recalc_defect=false)
	Set up solver. More...
virtual void	apply (X &x, X &b, InverseOperatorResult &res)
	Apply inverse operator,. More...
virtual void	apply (X &x, Y &b, double reduction, InverseOperatorResult &res)
	Apply inverse operator. More...
virtual void	apply (X &x, X &b, double reduction, InverseOperatorResult &res)=0
	apply inverse operator, with given convergence criteria. More...

Protected Member Functions
void	printHeader (std::ostream &s) const
	helper function for printing header of solver output
void	printOutput (std::ostream &s, const double iter, const DataType &norm, const DataType &norm_old) const
	helper function for printing solver output
void	printOutput (std::ostream &s, const double iter, const DataType &norm) const
	helper function for printing solver output

Detailed Description

template<class X, class Y = X, class F = Y>
class Dune::RestartedGMResSolver< X, Y, F >

implements the Generalized Minimal Residual (GMRes) method

GMRes solves the unsymmetric linear system Ax = b using the Generalized Minimal Residual method as described the SIAM Templates book (http://www.netlib.org/templates/templates.pdf).

Todo:

construct F via rebind and an appropriate field_type

Constructor & Destructor Documentation

RestartedGMResSolver() [1/2]

template<class X , class Y = X, class F = Y>

template<class L , class P >

Dune::RestartedGMResSolver< X, Y, F >::RestartedGMResSolver ( L &  op, P &  prec, double  reduction, int  restart, int  maxit, int  verbose, bool  recalc_defect = false  )

inline

Set up solver.

Set up Loop solver.

Parameters

op	The operator we solve.
prec	The preconditioner to apply in each iteration of the loop. Has to inherit from Preconditioner.
reduction	The relative defect reduction to achieve when applying the operator.
maxit	The maximum number of iteration steps allowed when applying the operator.
verbose	The verbosity level.

Verbose levels are:

• 0 : print nothing
• 1 : print initial and final defect and statistics
• 2 : print line for each iteration

Parameters

restart	number of GMRes cycles before restart
recalc_defect	recalculate the defect after everey restart or not [default=false]

References dune_static_assert, and Dune::SolverCategory::sequential.

RestartedGMResSolver() [2/2]

template<class X , class Y = X, class F = Y>

template<class L , class S , class P >

Dune::RestartedGMResSolver< X, Y, F >::RestartedGMResSolver ( L &  op, S &  sp, P &  prec, double  reduction, int  restart, int  maxit, int  verbose, bool  recalc_defect = false  )

inline

Set up solver.

Set up loop solver.

Parameters

op	The operator we solve.
sp	The scalar product to use, e. g. SeqScalarproduct.
prec	The preconditioner to apply in each iteration of the loop. Has to inherit from Preconditioner.
reduction	The relative defect reduction to achieve when applying the operator.
maxit	The maximum number of iteration steps allowed when applying the operator.
verbose	The verbosity level.

Verbose levels are:

• 0 : print nothing
• 1 : print initial and final defect and statistics
• 2 : print line for each iteration

Parameters

restart	number of GMRes cycles before restart
recalc_defect	recalculate the defect after everey restart or not [default=false]

References dune_static_assert.

Member Function Documentation

apply() [1/3]

virtual void Dune::InverseOperator< X, X >::apply ( X &  x, X &  b, double  reduction, InverseOperatorResult &  res  )

pure virtualinherited

apply inverse operator, with given convergence criteria.

Warning

Right hand side b may be overwritten!

Parameters

x	The left hand side to store the result in.
b	The right hand side
reduction	The minimum defect reduction to achieve.
res	Object to store the statistics about applying the operator.

Implemented in Dune::LoopSolver< X >, Dune::GradientSolver< X >, Dune::CGSolver< X >, Dune::BiCGSTABSolver< X >, Dune::MINRESSolver< X >, and Dune::GeneralizedPCGSolver< X >.

apply() [2/3]

template<class X , class Y = X, class F = Y>

virtual void Dune::RestartedGMResSolver< X, Y, F >::apply ( X &  x, X &  b, InverseOperatorResult &  res  )

inlinevirtual

Apply inverse operator,.

Warning

Note: right hand side b may be overwritten!

Parameters

x	The left hand side to store the result in.
b	The right hand side
res	Object to store the statistics about applying the operator.

Implements Dune::InverseOperator< X, X >.

References Dune::RestartedGMResSolver< X, Y, F >::apply().

Referenced by Dune::RestartedGMResSolver< X, Y, F >::apply().

apply() [3/3]

template<class X , class Y = X, class F = Y>

virtual void Dune::RestartedGMResSolver< X, Y, F >::apply ( X &  x, Y &  b, double  reduction, InverseOperatorResult &  res  )

inlinevirtual

Apply inverse operator.

apply inverse operator, with given convergence criteria.

Warning

Right hand side b may be overwritten!

Parameters

x	The left hand side to store the result in.
b	The right hand side
reduction	The minimum defect reduction to achieve.
res	Object to store the statistics about applying the operator.

References Dune::LinearOperator< X, Y >::apply(), Dune::Preconditioner< X, Y >::apply(), Dune::LinearOperator< X, Y >::applyscaleadd(), Dune::InverseOperatorResult::clear(), Dune::InverseOperatorResult::conv_rate, Dune::InverseOperatorResult::converged, DUNE_THROW, Dune::Timer::elapsed(), Dune::InverseOperatorResult::elapsed, Dune::InverseOperatorResult::iterations, Dune::Preconditioner< X, Y >::post(), Dune::Preconditioner< X, Y >::pre(), Dune::InverseOperator< X, X >::printHeader(), Dune::InverseOperator< X, X >::printOutput(), and Dune::InverseOperatorResult::reduction.

---

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

• dune/istl/solvers.hh