A status test for testing the norm of the eigenvectors residuals. More...

#include <AnasaziStatusTestResNorm.hpp>

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

Public Member Functions
Constructors/destructors
	StatusTestResNorm (typename Teuchos::ScalarTraits< ScalarType >::magnitudeType tol, int quorum=-1, ResType whichNorm=RES_ORTH, bool scaled=true, bool throwExceptionOnNaN=true)
	Constructor. More...

virtual	~StatusTestResNorm ()
	Destructor. More...

Status methods
TestStatus	checkStatus (Eigensolver< ScalarType, MV, OP > *solver)

TestStatus	getStatus () const
	Return the result of the most recent checkStatus call, or undefined if it has not been run. More...

std::vector< int >	whichVecs () const
	Get the indices for the vectors that passed the test. More...

int	howMany () const
	Get the number of vectors that passed the test. More...

Accessor methods
void	setQuorum (int quorum)
	Set quorum. More...

int	getQuorum () const
	Get quorum. More...

void	setTolerance (typename Teuchos::ScalarTraits< ScalarType >::magnitudeType tol)
	Set tolerance. This also resets the test status to Undefined. More...

Teuchos::ScalarTraits< ScalarType >::magnitudeType	getTolerance ()
	Get tolerance. More...

void	setWhichNorm (ResType whichNorm)
	Set the residual norm to be used by the status test. More...

ResType	getWhichNorm ()
	Return the residual norm used by the status test. More...

void	setScale (bool relscale)
	Instruct test to scale norms by eigenvalue estimates (relative scale). This also resets the test status to Undefined. More...

bool	getScale ()
	Returns true if the test scales the norms by the eigenvalue estimates (relative scale). More...

Reset methods
void	reset ()
	Informs the status test that it should reset its internal configuration to the uninitialized state. More...

void	clearStatus ()
	Clears the results of the last status test. More...

Print methods
std::ostream &	print (std::ostream &os, int indent=0) const
	Output formatted description of stopping test to output stream. More...

Public Member Functions inherited from Anasazi::StatusTest< ScalarType, MV, OP >
	StatusTest ()
	Constructor. More...

virtual	~StatusTest ()
	Destructor. More...

Detailed Description

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

A status test for testing the norm of the eigenvectors residuals.

StatusTestResNorm was designed to be used as a test for convergence. The tester compares the norms of the residual vectors against a user specified tolerance.

In addition to specifying the tolerance, the user may specify:

the norm to be used: 2-norm or OrthoManager::norm() or Eigensolver::getRitzRes2Norms()
the scale: absolute or relative to magnitude of Ritz value
the quorum: the number of vectors required for the test to evaluate as Passed.

Definition at line 91 of file AnasaziStatusTestResNorm.hpp.

Constructor & Destructor Documentation

◆ StatusTestResNorm()

template<class ScalarType , class MV , class OP >

Anasazi::StatusTestResNorm< ScalarType, MV, OP >::StatusTestResNorm	(	typename Teuchos::ScalarTraits< ScalarType >::magnitudeType	tol,
		int	quorum = `-1`,
		ResType	whichNorm = `RES_ORTH`,
		bool	scaled = `true`,
		bool	throwExceptionOnNaN = `true`
	)

Constructor.

Definition at line 229 of file AnasaziStatusTestResNorm.hpp.

◆ ~StatusTestResNorm()

template<class ScalarType , class MV , class OP >

virtual Anasazi::StatusTestResNorm< ScalarType, MV, OP >::~StatusTestResNorm ( )

inlinevirtual

Destructor.

Definition at line 104 of file AnasaziStatusTestResNorm.hpp.

Member Function Documentation

◆ checkStatus()

template<class ScalarType , class MV , class OP >

TestStatus Anasazi::StatusTestResNorm< ScalarType, MV, OP >::checkStatus ( Eigensolver< ScalarType, MV, OP > * solver )

virtual

Check status as defined by test.

Returns: TestStatus indicating whether the test passed or failed.

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

Definition at line 234 of file AnasaziStatusTestResNorm.hpp.

◆ getStatus()

template<class ScalarType , class MV , class OP >

TestStatus Anasazi::StatusTestResNorm< ScalarType, MV, OP >::getStatus ( ) const

inlinevirtual

Return the result of the most recent checkStatus call, or undefined if it has not been run.

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

Definition at line 116 of file AnasaziStatusTestResNorm.hpp.

◆ whichVecs()

template<class ScalarType , class MV , class OP >

std::vector<int> Anasazi::StatusTestResNorm< ScalarType, MV, OP >::whichVecs ( ) const

inlinevirtual

Get the indices for the vectors that passed the test.

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

Definition at line 119 of file AnasaziStatusTestResNorm.hpp.

◆ howMany()

template<class ScalarType , class MV , class OP >

int Anasazi::StatusTestResNorm< ScalarType, MV, OP >::howMany ( ) const

inlinevirtual

Get the number of vectors that passed the test.

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

Definition at line 124 of file AnasaziStatusTestResNorm.hpp.

◆ setQuorum()

template<class ScalarType , class MV , class OP >

void Anasazi::StatusTestResNorm< ScalarType, MV, OP >::setQuorum ( int quorum )

inline

Set quorum.

Setting quorum to -1 signifies that all residuals from the solver must meet the tolerance. This also resets the test status to Undefined.

Definition at line 138 of file AnasaziStatusTestResNorm.hpp.

◆ getQuorum()

template<class ScalarType , class MV , class OP >

int Anasazi::StatusTestResNorm< ScalarType, MV, OP >::getQuorum ( ) const

inline

Get quorum.

Definition at line 145 of file AnasaziStatusTestResNorm.hpp.

◆ setTolerance()

template<class ScalarType , class MV , class OP >

void Anasazi::StatusTestResNorm< ScalarType, MV, OP >::setTolerance ( typename Teuchos::ScalarTraits< ScalarType >::magnitudeType tol )

inline

Set tolerance. This also resets the test status to Undefined.

Definition at line 152 of file AnasaziStatusTestResNorm.hpp.

◆ getTolerance()

template<class ScalarType , class MV , class OP >

Teuchos::ScalarTraits<ScalarType>::magnitudeType Anasazi::StatusTestResNorm< ScalarType, MV, OP >::getTolerance ( )

inline

Get tolerance.

Definition at line 158 of file AnasaziStatusTestResNorm.hpp.

◆ setWhichNorm()

template<class ScalarType , class MV , class OP >

void Anasazi::StatusTestResNorm< ScalarType, MV, OP >::setWhichNorm ( ResType whichNorm )

inline

Set the residual norm to be used by the status test.

This also resets the test status to Undefined.

Definition at line 164 of file AnasaziStatusTestResNorm.hpp.

◆ getWhichNorm()

template<class ScalarType , class MV , class OP >

ResType Anasazi::StatusTestResNorm< ScalarType, MV, OP >::getWhichNorm ( )

inline

Return the residual norm used by the status test.

Definition at line 170 of file AnasaziStatusTestResNorm.hpp.

◆ setScale()

template<class ScalarType , class MV , class OP >

void Anasazi::StatusTestResNorm< ScalarType, MV, OP >::setScale ( bool relscale )

inline

Instruct test to scale norms by eigenvalue estimates (relative scale). This also resets the test status to Undefined.

Definition at line 175 of file AnasaziStatusTestResNorm.hpp.

◆ getScale()

template<class ScalarType , class MV , class OP >

bool Anasazi::StatusTestResNorm< ScalarType, MV, OP >::getScale ( )

inline

Returns true if the test scales the norms by the eigenvalue estimates (relative scale).

Definition at line 181 of file AnasaziStatusTestResNorm.hpp.

◆ reset()

template<class ScalarType , class MV , class OP >

void Anasazi::StatusTestResNorm< ScalarType, MV, OP >::reset ( )

inlinevirtual

Informs the status test that it should reset its internal configuration to the uninitialized state.

This is necessary for the case when the status test is being reused by another solver or for another eigenvalue problem. The status test may have information that pertains to a particular problem or solver state. The internal information will be reset back to the uninitialized state. The user specified information that the convergence test uses will remain.

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

Definition at line 192 of file AnasaziStatusTestResNorm.hpp.

◆ clearStatus()

template<class ScalarType , class MV , class OP >

void Anasazi::StatusTestResNorm< ScalarType, MV, OP >::clearStatus ( )

inlinevirtual

Clears the results of the last status test.

This should be distinguished from the reset() method, as it only clears the cached result from the last status test, so that a call to getStatus() will return Undefined. This is necessary for the SEQOR and SEQAND tests in the StatusTestCombo class, which may short circuit and not evaluate all of the StatusTests contained in them.

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

Definition at line 203 of file AnasaziStatusTestResNorm.hpp.