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

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

#include <BelosCGIteration.hpp>

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

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

Public Attributes
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::CGIterationStateBase< ScalarType, MV >

Structure to contain pointers to CGIteration state variables.

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

Definition at line 33 of file BelosCGIteration.hpp.

Constructor & Destructor Documentation

~CGIterationStateBase()

template<class ScalarType, class MV>

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

virtualdefault

Member Function Documentation

initialize()

template<class ScalarType, class MV>

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

inlinevirtual

Reimplemented in Belos::BlockCGIterationState< ScalarType, MV >, Belos::CGIterationState< ScalarType, MV >, Belos::CGSingleRedIterationState< ScalarType, MV >, and Belos::PseudoBlockCGIterationState< ScalarType, MV >.

Definition at line 36 of file BelosCGIteration.hpp.

isInitialized()

template<class ScalarType, class MV>

bool Belos::CGIterationStateBase< ScalarType, MV >::isInitialized ( ) const

inline

Definition at line 47 of file BelosCGIteration.hpp.

numVectors()

template<class ScalarType, class MV>

int Belos::CGIterationStateBase< ScalarType, MV >::numVectors ( ) const

inline

Definition at line 49 of file BelosCGIteration.hpp.

matches()

template<class ScalarType, class MV>

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

inlinevirtual

Reimplemented in Belos::BlockCGIterationState< ScalarType, MV >, Belos::CGIterationState< ScalarType, MV >, Belos::CGSingleRedIterationState< ScalarType, MV >, and Belos::PseudoBlockCGIterationState< ScalarType, MV >.

Definition at line 51 of file BelosCGIteration.hpp.

Member Data Documentation

R

template<class ScalarType, class MV>

Teuchos::RCP<MV> Belos::CGIterationStateBase< ScalarType, MV >::R

The current residual.

Definition at line 63 of file BelosCGIteration.hpp.

Z

template<class ScalarType, class MV>

Teuchos::RCP<MV> Belos::CGIterationStateBase< ScalarType, MV >::Z

The current preconditioned residual.

Definition at line 66 of file BelosCGIteration.hpp.

P

template<class ScalarType, class MV>

Teuchos::RCP<MV> Belos::CGIterationStateBase< ScalarType, MV >::P

The current decent direction vector.

Definition at line 69 of file BelosCGIteration.hpp.

AP

template<class ScalarType, class MV>

Teuchos::RCP<MV> Belos::CGIterationStateBase< ScalarType, MV >::AP

The matrix A applied to current decent direction vector.

Definition at line 72 of file BelosCGIteration.hpp.

---

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

• BelosCGIteration.hpp