Dune::CGSolver< X > Class Template Reference

conjugate gradient method More...

#include <dune/istl/solvers.hh>

Public Types
typedef X	domain_type
	The domain type of the operator to be inverted.
typedef X	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)

Public Member Functions
template<class L , class P >
	CGSolver (L &op, P &prec, real_type reduction, int maxit, int verbose)
	Set up conjugate gradient solver. More...
template<class L , class S , class P >
	CGSolver (L &op, S &sp, P &prec, real_type reduction, int maxit, int verbose)
	Set up conjugate gradient 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 reduction factor. 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 Dune::CGSolver< X >

conjugate gradient method

Constructor & Destructor Documentation

CGSolver() [1/2]

template<class X >

template<class L , class P >

Dune::CGSolver< X >::CGSolver ( L &  op, P &  prec, real_type  reduction, int  maxit, int  verbose  )

inline

Set up conjugate gradient solver.

References Dune::SolverCategory::sequential.

CGSolver() [2/2]

template<class X >

template<class L , class S , class P >

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

inline

Set up conjugate gradient solver.

Member Function Documentation

apply() [1/2]

template<class X >

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

inlinevirtual

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 >.

apply() [2/2]

template<class X >

virtual void Dune::CGSolver< X >::apply ( X &  x, X &  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.

Implements Dune::InverseOperator< X, X >.

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::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