Belos Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
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 >:

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

virtual int setTolerance (MagnitudeType tolerance)=0
 Set the value of the tolerance.
virtual int setQuorum (int quorum)=0
virtual int setShowMaxResNormOnly (bool showMaxResNormOnly)=0
 Set whether the only maximum residual norm is displayed when the print() method is called.
virtual int defineScaleForm (ScaleType TypeOfScaling, NormType TypeOfNorm, MagnitudeType ScaleValue=Teuchos::ScalarTraits< MagnitudeType >::one())=0
 Define the form of the scaling for the residual.
virtual int getQuorum () const =0
virtual bool getShowMaxResNormOnly ()=0
 Returns whether the only maximum residual norm is displayed when the print() method is called.
virtual std::vector< int > convIndices ()=0
 Returns the std::vector containing the indices of the residuals that passed the test.
virtual MagnitudeType getTolerance () const =0
 Returns the value of the tolerance, $ \tau $, set in the constructor.
virtual const std::vector< MagnitudeType > * getTestValue () const =0
 Returns the test value, $ \frac{\|r\|}{\sigma} $, computed in most recent call to CheckStatus.
virtual Teuchos::RCP< MV > getSolution ()=0
virtual bool getLOADetected () const =0
 Returns a boolean indicating a loss of accuracy has been detected in computing the residual.
 StatusTest ()
 Constructor.
virtual ~StatusTest ()
 Destructor.
virtual StatusType checkStatus (Iteration< ScalarType, MV, OP > *iSolver)=0
 Check convergence status: Unconverged, Converged, Failed.
virtual StatusType getStatus () const =0
 Return the result of the most recent CheckStatus call.
virtual void reset ()=0
 Informs the convergence test that it should reset its internal configuration to the initialized state.
virtual void print (std::ostream &os, int indent=0) const =0
 Output formatted description of stopping test to output stream.
virtual void printStatus (std::ostream &os, StatusType type) const
 Output the result of the most recent CheckStatus call.

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

◆ SCT

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.

◆ MagnitudeType

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

Definition at line 77 of file BelosStatusTestGenResSubNorm.hpp.

◆ MVT

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: