Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar > Class Template Reference

Subclass of Belos::StatusTest that implements every possible form of SolveCriteria that exists by forcing the computation of X and R. More...

#include <Thyra_GeneralSolveCriteriaBelosStatusTest_decl.hpp>

Inheritance diagram for Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >:

Related Symbols
(Note that these are not member symbols.)
template<class Scalar>
RCP< GeneralSolveCriteriaBelosStatusTest< Scalar > >	createGeneralSolveCriteriaBelosStatusTest (const SolveCriteria< Scalar > &solveCriteria, const int convergenceTestFrequency)
	Nonmember constructor.

Public typdefs.
typedef MultiVectorBase< Scalar >	MV
typedef LinearOpBase< Scalar >	OP
typedef ScalarTraits< Scalar >::magnitudeType	ScalarMag

Overridden public functions from Belos::StatusTest.
virtual Belos::StatusType	checkStatus (Belos::Iteration< Scalar, MV, OP > *iSolver)
virtual Belos::StatusType	getStatus () const
virtual void	reset ()
virtual void	print (std::ostream &os, int indent) const

Constructors/initializers/accessors
	GeneralSolveCriteriaBelosStatusTest ()
void	setSolveCriteria (const SolveCriteria< Scalar > &solveCriteria, const int convergenceTestFrequency)
ArrayView< const ScalarMag >	achievedTol () const

Detailed Description

template<class Scalar>
class Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >

Subclass of Belos::StatusTest that implements every possible form of SolveCriteria that exists by forcing the computation of X and R.

Definition at line 28 of file Thyra_GeneralSolveCriteriaBelosStatusTest_decl.hpp.

Member Typedef Documentation

MV

template<class Scalar>

typedef MultiVectorBase<Scalar> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::MV

Definition at line 37 of file Thyra_GeneralSolveCriteriaBelosStatusTest_decl.hpp.

OP

template<class Scalar>

typedef LinearOpBase<Scalar> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::OP

Definition at line 39 of file Thyra_GeneralSolveCriteriaBelosStatusTest_decl.hpp.

ScalarMag

template<class Scalar>

typedef ScalarTraits<Scalar>::magnitudeType Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::ScalarMag

Definition at line 41 of file Thyra_GeneralSolveCriteriaBelosStatusTest_decl.hpp.

Constructor & Destructor Documentation

GeneralSolveCriteriaBelosStatusTest()

template<class Scalar>

Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::GeneralSolveCriteriaBelosStatusTest

(

)

Definition at line 32 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

Member Function Documentation

setSolveCriteria()

template<class Scalar>

void Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::setSolveCriteria	(	const SolveCriteria< Scalar > &	solveCriteria,
		const int	convergenceTestFrequency )

Definition at line 44 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

achievedTol()

template<class Scalar>

ArrayView< const typename ScalarTraits< Scalar >::magnitudeType > Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::achievedTol

(

)

const

Definition at line 77 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

checkStatus()

template<class Scalar>

Belos::StatusType Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::checkStatus ( Belos::Iteration< Scalar, MV, OP > * iSolver )

virtual

Definition at line 88 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

getStatus()

template<class Scalar>

Belos::StatusType Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::getStatus ( ) const

virtual

Implements Belos::StatusTest< Scalar, MultiVectorBase< Scalar >, LinearOpBase< Scalar > >.

Definition at line 180 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

reset()

template<class Scalar>

void Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::reset ( )

virtual

Implements Belos::StatusTest< Scalar, MultiVectorBase< Scalar >, LinearOpBase< Scalar > >.

Definition at line 187 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

print()

template<class Scalar>

void Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::print ( std::ostream & os, int indent ) const

virtual

Implements Belos::StatusTest< Scalar, MultiVectorBase< Scalar >, LinearOpBase< Scalar > >.

Definition at line 200 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

Friends And Related Symbol Documentation

createGeneralSolveCriteriaBelosStatusTest()

template<class Scalar>

RCP< GeneralSolveCriteriaBelosStatusTest< Scalar > > createGeneralSolveCriteriaBelosStatusTest ( const SolveCriteria< Scalar > & solveCriteria, const int convergenceTestFrequency )

related

Nonmember constructor.

Definition at line 107 of file Thyra_GeneralSolveCriteriaBelosStatusTest_decl.hpp.

---

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

• Thyra_GeneralSolveCriteriaBelosStatusTest_decl.hpp
• Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp