44 #ifndef BELOS_LSQR_STATUS_TEST_HPP 45 #define BELOS_LSQR_STATUS_TEST_HPP 64 template <
class ScalarType,
class MV,
class OP>
84 int term_iter_max = 1,
118 term_iter_max_ = term_iter_max;
119 if (term_iter_max_ < 1)
124 rel_rhs_err_ = rel_rhs_err;
128 rel_mat_err_ = rel_mat_err;
169 void print(std::ostream& os,
int indent = 0)
const;
190 std::ostringstream oss;
191 oss <<
"LSQRStatusTest<>: [ limit of condition number = " << condMax_ <<
" ]";
239 template <
class ScalarType,
class MV,
class OP>
246 term_iter_max_ (term_iter_max),
247 rel_rhs_err_ (rel_rhs_err),
248 rel_mat_err_ (rel_mat_err),
258 template <
class ScalarType,
class MV,
class OP>
262 template <
class ScalarType,
class MV,
class OP>
268 template <
class ScalarType,
class MV,
class OP>
273 if (condMax_ > MTzero )
275 rcondMin_ = MTone / condMax_;
282 bool termIterFlag =
false;
305 std::cout <<
" X " << state.
sol_norm 316 ScalarType stop_crit_1 = zero;
317 if( state.
bnorm > zero )
321 ScalarType stop_crit_2 = zero;
359 if (stop_crit_1 <= resid_tol )
360 std::cout <<
"Conv: stop_crit_1 " << stop_crit_1 <<
" resid_tol " << resid_tol << std::endl;
362 if (stop_crit_1 <= resid_tol_mach )
363 std::cout <<
"Conv: stop_crit_1 " << stop_crit_1 <<
" resid_tol_mach " << resid_tol_mach << std::endl;
365 if (stop_crit_2 <= rel_mat_err_ )
366 std::cout <<
"Conv: stop_crit_2 " << stop_crit_2 <<
" rel_mat_err " << rel_mat_err_ << std::endl;
371 if (stop_crit_3 <= rcondMin_ )
372 std::cout <<
"Conv: stop_crit_3 " << stop_crit_3 <<
" rcondMin_ " << rcondMin_ << std::endl;
394 template <
class ScalarType,
class MV,
class OP>
397 for (
int j = 0; j < indent; j++)
399 printStatus(os, status_);
400 os <<
"limit of condition number = " << condMax_ << std::endl;
401 os <<
"limit of condition number = " << condMax_ << std::endl;
404 template <
class ScalarType,
class MV,
class OP>
407 os << std::left << std::setw(13) << std::setfill(
'.');
420 os << std::left << std::setfill(
' ');
Teuchos::ScalarTraits< ScalarType > SCT
Belos concrete class that iterates LSQR.
void printStatus(std::ostream &os, Belos::StatusType type) const
Print message for each status specific to this stopping test.
int setTermIterMax(int term_iter_max)
ScalarType resid_norm
The current residual norm.
static magnitudeType eps()
MagnitudeType getMatNorm() const
Returns the value of the observed (Frobenius) norm of A.
Pure virtual base class for defining the status testing capabilities of Belos.
MagnitudeType getResidNorm() const
Returns the value of the observed norm of the residual r = b-Ax.
ScalarType sol_norm
An estimate of the norm of the solution.
ScalarType mat_cond_num
An approximation to the condition number of A.
A pure virtual class for defining the status tests for the Belos iterative solvers.
std::string description() const
Method to return description of the maximum iteration status test.
StatusType
Whether the StatusTest wants iteration to stop.
Traits class which defines basic operations on multivectors.
ScalarType frob_mat_norm
An approximation to the Frobenius norm of A.
SCT::magnitudeType MagnitudeType
Belos::StatusType getStatus() const
Return the result of the most recent CheckStatus call.
ScalarType mat_resid_norm
An estimate of the norm of A^T*resid.
Belos::StatusType checkStatus(Belos::Iteration< ScalarType, MV, OP > *iSolver)
Check convergence status of the iterative solver: Unconverged, Converged, Failed. ...
MagnitudeType getLSResidNorm() const
Returns the value of the observed norm of the Least Squares residual A^T r.
Belos::MultiVecTraits< ScalarType, MV > MVT
MagnitudeType getRelRhsErr() const
Returns the value of the estimate of the relative error in the data defining b set in the constructor...
Belos::StatusType firstCallCheckStatusSetup(Belos::Iteration< ScalarType, MV, OP > *iSolver)
Called in checkStatus exactly once, on the first call to checkStatus.
int getTermIterMax() const
Returns the number of successful convergent iterations required set in the constructor.
int setCondLim(MagnitudeType condMax)
Set the tolerances.
MagnitudeType getCondMaxLim() const
Returns the value of the upper limit of the condition number of Abar set in the constructor.
LSQRStatusTest(MagnitudeType condMax=0.0, int term_iter_max=1, MagnitudeType rel_rhs_err=0.0, MagnitudeType rel_mat_err=0.0)
Constructor.
int setRelMatErr(MagnitudeType rel_mat_err)
MagnitudeType getMatCondNum() const
Returns the value of the observed condition number of Abar.
Implementation of the LSQR iteration.
int getTermIter() const
!Returns the current number of successful iterations from the most recent StatusTest call...
void reset()
Resets the status test to the initial internal state.
ScalarType bnorm
The norm of the RHS vector b.
virtual ~LSQRStatusTest()
Destructor.
#define TEUCHOS_ASSERT(assertion_test)
int setRelRhsErr(MagnitudeType rel_rhs_err)
Structure to contain pointers to LSQRIteration state variables, ...
MagnitudeType getMatErr() const
Returns the value of the estimate of the relative error in the data defining A set in the constructor...
void print(std::ostream &os, int indent=0) const
Output formatted description of stopping test to output stream.
LSQRIterationState< ScalarType, MV > getState() const
Get the current state of the linear solver.