Belos::SolverManager< ScalarType, MV, OP > Class Template Reference

The Belos::SolverManager is a templated virtual base class that defines the basic interface that any solver manager will support. More...

#include <BelosSolverManager.hpp>

Inheritance diagram for Belos::SolverManager< ScalarType, MV, OP >:

[legend]List of all members.

Public Member Functions
Constructors/Destructor
	SolverManager ()
	Empty constructor.
virtual	~SolverManager ()
	Destructor.
Accessor methods
virtual const LinearProblem< ScalarType, MV, OP > &	getProblem () const =0
virtual Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const =0
virtual Teuchos::RCP< const Teuchos::ParameterList >	getCurrentParameters () const =0
virtual int	getNumIters () const =0
	Get the iteration count for the most recent call to solve().
virtual bool	isLOADetected () const =0
Set methods
virtual void	setProblem (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem)=0
virtual void	setParameters (const Teuchos::RCP< Teuchos::ParameterList > &params)=0
Solver application methods
virtual ReturnType	solve ()=0
	This method performs possibly repeated calls to the underlying linear solver's iterate() routine until the problem has been solved (as decided by the solver manager) or the solver manager decides to quit.

---

Detailed Description

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

The Belos::SolverManager is a templated virtual base class that defines the basic interface that any solver manager will support.

Definition at line 53 of file BelosSolverManager.hpp.

---

Constructor & Destructor Documentation

template<class ScalarType, class MV, class OP>

Belos::SolverManager< ScalarType, MV, OP >::SolverManager

(

)

[inline]

Empty constructor.

Definition at line 61 of file BelosSolverManager.hpp.

template<class ScalarType, class MV, class OP>

virtual Belos::SolverManager< ScalarType, MV, OP >::~SolverManager

(

)

[inline, virtual]

Destructor.

Definition at line 64 of file BelosSolverManager.hpp.

---

Member Function Documentation

template<class ScalarType, class MV, class OP>

virtual const LinearProblem<ScalarType,MV,OP>& Belos::SolverManager< ScalarType, MV, OP >::getProblem

(

)

const [pure virtual]

Implemented in Belos::BlockCGSolMgr< ScalarType, MV, OP >, Belos::BlockGmresSolMgr< ScalarType, MV, OP >, Belos::GCRODRSolMgr< ScalarType, MV, OP >, Belos::GmresPolySolMgr< ScalarType, MV, OP >, Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >, and Belos::RCGSolMgr< ScalarType, MV, OP >.

template<class ScalarType, class MV, class OP>

virtual Teuchos::RCP<const Teuchos::ParameterList> Belos::SolverManager< ScalarType, MV, OP >::getValidParameters

(

)

const [pure virtual]

Implemented in Belos::BlockCGSolMgr< ScalarType, MV, OP >, Belos::BlockGmresSolMgr< ScalarType, MV, OP >, Belos::GCRODRSolMgr< ScalarType, MV, OP >, Belos::GmresPolySolMgr< ScalarType, MV, OP >, Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >, and Belos::RCGSolMgr< ScalarType, MV, OP >.

template<class ScalarType, class MV, class OP>

virtual Teuchos::RCP<const Teuchos::ParameterList> Belos::SolverManager< ScalarType, MV, OP >::getCurrentParameters

(

)

const [pure virtual]

Implemented in Belos::BlockCGSolMgr< ScalarType, MV, OP >, Belos::BlockGmresSolMgr< ScalarType, MV, OP >, Belos::GCRODRSolMgr< ScalarType, MV, OP >, Belos::GmresPolySolMgr< ScalarType, MV, OP >, Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >, and Belos::RCGSolMgr< ScalarType, MV, OP >.

template<class ScalarType, class MV, class OP>

virtual int Belos::SolverManager< ScalarType, MV, OP >::getNumIters

(

)

const [pure virtual]

Get the iteration count for the most recent call to solve().

Implemented in Belos::BlockCGSolMgr< ScalarType, MV, OP >, Belos::BlockGmresSolMgr< ScalarType, MV, OP >, Belos::GCRODRSolMgr< ScalarType, MV, OP >, Belos::GmresPolySolMgr< ScalarType, MV, OP >, Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >, and Belos::RCGSolMgr< ScalarType, MV, OP >.

template<class ScalarType, class MV, class OP>

virtual bool Belos::SolverManager< ScalarType, MV, OP >::isLOADetected

(

)

const [pure virtual]

Implemented in Belos::BlockCGSolMgr< ScalarType, MV, OP >, Belos::BlockGmresSolMgr< ScalarType, MV, OP >, Belos::GCRODRSolMgr< ScalarType, MV, OP >, Belos::GmresPolySolMgr< ScalarType, MV, OP >, Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >, and Belos::RCGSolMgr< ScalarType, MV, OP >.

template<class ScalarType, class MV, class OP>

virtual void Belos::SolverManager< ScalarType, MV, OP >::setProblem

(

const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &

problem

)

[pure virtual]

Implemented in Belos::BlockCGSolMgr< ScalarType, MV, OP >, Belos::BlockGmresSolMgr< ScalarType, MV, OP >, Belos::GCRODRSolMgr< ScalarType, MV, OP >, Belos::GmresPolySolMgr< ScalarType, MV, OP >, Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >, and Belos::RCGSolMgr< ScalarType, MV, OP >.

template<class ScalarType, class MV, class OP>

virtual void Belos::SolverManager< ScalarType, MV, OP >::setParameters

(

const Teuchos::RCP< Teuchos::ParameterList > &

params

)

[pure virtual]

Implemented in Belos::BlockCGSolMgr< ScalarType, MV, OP >, Belos::BlockGmresSolMgr< ScalarType, MV, OP >, Belos::GCRODRSolMgr< ScalarType, MV, OP >, Belos::GmresPolySolMgr< ScalarType, MV, OP >, Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >, and Belos::RCGSolMgr< ScalarType, MV, OP >.

template<class ScalarType, class MV, class OP>

virtual ReturnType Belos::SolverManager< ScalarType, MV, OP >::solve

(

)

[pure virtual]

This method performs possibly repeated calls to the underlying linear solver's iterate() routine until the problem has been solved (as decided by the solver manager) or the solver manager decides to quit.

Returns:

ReturnType specifying:

• Converged: the linear problem was solved to the specification required by the solver manager.
• Unconverged: the linear problem was not solved to the specification desired by the solver manager

Implemented in Belos::BlockCGSolMgr< ScalarType, MV, OP >, Belos::BlockGmresSolMgr< ScalarType, MV, OP >, Belos::GCRODRSolMgr< ScalarType, MV, OP >, Belos::GmresPolySolMgr< ScalarType, MV, OP >, Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >, and Belos::RCGSolMgr< ScalarType, MV, OP >.

---

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

• BelosSolverManager.hpp

---