Anasazi  Version of the Day
Public Attributes | List of all members
Anasazi::LOBPCGState< ScalarType, MultiVector > Struct Template Reference

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

#include <AnasaziLOBPCG.hpp>

Public Attributes

Teuchos::RCP< const MultiVector > V
 The current test basis. More...
 
Teuchos::RCP< const MultiVector > KV
 The image of the current test basis under K. More...
 
Teuchos::RCP< const MultiVector > MV
 The image of the current test basis under M, or Teuchos::null if M was not specified. More...
 
Teuchos::RCP< const MultiVector > X
 The current eigenvectors. More...
 
Teuchos::RCP< const MultiVector > KX
 The image of the current eigenvectors under K. More...
 
Teuchos::RCP< const MultiVector > MX
 The image of the current eigenvectors under M, or Teuchos::null if M was not specified. More...
 
Teuchos::RCP< const MultiVector > P
 The current search direction. More...
 
Teuchos::RCP< const MultiVector > KP
 The image of the current search direction under K. More...
 
Teuchos::RCP< const MultiVector > MP
 The image of the current search direction under M, or Teuchos::null if M was not specified. More...
 
Teuchos::RCP< const MultiVector > H
 The current preconditioned residual vectors. More...
 
Teuchos::RCP< const MultiVector > KH
 The image of the current preconditioned residual vectors under K. More...
 
Teuchos::RCP< const MultiVector > MH
 The image of the current preconditioned residual vectors under M, or Teuchos::null if M was not specified. More...
 
Teuchos::RCP< const MultiVector > R
 The current residual vectors. More...
 
Teuchos::RCP< const std::vector< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > > T
 The current Ritz values. More...
 

Detailed Description

template<class ScalarType, class MultiVector>
struct Anasazi::LOBPCGState< ScalarType, MultiVector >

Structure to contain pointers to Anasazi state variables.

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

Definition at line 101 of file AnasaziLOBPCG.hpp.

Member Data Documentation

◆ V

template<class ScalarType, class MultiVector>
Teuchos::RCP<const MultiVector> Anasazi::LOBPCGState< ScalarType, MultiVector >::V

The current test basis.

Definition at line 103 of file AnasaziLOBPCG.hpp.

◆ KV

template<class ScalarType, class MultiVector>
Teuchos::RCP<const MultiVector> Anasazi::LOBPCGState< ScalarType, MultiVector >::KV

The image of the current test basis under K.

Definition at line 105 of file AnasaziLOBPCG.hpp.

◆ MV

template<class ScalarType, class MultiVector>
Teuchos::RCP<const MultiVector> Anasazi::LOBPCGState< ScalarType, MultiVector >::MV

The image of the current test basis under M, or Teuchos::null if M was not specified.

Definition at line 107 of file AnasaziLOBPCG.hpp.

◆ X

template<class ScalarType, class MultiVector>
Teuchos::RCP<const MultiVector> Anasazi::LOBPCGState< ScalarType, MultiVector >::X

The current eigenvectors.

Definition at line 110 of file AnasaziLOBPCG.hpp.

◆ KX

template<class ScalarType, class MultiVector>
Teuchos::RCP<const MultiVector> Anasazi::LOBPCGState< ScalarType, MultiVector >::KX

The image of the current eigenvectors under K.

Definition at line 112 of file AnasaziLOBPCG.hpp.

◆ MX

template<class ScalarType, class MultiVector>
Teuchos::RCP<const MultiVector> Anasazi::LOBPCGState< ScalarType, MultiVector >::MX

The image of the current eigenvectors under M, or Teuchos::null if M was not specified.

Definition at line 114 of file AnasaziLOBPCG.hpp.

◆ P

template<class ScalarType, class MultiVector>
Teuchos::RCP<const MultiVector> Anasazi::LOBPCGState< ScalarType, MultiVector >::P

The current search direction.

Definition at line 117 of file AnasaziLOBPCG.hpp.

◆ KP

template<class ScalarType, class MultiVector>
Teuchos::RCP<const MultiVector> Anasazi::LOBPCGState< ScalarType, MultiVector >::KP

The image of the current search direction under K.

Definition at line 119 of file AnasaziLOBPCG.hpp.

◆ MP

template<class ScalarType, class MultiVector>
Teuchos::RCP<const MultiVector> Anasazi::LOBPCGState< ScalarType, MultiVector >::MP

The image of the current search direction under M, or Teuchos::null if M was not specified.

Definition at line 121 of file AnasaziLOBPCG.hpp.

◆ H

template<class ScalarType, class MultiVector>
Teuchos::RCP<const MultiVector> Anasazi::LOBPCGState< ScalarType, MultiVector >::H

The current preconditioned residual vectors.

H is only useful when LOBPCG::iterate() throw a LOBPCGRitzFailure exception.

Definition at line 127 of file AnasaziLOBPCG.hpp.

◆ KH

template<class ScalarType, class MultiVector>
Teuchos::RCP<const MultiVector> Anasazi::LOBPCGState< ScalarType, MultiVector >::KH

The image of the current preconditioned residual vectors under K.

Definition at line 129 of file AnasaziLOBPCG.hpp.

◆ MH

template<class ScalarType, class MultiVector>
Teuchos::RCP<const MultiVector> Anasazi::LOBPCGState< ScalarType, MultiVector >::MH

The image of the current preconditioned residual vectors under M, or Teuchos::null if M was not specified.

Definition at line 131 of file AnasaziLOBPCG.hpp.

◆ R

template<class ScalarType, class MultiVector>
Teuchos::RCP<const MultiVector> Anasazi::LOBPCGState< ScalarType, MultiVector >::R

The current residual vectors.

Definition at line 134 of file AnasaziLOBPCG.hpp.

◆ T

template<class ScalarType, class MultiVector>
Teuchos::RCP<const std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> > Anasazi::LOBPCGState< ScalarType, MultiVector >::T

The current Ritz values.

Definition at line 137 of file AnasaziLOBPCG.hpp.


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