Iter< T_ > Class Template Reference
Class to drive an iterative process. More...
Public Member Functions | |
Iter () | |
Default Constructor. More... | |
Iter (int max_it, double toler, int verbose=0) | |
Constructor with iteration parameters. More... | |
~Iter () | |
Destructor. | |
void | setMaxIter (int max_it) |
Set maximal number of iterations. | |
void | setTolerance (real_t toler) |
Set tolerance value for convergence. | |
void | setVerbose (int v) |
Set verbosity parameter. | |
bool | check (Vect< T_ > &u, const Vect< T_ > &v, int opt=2) |
Check convergence. More... | |
Detailed Description
template<class T_>
class OFELI::Iter< T_ >
Class to drive an iterative process.
This template class enables monitoring any iterative process. It simply sets default values for tolerance, maximal number of iterations and enables checking convergence using two successive iterates.
Constructor & Destructor Documentation
Iter | ( | ) |
Default Constructor.
This constructor set default values: the maximal number of iterations is set to 100
and the tolerance to 1.e-8
Iter | ( | int | max_it, |
double | toler, | ||
int | verbose = 0 |
||
) |
Constructor with iteration parameters.
- Parameters
-
[in] max_it Maximum number of iterations [in] toler Tolerance value for convergence [in] verbose Verbosity parameter [default: 0] 0
: No message output,> 0
: message output with increasing display.
Member Function Documentation
Check convergence.
- Parameters
-
[in,out] u Solution vector at previous iteration [in] v Solution vector at current iteration [in] opt Vector norm for convergence checking 1
: 1-norm,2
: 2-norm, 0: Max. norm [default:2
]
- Returns
- true if convergence criterion is satisfied, false if not
After checking, this function copied v
into u
.