Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Belos::CGIteration< ScalarType, MV, OP > Class Template Referenceabstract

#include <BelosCGIteration.hpp>

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

Public Member Functions

virtual void setDoCondEst (bool val)=0
 Sets whether or not to store the diagonal for condition estimation. More...
 
virtual Teuchos::ArrayView
< typename
Teuchos::ScalarTraits
< ScalarType >::magnitudeType > 
getDiag ()=0
 Gets the diagonal for condition estimation. More...
 
virtual Teuchos::ArrayView
< typename
Teuchos::ScalarTraits
< ScalarType >::magnitudeType > 
getOffDiag ()=0
 Gets the off-diagonal for condition estimation. More...
 
State methods
virtual void initializeCG (CGIterationState< ScalarType, MV > &newstate)=0
 Initialize the solver to an iterate, providing a complete state. More...
 
virtual CGIterationState
< ScalarType, MV > 
getState () const =0
 Get the current state of the linear solver. More...
 
- Public Member Functions inherited from Belos::Iteration< ScalarType, MV, OP >
 Iteration ()
 Default Constructor. More...
 
virtual ~Iteration ()
 Destructor. More...
 
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). More...
 
virtual void initialize ()=0
 Initialize the solver with the initial vectors from the linear problem or random data. More...
 
virtual int getNumIters () const =0
 Get the current iteration count. More...
 
virtual void resetNumIters (int iter=0)=0
 Reset the iteration count to iter. More...
 
virtual Teuchos::RCP< const MV > getNativeResiduals (std::vector< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > *norms) const =0
 Get the residuals native to the solver. More...
 
virtual Teuchos::RCP< MV > getCurrentUpdate () const =0
 Get the current update to the linear system. More...
 
virtual const LinearProblem
< ScalarType, MV, OP > & 
getProblem () const =0
 Get a constant reference to the linear problem. More...
 
virtual int getBlockSize () const =0
 Get the blocksize to be used by the iterative solver in solving this linear problem. More...
 
virtual void setBlockSize (int blockSize)=0
 Set the blocksize to be used by the iterative solver in solving this linear problem. More...
 
virtual bool isInitialized ()=0
 States whether the solver has been initialized or not. More...
 

Detailed Description

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

Definition at line 111 of file BelosCGIteration.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >
virtual void Belos::CGIteration< ScalarType, MV, OP >::initializeCG ( CGIterationState< ScalarType, MV > &  newstate)
pure virtual

Initialize the solver to an iterate, providing a complete state.

The CGIteration contains a certain amount of state, consisting of the current residual, preconditioned residual, and decent direction.

initialize() gives the user the opportunity to manually set these, although only the current unpreconditioned residual is required.

Postcondition
isInitialized() == true (see post-conditions of isInitialize())
Note
For any pointer in newstate which directly points to the multivectors in the solver, the data is not copied.

Implemented in Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, and Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >.

template<class ScalarType , class MV , class OP >
virtual CGIterationState<ScalarType,MV> Belos::CGIteration< ScalarType, MV, OP >::getState ( ) const
pure virtual

Get the current state of the linear solver.

The data is only valid if isInitialized() == true.

Returns
A CGIterationState object containing const pointers to the current solver state.

Implemented in Belos::BlockCGIter< ScalarType, MV, OP, true >, Belos::PseudoBlockCGIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, Belos::CGSingleRedIter< ScalarType, MV, OP >, and Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >.

template<class ScalarType , class MV , class OP >
virtual void Belos::CGIteration< ScalarType, MV, OP >::setDoCondEst ( bool  val)
pure virtual
template<class ScalarType , class MV , class OP >
virtual Teuchos::ArrayView<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> Belos::CGIteration< ScalarType, MV, OP >::getDiag ( )
pure virtual
template<class ScalarType , class MV , class OP >
virtual Teuchos::ArrayView<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> Belos::CGIteration< ScalarType, MV, OP >::getOffDiag ( )
pure virtual

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

Generated on Tue Jul 23 2024 09:24:23 for Belos by doxygen 1.8.5