DUNE-FEM (unstable)
Base class for all implementations of iterative solvers. More...
#include <dune/istl/solver.hh>
Classes | |
class | Iteration |
Class for controlling iterative methods. More... | |
Public Types | |
typedef X | domain_type |
Type of the domain of the operator to be inverted. | |
typedef Y | 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_type > | scalar_real_type |
scalar type underlying the field_type | |
Public Member Functions | |
IterativeSolver (const LinearOperator< X, Y > &op, Preconditioner< X, Y > &prec, scalar_real_type reduction, int maxit, int verbose) | |
General constructor to initialize an iterative solver. More... | |
IterativeSolver (const LinearOperator< X, Y > &op, const ScalarProduct< X > &sp, Preconditioner< X, Y > &prec, scalar_real_type reduction, int maxit, int verbose) | |
General constructor to initialize an iterative solver. More... | |
IterativeSolver (std::shared_ptr< const LinearOperator< X, Y > > op, std::shared_ptr< Preconditioner< X, X > > prec, const ParameterTree &configuration) | |
Constructor. More... | |
IterativeSolver (std::shared_ptr< const LinearOperator< X, Y > > op, std::shared_ptr< const ScalarProduct< X > > sp, std::shared_ptr< Preconditioner< X, X > > prec, const ParameterTree &configuration) | |
Constructor. More... | |
IterativeSolver (std::shared_ptr< const LinearOperator< X, Y > > op, std::shared_ptr< const ScalarProduct< X > > sp, std::shared_ptr< Preconditioner< X, Y > > prec, scalar_real_type reduction, int maxit, int verbose) | |
General constructor to initialize an iterative solver. More... | |
void | apply (X &x, X &b, double reduction, InverseOperatorResult &res) override |
Apply inverse operator with given reduction factor. More... | |
SolverCategory::Category | category () const override |
Category of the solver (see SolverCategory::Category) | |
virtual void | apply (X &x, Y &b, InverseOperatorResult &res)=0 |
Apply inverse operator,. More... | |
virtual void | apply (X &x, Y &b, double reduction, InverseOperatorResult &res)=0 |
apply inverse operator, with given convergence criteria. More... | |
Detailed Description
class Dune::IterativeSolver< X, Y >
Base class for all implementations of iterative solvers.
This class provides all storage, which is needed by the usual iterative solvers. In additional it provides all the necessary constructors, which are then only imported in the actual solver implementation.
Constructor & Destructor Documentation
◆ IterativeSolver() [1/5]
|
inline |
General constructor to initialize an iterative 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
References Dune::SolverCategory::category(), DUNE_THROW, and Dune::SolverCategory::sequential.
◆ IterativeSolver() [2/5]
|
inline |
General constructor to initialize an iterative 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
References Dune::SolverCategory::category(), and DUNE_THROW.
◆ IterativeSolver() [3/5]
|
inline |
Constructor.
- Parameters
-
op The operator we solve prec The preconditioner to apply in each iteration of the loop. configuration ParameterTree containing iterative solver parameters.
ParameterTree Key | Meaning |
---|---|
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 |
See ISTL_Factory for the ParameterTree layout and examples.
◆ IterativeSolver() [4/5]
|
inline |
Constructor.
- 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. configuration ParameterTree containing iterative solver parameters.
ParameterTree Key | Meaning |
---|---|
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 |
See ISTL_Factory for the ParameterTree layout and examples.
◆ IterativeSolver() [5/5]
|
inline |
General constructor to initialize an iterative 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
References Dune::SolverCategory::category(), and DUNE_THROW.
Member Function Documentation
◆ apply() [1/3]
|
inlineoverride |
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.
- Exceptions
-
SolverAbort When the solver detects a problem and cannot continue
Reimplemented in Dune::RestartedGMResSolver< X, X >.
References Dune::IterativeSolver< X, Y >::apply().
Referenced by Dune::IterativeSolver< X, Y >::apply().
◆ apply() [2/3]
|
pure virtualinherited |
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.
- Exceptions
-
SolverAbort When the solver detects a problem and cannot continue
Implemented in Dune::Cholmod< Vector, Index >, Dune::IterativeSolver< X, X >, and Dune::RestartedGMResSolver< X, X >.
◆ apply() [3/3]
|
pure virtualinherited |
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.
- Exceptions
-
SolverAbort When the solver detects a problem and cannot continue
Implemented in Dune::Cholmod< Vector, Index >, Dune::LoopSolver< X >, Dune::GradientSolver< X >, Dune::CGSolver< X >, Dune::BiCGSTABSolver< X >, Dune::MINRESSolver< X >, Dune::RestartedGMResSolver< X, X >, Dune::GeneralizedPCGSolver< X >, Dune::RestartedFCGSolver< X >, and Dune::CompleteFCGSolver< X >.
The documentation for this class was generated from the following file:
- dune/istl/solver.hh