Dune::GeneralizedPCGSolver< X > Class Template Reference

Generalized preconditioned conjugate gradient solver. 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.

Public Member Functions
template<class L , class P >
	GeneralizedPCGSolver (L &op, P &prec, double reduction, int maxit, int verbose, int restart=10)
	Set up nonlinear preconditioned conjugate gradient solver. More...
template<class L , class P , class S >
	GeneralizedPCGSolver (L &op, S &sp, P &prec, double reduction, int maxit, int verbose, int restart=10)
	Set up nonlinear preconditioned 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 double iter, const DataType &norm, const DataType &norm_old) const
	helper function for printing solver output
void	printOutput (std::ostream &s, const double iter, const DataType &norm) const
	helper function for printing solver output

Detailed Description

template<class X>
class Dune::GeneralizedPCGSolver< X >

Generalized preconditioned conjugate gradient solver.

A preconditioned conjugate gradient that allows the preconditioner to change between iterations.

One example for such preconditioner is AMG when used without a direct coarse solver. In this case the number of iterations performed on the coarsest level might change between applications.

In contrast to CGSolver the search directions are stored and the orthogonalization is done explicitly.

Constructor & Destructor Documentation

GeneralizedPCGSolver() [1/2]

template<class X >

template<class L , class P >

Dune::GeneralizedPCGSolver< X >::GeneralizedPCGSolver ( L &  op, P &  prec, double  reduction, int  maxit, int  verbose, int  restart = 10  )

inline

Set up nonlinear preconditioned conjugate gradient 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

Parameters

restart

When to restart the construction of the Krylov search space.

References dune_static_assert, and Dune::SolverCategory::sequential.

GeneralizedPCGSolver() [2/2]

template<class X >

template<class L , class P , class S >

Dune::GeneralizedPCGSolver< X >::GeneralizedPCGSolver ( L &  op, S &  sp, P &  prec, double  reduction, int  maxit, int  verbose, int  restart = 10  )

inline

Set up nonlinear preconditioned conjugate gradient 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

Parameters

restart

When to restart the construction of the Krylov search space.

References dune_static_assert.

Member Function Documentation

apply() [1/2]

template<class X >

virtual void Dune::GeneralizedPCGSolver< 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::GeneralizedPCGSolver< 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