conjugate gradient method
More...
#include <dune/istl/solvers.hh>
|
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...
|
|
|
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...
|
|
template<class X>
class Dune::CGSolver< X >
conjugate gradient method
◆ domain_type
The domain type of the operator to be inverted.
◆ field_type
The field type of the operator to be inverted.
◆ range_type
The range type of the operator to be inverted.
◆ real_type
The real type of the field type (is the same if using real numbers, but differs for std::complex)
◆ anonymous enum
◆ CGSolver() [1/2]
template<class X >
template<class L , class P >
Set up conjugate gradient solver.
◆ CGSolver() [2/2]
template<class X >
template<class L , class S , class P >
Set up conjugate gradient solver.
◆ apply() [1/2]
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. |
- Exceptions
-
SolverAbort | When the solver detects a problem and cannot continue |
- Note
- Currently, the CGSolver 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 >.
◆ apply() [2/2]
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 |
- Note
- Currently, the CGSolver 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 >.
◆ printHeader()
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 DataType & |
norm_old |
|
) |
| 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 |
|
inlineprotectedinherited |
helper function for printing solver output
The documentation for this class was generated from the following file: