An implementation of StatusTestResNorm using a family of residual norms. More...

#include <BelosStatusTestGenResNorm.hpp>

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

Public Types
typedef Teuchos::ScalarTraits < ScalarType >	SCT

typedef SCT::magnitudeType	MagnitudeType

typedef MultiVecTraits < ScalarType, MV >	MVT

Enums.
enum	ResType { Implicit, Explicit }
	Select how the residual std::vector is produced. More...

Public Types inherited from Belos::StatusTestResNorm< ScalarType, MV, OP >
typedef Teuchos::ScalarTraits < ScalarType >	SCT

typedef SCT::magnitudeType	MagnitudeType

typedef MultiVecTraits < ScalarType, MV >	MVT

Public Member Functions
Constructors/destructors.
	StatusTestGenResNorm (MagnitudeType Tolerance, int quorum=-1, bool showMaxResNormOnly=false)
	Constructor. More...

virtual	~StatusTestGenResNorm ()
	Destructor. More...

Form and parameter definition methods.
int	defineResForm (ResType TypeOfResidual, NormType TypeOfNorm)
	Define form of the residual, its norm and optional weighting std::vector. More...

int	defineScaleForm (ScaleType TypeOfScaling, NormType TypeOfNorm, MagnitudeType ScaleValue=Teuchos::ScalarTraits< MagnitudeType >::one())
	Define form of the scaling, its norm, its optional weighting std::vector, or, alternatively, define an explicit value. More...

NormType	getResNormType ()

int	setTolerance (MagnitudeType tolerance)
	Set the value of the tolerance. More...

int	setQuorum (int quorum)
	Sets the number of residuals that must pass the convergence test before Passed is returned. More...

int	setShowMaxResNormOnly (bool showMaxResNormOnly)
	Set whether the only maximum residual norm is displayed when the print() method is called. More...

Status methods
StatusType	checkStatus (Iteration< ScalarType, MV, OP > *iSolver)
	Check convergence status: Passed, Failed, or Undefined. More...

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

Reset methods
void	reset ()
	Resets the internal configuration to the initial state. 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, StatusType type) const
	Print message for each status specific to this stopping test. More...

Methods to access data members.
Teuchos::RCP< MV >	getSolution ()
	Returns the current solution estimate that was computed for the most recent residual test. More...

int	getQuorum () const
	Returns the number of residuals that must pass the convergence test before Passed is returned. More...

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

std::vector< int >	convIndices ()
	Returns the std::vector containing the indices of the residuals that passed the test. More...

MagnitudeType	getTolerance () const
	Returns the value of the tolerance, $\tau$ , set in the constructor. More...

const std::vector < MagnitudeType > *	getTestValue () const
	Returns the test value, $\frac{\\|r\\|}{\sigma}$ , computed in most recent call to CheckStatus. More...

const std::vector < MagnitudeType > *	getResNormValue () const
	Returns the residual norm value, $\\|r\\|$ , computed in most recent call to CheckStatus. More...

const std::vector < MagnitudeType > *	getScaledNormValue () const
	Returns the scaled norm value, $\sigma$ . More...

bool	getLOADetected () const
	Returns a boolean indicating a loss of accuracy has been detected in computing the residual. More...

Misc.
StatusType	firstCallCheckStatusSetup (Iteration< ScalarType, MV, OP > *iSolver)
	Call to setup initial scaling std::vector. More...

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

Form and parameter definition methods.
Methods to access data 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
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

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

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

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

Detailed Description

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

An implementation of StatusTestResNorm using a family of residual norms.

StatusTestGenResNorm is an implementation of StatusTestResNorm that allows a user to construct one of a family of residual tests for use as a status/convergence test for Belos. The form of the test is

$\frac{\|r_i\|}{\sigma_i} \le \tau$

where

is the i-th residual std::vector, implicitly or explicitly computed (determined by enum ResType),
$\|r_i\|$ is the i-th residual norm determined by the enum NormType (1-norm, 2-norm or inf-norm),
$\sigma_i$ is the i-th scale factor that can be passed in as a precomputed number of the templated type, or can be selected from by the enum ScaleType (norm of RHS, norm of initial residual).
$\tau$ is the tolerance that is passed in as a number of the templated type to the constructor. The value of $\tau$ can be reset using the setTolerance() method.

Definition at line 79 of file BelosStatusTestGenResNorm.hpp.

Member Typedef Documentation

template<class ScalarType , class MV , class OP >

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

Definition at line 84 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

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

Definition at line 85 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

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

Definition at line 86 of file BelosStatusTestGenResNorm.hpp.

Member Enumeration Documentation

template<class ScalarType , class MV , class OP >

enum Belos::StatusTestGenResNorm::ResType

Select how the residual std::vector is produced.

Enumerator
Implicit	Use the residual std::vector produced by the iterative solver.
Explicit	Explicitly compute the residual std::vector r = b - A*x using the linear problem.

Definition at line 94 of file BelosStatusTestGenResNorm.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >

Belos::StatusTestGenResNorm< ScalarType, MV, OP >::StatusTestGenResNorm	(	MagnitudeType	Tolerance,
		int	quorum = `-1`,
		bool	showMaxResNormOnly = `false`
	)

Constructor.

The constructor takes a single argument specifying the tolerance ( $\tau$ ). If none of the form definition methods are called, we use $\|r\|_2/\|r^{(0)}\|_2 \le \tau$ as the stopping criterion, where $\|r\|_2$ uses the least costly form of the 2-norm of residual available from the iterative method and $\|r^{(0)}\|_2$ is the corresponding norm of the initial residual. The least costly form of the 2-norm depends on the chosen iterative method. Most Krylov methods produce the preconditioned residual std::vector in a form that would be exact in infinite precision arithmetic. This std::vector may be different from the true residual either because left preconditioning was used, or because round-off error has introduced significant error, or both.

