Stratimikos Package Browser (Single Doxygen Collection) Version of the Day
Private Member Functions | Private Attributes | Related Functions
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 >:
Inheritance graph
[legend]

List of all members.

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< ScalarMagr0_nrm_
Array< ScalarMagb_nrm_
Array< ScalarMaglastNumerator_
Array< ScalarMaglastDenominator_
Array< ScalarMaglastAchievedTol_
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.

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

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


Member Typedef Documentation

template<class Scalar>
typedef MultiVectorBase<Scalar> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::MV
template<class Scalar>
typedef LinearOpBase<Scalar> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::OP
template<class Scalar>
typedef ScalarTraits<Scalar>::magnitudeType Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::ScalarMag

Constructor & Destructor Documentation


Member Function Documentation

template<class Scalar>
void Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::setSolveCriteria ( const SolveCriteria< Scalar > &  solveCriteria,
const int  convergenceTestFrequency 
)
template<class Scalar >
ArrayView< const typename ScalarTraits< Scalar >::magnitudeType > Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::achievedTol ( ) const
template<class Scalar>
Belos::StatusType Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::checkStatus ( Belos::Iteration< Scalar, MV, OP > *  iSolver) [virtual]
template<class Scalar >
Belos::StatusType Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::getStatus ( ) const [virtual]
template<class Scalar >
void Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::reset ( ) [virtual]
template<class Scalar >
void Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::print ( std::ostream &  os,
int  indent 
) const [virtual]
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]
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 Function Documentation

template<class Scalar >
RCP< GeneralSolveCriteriaBelosStatusTest< Scalar > > createGeneralSolveCriteriaBelosStatusTest ( const SolveCriteria< Scalar > &  solveCriteria,
const int  convergenceTestFrequency 
) [related]

Nonmember constructor.

Definition at line 99 of file Thyra_GeneralSolveCriteriaBelosStatusTest_decl.hpp.


Member Data Documentation

template<class Scalar>
SolveCriteria<Scalar> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::solveCriteria_ [private]
template<class Scalar>
int Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::convergenceTestFrequency_ [private]
template<class Scalar>
bool Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::compute_x_ [private]
template<class Scalar>
bool Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::compute_r_ [private]
template<class Scalar>
Array<ScalarMag> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::r0_nrm_ [private]
template<class Scalar>
Array<ScalarMag> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::b_nrm_ [private]
template<class Scalar>
Array<ScalarMag> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::lastNumerator_ [private]
template<class Scalar>
Array<ScalarMag> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::lastDenominator_ [private]
template<class Scalar>
Array<ScalarMag> Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::lastAchievedTol_ [private]
template<class Scalar>
int Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::lastCurrIter_ [private]
template<class Scalar>
Belos::StatusType Thyra::GeneralSolveCriteriaBelosStatusTest< Scalar >::lastRtnStatus_ [private]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines