Belos::StatusTestResNorm< ScalarType, MV, OP > Class Template Reference

An abstract class of StatusTest for stopping criteria using residual norms. More...

#include <BelosStatusTestResNorm.hpp>

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

List of all members.

Public Types
typedef Teuchos::ScalarTraits < ScalarType >	SCT
typedef SCT::magnitudeType	MagnitudeType
typedef MultiVecTraits < ScalarType, MV >	MVT
Public Member Functions
Form and parameter definition methods.
virtual int	setTolerance (MagnitudeType tolerance)=0
	Set the value of the tolerance.
virtual int	setQuorum (int quorum)=0
	Sets the number of residuals that must pass the convergence test before Passed is returned.
virtual int	setShowMaxResNormOnly (bool showMaxResNormOnly)=0
	Set whether the only maximum residual norm is displayed when the print() method is called.
virtual int	defineScaleForm (ScaleType TypeOfScaling, NormType TypeOfNorm, MagnitudeType ScaleValue=Teuchos::ScalarTraits< MagnitudeType >::one())=0
	Define the form of the scaling for the residual.
Methods to access data members.
virtual int	getQuorum () const =0
	Returns the number of residuals that must pass the convergence test before Passed is returned.
virtual bool	getShowMaxResNormOnly ()=0
	Returns whether the only maximum residual norm is displayed when the print() method is called.
virtual std::vector< int >	convIndices ()=0
	Returns the std::vector containing the indices of the residuals that passed the test.
virtual MagnitudeType	getTolerance () const =0
	Returns the value of the tolerance, , set in the constructor.
virtual const std::vector < MagnitudeType > *	getTestValue () const =0
	Returns the test value, , computed in most recent call to CheckStatus.
virtual Teuchos::RCP< MV >	getSolution ()=0
	Returns the current solution estimate that was computed for the most recent residual test.
virtual bool	getLOADetected () const =0
	Returns a boolean indicating a loss of accuracy has been detected in computing the residual.

---

Detailed Description

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

An abstract class of StatusTest for stopping criteria using residual norms.

Definition at line 62 of file BelosStatusTestResNorm.hpp.

---

Member Typedef Documentation

template<class ScalarType , class MV , class OP >

typedef Teuchos::ScalarTraits<ScalarType> Belos::StatusTestResNorm< ScalarType, MV, OP >::SCT

Reimplemented in Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

Definition at line 67 of file BelosStatusTestResNorm.hpp.

template<class ScalarType , class MV , class OP >

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

Reimplemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

Definition at line 68 of file BelosStatusTestResNorm.hpp.

template<class ScalarType , class MV , class OP >

typedef MultiVecTraits<ScalarType,MV> Belos::StatusTestResNorm< ScalarType, MV, OP >::MVT

Reimplemented in Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

Definition at line 69 of file BelosStatusTestResNorm.hpp.

---

Member Function Documentation

template<class ScalarType , class MV , class OP >

virtual int Belos::StatusTestResNorm< ScalarType, MV, OP >::setTolerance

(

MagnitudeType

tolerance

)

[pure virtual]

Set the value of the tolerance.

We allow the tolerance to be reset for cases where, in the process of testing the residual, we find that the initial tolerance was too tight or too lax.

Implemented in Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual int Belos::StatusTestResNorm< ScalarType, MV, OP >::setQuorum

(

int

quorum

)

[pure virtual]

Sets the number of residuals that must pass the convergence test before Passed is returned.

Note:

If quorum=-1 then all residuals must pass the convergence test before Passed is returned.

Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual int Belos::StatusTestResNorm< ScalarType, MV, OP >::setShowMaxResNormOnly

(

bool

showMaxResNormOnly

)

[pure virtual]

Set whether the only maximum residual norm is displayed when the print() method is called.

Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual int Belos::StatusTestResNorm< ScalarType, MV, OP >::defineScaleForm	(	ScaleType	TypeOfScaling,
		NormType	TypeOfNorm,
		MagnitudeType	ScaleValue = Teuchos::ScalarTraits< MagnitudeType >::one()
	)		[pure virtual]

Define the form of the scaling for the residual.

Implemented in Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual int Belos::StatusTestResNorm< ScalarType, MV, OP >::getQuorum

(

)

const [pure virtual]

Returns the number of residuals that must pass the convergence test before Passed is returned.

Note:

If quorum=-1 then all residuals must pass the convergence test before Passed is returned.

Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual bool Belos::StatusTestResNorm< ScalarType, MV, OP >::getShowMaxResNormOnly

(

)

[pure virtual]

Returns whether the only maximum residual norm is displayed when the print() method is called.

Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual std::vector<int> Belos::StatusTestResNorm< ScalarType, MV, OP >::convIndices

(

)

[pure virtual]

Returns the std::vector containing the indices of the residuals that passed the test.

Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual MagnitudeType Belos::StatusTestResNorm< ScalarType, MV, OP >::getTolerance

(

)

const [pure virtual]

Returns the value of the tolerance, , set in the constructor.

Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual const std::vector<MagnitudeType>* Belos::StatusTestResNorm< ScalarType, MV, OP >::getTestValue

(

)

const [pure virtual]

Returns the test value, , computed in most recent call to CheckStatus.

Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual Teuchos::RCP<MV> Belos::StatusTestResNorm< ScalarType, MV, OP >::getSolution

(

)

[pure virtual]

Returns the current solution estimate that was computed for the most recent residual test.

Note:

This method will return a null pointer if no vector was computed.

Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual bool Belos::StatusTestResNorm< ScalarType, MV, OP >::getLOADetected

(

)

const [pure virtual]

Returns a boolean indicating a loss of accuracy has been detected in computing the residual.

Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.

---

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

• BelosStatusTestResNorm.hpp