Belos Version of the Day
Loading...
Searching...
No Matches
Public Types | List of all members
Belos::StatusTestGenResSubNorm< ScalarType, Thyra::MultiVectorBase< ScalarType >, Thyra::LinearOpBase< ScalarType > > Class Template Reference

#include <BelosStatusTestGenResSubNorm.hpp>

Inheritance diagram for Belos::StatusTestGenResSubNorm< ScalarType, Thyra::MultiVectorBase< ScalarType >, Thyra::LinearOpBase< ScalarType > >:
Inheritance graph
[legend]

Public Types

typedef Thyra::MultiVectorBase< ScalarType > MV
 
typedef Thyra::LinearOpBase< ScalarType > OP
 
typedef Teuchos::ScalarTraits< ScalarType > SCT
 
typedef SCT::magnitudeType MagnitudeType
 
typedef MultiVecTraits< ScalarType, MVMVT
 
typedef OperatorTraits< ScalarType, MV, OPOT
 
- Public Types inherited from Belos::StatusTestResNorm< ScalarType, Thyra::MultiVectorBase< ScalarType >, Thyra::LinearOpBase< ScalarType > >
typedef Teuchos::ScalarTraits< ScalarType > SCT
 
typedef SCT::magnitudeType MagnitudeType
 
typedef MultiVecTraits< ScalarType, Thyra::MultiVectorBase< ScalarType > > MVT
 

Additional Inherited Members

- Public Member Functions inherited from Belos::StatusTestResNorm< ScalarType, Thyra::MultiVectorBase< ScalarType >, Thyra::LinearOpBase< ScalarType > >
virtual int setTolerance (MagnitudeType tolerance)=0
 Set the value of the tolerance.
 
virtual int setQuorum (int quorum)=0
 Sets the number of residuals that must pass the convergence test before Passed is returned.
 
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
 Returns the number of residuals that must pass the convergence test before Passed is returned.
 
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< Thyra::MultiVectorBase< ScalarType > > getSolution ()=0
 Returns the current solution estimate that was computed for the most recent residual test.
 
virtual bool getLOADetected () const=0
 Returns a boolean indicating a loss of accuracy has been detected in computing the residual.
 
- Public Member Functions inherited from Belos::StatusTest< ScalarType, MV, OP >
 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 Belos::StatusTestGenResSubNorm< ScalarType, Thyra::MultiVectorBase< ScalarType >, Thyra::LinearOpBase< ScalarType > >

Definition at line 267 of file BelosStatusTestGenResSubNorm.hpp.

Member Typedef Documentation

◆ MV

template<class ScalarType >
typedef Thyra::MultiVectorBase<ScalarType> Belos::StatusTestGenResSubNorm< ScalarType, Thyra::MultiVectorBase< ScalarType >, Thyra::LinearOpBase< ScalarType > >::MV

Definition at line 272 of file BelosStatusTestGenResSubNorm.hpp.

◆ OP

template<class ScalarType >
typedef Thyra::LinearOpBase<ScalarType> Belos::StatusTestGenResSubNorm< ScalarType, Thyra::MultiVectorBase< ScalarType >, Thyra::LinearOpBase< ScalarType > >::OP

Definition at line 273 of file BelosStatusTestGenResSubNorm.hpp.

◆ SCT

template<class ScalarType >
typedef Teuchos::ScalarTraits<ScalarType> Belos::StatusTestGenResSubNorm< ScalarType, Thyra::MultiVectorBase< ScalarType >, Thyra::LinearOpBase< ScalarType > >::SCT

Definition at line 275 of file BelosStatusTestGenResSubNorm.hpp.

◆ MagnitudeType

template<class ScalarType >
typedef SCT::magnitudeType Belos::StatusTestGenResSubNorm< ScalarType, Thyra::MultiVectorBase< ScalarType >, Thyra::LinearOpBase< ScalarType > >::MagnitudeType

Definition at line 276 of file BelosStatusTestGenResSubNorm.hpp.

◆ MVT

template<class ScalarType >
typedef MultiVecTraits<ScalarType,MV> Belos::StatusTestGenResSubNorm< ScalarType, Thyra::MultiVectorBase< ScalarType >, Thyra::LinearOpBase< ScalarType > >::MVT

Definition at line 277 of file BelosStatusTestGenResSubNorm.hpp.

◆ OT

template<class ScalarType >
typedef OperatorTraits<ScalarType,MV,OP> Belos::StatusTestGenResSubNorm< ScalarType, Thyra::MultiVectorBase< ScalarType >, Thyra::LinearOpBase< ScalarType > >::OT

Definition at line 278 of file BelosStatusTestGenResSubNorm.hpp.


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

Generated for Belos by doxygen 1.10.0