A Belos::StatusTest class for specifying convergence of LSQR. The outer status tests passes if an inner status passes a user specified number of times consecutively. The inner status test depends on information specific to LSQR iteration. More...

#include <BelosLSQRStatusTest.hpp>

Inheritance diagram for Belos::LSQRStatusTest< ScalarType, MV, OP >:

[legend]

Public Types
typedef Teuchos::ScalarTraits < ScalarType >	SCT

typedef SCT::magnitudeType	MagnitudeType

typedef Belos::MultiVecTraits < ScalarType, MV >	MVT

Constructor/Destructor.
	LSQRStatusTest (MagnitudeType condMax=0.0, int term_iter_max=1, MagnitudeType rel_rhs_err=0.0, MagnitudeType rel_mat_err=0.0)
	Constructor. More...

virtual	~LSQRStatusTest ()
	Destructor. More...

Status method
Belos::StatusType	checkStatus (Belos::Iteration< ScalarType, MV, OP > *iSolver)
	Check convergence status of the iterative solver: Unconverged, Converged, Failed. More...

Belos::StatusType	getStatus () const
	Return the result of the most recent CheckStatus call. More...

Reset methods
void	reset ()
	Resets the status test to the initial internal state. More...

int	setCondLim (MagnitudeType condMax)
	Set the tolerances. More...

int	setTermIterMax (int term_iter_max)

int	setRelRhsErr (MagnitudeType rel_rhs_err)

int	setRelMatErr (MagnitudeType rel_mat_err)

Accessor methods
MagnitudeType	getCondMaxLim () const
	Returns the value of the upper limit of the condition number of Abar set in the constructor. More...

int	getTermIterMax () const
	Returns the number of successful convergent iterations required set in the constructor. More...

MagnitudeType	getRelRhsErr () const
	Returns the value of the estimate of the relative error in the data defining b set in the constructor. More...

MagnitudeType	getMatErr () const
	Returns the value of the estimate of the relative error in the data defining A set in the constructor. More...

MagnitudeType	getMatCondNum () const
	Returns the value of the observed condition number of Abar. More...

MagnitudeType	getMatNorm () const
	Returns the value of the observed (Frobenius) norm of A. More...

int	getTermIter () const
	!Returns the current number of successful iterations from the most recent StatusTest call. More...

MagnitudeType	getResidNorm () const
	Returns the value of the observed norm of the residual r = b-Ax. More...

MagnitudeType	getLSResidNorm () const
	Returns the value of the observed norm of the Least Squares residual A^T r. More...

Print methods
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...

Misc.
Belos::StatusType	firstCallCheckStatusSetup (Belos::Iteration< ScalarType, MV, OP > *iSolver)
	Called in checkStatus exactly once, on the first call to checkStatus. More...

Overridden from Teuchos::Describable
std::string	description () const
	Method to return description of the maximum iteration status test. More...

Private data members.
MagnitudeType	condMax_
	Upper limit of condition number of Abar. More...

int	term_iter_max_
	How many iterations in a row a passing test for convergence is required. More...

MagnitudeType	rel_rhs_err_
	Error in data defining b. More...

MagnitudeType	rel_mat_err_
	Error in data defining A. More...

MagnitudeType	rcondMin_
	One of the tolerances defining convergence, the reciprocal of condMax_ or, if that is zero, machine epsilon. More...

Belos::StatusType	status_
	Status. More...

int	term_iter_

MagnitudeType	matCondNum_

MagnitudeType	matNorm_

MagnitudeType	resNorm_

MagnitudeType	matResNorm_

Additional Inherited Members
Public Member Functions inherited from Belos::StatusTest< ScalarType, MV, OP >
	StatusTest ()
	Constructor. More...

virtual	~StatusTest ()
	Destructor. More...

Public Member Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Detailed Description

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

A Belos::StatusTest class for specifying convergence of LSQR. The outer status tests passes if an inner status passes a user specified number of times consecutively. The inner status test depends on information specific to LSQR iteration.

Definition at line 33 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 38 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

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

Definition at line 39 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 40 of file BelosLSQRStatusTest.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >

Belos::LSQRStatusTest< ScalarType, MV, OP >::LSQRStatusTest	(	MagnitudeType	condMax = `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 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 209 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

Belos::LSQRStatusTest< ScalarType, MV, OP >::~LSQRStatusTest ( )

virtual

Destructor.

Definition at line 227 of file BelosLSQRStatusTest.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >

Belos::StatusType Belos::LSQRStatusTest< ScalarType, MV, OP >::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 237 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

Belos::StatusType Belos::LSQRStatusTest< ScalarType, MV, OP >::getStatus ( ) const

inlinevirtual

Return the result of the most recent CheckStatus call.

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

Definition at line 69 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

void Belos::LSQRStatusTest< ScalarType, MV, OP >::reset ( )

virtual

Resets the status test to the initial internal state.

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

Definition at line 231 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

int Belos::LSQRStatusTest< ScalarType, MV, OP >::setCondLim ( MagnitudeType condMax )

inline

Set the tolerances.

Definition at line 80 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 85 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 91 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 95 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::getCondMaxLim ( ) const

inline

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

Definition at line 105 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 108 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 111 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 114 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::getMatCondNum ( ) const

inline

Returns the value of the observed condition number of Abar.

Definition at line 117 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::getMatNorm ( ) const

inline

Returns the value of the observed (Frobenius) norm of A.

Definition at line 120 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

int Belos::LSQRStatusTest< ScalarType, MV, OP >::getTermIter ( ) const

inline

!Returns the current number of successful iterations from the most recent StatusTest call.

Definition at line 123 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::getResidNorm ( ) const

inline

Returns the value of the observed norm of the residual r = b-Ax.

Definition at line 126 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::getLSResidNorm ( ) const

inline

Returns the value of the observed norm of the Least Squares residual A^T r.

Definition at line 129 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

void Belos::LSQRStatusTest< ScalarType, MV, OP >::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 363 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

void Belos::LSQRStatusTest< ScalarType, MV, OP >::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 373 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

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

Called in checkStatus exactly once, on the first call to checkStatus.

template<class ScalarType , class MV , class OP >

std::string Belos::LSQRStatusTest< ScalarType, MV, OP >::description ( ) const

inlinevirtual

Method to return description of the maximum iteration status test.

Reimplemented from Teuchos::Describable.

Definition at line 156 of file BelosLSQRStatusTest.hpp.

Member Data Documentation

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::condMax_

private

Upper limit of condition number of Abar.

Definition at line 170 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

int Belos::LSQRStatusTest< ScalarType, MV, OP >::term_iter_max_

private

How many iterations in a row a passing test for convergence is required.

Definition at line 173 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::rel_rhs_err_

private

Error in data defining b.

Definition at line 176 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::rel_mat_err_

private

Error in data defining A.

Definition at line 179 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::rcondMin_

private

One of the tolerances defining convergence, the reciprocal of condMax_ or, if that is zero, machine epsilon.

Definition at line 182 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

Belos::StatusType Belos::LSQRStatusTest< ScalarType, MV, OP >::status_

private

Status.

Definition at line 185 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

int Belos::LSQRStatusTest< ScalarType, MV, OP >::term_iter_

private

Definition at line 189 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::matCondNum_

private

Definition at line 192 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::matNorm_

private

Definition at line 195 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::resNorm_

private

Definition at line 198 of file BelosLSQRStatusTest.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRStatusTest< ScalarType, MV, OP >::matResNorm_

private

Definition at line 201 of file BelosLSQRStatusTest.hpp.

The documentation for this class was generated from the following file:

BelosLSQRStatusTest.hpp

Public Types

Constructor/Destructor.

Status method

Reset methods

Accessor methods

Print methods

Misc.

Overridden from Teuchos::Describable

Private data members.

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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