Belos Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | List of all members
Belos::StatusTestGenResSubNorm< ScalarType, MV, OP > Class Template Reference

An implementation of StatusTestResNorm using a family of norms of subvectors of the residual vectors. More...

#include <BelosStatusTestGenResSubNorm.hpp>

Inheritance diagram for Belos::StatusTestGenResSubNorm< ScalarType, MV, OP >:
Inheritance graph
[legend]

Public Types

typedef Teuchos::ScalarTraits
< ScalarType > 
SCT
 
typedef SCT::magnitudeType MagnitudeType
 
typedef MultiVecTraits
< ScalarType, MV > 
MVT
 
- Public Types inherited from Belos::StatusTestResNorm< ScalarType, MV, OP >
typedef Teuchos::ScalarTraits
< ScalarType > 
SCT
 
typedef SCT::magnitudeType MagnitudeType
 
typedef MultiVecTraits
< ScalarType, MV > 
MVT
 

Additional Inherited Members

- Public Member Functions inherited from Belos::StatusTestResNorm< ScalarType, MV, OP >
virtual int setTolerance (MagnitudeType tolerance)=0
 Set the value of the tolerance. More...
 
virtual int setQuorum (int quorum)=0
 Sets the number of residuals that must pass the convergence test before Passed is returned. More...
 
virtual int setShowMaxResNormOnly (bool showMaxResNormOnly)=0
 Set whether the only maximum residual norm is displayed when the print() method is called. More...
 
virtual int defineScaleForm (ScaleType TypeOfScaling, NormType TypeOfNorm, MagnitudeType ScaleValue=Teuchos::ScalarTraits< MagnitudeType >::one())=0
 Define the form of the scaling for the residual. More...
 
virtual int getQuorum () const =0
 Returns the number of residuals that must pass the convergence test before Passed is returned. More...
 
virtual bool getShowMaxResNormOnly ()=0
 Returns whether the only maximum residual norm is displayed when the print() method is called. More...
 
virtual std::vector< int > convIndices ()=0
 Returns the std::vector containing the indices of the residuals that passed the test. More...
 
virtual MagnitudeType getTolerance () const =0
 Returns the value of the tolerance, $ \tau $, set in the constructor. More...
 
virtual const std::vector
< MagnitudeType > * 
getTestValue () const =0
 Returns the test value, $ \frac{\|r\|}{\sigma} $, computed in most recent call to CheckStatus. More...
 
virtual Teuchos::RCP< MV > getSolution ()=0
 Returns the current solution estimate that was computed for the most recent residual test. More...
 
virtual bool getLOADetected () const =0
 Returns a boolean indicating a loss of accuracy has been detected in computing the residual. More...
 
- Public Member Functions inherited from Belos::StatusTest< ScalarType, MV, OP >
 StatusTest ()
 Constructor. More...
 
virtual ~StatusTest ()
 Destructor. More...
 
virtual StatusType checkStatus (Iteration< ScalarType, MV, OP > *iSolver)=0
 Check convergence status: Unconverged, Converged, Failed. More...
 
virtual StatusType getStatus () const =0
 Return the result of the most recent CheckStatus call. More...
 
virtual void reset ()=0
 Informs the convergence test that it should reset its internal configuration to the initialized state. More...
 
virtual void print (std::ostream &os, int indent=0) const =0
 Output formatted description of stopping test to output stream. More...
 
virtual void printStatus (std::ostream &os, StatusType type) const
 Output the result of the most recent CheckStatus call. More...
 
- Public Member Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
virtual std::string description () const
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 

Detailed Description

template<class ScalarType, class MV, class OP>
class Belos::StatusTestGenResSubNorm< ScalarType, MV, OP >

An implementation of StatusTestResNorm using a family of norms of subvectors of the residual vectors.

StatusTestGenResSubNorm is an implementation of StatusTestResNorm that allows a user to construct one of a family of residual tests for use as a status/convergence test for Belos.

Definition at line 72 of file BelosStatusTestGenResSubNorm.hpp.

Member Typedef Documentation

template<class ScalarType , class MV , class OP >
typedef Teuchos::ScalarTraits<ScalarType> Belos::StatusTestGenResSubNorm< ScalarType, MV, OP >::SCT

Definition at line 76 of file BelosStatusTestGenResSubNorm.hpp.

template<class ScalarType , class MV , class OP >
typedef SCT::magnitudeType Belos::StatusTestGenResSubNorm< ScalarType, MV, OP >::MagnitudeType

Definition at line 77 of file BelosStatusTestGenResSubNorm.hpp.

template<class ScalarType , class MV , class OP >
typedef MultiVecTraits<ScalarType,MV> Belos::StatusTestGenResSubNorm< ScalarType, MV, OP >::MVT

Definition at line 78 of file BelosStatusTestGenResSubNorm.hpp.


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