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

#include <BelosIteration.hpp>

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

Public Member Functions
Constructors/Destructor
	Iteration ()
	Default Constructor.
virtual	~Iteration ()
	Destructor.
Solver methods
virtual void	iterate ()=0
	This method performs linear solver iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown).
virtual void	initialize ()=0
	Initialize the solver with the initial vectors from the linear problem or random data.
Status methods
virtual int	getNumIters () const =0
	Get the current iteration count.
virtual void	resetNumIters (int iter=0)=0
	Reset the iteration count to iter.
virtual Teuchos::RCP< const MV >	getNativeResiduals (std::vector< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > *norms) const =0
virtual Teuchos::RCP< MV >	getCurrentUpdate () const =0
	Get the current update to the linear system.
Accessor methods
virtual const LinearProblem< ScalarType, MV, OP > &	getProblem () const =0
	Get a constant reference to the linear problem.
virtual int	getBlockSize () const =0
	Get the blocksize to be used by the iterative solver in solving this linear problem.
virtual void	setBlockSize (int blockSize)=0
	Set the blocksize to be used by the iterative solver in solving this linear problem.
virtual bool	isInitialized ()=0
	States whether the solver has been initialized or not.

Detailed Description

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

Definition at line 41 of file BelosIteration.hpp.

Constructor & Destructor Documentation

Iteration()

template<class ScalarType, class MV, class OP>

Belos::Iteration< ScalarType, MV, OP >::Iteration ( )

inline

Default Constructor.

Definition at line 49 of file BelosIteration.hpp.

~Iteration()

template<class ScalarType, class MV, class OP>

virtual Belos::Iteration< ScalarType, MV, OP >::~Iteration ( )

inlinevirtual

Destructor.

Definition at line 52 of file BelosIteration.hpp.

Member Function Documentation

iterate()

template<class ScalarType, class MV, class OP>

virtual void Belos::Iteration< ScalarType, MV, OP >::iterate ( )

pure virtual

This method performs linear solver iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown).

Implemented in Belos::BiCGStabIter< ScalarType, MV, OP >, Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >, Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::BlockFGmresIter< ScalarType, MV, OP >, Belos::BlockGCRODRIter< ScalarType, MV, OP >, Belos::BlockGmresIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, Belos::FixedPointIter< ScalarType, MV, OP >, Belos::GCRODRIter< ScalarType, MV, OP >, Belos::LSQRIter< ScalarType, MV, OP >, Belos::MinresIter< ScalarType, MV, OP >, Belos::PCPGIter< ScalarType, MV, OP >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::PseudoBlockGmresIter< ScalarType, MV, OP >, Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >, Belos::PseudoBlockTFQMRIter< ScalarType, MV, OP >, Belos::RCGIter< ScalarType, MV, OP >, and Belos::TFQMRIter< ScalarType, MV, OP >.

initialize()

template<class ScalarType, class MV, class OP>

virtual void Belos::Iteration< ScalarType, MV, OP >::initialize ( )

pure virtual

Initialize the solver with the initial vectors from the linear problem or random data.

Implemented in Belos::BiCGStabIter< ScalarType, MV, OP >, Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >, Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::BlockFGmresIter< ScalarType, MV, OP >, Belos::BlockGCRODRIter< ScalarType, MV, OP >, Belos::BlockGmresIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, Belos::FixedPointIter< ScalarType, MV, OP >, Belos::GCRODRIter< ScalarType, MV, OP >, Belos::LSQRIter< ScalarType, MV, OP >, Belos::MinresIter< ScalarType, MV, OP >, Belos::PCPGIter< ScalarType, MV, OP >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::PseudoBlockGmresIter< ScalarType, MV, OP >, Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >, Belos::PseudoBlockTFQMRIter< ScalarType, MV, OP >, Belos::RCGIter< ScalarType, MV, OP >, and Belos::TFQMRIter< ScalarType, MV, OP >.

getNumIters()

template<class ScalarType, class MV, class OP>

