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. More...
Teuchos::RCP< MV >	Z
	The current preconditioned residual. More...
Teuchos::RCP< MV >	P
	The current decent direction vector. More...
Teuchos::RCP< MV >	AP
	The matrix A applied to current decent direction vector. More...

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

template<class ScalarType , class MV >

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

virtualdefault

Member Function Documentation

template<class ScalarType , class MV >

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

inlinevirtual

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

Definition at line 36 of file BelosCGIteration.hpp.

template<class ScalarType , class MV >

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

inline

Definition at line 47 of file BelosCGIteration.hpp.

template<class ScalarType , class MV >

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

inline

Definition at line 49 of file BelosCGIteration.hpp.

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::CGSingleRedIterationState< ScalarType, MV >, Belos::CGIterationState< ScalarType, MV >, Belos::PseudoBlockCGIterationState< ScalarType, MV >, and Belos::BlockCGIterationState< ScalarType, MV >.

Definition at line 51 of file BelosCGIteration.hpp.

Member Data Documentation

template<class ScalarType , class MV >

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

The current residual.

Definition at line 63 of file BelosCGIteration.hpp.

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.

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.

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