Belos::CGIterationState< ScalarType, MV, DM > Class Template Reference

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

#include <BelosCGIter.hpp>

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

Public Member Functions
	CGIterationState ()=default
	CGIterationState (Teuchos::RCP< const MV > tmp)
virtual	~CGIterationState ()=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

Public Attributes
Teuchos::RCP< MV >	S
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::CGIterationState< ScalarType, MV, DM >

Structure to contain pointers to CGIteration state variables.

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

Definition at line 53 of file BelosCGIter.hpp.

Constructor & Destructor Documentation

CGIterationState() [1/2]

template<class ScalarType, class MV, class DM = DefaultDenseMatrix<int,ScalarType>>

Belos::CGIterationState< ScalarType, MV, DM >::CGIterationState ( )

default

CGIterationState() [2/2]

template<class ScalarType, class MV, class DM = DefaultDenseMatrix<int,ScalarType>>

Belos::CGIterationState< ScalarType, MV, DM >::CGIterationState ( Teuchos::RCP< const MV > tmp )

inline

Definition at line 58 of file BelosCGIter.hpp.

~CGIterationState()

template<class ScalarType, class MV, class DM = DefaultDenseMatrix<int,ScalarType>>

virtual Belos::CGIterationState< ScalarType, MV, DM >::~CGIterationState ( )

virtualdefault

Member Function Documentation

initialize()

template<class ScalarType, class MV, class DM = DefaultDenseMatrix<int,ScalarType>>

void Belos::CGIterationState< ScalarType, MV, DM >::initialize ( Teuchos::RCP< const MV > tmp, int _numVectors )

inlinevirtual

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

Definition at line 64 of file BelosCGIter.hpp.

matches()

template<class ScalarType, class MV, class DM = DefaultDenseMatrix<int,ScalarType>>

bool Belos::CGIterationState< ScalarType, MV, DM >::matches ( Teuchos::RCP< const MV > tmp, int _numVectors = 1 ) const

inlinevirtual

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

Definition at line 83 of file BelosCGIter.hpp.

Member Data Documentation

S

template<class ScalarType, class MV, class DM = DefaultDenseMatrix<int,ScalarType>>

Teuchos::RCP<MV> Belos::CGIterationState< ScalarType, MV, DM >::S

Definition at line 88 of file BelosCGIter.hpp.

---

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

• BelosCGIter.hpp