Belos Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Belos::StatusTestFactory< Scalar, MV, OP > Class Template Reference

Factory to build a set of status tests from a parameter list. More...

#include <BelosStatusTestFactory.hpp>

Public Types

typedef Teuchos::ScalarTraits< Scalar >::magnitudeType magnitude_type
 
typedef StatusTest< Scalar, MV, OP > base_test
 
typedef StatusTestMaxIters< Scalar, MV, OP > max_iter_test
 
typedef StatusTestCombo< Scalar, MV, OP > combo_test
 

Public Member Functions

 StatusTestFactory ()
 Constructor.
 
virtual ~StatusTestFactory ()
 Destructor.
 
Teuchos::RCP< base_testbuildStatusTests (Teuchos::ParameterList &p) const
 returns a StatusTest set from a parameter list
 
Teuchos::RCP< std::map< std::string, Teuchos::RCP< base_test > > > getTaggedTests () const
 

Static Public Member Functions

static StatusTestCombo< Scalar, MV, OP >::ComboType stringToComboType (const std::string &comboString)
 

Detailed Description

template<class Scalar, class MV, class OP>
class Belos::StatusTestFactory< Scalar, MV, OP >

Factory to build a set of status tests from a parameter list.

Author
Tobias Wiesner

This factory takes a Teuchos::ParameterList and generates an entire set (a tree) of status tests for use in Belos.

Definition at line 58 of file BelosStatusTestFactory.hpp.

Member Typedef Documentation

◆ magnitude_type

template<class Scalar , class MV , class OP >
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Belos::StatusTestFactory< Scalar, MV, OP >::magnitude_type

Definition at line 60 of file BelosStatusTestFactory.hpp.

◆ base_test

template<class Scalar , class MV , class OP >
typedef StatusTest<Scalar,MV,OP> Belos::StatusTestFactory< Scalar, MV, OP >::base_test

Definition at line 61 of file BelosStatusTestFactory.hpp.

◆ max_iter_test

template<class Scalar , class MV , class OP >
typedef StatusTestMaxIters<Scalar,MV,OP> Belos::StatusTestFactory< Scalar, MV, OP >::max_iter_test

Definition at line 63 of file BelosStatusTestFactory.hpp.

◆ combo_test

template<class Scalar , class MV , class OP >
typedef StatusTestCombo<Scalar,MV,OP> Belos::StatusTestFactory< Scalar, MV, OP >::combo_test

Definition at line 64 of file BelosStatusTestFactory.hpp.

Constructor & Destructor Documentation

◆ StatusTestFactory()

template<class Scalar , class MV , class OP >
Belos::StatusTestFactory< Scalar, MV, OP >::StatusTestFactory ( )
inline

Constructor.

Definition at line 67 of file BelosStatusTestFactory.hpp.

◆ ~StatusTestFactory()

template<class Scalar , class MV , class OP >
virtual Belos::StatusTestFactory< Scalar, MV, OP >::~StatusTestFactory ( )
inlinevirtual

Destructor.

Definition at line 72 of file BelosStatusTestFactory.hpp.

Member Function Documentation

◆ buildStatusTests()

template<class Scalar , class MV , class OP >
Teuchos::RCP< base_test > Belos::StatusTestFactory< Scalar, MV, OP >::buildStatusTests ( Teuchos::ParameterList & p) const
inline

returns a StatusTest set from a parameter list

Definition at line 75 of file BelosStatusTestFactory.hpp.

◆ stringToComboType()

template<class Scalar , class MV , class OP >
static StatusTestCombo< Scalar, MV, OP >::ComboType Belos::StatusTestFactory< Scalar, MV, OP >::stringToComboType ( const std::string & comboString)
inlinestatic

Definition at line 109 of file BelosStatusTestFactory.hpp.

◆ getTaggedTests()

template<class Scalar , class MV , class OP >
Teuchos::RCP< std::map< std::string, Teuchos::RCP< base_test > > > Belos::StatusTestFactory< Scalar, MV, OP >::getTaggedTests ( ) const
inline

Definition at line 119 of file BelosStatusTestFactory.hpp.


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

Generated for Belos by doxygen 1.10.0