You can also state the number of vectors that must pass the convergence criteria before the status test passes by using the quorum argument.

Definition at line 387 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

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

virtual

Destructor.

Definition at line 410 of file BelosStatusTestGenResNorm.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >

int Belos::StatusTestGenResNorm< ScalarType, MV, OP >::defineResForm	(	ResType	TypeOfResidual,
		NormType	TypeOfNorm
	)

Define form of the residual, its norm and optional weighting std::vector.

This method defines the form of $\|r\|$ . We specify:

Whether the residual std::vector should be explicitly computed, or taken from the iterative method.
The norm to be used on the residual (this may be different than the norm used in DefineScaleForm()).

Definition at line 427 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

int Belos::StatusTestGenResNorm< ScalarType, MV, OP >::defineScaleForm	(	ScaleType	TypeOfScaling,
		NormType	TypeOfNorm,
		MagnitudeType	ScaleValue = `Teuchos::ScalarTraits<MagnitudeType>::one()`
	)

virtual

Define form of the scaling, its norm, its optional weighting std::vector, or, alternatively, define an explicit value.

This method defines the form of how the residual is scaled (if at all). It operates in two modes:

User-provided scaling value:
- Set argument TypeOfScaling to UserProvided.
- Set ScaleValue to a non-zero value that the residual norm will be divided by.
- TypeOfNorm argument will be ignored.
- Sample use: Define ScaleValue = $\|A\|_{\infty}$ where is the matrix of the linear problem.
Use a supported Scaling Form:
- Define TypeOfScaling to be the norm of the right hand side, the initial residual std::vector, or to none.
- Define norm to be used on the scaling std::vector (this may be different than the norm used in DefineResForm()).

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

Definition at line 440 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

NormType Belos::StatusTestGenResNorm< ScalarType, MV, OP >::getResNormType ( )

inline

Definition at line 159 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

int Belos::StatusTestGenResNorm< ScalarType, MV, OP >::setTolerance ( MagnitudeType tolerance )

inlinevirtual

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.

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

Definition at line 165 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

int Belos::StatusTestGenResNorm< ScalarType, MV, OP >::setQuorum ( int quorum )

inlinevirtual

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.

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

Definition at line 169 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

int Belos::StatusTestGenResNorm< ScalarType, MV, OP >::setShowMaxResNormOnly ( bool showMaxResNormOnly )

inlinevirtual

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

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

Definition at line 172 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

StatusType Belos::StatusTestGenResNorm< ScalarType, MV, OP >::checkStatus ( Iteration< ScalarType, MV, OP > * iSolver )

virtual

Check convergence status: Passed, Failed, or Undefined.

This method checks to see if the convergence criteria are met. Depending on how the residual test is constructed this method will return the appropriate status type.

Returns: StatusType: Passed, Failed, or Undefined.

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

Definition at line 455 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Return the result of the most recent CheckStatus call.

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

Definition at line 188 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

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

virtual

Resets the internal configuration to the initial state.

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

Definition at line 414 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

void Belos::StatusTestGenResNorm< 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 591 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

void Belos::StatusTestGenResNorm< ScalarType, MV, OP >::printStatus	(	std::ostream &	os,
		StatusType	type
	)		const

virtual

Print message for each status specific to this stopping test.

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

Definition at line 623 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::StatusTestGenResNorm< ScalarType, MV, OP >::getSolution ( )

inlinevirtual

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

Note: This is useful for explicit residual tests, if this test is an implicit residual test a null pointer will be returned.

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

Definition at line 215 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

int Belos::StatusTestGenResNorm< ScalarType, MV, OP >::getQuorum ( ) const

inlinevirtual

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.

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

Definition at line 219 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

bool Belos::StatusTestGenResNorm< ScalarType, MV, OP >::getShowMaxResNormOnly ( )

inlinevirtual

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

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

Definition at line 222 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

std::vector<int> Belos::StatusTestGenResNorm< ScalarType, MV, OP >::convIndices ( )

inlinevirtual

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

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

Definition at line 225 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::StatusTestGenResNorm< ScalarType, MV, OP >::getTolerance ( ) const

inlinevirtual

Returns the value of the tolerance, $\tau$ , set in the constructor.

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

Definition at line 228 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

const std::vector<MagnitudeType>* Belos::StatusTestGenResNorm< ScalarType, MV, OP >::getTestValue ( ) const

inlinevirtual

Returns the test value, $\frac{\|r\|}{\sigma}$ , computed in most recent call to CheckStatus.

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

Definition at line 231 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

const std::vector<MagnitudeType>* Belos::StatusTestGenResNorm< ScalarType, MV, OP >::getResNormValue ( ) const

inline

Returns the residual norm value, $\|r\|$ , computed in most recent call to CheckStatus.

Definition at line 234 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

const std::vector<MagnitudeType>* Belos::StatusTestGenResNorm< ScalarType, MV, OP >::getScaledNormValue ( ) const

inline

Returns the scaled norm value, $\sigma$ .

Definition at line 237 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

bool Belos::StatusTestGenResNorm< ScalarType, MV, OP >::getLOADetected ( ) const

inlinevirtual

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

Note: This status test does not check for loss of accuracy, so this method will always return false.

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

Definition at line 241 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

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

Call to setup initial scaling std::vector.

After this function is called getScaledNormValue() can be called to get the scaling std::vector.

Definition at line 643 of file BelosStatusTestGenResNorm.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Method to return description of the maximum iteration status test.

Reimplemented from Teuchos::Describable.

Definition at line 261 of file BelosStatusTestGenResNorm.hpp.

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

BelosStatusTestGenResNorm.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

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