Belos Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
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.
 
Teuchos::RCP< const MV > V
 Bidiagonalization vector.
 
Teuchos::RCP< const MV > W
 The search direction vector.
 
Teuchos::ScalarTraits< ScalarType >::magnitudeType lambda
 The damping value.
 
ScalarType resid_norm
 The current residual norm.
 
ScalarType frob_mat_norm
 An approximation to the Frobenius norm of A.
 
ScalarType mat_cond_num
 An approximation to the condition number of A.
 
ScalarType mat_resid_norm
 An estimate of the norm of A^T*resid.
 
ScalarType sol_norm
 An estimate of the norm of the solution.
 
ScalarType bnorm
 The norm of the RHS vector b.
 

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 65 of file BelosLSQRIteration.hpp.

Constructor & Destructor Documentation

◆ LSQRIterationState()

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

Definition at line 97 of file BelosLSQRIteration.hpp.

Member Data Documentation

◆ U

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

Bidiagonalization vector.

Definition at line 68 of file BelosLSQRIteration.hpp.

◆ V

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

Bidiagonalization vector.

Definition at line 71 of file BelosLSQRIteration.hpp.

◆ W

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

The search direction vector.

Definition at line 74 of file BelosLSQRIteration.hpp.

◆ lambda

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

The damping value.

Definition at line 77 of file BelosLSQRIteration.hpp.

◆ resid_norm

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

The current residual norm.

Definition at line 80 of file BelosLSQRIteration.hpp.

◆ frob_mat_norm

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

An approximation to the Frobenius norm of A.

Definition at line 83 of file BelosLSQRIteration.hpp.

◆ mat_cond_num

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

An approximation to the condition number of A.

Definition at line 86 of file BelosLSQRIteration.hpp.

◆ mat_resid_norm

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 89 of file BelosLSQRIteration.hpp.

◆ sol_norm

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

An estimate of the norm of the solution.

Definition at line 92 of file BelosLSQRIteration.hpp.

◆ bnorm

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

The norm of the RHS vector b.

Definition at line 95 of file BelosLSQRIteration.hpp.


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