Belos Version of the Day
Public Types
Belos::LSQRStatusTest< ScalarType, MV, OP > Class Template Reference

#include <BelosLSQRStatusTest.hpp>

Inheritance diagram for Belos::LSQRStatusTest< ScalarType, MV, OP >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef Teuchos::ScalarTraits
< ScalarType > 
SCT
typedef SCT::magnitudeType MagnitudeType
typedef Belos::MultiVecTraits
< ScalarType, MV > 
MVT

Public Member Functions

Constructor/Destructor.
 LSQRStatusTest (MagnitudeType cond_lim=0.0, int term_iter_max=1, MagnitudeType rel_rhs_err=0.0, MagnitudeType rel_mat_err=0.0)
 Constructor.
virtual ~LSQRStatusTest ()
 Destructor.
Form and parameter definition methods.
int setCondLim (MagnitudeType cond_lim)
 Set the value of the tolerance.
int setTermIterMax (int term_iter_max)
int setRelRhsErr (MagnitudeType rel_rhs_err)
int setRelMatErr (MagnitudeType rel_mat_err)
Status method
Belos::StatusType checkStatus (Belos::Iteration< ScalarType, MV, OP > *iSolver)
 Check convergence status of the iterative solver: Unconverged, Converged, Failed.
Belos::StatusType getStatus () const
 Return the result of the most recent CheckStatus call.
Reset methods
void reset ()
 Resets the status test to the initial internal state.
Print methods
void print (std::ostream &os, int indent=0) const
 Output formatted description of stopping test to output stream.
void printStatus (std::ostream &os, Belos::StatusType type) const
 Print message for each status specific to this stopping test.
Methods to access data members.
MagnitudeType getCondLim () const
 Returns the value of the upper limit of the condition number of Abar set in the constructor.
int getTermIterMax () const
 Returns the number of successful convergent iterations required set in the constructor.
MagnitudeType getRelRhsErr () const
 Returns the value of the estimate of the relative error in the data defining b set in the constructor.
MagnitudeType getMatErr () const
 Returns the value of the estimate of the relative error in the data defining A set in the constructor.
Misc.
Belos::StatusType firstCallCheckStatusSetup (Belos::Iteration< ScalarType, MV, OP > *iSolver)
 Call to setup initialization.
Overridden from Teuchos::Describable
std::string description () const
 Method to return description of the maximum iteration status test.

Detailed Description

template<class ScalarType, class MV, class OP>
class Belos::LSQRStatusTest< ScalarType, MV, OP >

Definition at line 65 of file BelosLSQRStatusTest.hpp.


Member Typedef Documentation

template<class ScalarType , class MV , class OP >
typedef Teuchos::ScalarTraits<ScalarType> Belos::LSQRStatusTest< ScalarType, MV, OP >::SCT

Definition at line 70 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
typedef SCT::magnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::MagnitudeType

Definition at line 71 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
typedef Belos::MultiVecTraits<ScalarType,MV> Belos::LSQRStatusTest< ScalarType, MV, OP >::MVT

Definition at line 72 of file BelosLSQRStatusTest.hpp.


Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
LSQRStatusTest::LSQRStatusTest ( MagnitudeType  cond_lim = 0.0,
int  term_iter_max = 1,
MagnitudeType  rel_rhs_err = 0.0,
MagnitudeType  rel_mat_err = 0.0 
)

Constructor.

The constructor has four optional arguments, specifying the upper limit of the apparent condition number of Abar, the number of successful 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.

Definition at line 220 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
LSQRStatusTest::~LSQRStatusTest ( ) [virtual]

Destructor.

Definition at line 230 of file BelosLSQRStatusTest.hpp.


Member Function Documentation

template<class ScalarType , class MV , class OP >
int Belos::LSQRStatusTest< ScalarType, MV, OP >::setCondLim ( MagnitudeType  cond_lim) [inline]

Set the value of the tolerance.

Resetting the limit of the condition number of Abar is allowed in cases where, in the process of testing convergence, the initial is found to be either too tight or too lax.

Definition at line 96 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
int Belos::LSQRStatusTest< ScalarType, MV, OP >::setTermIterMax ( int  term_iter_max) [inline]

Definition at line 101 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
int Belos::LSQRStatusTest< ScalarType, MV, OP >::setRelRhsErr ( MagnitudeType  rel_rhs_err) [inline]

Definition at line 107 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
int Belos::LSQRStatusTest< ScalarType, MV, OP >::setRelMatErr ( MagnitudeType  rel_mat_err) [inline]

Definition at line 111 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
Belos::StatusType LSQRStatusTest::checkStatus ( Belos::Iteration< ScalarType, MV, OP > *  iSolver) [virtual]

Check convergence status of the iterative solver: Unconverged, Converged, Failed.

This method checks if the convergence criteria are met using the current information from the iterative solver.

Implements Belos::StatusTest< ScalarType, MV, OP >.

Definition at line 257 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
Belos::StatusType Belos::LSQRStatusTest< ScalarType, MV, OP >::getStatus ( ) const [inline, virtual]

Return the result of the most recent CheckStatus call.

Implements Belos::StatusTest< ScalarType, MV, OP >.

Definition at line 126 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
void LSQRStatusTest::reset ( ) [virtual]

Resets the status test to the initial internal state.

Implements Belos::StatusTest< ScalarType, MV, OP >.

Definition at line 234 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
void LSQRStatusTest::print ( std::ostream &  os,
int  indent = 0 
) const [virtual]

Output formatted description of stopping test to output stream.

Implements Belos::StatusTest< ScalarType, MV, OP >.

Definition at line 298 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
void LSQRStatusTest::printStatus ( std::ostream &  os,
Belos::StatusType  type 
) const [virtual]

Print message for each status specific to this stopping test.

Reimplemented from Belos::StatusTest< ScalarType, MV, OP >.

Definition at line 307 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::getCondLim ( ) const [inline]

Returns the value of the upper limit of the condition number of Abar set in the constructor.

Definition at line 153 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
int Belos::LSQRStatusTest< ScalarType, MV, OP >::getTermIterMax ( ) const [inline]

Returns the number of successful convergent iterations required set in the constructor.

Definition at line 156 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::getRelRhsErr ( ) const [inline]

Returns the value of the estimate of the relative error in the data defining b set in the constructor.

Definition at line 159 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::getMatErr ( ) const [inline]

Returns the value of the estimate of the relative error in the data defining A set in the constructor.

Definition at line 162 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
Belos::StatusType LSQRStatusTest::firstCallCheckStatusSetup ( Belos::Iteration< ScalarType, MV, OP > *  iSolver)

Call to setup initialization.

Definition at line 241 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >
std::string Belos::LSQRStatusTest< ScalarType, MV, OP >::description ( ) const [inline, virtual]

Method to return description of the maximum iteration status test.

Reimplemented from Teuchos::Describable.

Definition at line 178 of file BelosLSQRStatusTest.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines