dune-istl  2.5.1
Public Types | Public Member Functions | Protected Types | Protected Member Functions | List of all members
Dune::RestartedGMResSolver< X, Y, F > Class Template Reference

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

#include <dune/istl/solvers.hh>

Inheritance diagram for Dune::RestartedGMResSolver< X, Y, F >:
Inheritance graph

Public Types

typedef X domain_type
 The domain type of the operator to be inverted. More...
 
typedef Y range_type
 The range type of the operator to be inverted. More...
 
typedef X::field_type field_type
 The field type of the operator to be inverted. More...
 
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) More...
 
typedef F basis_type
 The field type of the basis vectors. More...
 

Public Member Functions

template<class L , class P >
 RestartedGMResSolver (L &op, P &prec, real_type reduction, int restart, int maxit, int verbose, bool recalc_defect)
 
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, bool recalc_defect)
 
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...
 

Protected Types

enum  { iterationSpacing = 5, normSpacing = 16 }
 

Protected Member Functions

void printHeader (std::ostream &s) const
 helper function for printing header of solver output More...
 
template<typename CountType , typename DataType >
void printOutput (std::ostream &s, const CountType &iter, const DataType &norm, const DataType &norm_old) const
 helper function for printing solver output More...
 
template<typename CountType , typename DataType >
void printOutput (std::ostream &s, const CountType &iter, const DataType &norm) const
 helper function for printing solver output More...
 

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
Xtrial vector, vector type of the solution
Ytest vector, vector type of the RHS
Fvector type for orthonormal basis of Krylov space

Member Typedef Documentation

◆ basis_type

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

The field type of the basis vectors.

◆ domain_type

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

The domain type of the operator to be inverted.

◆ field_type

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

The field type of the operator to be inverted.

◆ range_type

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

The range type of the operator to be inverted.

◆ real_type

template<class X , class Y = X, class F = Y>
typedef FieldTraits<field_type>::real_type Dune::RestartedGMResSolver< X, Y, F >::real_type

The real type of the field type (is the same if using real numbers, but differs for std::complex)

Member Enumeration Documentation

◆ anonymous enum

template<class X, class Y>
anonymous enum
protectedinherited
Enumerator
iterationSpacing 
normSpacing 

Constructor & Destructor Documentation

◆ RestartedGMResSolver() [1/4]

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,
bool  recalc_defect 
)
inline
Deprecated:
"recalc_defect is a unused parameter! Use RestartedGMResSolver(L& op, P& prec, real_type reduction, int restart, int maxit, int verbose) instead"

◆ RestartedGMResSolver() [2/4]

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
restartnumber of GMRes cycles before restart

◆ RestartedGMResSolver() [3/4]

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,
bool  recalc_defect 
)
inline
Deprecated:
"recalc_defect is a unused parameter! Use RestartedGMResSolver(L& op, S& sp, P& prec, real_type reduction, int restart, int maxit, int verbose) instead"

◆ RestartedGMResSolver() [4/4]

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
restartnumber of GMRes cycles before restart

Member Function Documentation

◆ apply() [1/2]

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
xThe left hand side to store the result in.
bThe right hand side
resObject to store the statistics about applying the operator.
Exceptions
SolverAbortWhen the solver detects a problem and cannot continue
Note
Currently, the RestartedGMResSolver aborts when it detects a breakdown.

Implements Dune::InverseOperator< X, Y >.

◆ apply() [2/2]

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
xThe left hand side to store the result in.
bThe right hand side
reductionThe minimum defect reduction to achieve.
resObject to store the statistics about applying the operator.
Exceptions
SolverAbortWhen the solver detects a problem and cannot continue
Note
Currently, the RestartedGMResSolver aborts when it detects a breakdown.

Implements Dune::InverseOperator< X, Y >.

◆ printHeader()

template<class X, class Y>
void Dune::InverseOperator< X, Y >::printHeader ( std::ostream &  s) const
inlineprotectedinherited

helper function for printing header of solver output

◆ printOutput() [1/2]

template<class X, class Y>
template<typename CountType , typename DataType >
void Dune::InverseOperator< X, Y >::printOutput ( std::ostream &  s,
const CountType &  iter,
const DataType &  norm,
const DataType &  norm_old 
) const
inlineprotectedinherited

helper function for printing solver output

◆ printOutput() [2/2]

template<class X, class Y>
template<typename CountType , typename DataType >
void Dune::InverseOperator< X, Y >::printOutput ( std::ostream &  s,
const CountType &  iter,
const DataType &  norm 
) const
inlineprotectedinherited

helper function for printing solver output


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