Belos::Details::RealSolverManager< ScalarType, MV, OP, true > Class Template Reference

#include <BelosSolverManager.hpp>

Inheritance diagram for Belos::Details::RealSolverManager< ScalarType, MV, OP, true >:

List of all members.

Public Member Functions
	RealSolverManager ()
virtual	~RealSolverManager ()
virtual const LinearProblem < ScalarType, MV, OP > &	getProblem () const
	Return a reference to the linear problem being solved by this solver manager.
virtual ::Teuchos::RCP< const ::Teuchos::ParameterList >	getValidParameters () const
	Return the valid parameters for this solver manager.
virtual ::Teuchos::RCP< const ::Teuchos::ParameterList >	getCurrentParameters () const
	Return the current parameters being used for this solver manager.
virtual int	getNumIters () const
	Get the iteration count for the most recent call to solve().
virtual bool	isLOADetected () const
	Returns whether a loss of accuracy was detected in the solver.
virtual void	setProblem (const ::Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem)
	Set the linear problem that needs to be solved.
virtual void	setParameters (const ::Teuchos::RCP<::Teuchos::ParameterList > &params)
	Set the parameters to use when solving the linear problem.
virtual void	reset (const ResetType type)
	Reset the solver manager.
virtual ReturnType	solve ()
	Iterate until the status test tells us to stop.

---

Detailed Description

template<class ScalarType, class MV, class OP>
class Belos::Details::RealSolverManager< ScalarType, MV, OP, true >

Definition at line 226 of file BelosSolverManager.hpp.

---

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >

Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::RealSolverManager

(

)

[inline]

Definition at line 229 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >

virtual Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::~RealSolverManager

(

)

[inline, virtual]

Definition at line 233 of file BelosSolverManager.hpp.

---

Member Function Documentation

template<class ScalarType , class MV , class OP >

virtual const LinearProblem<ScalarType,MV,OP>& Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::getProblem

(

)

const [inline, virtual]

Return a reference to the linear problem being solved by this solver manager.

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

Definition at line 235 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >

virtual ::Teuchos::RCP<const ::Teuchos::ParameterList> Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::getValidParameters

(

)

const [inline, virtual]

Return the valid parameters for this solver manager.

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

Definition at line 239 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >

virtual ::Teuchos::RCP<const ::Teuchos::ParameterList> Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::getCurrentParameters

(

)

const [inline, virtual]

Return the current parameters being used for this solver manager.

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

Definition at line 243 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >

virtual int Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::getNumIters

(

)

const [inline, virtual]

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

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

Definition at line 247 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >

virtual bool Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::isLOADetected

(

)

const [inline, virtual]

Returns whether a loss of accuracy was detected in the solver.

Note:

This method is normally applicable to GMRES-type solvers.

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

Definition at line 251 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >

virtual void Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::setProblem

(

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

problem

)

[inline, virtual]

Set the linear problem that needs to be solved.

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

Definition at line 255 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >

virtual void Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::setParameters

(

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

params

)

[inline, virtual]

Set the parameters to use when solving the linear problem.

Parameters:

params

[in/out] List of parameters to use when solving the linear problem. This list will be modified as necessary to include default parameters that need not be provided. If params is null, then this method uses default parameters.

Note:

The ParameterList returned by getValidParameters() has all the parameters that the solver understands, possibly including human-readable documentation and validators.

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

Definition at line 259 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >

virtual void Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::reset

(

const ResetType

type

)

[inline, virtual]

Reset the solver manager.

Reset the solver manager in a way specified by the ResetType parameter. This informs the solver manager that the solver should prepare for the next call to solve by resetting certain elements of the iterative solver strategy.

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

Definition at line 263 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >

virtual ReturnType Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::solve

(

)

[inline, virtual]

Iterate until the status test tells us to stop.

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 via the status test(s)), or the solver manager decides to quit.

Returns:

A Belos::ReturnType enum specifying:

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

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

Definition at line 267 of file BelosSolverManager.hpp.

---

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

• BelosSolverManager.hpp