dune-istl  3.0-git
Public Types | Public Member Functions | Protected Types | Protected Member Functions | List of all members
Dune::LoopSolver< X > Class Template Reference

Preconditioned loop solver. More...

#include <dune/istl/solvers.hh>

Inheritance diagram for Dune::LoopSolver< X >:
Inheritance graph

Public Types

typedef X domain_type
 The domain type of the operator that we do the inverse for. More...
 
typedef X range_type
 The range type of the operator that we do the inverse for. More...
 
typedef X::field_type field_type
 The field type of the operator that we do the inverse for. 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...
 

Public Member Functions

template<class L , class P >
 LoopSolver (L &op, P &prec, real_type reduction, int maxit, int verbose)
 Set up Loop solver. More...
 
template<class L , class S , class P >
 LoopSolver (L &op, S &sp, P &prec, real_type reduction, int maxit, int verbose)
 Set up loop solver. More...
 
virtual void apply (X &x, X &b, InverseOperatorResult &res)
 Apply inverse operator,. More...
 
virtual void apply (X &x, X &b, double reduction, InverseOperatorResult &res)
 apply inverse operator, with given convergence criteria. More...
 

Protected Types

enum  
 

Protected Member Functions

void printHeader (std::ostream &s) const
 helper function for printing header of solver output More...
 
void printOutput (std::ostream &s, const CountType &iter, const DataType &norm, const DataType &norm_old) const
 helper function for printing solver output More...
 
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 Dune::LoopSolver< X >

Preconditioned loop solver.

Implements a preconditioned loop. Using this class every Preconditioner can be turned into a solver. The solver will apply one preconditioner step in each iteration loop.

Member Typedef Documentation

◆ domain_type

template<class X >
typedef X Dune::LoopSolver< X >::domain_type

The domain type of the operator that we do the inverse for.

◆ field_type

template<class X >
typedef X::field_type Dune::LoopSolver< X >::field_type

The field type of the operator that we do the inverse for.

◆ range_type

template<class X >
typedef X Dune::LoopSolver< X >::range_type

The range type of the operator that we do the inverse for.

◆ real_type

template<class X >
typedef FieldTraits<field_type>::real_type Dune::LoopSolver< X >::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

anonymous enum
protectedinherited

Constructor & Destructor Documentation

◆ LoopSolver() [1/2]

template<class X >
template<class L , class P >
Dune::LoopSolver< X >::LoopSolver ( L &  op,
P &  prec,
real_type  reduction,
int  maxit,
int  verbose 
)
inline

Set up Loop solver.

Parameters
opThe operator we solve.
precThe preconditioner to apply in each iteration of the loop. Has to inherit from Preconditioner.
reductionThe relative defect reduction to achieve when applying the operator.
maxitThe maximum number of iteration steps allowed when applying the operator.
verboseThe verbosity level.

Verbose levels are:

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

◆ LoopSolver() [2/2]

template<class X >
template<class L , class S , class P >
Dune::LoopSolver< X >::LoopSolver ( L &  op,
S &  sp,
P &  prec,
real_type  reduction,
int  maxit,
int  verbose 
)
inline

Set up loop solver.

Parameters
opThe operator we solve.
spThe scalar product to use, e. g. SeqScalarproduct.
precThe preconditioner to apply in each iteration of the loop. Has to inherit from Preconditioner.
reductionThe relative defect reduction to achieve when applying the operator.
maxitThe maximum number of iteration steps allowed when applying the operator.
verboseThe verbosity level.

Verbose levels are:

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

Member Function Documentation

◆ apply() [1/2]

template<class X >
virtual void Dune::LoopSolver< X >::apply ( X &  x,
X &  b,
InverseOperatorResult res 
)
inlinevirtual

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

Implements Dune::InverseOperator< X, X >.

◆ apply() [2/2]

template<class X >
virtual void Dune::LoopSolver< X >::apply ( X &  x,
X &  b,
double  reduction,
InverseOperatorResult res 
)
inlinevirtual

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

Implements Dune::InverseOperator< X, X >.

◆ printHeader()

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

helper function for printing header of solver output

◆ printOutput() [1/2]

void Dune::InverseOperator< X, X >::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]

void Dune::InverseOperator< X, X >::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: