#include <Belos_StatusTest_GenResNorm_MP_Vector.hpp>

Inheritance diagram for Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >:

Public Types
typedef Sacado::MP::Vector< Storage >	ScalarType

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

Private data members.
MagnitudeType	tolerance_
	Tolerance used to determine convergence.

int	quorum_
	Number of residuals that must pass the convergence test before Passed is returned.

bool	showMaxResNormOnly_
	Determines if the entries for all of the residuals are shown or just the max.

ResType	restype_
	Type of residual to use (explicit or implicit)

NormType	resnormtype_
	Type of norm to use on residual (OneNorm, TwoNorm, or InfNorm).

ScaleType	scaletype_
	Type of scaling to use (Norm of RHS, Norm of Initial Residual, None or User provided)

NormType	scalenormtype_
	Type of norm to use on the scaling (OneNorm, TwoNorm, or InfNorm)

MagnitudeType	scalevalue_
	Scaling value.

std::vector< MagnitudeType >	scalevector_
	Scaling std::vector.

std::vector< MagnitudeType >	resvector_
	Residual norm std::vector.

std::vector< MagnitudeType >	testvector_
	Test std::vector = resvector_ / scalevector_.

std::vector< int >	ind_
	Vector containing the indices for the vectors that passed the test.

Teuchos::RCP< MV >	curSoln_
	Most recent solution vector used by this status test.

StatusType	status_
	Status.

int	curBlksz_
	The current blocksize of the linear system being solved.

int	curNumRHS_
	The current number of right-hand sides being solved for.

std::vector< int >	curLSIdx_
	The indices of the current number of right-hand sides being solved for.

int	curLSNum_
	The current number of linear systems that have been loaded into the linear problem.

int	numrhs_
	The total number of right-hand sides being solved for.

bool	firstcallCheckStatus_
	Is this the first time CheckStatus is called?

bool	firstcallDefineResForm_
	Is this the first time DefineResForm is called?

bool	firstcallDefineScaleForm_
	Is this the first time DefineScaleForm is called?

std::vector< int >	ensemble_converged
	Which ensemble components have converged.

std::vector< int >	ensemble_iterations
	The number of iterations at which point each ensemble component converges.

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

virtual	~StatusTestGenResNorm ()
	Destructor.

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

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.

NormType	getResNormType ()

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

int	setQuorum (int quorum)

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

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

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

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

Methods to access data members.
Teuchos::RCP< MV >	getSolution ()

int	getQuorum () const

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

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

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

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

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

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

bool	getLOADetected () const

const std::vector< int >	getEnsembleIterations () const
	Returns number of ensemble iterations.

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

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

Private methods.
std::string	resFormStr () const
	Description of current residual form.

Detailed Description

template<class Storage, class MV, class OP>
class Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >

Definition at line 85 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

Member Typedef Documentation

◆ ScalarType

template<class Storage, class MV, class OP>

typedef Sacado::MP::Vector<Storage> Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::ScalarType

Definition at line 91 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ SCT

template<class Storage, class MV, class OP>

typedef Teuchos::ScalarTraits<ScalarType> Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::SCT

Definition at line 92 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ MagnitudeType

template<class Storage, class MV, class OP>

typedef SCT::magnitudeType Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::MagnitudeType

Definition at line 93 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ MVT

template<class Storage, class MV, class OP>

typedef MultiVecTraits<ScalarType,MV> Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::MVT

Definition at line 94 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

Member Enumeration Documentation

◆ ResType

template<class Storage, class MV, class OP>

enum Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::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 102 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

Constructor & Destructor Documentation

◆ StatusTestGenResNorm()

template<class Storage, class MV, class OP>

Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, 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.

◆ ~StatusTestGenResNorm()

template<class Storage, class MV, class OP>

virtual Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::~StatusTestGenResNorm ( )

virtual

Destructor.

Member Function Documentation

◆ defineResForm()

template<class Storage, class MV, class OP>

int Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, 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()).

◆ defineScaleForm()

template<class Storage, class MV, class OP>

int Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::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.

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()).

◆ getResNormType()

template<class Storage, class MV, class OP>

NormType Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::getResNormType ( )

inline

Definition at line 167 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ setTolerance()

template<class Storage, class MV, class OP>

int Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::setTolerance ( MagnitudeType tolerance )

inline

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.

Definition at line 173 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ setQuorum()

template<class Storage, class MV, class OP>

int Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::setQuorum ( int quorum )

inline

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.

Definition at line 177 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ setShowMaxResNormOnly()

template<class Storage, class MV, class OP>

int Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::setShowMaxResNormOnly ( bool showMaxResNormOnly )

inline

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

Definition at line 180 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ checkStatus()

template<class Storage, class MV, class OP>

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

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.

◆ getStatus()

template<class Storage, class MV, class OP>

StatusType Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::getStatus ( ) const

inline

Return the result of the most recent CheckStatus call.

Definition at line 196 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ reset()

template<class Storage, class MV, class OP>

void Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::reset ( )

Resets the internal configuration to the initial state.

◆ print()

template<class Storage, class MV, class OP>

void Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::print	(	std::ostream &	os,
		int	indent = 0 ) const

Output formatted description of stopping test to output stream.

◆ printStatus()

template<class Storage, class MV, class OP>

void Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::printStatus	(	std::ostream &	os,
		StatusType	type ) const

Print message for each status specific to this stopping test.

◆ getSolution()

template<class Storage, class MV, class OP>

Teuchos::RCP< MV > Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::getSolution ( )

inline

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.

Definition at line 223 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ getQuorum()

template<class Storage, class MV, class OP>

int Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::getQuorum ( ) const

inline

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.

Definition at line 227 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ getShowMaxResNormOnly()

template<class Storage, class MV, class OP>

bool Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::getShowMaxResNormOnly ( )

inline

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

Definition at line 230 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ convIndices()

template<class Storage, class MV, class OP>

std::vector< int > Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::convIndices ( )

inline

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

Definition at line 233 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ getTolerance()

template<class Storage, class MV, class OP>

MagnitudeType Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::getTolerance ( ) const

inline

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

Definition at line 236 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ getTestValue()

template<class Storage, class MV, class OP>

const std::vector< MagnitudeType > * Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::getTestValue ( ) const

inline

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

Definition at line 239 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ getResNormValue()

template<class Storage, class MV, class OP>

const std::vector< MagnitudeType > * Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::getResNormValue ( ) const

inline

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

Definition at line 242 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ getScaledNormValue()

template<class Storage, class MV, class OP>

const std::vector< MagnitudeType > * Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::getScaledNormValue ( ) const

inline

Returns the scaled norm value, $\sigma$ .

Definition at line 245 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ getLOADetected()

template<class Storage, class MV, class OP>

bool Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::getLOADetected ( ) const

inline

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.

Definition at line 249 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ getEnsembleIterations()

template<class Storage, class MV, class OP>

const std::vector< int > Belos::StatusTestGenResNorm< Sacado::MP::Vector< Storage >, MV, OP >::getEnsembleIterations ( ) const

inline

Returns number of ensemble iterations.

Definition at line 252 of file Belos_StatusTest_GenResNorm_MP_Vector.hpp.

◆ firstCallCheckStatusSetup()

template<class Storage, class MV, class OP>

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