A tag for the solver GMRES. Used for supplying solver parameters and for dispatching the solve() function. More...
#include <gmres.hpp>
Public Member Functions | |
| gmres_tag (double tol=1e-10, unsigned int max_iterations=300, unsigned int krylov_dim=20) | |
| The constructor. | |
| double | tolerance () const |
| Returns the relative tolerance. | |
| unsigned int | max_iterations () const |
| Returns the maximum number of iterations. | |
| unsigned int | krylov_dim () const |
| Returns the maximum dimension of the Krylov space before restart. | |
| unsigned int | max_restarts () const |
| Returns the maximum number of GMRES restarts. | |
| unsigned int | iters () const |
| Return the number of solver iterations: | |
| void | iters (unsigned int i) const |
| Set the number of solver iterations (should only be modified by the solver). | |
| double | error () const |
| Returns the estimated relative error at the end of the solver run. | |
| void | error (double e) const |
| Sets the estimated relative error at the end of the solver run. | |
A tag for the solver GMRES. Used for supplying solver parameters and for dispatching the solve() function.
| gmres_tag | ( | double | tol = 1e-10, |
|
| unsigned int | max_iterations = 300, |
|||
| unsigned int | krylov_dim = 20 | |||
| ) | [inline] |
The constructor.
| tol | Relative tolerance for the residual (solver quits if ||r|| < tol * ||r_initial||) | |
| max_iterations | The maximum number of iterations (including restarts | |
| krylov_dim | The maximum dimension of the Krylov space before restart (number of restarts is found by max_iterations / krylov_dim) |
| double error | ( | ) | const [inline] |
Returns the estimated relative error at the end of the solver run.
| void error | ( | double | e | ) | const [inline] |
Sets the estimated relative error at the end of the solver run.
| void iters | ( | unsigned int | i | ) | const [inline] |
Set the number of solver iterations (should only be modified by the solver).
| unsigned int iters | ( | ) | const [inline] |
Return the number of solver iterations:
| unsigned int krylov_dim | ( | ) | const [inline] |
Returns the maximum dimension of the Krylov space before restart.
| unsigned int max_iterations | ( | ) | const [inline] |
Returns the maximum number of iterations.
| unsigned int max_restarts | ( | ) | const [inline] |
Returns the maximum number of GMRES restarts.
| double tolerance | ( | ) | const [inline] |
Returns the relative tolerance.
1.7.1