virtual int Belos::Iteration< ScalarType, MV, OP >::getNumIters ( ) const

pure virtual

Get the current iteration count.

Implemented in Belos::BiCGStabIter< ScalarType, MV, OP >, Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >, Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::BlockFGmresIter< ScalarType, MV, OP >, Belos::BlockGCRODRIter< ScalarType, MV, OP >, Belos::BlockGmresIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, Belos::FixedPointIter< ScalarType, MV, OP >, Belos::GCRODRIter< ScalarType, MV, OP >, Belos::LSQRIter< ScalarType, MV, OP >, Belos::MinresIter< ScalarType, MV, OP >, Belos::PCPGIter< ScalarType, MV, OP >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::PseudoBlockGmresIter< ScalarType, MV, OP >, Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >, Belos::PseudoBlockTFQMRIter< ScalarType, MV, OP >, Belos::RCGIter< ScalarType, MV, OP >, and Belos::TFQMRIter< ScalarType, MV, OP >.

resetNumIters()

template<class ScalarType, class MV, class OP>

virtual void Belos::Iteration< ScalarType, MV, OP >::resetNumIters ( int iter = 0 )

pure virtual

Reset the iteration count to iter.

Implemented in Belos::BiCGStabIter< ScalarType, MV, OP >, Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >, Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::BlockFGmresIter< ScalarType, MV, OP >, Belos::BlockGCRODRIter< ScalarType, MV, OP >, Belos::BlockGmresIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, Belos::FixedPointIter< ScalarType, MV, OP >, Belos::GCRODRIter< ScalarType, MV, OP >, Belos::LSQRIter< ScalarType, MV, OP >, Belos::MinresIter< ScalarType, MV, OP >, Belos::PCPGIter< ScalarType, MV, OP >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::PseudoBlockGmresIter< ScalarType, MV, OP >, Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >, Belos::PseudoBlockTFQMRIter< ScalarType, MV, OP >, Belos::RCGIter< ScalarType, MV, OP >, and Belos::TFQMRIter< ScalarType, MV, OP >.

getNativeResiduals()

template<class ScalarType, class MV, class OP>

virtual Teuchos::RCP< const MV > Belos::Iteration< ScalarType, MV, OP >::getNativeResiduals ( std::vector< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > * norms ) const

pure virtual

Get the residuals native to the solver.

Returns

A multivector with blockSize vectors containing the native residuals, else the native residual norm is returned.

getCurrentUpdate()

template<class ScalarType, class MV, class OP>

virtual Teuchos::RCP< MV > Belos::Iteration< ScalarType, MV, OP >::getCurrentUpdate ( ) const

pure virtual

Get the current update to the linear system.

Note

Some solvers, like GMRES, do not compute updates to the solution every iteration. This method forces the computation of the current update.

Implemented in Belos::BiCGStabIter< ScalarType, MV, OP >, Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >, Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::BlockFGmresIter< ScalarType, MV, OP >, Belos::BlockGCRODRIter< ScalarType, MV, OP >, Belos::BlockGmresIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, Belos::FixedPointIter< ScalarType, MV, OP >, Belos::GCRODRIter< ScalarType, MV, OP >, Belos::LSQRIter< ScalarType, MV, OP >, Belos::MinresIter< ScalarType, MV, OP >, Belos::PCPGIter< ScalarType, MV, OP >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::PseudoBlockGmresIter< ScalarType, MV, OP >, Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >, Belos::PseudoBlockTFQMRIter< ScalarType, MV, OP >, Belos::RCGIter< ScalarType, MV, OP >, and Belos::TFQMRIter< ScalarType, MV, OP >.

getProblem()

template<class ScalarType, class MV, class OP>

virtual const LinearProblem< ScalarType, MV, OP > & Belos::Iteration< ScalarType, MV, OP >::getProblem ( ) const

pure virtual

Get a constant reference to the linear problem.

