#include <BelosLSQRStatusTest.hpp>
|
void | print (std::ostream &os, int indent=0) const |
| Output formatted description of stopping test to output stream. More...
|
|
void | printStatus (std::ostream &os, Belos::StatusType type) const |
| Print message for each status specific to this stopping test. More...
|
|
|
std::string | description () const |
| Method to return description of the maximum iteration status test. More...
|
|
template<class ScalarType, class MV, class OP>
class Belos::LSQRStatusTest< ScalarType, MV, OP >
Definition at line 65 of file BelosLSQRStatusTest.hpp.
◆ SCT
template<class ScalarType , class MV , class OP >
◆ MagnitudeType
template<class ScalarType , class MV , class OP >
◆ MVT
template<class ScalarType , class MV , class OP >
◆ LSQRStatusTest()
template<class ScalarType , class MV , class OP >
Constructor.
The constructor has four optional arguments, specifying the maximum observed condition number of Abar, the number of successive convergent iterations, an estimate of the relative error in the data defining the right-hand side (b), and an estimate of the relative error in the data defining the coefficinet matrix (A). The default termIterMax is 1, and the other three parameters default to 0. The defaults specified in LSQRSolMgr are more realistic.
Definition at line 241 of file BelosLSQRStatusTest.hpp.
◆ ~LSQRStatusTest()
template<class ScalarType , class MV , class OP >
LSQRStatusTest::~LSQRStatusTest |
( |
| ) |
|
|
virtual |
◆ checkStatus()
template<class ScalarType , class MV , class OP >
◆ getStatus()
template<class ScalarType , class MV , class OP >
◆ reset()
template<class ScalarType , class MV , class OP >
void LSQRStatusTest::reset |
( |
| ) |
|
|
virtual |
◆ setCondLim()
template<class ScalarType , class MV , class OP >
◆ setTermIterMax()
template<class ScalarType , class MV , class OP >
◆ setRelRhsErr()
template<class ScalarType , class MV , class OP >
◆ setRelMatErr()
template<class ScalarType , class MV , class OP >
◆ getCondMaxLim()
template<class ScalarType , class MV , class OP >
Returns the value of the upper limit of the condition number of Abar set in the constructor.
Definition at line 137 of file BelosLSQRStatusTest.hpp.
◆ getTermIterMax()
template<class ScalarType , class MV , class OP >
Returns the number of successful convergent iterations required set in the constructor.
Definition at line 140 of file BelosLSQRStatusTest.hpp.
◆ getRelRhsErr()
template<class ScalarType , class MV , class OP >
Returns the value of the estimate of the relative error in the data defining b set in the constructor.
Definition at line 143 of file BelosLSQRStatusTest.hpp.
◆ getMatErr()
template<class ScalarType , class MV , class OP >
Returns the value of the estimate of the relative error in the data defining A set in the constructor.
Definition at line 146 of file BelosLSQRStatusTest.hpp.
◆ getMatCondNum()
template<class ScalarType , class MV , class OP >
◆ getMatNorm()
template<class ScalarType , class MV , class OP >
◆ getTermIter()
template<class ScalarType , class MV , class OP >
◆ getResidNorm()
template<class ScalarType , class MV , class OP >
◆ getLSResidNorm()
template<class ScalarType , class MV , class OP >
Returns the value of the observed norm of the Least Squares residual A^T r.
Definition at line 161 of file BelosLSQRStatusTest.hpp.
◆ print()
template<class ScalarType , class MV , class OP >
void LSQRStatusTest::print |
( |
std::ostream & |
os, |
|
|
int |
indent = 0 |
|
) |
| const |
|
virtual |
◆ printStatus()
template<class ScalarType , class MV , class OP >
◆ firstCallCheckStatusSetup()
template<class ScalarType , class MV , class OP >
Called in checkStatus exactly once, on the first call to checkStatus.
◆ description()
template<class ScalarType , class MV , class OP >
◆ condMax_
template<class ScalarType , class MV , class OP >
◆ term_iter_max_
template<class ScalarType , class MV , class OP >
◆ rel_rhs_err_
template<class ScalarType , class MV , class OP >
◆ rel_mat_err_
template<class ScalarType , class MV , class OP >
◆ rcondMin_
template<class ScalarType , class MV , class OP >
One of the tolerances defining convergence, the reciprocal of condMax_ or, if that is zero, machine epsilon.
Definition at line 214 of file BelosLSQRStatusTest.hpp.
◆ status_
template<class ScalarType , class MV , class OP >
◆ term_iter_
template<class ScalarType , class MV , class OP >
◆ matCondNum_
template<class ScalarType , class MV , class OP >
◆ matNorm_
template<class ScalarType , class MV , class OP >
◆ resNorm_
template<class ScalarType , class MV , class OP >
◆ matResNorm_
template<class ScalarType , class MV , class OP >
The documentation for this class was generated from the following file: