Belos Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
Belos::CGSingleRedIterationState< ScalarType, MV > Class Template Reference

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

#include <BelosCGSingleRedIter.hpp>

Inheritance diagram for Belos::CGSingleRedIterationState< ScalarType, MV >:
Inheritance graph
[legend]

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 >
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 >
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::CGSingleRedIterationState< ScalarType, MV >

Structure to contain pointers to CGSingleRedIteration state variables.

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

Definition at line 54 of file BelosCGSingleRedIter.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV >
Belos::CGSingleRedIterationState< ScalarType, MV >::CGSingleRedIterationState ( )
default
template<class ScalarType , class MV >
Belos::CGSingleRedIterationState< ScalarType, MV >::CGSingleRedIterationState ( Teuchos::RCP< const MV >  tmp)
inline

Definition at line 59 of file BelosCGSingleRedIter.hpp.

template<class ScalarType , class MV >
virtual Belos::CGSingleRedIterationState< ScalarType, MV >::~CGSingleRedIterationState ( )
virtualdefault

Member Function Documentation

template<class ScalarType , class MV >
void Belos::CGSingleRedIterationState< ScalarType, MV >::initialize ( Teuchos::RCP< const MV >  tmp,
int  _numVectors 
)
inlinevirtual

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

Definition at line 65 of file BelosCGSingleRedIter.hpp.

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

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

Definition at line 107 of file BelosCGSingleRedIter.hpp.

Member Data Documentation

template<class ScalarType , class MV >
Teuchos::RCP<MV> Belos::CGSingleRedIterationState< ScalarType, MV >::W

Definition at line 117 of file BelosCGSingleRedIter.hpp.

template<class ScalarType , class MV >
Teuchos::RCP<MV> Belos::CGSingleRedIterationState< ScalarType, MV >::V

Definition at line 118 of file BelosCGSingleRedIter.hpp.

template<class ScalarType , class MV >
Teuchos::RCP<MV> Belos::CGSingleRedIterationState< ScalarType, MV >::U

Definition at line 119 of file BelosCGSingleRedIter.hpp.

template<class ScalarType , class MV >
Teuchos::RCP<MV> Belos::CGSingleRedIterationState< ScalarType, MV >::S

Definition at line 120 of file BelosCGSingleRedIter.hpp.

template<class ScalarType , class MV >
Teuchos::RCP<MV> Belos::CGSingleRedIterationState< ScalarType, MV >::T

Definition at line 121 of file BelosCGSingleRedIter.hpp.

template<class ScalarType , class MV >
Teuchos::RCP<MV> Belos::CGSingleRedIterationState< ScalarType, MV >::AZ

Definition at line 122 of file BelosCGSingleRedIter.hpp.


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