|
namespace ewalena
0.2.15
ewalena is not an acronym
|
|
namespace ewalena
0.2.15
ewalena is not an acronym
|
Solver control for eigenspectrum problems. More...
#include <include/ewalena/lac/solver_control.h>
Public Types | |
| enum | State { null = 0, pass, fail } |
Public Member Functions | |
| State | check (const unsigned int n_iterations, const ValueType tolerance) |
| unsigned int | max_n_iterations () const |
| ValueType | max_tolerance () const |
| unsigned int | n_iterations () const |
| State | solver_state () |
| SolverControl (const unsigned int max_n_iterations, const double max_tolerance) | |
| ValueType | tolerance () const |
| ~SolverControl () | |
Protected Attributes | |
| unsigned int | max_n_iterations_ |
| ValueType | max_tolerance_ |
| unsigned int | n_iterations_ |
| State | solver_state_ |
| ValueType | tolerance_ |
Solver control for eigenspectrum problems.
The SolverBase class is a base class for solving eigenspectrum problems. The matrix 
has a right-eigenvector 
and eigenvalue 
if:
![\[A\cdot x=\lambda x\quad.\]](form_102.png)
SolverXXX class documentation for a description of which options are suitable for which solvers.| enum ewalena::SolverControl::State |
| ewalena::SolverControl< ValueType >::SolverControl | ( | const unsigned int | max_n_iterations, |
| const double | max_tolerance | ||
| ) |
Constructor.
| ewalena::SolverControl< ValueType >::~SolverControl | ( | ) |
Destructor.
| State ewalena::SolverControl< ValueType >::check | ( | const unsigned int | n_iterations, |
| const ValueType | tolerance | ||
| ) |
Check the maximal number of iterations allowed for this solver control against the number of concurrent iterations and return the state of the solver.
| unsigned int ewalena::SolverControl< ValueType >::max_n_iterations | ( | ) | const |
Return the maximum number of iterations attached to this solver control.
| ValueType ewalena::SolverControl< ValueType >::max_tolerance | ( | ) | const |
Return the maximum tolerance attached to this solver control.
| unsigned int ewalena::SolverControl< ValueType >::n_iterations | ( | ) | const |
Return the number of iterations passed by this solver at the time of calling this function.
| State ewalena::SolverControl< ValueType >::solver_state | ( | ) |
Return the state of the solver.
| ValueType ewalena::SolverControl< ValueType >::tolerance | ( | ) | const |
Return the tolerance obtained by this solver at the time of calling this function.
unsigned int ewalena::SolverControl< ValueType >::max_n_iterations_ [protected] |
Prescribed maximum number of iterations n_iterations that can be tried before solver failure is asserted.
ValueType ewalena::SolverControl< ValueType >::max_tolerance_ [protected] |
Prescribed tolerance that can be tried before solver failure is asserted.
unsigned int ewalena::SolverControl< ValueType >::n_iterations_ [protected] |
Internal reference to the total number of iterations this solver has completed, ie. asserts success. This usually refers to the maximally outer iteration in the case where two, or more, iterative procedures are used in the solver process.
State ewalena::SolverControl< ValueType >::solver_state_ [protected] |
Internal reference to the state of the solver.
ValueType ewalena::SolverControl< ValueType >::tolerance_ [protected] |
Internal reference to the total tolerance to be sought for the solver to report success.
1.7.6.1