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. More...
virtual	~StatusTestFactory ()
	Destructor. More...
Teuchos::RCP< base_test >	buildStatusTests (Teuchos::ParameterList &p) const
	returns a StatusTest set from a parameter list More...
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)

Private Member Functions
Teuchos::RCP< base_test >	buildComboTest (Teuchos::ParameterList &p) const
Teuchos::RCP< base_test >	buildMaxItersTest (Teuchos::ParameterList &p) const
Teuchos::RCP< base_test >	buildResidualNormTest (Teuchos::ParameterList &p) const
Teuchos::RCP< base_test >	buildPartialResidualNormTest (Teuchos::ParameterList &p) const

Static Private Member Functions
static NormType	stringToNormType (const std::string &normType)
static ScaleType	stringToScaleType (const std::string &scaleType)

Private Attributes
Teuchos::RCP< std::map < std::string, Teuchos::RCP < base_test > > >	tagged_tests_
	maps test names (defined by the "Tag" parameter) to the corresponding status test More...

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

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.

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.

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.

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

template<class Scalar , class MV , class OP >

Belos::StatusTestFactory< Scalar, MV, OP >::StatusTestFactory ( )

inline

Constructor.

Definition at line 67 of file BelosStatusTestFactory.hpp.

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

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.

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.

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.

template<class Scalar , class MV , class OP >

Teuchos::RCP<base_test> Belos::StatusTestFactory< Scalar, MV, OP >::buildComboTest ( Teuchos::ParameterList &  p ) const

inlineprivate

Definition at line 126 of file BelosStatusTestFactory.hpp.

template<class Scalar , class MV , class OP >

Teuchos::RCP<base_test> Belos::StatusTestFactory< Scalar, MV, OP >::buildMaxItersTest ( Teuchos::ParameterList &  p ) const

inlineprivate

Definition at line 148 of file BelosStatusTestFactory.hpp.

template<class Scalar , class MV , class OP >

Teuchos::RCP<base_test> Belos::StatusTestFactory< Scalar, MV, OP >::buildResidualNormTest ( Teuchos::ParameterList &  p ) const

inlineprivate

Definition at line 154 of file BelosStatusTestFactory.hpp.

template<class Scalar , class MV , class OP >

Teuchos::RCP<base_test> Belos::StatusTestFactory< Scalar, MV, OP >::buildPartialResidualNormTest ( Teuchos::ParameterList &  p ) const

inlineprivate

Definition at line 181 of file BelosStatusTestFactory.hpp.

template<class Scalar , class MV , class OP >

static NormType Belos::StatusTestFactory< Scalar, MV, OP >::stringToNormType ( const std::string &  normType )

inlinestaticprivate

Definition at line 205 of file BelosStatusTestFactory.hpp.

template<class Scalar , class MV , class OP >

static ScaleType Belos::StatusTestFactory< Scalar, MV, OP >::stringToScaleType ( const std::string &  scaleType )

inlinestaticprivate

Definition at line 227 of file BelosStatusTestFactory.hpp.

Member Data Documentation

template<class Scalar , class MV , class OP >

Teuchos::RCP<std::map<std::string, Teuchos::RCP<base_test> > > Belos::StatusTestFactory< Scalar, MV, OP >::tagged_tests_

private

maps test names (defined by the "Tag" parameter) to the corresponding status test

Definition at line 124 of file BelosStatusTestFactory.hpp.

---

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

• BelosStatusTestFactory.hpp