ViennaCL - The Vienna Computing Library  1.5.1
Public Member Functions
gmres_tag Class Reference

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. More...
 
double tolerance () const
 Returns the relative tolerance. More...
 
unsigned int max_iterations () const
 Returns the maximum number of iterations. More...
 
unsigned int krylov_dim () const
 Returns the maximum dimension of the Krylov space before restart. More...
 
unsigned int max_restarts () const
 Returns the maximum number of GMRES restarts. More...
 
unsigned int iters () const
 Return the number of solver iterations: More...
 
void iters (unsigned int i) const
 Set the number of solver iterations (should only be modified by the solver) More...
 
double error () const
 Returns the estimated relative error at the end of the solver run. More...
 
void error (double e) const
 Sets the estimated relative error at the end of the solver run. More...
 

Detailed Description

A tag for the solver GMRES. Used for supplying solver parameters and for dispatching the solve() function.

Constructor & Destructor Documentation

gmres_tag ( double  tol = 1e-10,
unsigned int  max_iterations = 300,
unsigned int  krylov_dim = 20 
)
inline

The constructor.

Parameters
tolRelative tolerance for the residual (solver quits if ||r|| < tol * ||r_initial||)
max_iterationsThe maximum number of iterations (including restarts
krylov_dimThe maximum dimension of the Krylov space before restart (number of restarts is found by max_iterations / krylov_dim)

Member Function Documentation

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.

unsigned int iters ( ) const
inline

Return the number of solver iterations:

void iters ( unsigned int  i) const
inline

Set the number of solver iterations (should only be modified by the solver)

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.


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