Belos Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
BelosLSQRIteration.hpp
Go to the documentation of this file.
1//@HEADER
2// ************************************************************************
3//
4// Belos: Block Linear Solvers Package
5// Copyright 2004 Sandia Corporation
6//
7// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8// the U.S. Government retains certain rights in this software.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ************************************************************************
40//@HEADER
41
42#ifndef BELOS_LSQR_ITERATION_HPP
43#define BELOS_LSQR_ITERATION_HPP
44
50#include "BelosConfigDefs.hpp"
51#include "BelosTypes.hpp"
52#include "BelosIteration.hpp"
53
54namespace Belos {
55
57
58
64 template <class ScalarType, class MV>
66
68 Teuchos::RCP<const MV> U;
69
71 Teuchos::RCP<const MV> V;
72
74 Teuchos::RCP<const MV> W;
75
77 typename Teuchos::ScalarTraits<ScalarType>::magnitudeType lambda;
78
80 ScalarType resid_norm;
81
83 ScalarType frob_mat_norm;
84
86 ScalarType mat_cond_num;
87
89 ScalarType mat_resid_norm;
90
92 ScalarType sol_norm;
93
95 ScalarType bnorm;
96
97 LSQRIterationState() : U(Teuchos::null), V(Teuchos::null),
98 W(Teuchos::null), lambda(0.0),
99 resid_norm(0.0), frob_mat_norm(0.0),
100 mat_cond_num(0.0), mat_resid_norm(0.0),
101 sol_norm(0.0), bnorm(0.0)
102 {}
103 };
104
106
107
114class LSQRIterateFailure : public BelosError {public:
115 LSQRIterateFailure(const std::string& what_arg) : BelosError(what_arg)
116 {}};
117
119
120} // end Belos namespace
121
122
123#endif /* BELOS_LSQR_ITERATION_HPP */
Belos header file which uses auto-configuration information to include necessary C++ headers.
Pure virtual base class which describes the basic interface to the linear solver iteration.
Collection of types and exceptions used within the Belos solvers.
Parent class to all Belos exceptions.
Definition: BelosTypes.hpp:60
LSQRIterateFailure is thrown when the LSQRIteration object is unable to compute the next iterate in t...
LSQRIterateFailure(const std::string &what_arg)
Structure to contain pointers to LSQRIteration state variables, ...
ScalarType sol_norm
An estimate of the norm of the solution.
ScalarType frob_mat_norm
An approximation to the Frobenius norm of A.
Teuchos::RCP< const MV > V
Bidiagonalization vector.
ScalarType mat_resid_norm
An estimate of the norm of A^T*resid.
Teuchos::RCP< const MV > U
Bidiagonalization vector.
Teuchos::RCP< const MV > W
The search direction vector.
Teuchos::ScalarTraits< ScalarType >::magnitudeType lambda
The damping value.
ScalarType bnorm
The norm of the RHS vector b.
ScalarType resid_norm
The current residual norm.
ScalarType mat_cond_num
An approximation to the condition number of A.