dune-istl 2.10
Loading...
Searching...
No Matches
Dune::RestartedFCGSolver< X > Class Template Reference

Accelerated flexible conjugate gradient method. More...

#include <dune/istl/solvers.hh>

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

Public Types

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

Public Member Functions

 RestartedFCGSolver (const LinearOperator< X, X > &op, Preconditioner< X, X > &prec, scalar_real_type reduction, int maxit, int verbose, int mmax=10)
 Constructor to initialize a RestartedFCG solver.
 
 RestartedFCGSolver (const LinearOperator< X, X > &op, const ScalarProduct< X > &sp, Preconditioner< X, X > &prec, scalar_real_type reduction, int maxit, int verbose, int mmax=10)
 Constructor to initialize a RestartedFCG solver.
 
 RestartedFCGSolver (std::shared_ptr< const LinearOperator< X, X > > op, std::shared_ptr< const ScalarProduct< X > > sp, std::shared_ptr< Preconditioner< X, X > > prec, scalar_real_type reduction, int maxit, int verbose, int mmax=10)
 Constructor to initialize a RestartedFCG solver.
 
 RestartedFCGSolver (std::shared_ptr< const LinearOperator< X, X > > op, std::shared_ptr< Preconditioner< X, X > > prec, const ParameterTree &config)
 Constructor.
 
 RestartedFCGSolver (std::shared_ptr< const LinearOperator< X, X > > op, std::shared_ptr< const ScalarProduct< X > > sp, std::shared_ptr< Preconditioner< X, X > > prec, const ParameterTree &config)
 
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.
 
virtual SolverCategory::Category category () const
 Category of the solver (see SolverCategory::Category)
 
std::string name () const
 

Protected Types

using Iteration = typename IterativeSolver<X,X>::template Iteration<unsigned int>
 
enum  
 

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
 

Protected Attributes

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

Detailed Description

template<class X>
class Dune::RestartedFCGSolver< X >

Accelerated flexible conjugate gradient method.

Flexible conjugate gradient method as in Y. Notay 'Flexible conjugate Gradients', SIAM J. Sci. Comput Vol. 22, No.4, pp. 1444-1460

This solver discard cyclic all old directions to speed up computing. In exact arithmetic it is exactly the same as the GeneralizedPCGSolver, but it is much faster, depending on the operator and dimension. On the other hand for large mmax it uses noticeably more memory.

Member Typedef Documentation

◆ domain_type

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

Type of the domain of the operator to be inverted.

◆ field_type

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

The field type of the operator.

◆ Iteration

template<class X >
using Dune::RestartedFCGSolver< X >::Iteration = typename IterativeSolver<X,X>::template Iteration<unsigned int>
protected

◆ range_type

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

Type of the range of the operator to be inverted.

◆ real_type

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

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

◆ RestartedFCGSolver() [1/5]

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

Constructor to initialize a RestartedFCG solver.

Parameters
mmaxis the maximal number of previous vectors which are orthogonalized against the new search direction.

◆ RestartedFCGSolver() [2/5]

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

Constructor to initialize a RestartedFCG solver.

Parameters
mmaxis the maximal number of previous vectors which are orthogonalized against the new search direction.

◆ RestartedFCGSolver() [3/5]

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

Constructor to initialize a RestartedFCG solver.

Parameters
mmaxis the maximal number of previous vectors which are orthogonalized against the new search direction.

◆ RestartedFCGSolver() [4/5]

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

Constructor.

Additional parameter:

ParameterTree Key Meaning
mmax number of FCG cycles before restart. default=10

See ISTL_Factory for the ParameterTree layout and examples.

◆ RestartedFCGSolver() [5/5]

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

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::RestartedFCGSolver< 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
Note
Currently, the RestartedFCGSolver aborts when a NaN or infinite defect is detected. However, -ffinite-math-only (implied by -ffast-math) can inhibit a result from becoming NaN that really should be NaN. E.g. numeric_limits<double>::quiet_NaN()*0.0==0.0 with gcc-5.3 -ffast-math.

Implements Dune::InverseOperator< X, X >.

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

◆ _mmax

template<class X >
int Dune::RestartedFCGSolver< X >::_mmax
protected

◆ _op

std::shared_ptr<const 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<const 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: