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 if 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, real_type reduction, int restart, int maxit, int verbose)
	Set up solver. More...
template<class L , class S , class P >
	RestartedGMResSolver (L &op, S &sp, P &prec, real_type reduction, int restart, int maxit, int verbose)
	Set up solver. More...
virtual void	apply (X &x, Y &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, InverseOperatorResult &res)=0
	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 CountType &iter, const DataType &norm, const DataType &norm_old) const
	helper function for printing solver output
void	printOutput (std::ostream &s, const CountType &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).

Template Parameters

X	trial vector, vector type of the solution
Y	test vector, vector type of the RHS
F	vector type for orthonormal basis of Krylov space

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, real_type  reduction, int  restart, int  maxit, int  verbose  )

inline

Set up solver.

Parameters

restart

number of GMRes cycles before restart

References 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, real_type  reduction, int  restart, int  maxit, int  verbose  )

inline

Set up solver.

Parameters

restart

number of GMRes cycles before restart

Member Function Documentation

apply() [1/4]

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.

Exceptions

SolverAbort

When the solver detects a problem and cannot continue

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

apply() [2/4]

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

pure virtualinherited

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.

Exceptions

SolverAbort

When the solver detects a problem and cannot continue

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

apply() [3/4]

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.

Exceptions

SolverAbort

When the solver detects a problem and cannot continue

Note

Currently, the RestartedGMResSolver aborts when it detects a breakdown.

References Dune::InverseOperatorResult::clear(), Dune::InverseOperatorResult::conv_rate, Dune::InverseOperatorResult::converged, DUNE_THROW, Dune::Timer::elapsed(), Dune::InverseOperatorResult::elapsed, Dune::InverseOperatorResult::iterations, Dune::InverseOperator< X, X >::printHeader(), Dune::InverseOperator< X, X >::printOutput(), Dune::InverseOperatorResult::reduction, and Dune::Timer::reset().

apply() [4/4]

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

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

inlinevirtual

Apply inverse operator.

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.

Exceptions

SolverAbort

When the solver detects a problem and cannot continue

Note

Currently, the RestartedGMResSolver aborts when it detects a breakdown.

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

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

---

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

• dune/istl/solvers.hh