Belos Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Belos::GCRODRIteration< ScalarType, MV, OP, DM > Class Template Referenceabstract

Common base interface for GCRODRIter and FGCRODRIter. More...

#include <BelosGCRODRIteration.hpp>

Inheritance diagram for Belos::GCRODRIteration< ScalarType, MV, OP, DM >:
Inheritance graph
[legend]

Public Member Functions

virtual ~GCRODRIteration ()
 
virtual void initialize (GCRODRIterState< ScalarType, MV, DM > &newstate)=0
 
virtual GCRODRIterState< ScalarType, MV, DM > getState () const =0
 
virtual void updateLSQR (int dim=-1)=0
 
virtual int getCurSubspaceDim () const =0
 
virtual int getMaxSubspaceDim () const =0
 
virtual void setSize (int recycledBlocks, int numBlocks)=0
 
- Public Member Functions inherited from Belos::Iteration< ScalarType, MV, OP, DM >
 Iteration ()
 Default Constructor.
 
virtual ~Iteration ()
 Destructor.
 
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.
 
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
 Get the residuals native to the solver.
 
virtual Teuchos::RCP< MV > getCurrentUpdate () const =0
 Get the current update to the linear system.
 
virtual const LinearProblem< ScalarType, MV, OP, DM > & 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 DM = DefaultDenseMatrix<int, ScalarType>>
class Belos::GCRODRIteration< ScalarType, MV, OP, DM >

Common base interface for GCRODRIter and FGCRODRIter.

This mirrors the role of GmresIteration for BlockGmresSolMgr. It lets GCRODRSolMgr store either the standard or flexible iterator in the same RCP variable.

Definition at line 34 of file BelosGCRODRIteration.hpp.

Constructor & Destructor Documentation

◆ ~GCRODRIteration()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>
virtual Belos::GCRODRIteration< ScalarType, MV, OP, DM >::~GCRODRIteration ( )
inlinevirtual

Definition at line 36 of file BelosGCRODRIteration.hpp.

Member Function Documentation

◆ initialize()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>
virtual void Belos::GCRODRIteration< ScalarType, MV, OP, DM >::initialize ( GCRODRIterState< ScalarType, MV, DM > &  newstate)
pure virtual

◆ getState()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>
virtual GCRODRIterState< ScalarType, MV, DM > Belos::GCRODRIteration< ScalarType, MV, OP, DM >::getState ( ) const
pure virtual

◆ updateLSQR()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>
virtual void Belos::GCRODRIteration< ScalarType, MV, OP, DM >::updateLSQR ( int  dim = -1)
pure virtual

◆ getCurSubspaceDim()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>
virtual int Belos::GCRODRIteration< ScalarType, MV, OP, DM >::getCurSubspaceDim ( ) const
pure virtual

◆ getMaxSubspaceDim()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>
virtual int Belos::GCRODRIteration< ScalarType, MV, OP, DM >::getMaxSubspaceDim ( ) const
pure virtual

◆ setSize()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>
virtual void Belos::GCRODRIteration< ScalarType, MV, OP, DM >::setSize ( int  recycledBlocks,
int  numBlocks 
)
pure virtual

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

Generated for Belos by doxygen 1.9.8