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

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

#include <BelosCGIter.hpp>

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

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 >
virtual	~CGIterationStateBase ()=default
bool	isInitialized () const
int	numVectors () const

Public Attributes
Teuchos::RCP< MV >	S
Public Attributes inherited from Belos::CGIterationStateBase< ScalarType, MV >
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 Belos::CGIterationState< ScalarType, MV >

Structure to contain pointers to CGIteration state variables.

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

Definition at line 54 of file BelosCGIter.hpp.

Constructor & Destructor Documentation

CGIterationState() [1/2]

template<class ScalarType, class MV>

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

default

CGIterationState() [2/2]

template<class ScalarType, class MV>

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

inline

Definition at line 59 of file BelosCGIter.hpp.

~CGIterationState()

template<class ScalarType, class MV>

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

virtualdefault

Member Function Documentation

initialize()

template<class ScalarType, class MV>

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

inlinevirtual

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

Definition at line 65 of file BelosCGIter.hpp.

matches()

template<class ScalarType, class MV>

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

inlinevirtual

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

Definition at line 84 of file BelosCGIter.hpp.

Member Data Documentation

S

template<class ScalarType, class MV>

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

Definition at line 89 of file BelosCGIter.hpp.

---

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

• BelosCGIter.hpp