Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
Belos::LSQRIterationState< ScalarType, MV > Struct Template Reference

Structure to contain pointers to LSQRIteration state variables, ... More...

#include <BelosLSQRIteration.hpp>

Public Member Functions

 LSQRIterationState ()
 

Public Attributes

Teuchos::RCP< const MV > U
 Bidiagonalization vector. More...
 
Teuchos::RCP< const MV > V
 Bidiagonalization vector. More...
 
Teuchos::RCP< const MV > W
 The search direction vector. More...
 
Teuchos::ScalarTraits
< ScalarType >::magnitudeType 
lambda
 The damping value. More...
 
ScalarType resid_norm
 The current residual norm. More...
 
ScalarType frob_mat_norm
 An approximation to the Frobenius norm of A. More...
 
ScalarType mat_cond_num
 An approximation to the condition number of A. More...
 
ScalarType mat_resid_norm
 An estimate of the norm of A^T*resid. More...
 
ScalarType sol_norm
 An estimate of the norm of the solution. More...
 
ScalarType bnorm
 The norm of the RHS vector b. More...
 

Detailed Description

template<class ScalarType, class MV>
struct Belos::LSQRIterationState< ScalarType, MV >

Structure to contain pointers to LSQRIteration state variables, ...

This struct is utilized by initialize() and getState(). augment the basic interface for a Gmres linear solver iteration.

Definition at line 33 of file BelosLSQRIteration.hpp.

Constructor & Destructor Documentation

template<class ScalarType, class MV>
Belos::LSQRIterationState< ScalarType, MV >::LSQRIterationState ( )
inline

Definition at line 65 of file BelosLSQRIteration.hpp.

Member Data Documentation

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

Bidiagonalization vector.

Definition at line 36 of file BelosLSQRIteration.hpp.

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

Bidiagonalization vector.

Definition at line 39 of file BelosLSQRIteration.hpp.

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

The search direction vector.

Definition at line 42 of file BelosLSQRIteration.hpp.

template<class ScalarType, class MV>
Teuchos::ScalarTraits<ScalarType>::magnitudeType Belos::LSQRIterationState< ScalarType, MV >::lambda

The damping value.

Definition at line 45 of file BelosLSQRIteration.hpp.

template<class ScalarType, class MV>
ScalarType Belos::LSQRIterationState< ScalarType, MV >::resid_norm

The current residual norm.

Definition at line 48 of file BelosLSQRIteration.hpp.

template<class ScalarType, class MV>
ScalarType Belos::LSQRIterationState< ScalarType, MV >::frob_mat_norm

An approximation to the Frobenius norm of A.

Definition at line 51 of file BelosLSQRIteration.hpp.

template<class ScalarType, class MV>
ScalarType Belos::LSQRIterationState< ScalarType, MV >::mat_cond_num

An approximation to the condition number of A.

Definition at line 54 of file BelosLSQRIteration.hpp.

template<class ScalarType, class MV>
ScalarType Belos::LSQRIterationState< ScalarType, MV >::mat_resid_norm

An estimate of the norm of A^T*resid.

Definition at line 57 of file BelosLSQRIteration.hpp.

template<class ScalarType, class MV>
ScalarType Belos::LSQRIterationState< ScalarType, MV >::sol_norm

An estimate of the norm of the solution.

Definition at line 60 of file BelosLSQRIteration.hpp.

template<class ScalarType, class MV>
ScalarType Belos::LSQRIterationState< ScalarType, MV >::bnorm

The norm of the RHS vector b.

Definition at line 63 of file BelosLSQRIteration.hpp.


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

Generated on Mon Jul 15 2024 09:24:25 for Belos by doxygen 1.8.5