Implemented in Belos::BiCGStabIter< ScalarType, MV, OP >, Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >, Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::BlockFGmresIter< ScalarType, MV, OP >, Belos::BlockGCRODRIter< ScalarType, MV, OP >, Belos::BlockGmresIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, Belos::FixedPointIter< ScalarType, MV, OP >, Belos::GCRODRIter< ScalarType, MV, OP >, Belos::LSQRIter< ScalarType, MV, OP >, Belos::MinresIter< ScalarType, MV, OP >, Belos::PCPGIter< ScalarType, MV, OP >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::PseudoBlockGmresIter< ScalarType, MV, OP >, Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >, Belos::PseudoBlockTFQMRIter< ScalarType, MV, OP >, Belos::RCGIter< ScalarType, MV, OP >, and Belos::TFQMRIter< ScalarType, MV, OP >.

getBlockSize()

template<class ScalarType, class MV, class OP>

virtual int Belos::Iteration< ScalarType, MV, OP >::getBlockSize ( ) const

pure virtual

Get the blocksize to be used by the iterative solver in solving this linear problem.

Implemented in Belos::BiCGStabIter< ScalarType, MV, OP >, Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >, Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::BlockFGmresIter< ScalarType, MV, OP >, Belos::BlockGCRODRIter< ScalarType, MV, OP >, Belos::BlockGmresIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, Belos::FixedPointIter< ScalarType, MV, OP >, Belos::GCRODRIter< ScalarType, MV, OP >, Belos::LSQRIter< ScalarType, MV, OP >, Belos::MinresIter< ScalarType, MV, OP >, Belos::PCPGIter< ScalarType, MV, OP >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::PseudoBlockGmresIter< ScalarType, MV, OP >, Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >, Belos::PseudoBlockTFQMRIter< ScalarType, MV, OP >, Belos::RCGIter< ScalarType, MV, OP >, and Belos::TFQMRIter< ScalarType, MV, OP >.

setBlockSize()

template<class ScalarType, class MV, class OP>

virtual void Belos::Iteration< ScalarType, MV, OP >::setBlockSize ( int blockSize )

pure virtual

Set the blocksize to be used by the iterative solver in solving this linear problem.

Implemented in Belos::BiCGStabIter< ScalarType, MV, OP >, Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >, Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::BlockFGmresIter< ScalarType, MV, OP >, Belos::BlockGCRODRIter< ScalarType, MV, OP >, Belos::BlockGmresIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, Belos::FixedPointIter< ScalarType, MV, OP >, Belos::GCRODRIter< ScalarType, MV, OP >, Belos::LSQRIter< ScalarType, MV, OP >, Belos::MinresIter< ScalarType, MV, OP >, Belos::PCPGIter< ScalarType, MV, OP >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::PseudoBlockGmresIter< ScalarType, MV, OP >, Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >, Belos::PseudoBlockTFQMRIter< ScalarType, MV, OP >, Belos::RCGIter< ScalarType, MV, OP >, and Belos::TFQMRIter< ScalarType, MV, OP >.

isInitialized()

template<class ScalarType, class MV, class OP>

virtual bool Belos::Iteration< ScalarType, MV, OP >::isInitialized ( )

pure virtual

States whether the solver has been initialized or not.

Implemented in Belos::BiCGStabIter< ScalarType, MV, OP >, Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >, Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::BlockFGmresIter< ScalarType, MV, OP >, Belos::BlockGCRODRIter< ScalarType, MV, OP >, Belos::BlockGmresIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, Belos::FixedPointIter< ScalarType, MV, OP >, Belos::GCRODRIter< ScalarType, MV, OP >, Belos::LSQRIter< ScalarType, MV, OP >, Belos::MinresIter< ScalarType, MV, OP >, Belos::PCPGIter< ScalarType, MV, OP >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::PseudoBlockGmresIter< ScalarType, MV, OP >, Belos::PseudoBlockStochasticCGIter< ScalarType, MV, OP >, Belos::PseudoBlockTFQMRIter< ScalarType, MV, OP >, Belos::RCGIter< ScalarType, MV, OP >, and Belos::TFQMRIter< ScalarType, MV, OP >.

---

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

• BelosIteration.hpp