Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
BelosLSQRIteration.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Belos: Block Linear Solvers Package
4 //
5 // Copyright 2004-2016 NTESS and the Belos contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef BELOS_LSQR_ITERATION_HPP
11 #define BELOS_LSQR_ITERATION_HPP
12 
18 #include "BelosConfigDefs.hpp"
19 #include "BelosTypes.hpp"
20 #include "BelosIteration.hpp"
21 
22 namespace Belos {
23 
25 
26 
32  template <class ScalarType, class MV>
34 
37 
40 
43 
46 
48  ScalarType resid_norm;
49 
51  ScalarType frob_mat_norm;
52 
54  ScalarType mat_cond_num;
55 
57  ScalarType mat_resid_norm;
58 
60  ScalarType sol_norm;
61 
63  ScalarType bnorm;
64 
65  LSQRIterationState() : U(Teuchos::null), V(Teuchos::null),
66  W(Teuchos::null), lambda(0.0),
67  resid_norm(0.0), frob_mat_norm(0.0),
68  mat_cond_num(0.0), mat_resid_norm(0.0),
69  sol_norm(0.0), bnorm(0.0)
70  {}
71  };
72 
74 
75 
82 class LSQRIterateFailure : public BelosError {public:
83  LSQRIterateFailure(const std::string& what_arg) : BelosError(what_arg)
84  {}};
85 
87 
88 } // end Belos namespace
89 
90 
91 #endif /* BELOS_LSQR_ITERATION_HPP */
Teuchos::RCP< const MV > U
Bidiagonalization vector.
Collection of types and exceptions used within the Belos solvers.
ScalarType resid_norm
The current residual norm.
Teuchos::ScalarTraits< ScalarType >::magnitudeType lambda
The damping value.
ScalarType sol_norm
An estimate of the norm of the solution.
Pure virtual base class which describes the basic interface to the linear solver iteration.
ScalarType mat_cond_num
An approximation to the condition number of A.
ScalarType frob_mat_norm
An approximation to the Frobenius norm of A.
ScalarType mat_resid_norm
An estimate of the norm of A^T*resid.
LSQRIterateFailure(const std::string &what_arg)
Teuchos::RCP< const MV > W
The search direction vector.
Teuchos::RCP< const MV > V
Bidiagonalization vector.
ScalarType bnorm
The norm of the RHS vector b.
Parent class to all Belos exceptions.
Definition: BelosTypes.hpp:28
Structure to contain pointers to LSQRIteration state variables, ...
Belos header file which uses auto-configuration information to include necessary C++ headers...
LSQRIterateFailure is thrown when the LSQRIteration object is unable to compute the next iterate in t...

Generated on Fri Dec 13 2024 09:24:50 for Belos by doxygen 1.8.5