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

[legend]

Private Member Functions
ScalarMag	computeReductionFunctional (ESolveMeasureNormType measureType, const Ptr< const ReductionFunctional< Scalar > > &reductFunc, const Ptr< const VectorBase< Scalar > > &x, const Ptr< const VectorBase< Scalar > > &r) const

void	printRhsStatus (const int currIter, const int j, std::ostream &out, int indent=0) const

Private Attributes
SolveCriteria< Scalar >	solveCriteria_

int	convergenceTestFrequency_

bool	compute_x_

bool	compute_r_

Array< ScalarMag >	r0_nrm_

Array< ScalarMag >	b_nrm_

Array< ScalarMag >	lastNumerator_

Array< ScalarMag >	lastDenominator_

Array< ScalarMag >	lastAchievedTol_

int	lastCurrIter_

Belos::StatusType	lastRtnStatus_

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

Public typdefs.
typedef MultiVectorBase< Scalar >	MV

typedef LinearOpBase< Scalar >	OP

typedef ScalarTraits< Scalar > ::magnitudeType	ScalarMag

Constructors/initializers/accessors
	GeneralSolveCriteriaBelosStatusTest ()

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

ArrayView< const ScalarMag >	achievedTol () const

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

Additional Inherited Members
Public Member Functions inherited from Teuchos::VerboseObject< GeneralSolveCriteriaBelosStatusTest< Scalar > >
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList >	getValidVerboseObjectSublist ()

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	setupVerboseObjectSublist (ParameterList *paramList)

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	readVerboseObjectSublist (ParameterList paramList, RCP< FancyOStream > oStream, EVerbosityLevel *verbLevel)

void	readVerboseObjectSublist (ParameterList paramList, VerboseObject< GeneralSolveCriteriaBelosStatusTest< Scalar > > verboseObject)

	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (const EVerbosityLevel verbLevel) const

virtual EVerbosityLevel	getVerbLevel () const

Static Public Member Functions inherited from Teuchos::VerboseObject< GeneralSolveCriteriaBelosStatusTest< Scalar > >
static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static EVerbosityLevel	getDefaultVerbLevel ()

Protected Member Functions inherited from Teuchos::VerboseObject< GeneralSolveCriteriaBelosStatusTest< Scalar > >
void	initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

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

template<class Scalar>

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

Definition at line 37 of file Thyra_GeneralSolveCriteriaBelosStatusTest_decl.hpp.

template<class Scalar>

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

Definition at line 39 of file Thyra_GeneralSolveCriteriaBelosStatusTest_decl.hpp.

template<class Scalar>

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

Definition at line 41 of file Thyra_GeneralSolveCriteriaBelosStatusTest_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

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

Definition at line 32 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

Member Function Documentation

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.

template<class Scalar >

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

Definition at line 77 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

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.

template<class Scalar >

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

virtual

Definition at line 180 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

template<class Scalar >

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

virtual

Definition at line 187 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

template<class Scalar >

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

virtual

Definition at line 200 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

template<class Scalar>

GeneralSolveCriteriaBelosStatusTest< Scalar >::ScalarMag Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::computeReductionFunctional	(	ESolveMeasureNormType	measureType,
		const Ptr< const ReductionFunctional< Scalar > > &	reductFunc,
		const Ptr< const VectorBase< Scalar > > &	x,
		const Ptr< const VectorBase< Scalar > > &	r
	)		const

private

Definition at line 216 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

template<class Scalar >

void Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::printRhsStatus	(	const int	currIter,
		const int	j,
		std::ostream &	out,
		int	indent = `0`
	)		const

private

Definition at line 260 of file Thyra_GeneralSolveCriteriaBelosStatusTest_def.hpp.

Friends And Related Function Documentation

template<class Scalar >

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