Dune::BiCGSTABSolver< X > Class Template Reference
[Iterative Solvers]

#include <solvers.hh>

Inheritance diagram for Dune::BiCGSTABSolver< X >:

Dune::InverseOperator< X, X > List of all members.

Detailed Description

template<class X>
class Dune::BiCGSTABSolver< X >

Bi-conjugate Gradient Stabilized (BiCG-STAB).


Public Types

typedef X domain_type
 The domain type of the operator we are the inverse for.
typedef X range_type
 The range type of the operator we are the inverse for.
typedef X::field_type field_type
 The field type of the operator we are the inverse for.

Public Member Functions

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

Constructor & Destructor Documentation

template<class X>
template<class L, class P>
Dune::BiCGSTABSolver< X >::BiCGSTABSolver ( L &  op,
P &  prec,
double  reduction,
int  maxit,
int  verbose 
) [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
;

template<class X>
template<class L, class S, class P>
Dune::BiCGSTABSolver< X >::BiCGSTABSolver ( L &  op,
S &  sp,
P &  prec,
double  reduction,
int  maxit,
int  verbose 
) [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
;


Member Function Documentation

template<class X>
virtual void Dune::BiCGSTABSolver< X >::apply ( X &  x,
X &  b,
InverseOperatorResult res 
) [inline, virtual]

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.

Implements Dune::InverseOperator< X, X >.

template<class X>
virtual void Dune::BiCGSTABSolver< X >::apply ( X &  x,
X &  b,
double  reduction,
InverseOperatorResult res 
) [inline, virtual]

Apply inverse operator with given reduction factor.

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.

Implements Dune::InverseOperator< X, X >.


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

Generated on 12 Dec 2007 with Doxygen (ver 1.5.1)