dune-istl 2.8.0
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Dune::GeneralizedPCGSolver< X > Class Template Reference

Generalized preconditioned conjugate gradient solver. More...

#include <dune/istl/solvers.hh>

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

Public Types

typedef X domain_type
 Type of the domain of the operator to be inverted. More...
 
typedef X range_type
 Type of the range of the operator to be inverted. More...
 
typedef X::field_type field_type
 The field type of the operator. 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 Simd::Scalar< real_typescalar_real_type
 scalar type underlying the field_type More...
 

Public Member Functions

 GeneralizedPCGSolver (LinearOperator< X, X > &op, Preconditioner< X, X > &prec, scalar_real_type reduction, int maxit, int verbose, int restart=10)
 Set up nonlinear preconditioned conjugate gradient solver. More...
 
 GeneralizedPCGSolver (LinearOperator< X, X > &op, ScalarProduct< X > &sp, Preconditioner< X, X > &prec, scalar_real_type reduction, int maxit, int verbose, int restart=10)
 Set up nonlinear preconditioned conjugate gradient solver. More...
 
 GeneralizedPCGSolver (std::shared_ptr< LinearOperator< X, X > > op, std::shared_ptr< Preconditioner< X, X > > prec, const ParameterTree &configuration)
 Constructor. More...
 
 GeneralizedPCGSolver (std::shared_ptr< LinearOperator< X, X > > op, std::shared_ptr< ScalarProduct< X > > sp, std::shared_ptr< Preconditioner< X, X > > prec, const ParameterTree &configuration)
 
 GeneralizedPCGSolver (std::shared_ptr< LinearOperator< X, X > > op, std::shared_ptr< ScalarProduct< X > > sp, std::shared_ptr< Preconditioner< X, X > > prec, scalar_real_type 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...
 
virtual SolverCategory::Category category () const
 Category of the solver (see SolverCategory::Category) More...
 
std::string name () const
 

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

Protected Attributes

std::shared_ptr< LinearOperator< X, X > > _op
 
std::shared_ptr< Preconditioner< X, X > > _prec
 
std::shared_ptr< ScalarProduct< X > > _sp
 
scalar_real_type _reduction
 
int _maxit
 
int _verbose
 
SolverCategory::Category _category
 

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.

Member Typedef Documentation

◆ domain_type

typedef X Dune::InverseOperator< X, X >::domain_type
inherited

Type of the domain of the operator to be inverted.

◆ field_type

typedef X::field_type Dune::InverseOperator< X, X >::field_type
inherited

The field type of the operator.

◆ range_type

typedef X Dune::InverseOperator< X, X >::range_type
inherited

Type of the range of the operator to be inverted.

◆ real_type

typedef FieldTraits<field_type>::real_type Dune::InverseOperator< X, X >::real_type
inherited

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

◆ scalar_real_type

typedef Simd::Scalar<real_type> Dune::InverseOperator< X, X >::scalar_real_type
inherited

scalar type underlying the field_type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited

Constructor & Destructor Documentation

◆ GeneralizedPCGSolver() [1/5]

template<class X >
Dune::GeneralizedPCGSolver< X >::GeneralizedPCGSolver ( LinearOperator< X, X > &  op,
Preconditioner< X, X > &  prec,
scalar_real_type  reduction,
int  maxit,
int  verbose,
int  restart = 10 
)
inline

Set up nonlinear preconditioned conjugate gradient solver.

Parameters
restartnumber of GMRes cycles before restart

◆ GeneralizedPCGSolver() [2/5]

template<class X >
Dune::GeneralizedPCGSolver< X >::GeneralizedPCGSolver ( LinearOperator< X, X > &  op,
ScalarProduct< X > &  sp,
Preconditioner< X, X > &  prec,
scalar_real_type  reduction,
int  maxit,
int  verbose,
int  restart = 10 
)
inline

Set up nonlinear preconditioned conjugate gradient solver.

Parameters
restartWhen to restart the construction of the Krylov search space.

◆ GeneralizedPCGSolver() [3/5]

template<class X >
Dune::GeneralizedPCGSolver< X >::GeneralizedPCGSolver ( std::shared_ptr< LinearOperator< X, X > >  op,
std::shared_ptr< Preconditioner< X, X > >  prec,
const ParameterTree &  configuration 
)
inline

Constructor.

Additional parameter:

ParameterTree Key Meaning
restart number of PCG cycles before restart

See ISTL_Factory for the ParameterTree layout and examples.

◆ GeneralizedPCGSolver() [4/5]

template<class X >
Dune::GeneralizedPCGSolver< X >::GeneralizedPCGSolver ( std::shared_ptr< LinearOperator< X, X > >  op,
std::shared_ptr< ScalarProduct< X > >  sp,
std::shared_ptr< Preconditioner< X, X > >  prec,
const ParameterTree &  configuration 
)
inline

◆ GeneralizedPCGSolver() [5/5]

template<class X >
Dune::GeneralizedPCGSolver< X >::GeneralizedPCGSolver ( std::shared_ptr< LinearOperator< X, X > >  op,
std::shared_ptr< ScalarProduct< X > >  sp,
std::shared_ptr< Preconditioner< X, X > >  prec,
scalar_real_type  reduction,
int  maxit,
int  verbose,
int  restart = 10 
)
inline

Set up nonlinear preconditioned conjugate gradient solver.

Parameters
restartWhen to restart the construction of the Krylov search space.

Member Function Documentation

◆ apply() [1/2]

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

Apply inverse operator with given reduction factor.

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

Reimplemented in Dune::RestartedGMResSolver< 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
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 >.

◆ category()

virtual SolverCategory::Category Dune::IterativeSolver< X, X >::category ( ) const
inlinevirtualinherited

Category of the solver (see SolverCategory::Category)

Implements Dune::InverseOperator< X, X >.

◆ name()

std::string Dune::IterativeSolver< X, X >::name ( ) const
inlineinherited

◆ 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
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 DataType &  norm_old 
) const
inlineprotectedinherited

helper function for printing solver output

Member Data Documentation

◆ _category

SolverCategory::Category Dune::IterativeSolver< X, X >::_category
protectedinherited

◆ _maxit

int Dune::IterativeSolver< X, X >::_maxit
protectedinherited

◆ _op

std::shared_ptr<LinearOperator<X,X > > Dune::IterativeSolver< X, X >::_op
protectedinherited

◆ _prec

std::shared_ptr<Preconditioner<X,X > > Dune::IterativeSolver< X, X >::_prec
protectedinherited

◆ _reduction

scalar_real_type Dune::IterativeSolver< X, X >::_reduction
protectedinherited

◆ _sp

std::shared_ptr<ScalarProduct<X> > Dune::IterativeSolver< X, X >::_sp
protectedinherited

◆ _verbose

int Dune::IterativeSolver< X, X >::_verbose
protectedinherited

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