Belos Version of the Day
Loading...
Searching...
No Matches
Belos::BlockCGIterationState< ScalarType, MV, DM > Class Template Reference

Structure to contain pointers to BlockCGIteration state variables. More...

#include <BelosBlockCGIter.hpp>

Inheritance diagram for Belos::BlockCGIterationState< ScalarType, MV, DM >:

Public Member Functions

 BlockCGIterationState ()=default
 BlockCGIterationState (Teuchos::RCP< const MV > tmp)
virtual ~BlockCGIterationState ()=default
void initialize (Teuchos::RCP< const MV > tmp, int _numVectors)
bool matches (Teuchos::RCP< const MV > tmp, int _numVectors=1) const
Public Member Functions inherited from Belos::CGIterationStateBase< ScalarType, MV, DM >
virtual ~CGIterationStateBase ()=default
bool isInitialized () const
int numVectors () const

Additional Inherited Members

Public Attributes inherited from Belos::CGIterationStateBase< ScalarType, MV, DM >
Teuchos::RCP< MV > R
 The current residual.
Teuchos::RCP< MV > Z
 The current preconditioned residual.
Teuchos::RCP< MV > P
 The current decent direction vector.
Teuchos::RCP< MV > AP
 The matrix A applied to current decent direction vector.

Detailed Description

template<class ScalarType, class MV, class DM = DefaultDenseMatrix<int,ScalarType>>
class Belos::BlockCGIterationState< ScalarType, MV, DM >

Structure to contain pointers to BlockCGIteration state variables.

This struct is utilized by BlockCGIteration::initialize() and BlockCGIteration::getState().

Definition at line 43 of file BelosBlockCGIter.hpp.

Constructor & Destructor Documentation

◆ BlockCGIterationState() [1/2]

template<class ScalarType, class MV, class DM = DefaultDenseMatrix<int,ScalarType>>
Belos::BlockCGIterationState< ScalarType, MV, DM >::BlockCGIterationState ( )
default

◆ BlockCGIterationState() [2/2]

template<class ScalarType, class MV, class DM = DefaultDenseMatrix<int,ScalarType>>
Belos::BlockCGIterationState< ScalarType, MV, DM >::BlockCGIterationState ( Teuchos::RCP< const MV > tmp)
inline

Definition at line 48 of file BelosBlockCGIter.hpp.

◆ ~BlockCGIterationState()

template<class ScalarType, class MV, class DM = DefaultDenseMatrix<int,ScalarType>>
virtual Belos::BlockCGIterationState< ScalarType, MV, DM >::~BlockCGIterationState ( )
virtualdefault

Member Function Documentation

◆ initialize()

template<class ScalarType, class MV, class DM = DefaultDenseMatrix<int,ScalarType>>
void Belos::BlockCGIterationState< ScalarType, MV, DM >::initialize ( Teuchos::RCP< const MV > tmp,
int _numVectors )
inlinevirtual

Reimplemented from Belos::CGIterationStateBase< ScalarType, MV, DM >.

Definition at line 54 of file BelosBlockCGIter.hpp.

◆ matches()

template<class ScalarType, class MV, class DM = DefaultDenseMatrix<int,ScalarType>>
bool Belos::BlockCGIterationState< ScalarType, MV, DM >::matches ( Teuchos::RCP< const MV > tmp,
int _numVectors = 1 ) const
inlinevirtual

Reimplemented from Belos::CGIterationStateBase< ScalarType, MV, DM >.

Definition at line 64 of file BelosBlockCGIter.hpp.


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

Generated for Belos by doxygen 1.15.0