Stratimikos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Related Symbols | List of all members
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>

Inherits Belos::StatusTest< Scalar, MultiVectorBase< Scalar >, LinearOpBase< Scalar > >, and Teuchos::VerboseObject< 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.

SolveCriteria< Scalar > solveCriteria_
 
int convergenceTestFrequency_
 
bool compute_x_
 
bool compute_r_
 
Array< ScalarMagr0_nrm_
 
Array< ScalarMagb_nrm_
 
Array< ScalarMaglastNumerator_
 
Array< ScalarMaglastDenominator_
 
Array< ScalarMaglastAchievedTol_
 
int lastCurrIter_
 
Belos::StatusType lastRtnStatus_
 
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
 
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
 

Constructors/initializers/accessors

 GeneralSolveCriteriaBelosStatusTest ()
 
void setSolveCriteria (const SolveCriteria< Scalar > &solveCriteria, const int convergenceTestFrequency)
 
ArrayView< const ScalarMagachievedTol () 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 63 of file Thyra_GeneralSolveCriteriaBelosStatusTest_decl.hpp.

Member Typedef Documentation

◆ MV

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

◆ OP

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

◆ ScalarMag

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

Constructor & Destructor Documentation

◆ GeneralSolveCriteriaBelosStatusTest()

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

Member Function Documentation

◆ setSolveCriteria()

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

◆ achievedTol()

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

◆ checkStatus()

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

◆ getStatus()

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

◆ reset()

template<class Scalar >
void Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::reset ( )
virtual

◆ print()

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

◆ computeReductionFunctional()

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

◆ printRhsStatus()

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

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 142 of file Thyra_GeneralSolveCriteriaBelosStatusTest_decl.hpp.

Member Data Documentation

◆ solveCriteria_

template<class Scalar >
SolveCriteria<Scalar> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::solveCriteria_
private

◆ convergenceTestFrequency_

template<class Scalar >
int Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::convergenceTestFrequency_
private

◆ compute_x_

template<class Scalar >
bool Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::compute_x_
private

◆ compute_r_

template<class Scalar >
bool Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::compute_r_
private

◆ r0_nrm_

template<class Scalar >
Array<ScalarMag> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::r0_nrm_
private

◆ b_nrm_

template<class Scalar >
Array<ScalarMag> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::b_nrm_
private

◆ lastNumerator_

template<class Scalar >
Array<ScalarMag> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::lastNumerator_
private

◆ lastDenominator_

template<class Scalar >
Array<ScalarMag> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::lastDenominator_
private

◆ lastAchievedTol_

template<class Scalar >
Array<ScalarMag> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::lastAchievedTol_
private

◆ lastCurrIter_

template<class Scalar >
int Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::lastCurrIter_
private

◆ lastRtnStatus_

template<class Scalar >
Belos::StatusType Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::lastRtnStatus_
private

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