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

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

#include <BelosCGSingleRedIter.hpp>

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

Public Member Functions
	CGSingleRedIterationState ()=default
	CGSingleRedIterationState (Teuchos::RCP< const MV > tmp)
virtual	~CGSingleRedIterationState ()=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 >	W
Teuchos::RCP< MV >	V
Teuchos::RCP< MV >	U
Teuchos::RCP< MV >	S
Teuchos::RCP< MV >	T
Teuchos::RCP< MV >	AZ
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>
class Belos::CGSingleRedIterationState< ScalarType, MV, DM >

Structure to contain pointers to CGSingleRedIteration state variables.

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

Definition at line 53 of file BelosCGSingleRedIter.hpp.

Constructor & Destructor Documentation

CGSingleRedIterationState() [1/2]

template<class ScalarType , class MV , class DM >

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

default

CGSingleRedIterationState() [2/2]

template<class ScalarType , class MV , class DM >

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

inline

Definition at line 58 of file BelosCGSingleRedIter.hpp.

~CGSingleRedIterationState()

template<class ScalarType , class MV , class DM >

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

virtualdefault

Member Function Documentation

initialize()

template<class ScalarType , class MV , class DM >

void Belos::CGSingleRedIterationState< 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 BelosCGSingleRedIter.hpp.

matches()

template<class ScalarType , class MV , class DM >

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

inlinevirtual

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

Definition at line 106 of file BelosCGSingleRedIter.hpp.

Member Data Documentation

W

template<class ScalarType , class MV , class DM >

Teuchos::RCP<MV> Belos::CGSingleRedIterationState< ScalarType, MV, DM >::W

Definition at line 116 of file BelosCGSingleRedIter.hpp.

V

template<class ScalarType , class MV , class DM >

Teuchos::RCP<MV> Belos::CGSingleRedIterationState< ScalarType, MV, DM >::V

Definition at line 117 of file BelosCGSingleRedIter.hpp.

U

template<class ScalarType , class MV , class DM >

Teuchos::RCP<MV> Belos::CGSingleRedIterationState< ScalarType, MV, DM >::U

Definition at line 118 of file BelosCGSingleRedIter.hpp.

S

template<class ScalarType , class MV , class DM >

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

Definition at line 119 of file BelosCGSingleRedIter.hpp.

T

template<class ScalarType , class MV , class DM >

Teuchos::RCP<MV> Belos::CGSingleRedIterationState< ScalarType, MV, DM >::T

Definition at line 120 of file BelosCGSingleRedIter.hpp.

AZ

template<class ScalarType , class MV , class DM >

Teuchos::RCP<MV> Belos::CGSingleRedIterationState< ScalarType, MV, DM >::AZ

Definition at line 121 of file BelosCGSingleRedIter.hpp.

---

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

• BelosCGSingleRedIter.hpp