/usr/include/trilinos/BelosLSQRIteration.hpp is in libtrilinos-belos-dev 12.12.1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | //@HEADER
// ************************************************************************
//
// Belos: Block Linear Solvers Package
// Copyright 2004 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
//@HEADER
#ifndef BELOS_LSQR_ITERATION_HPP
#define BELOS_LSQR_ITERATION_HPP
/*! \file BelosLSQRIteration.hpp
\brief IterationState contains the data that defines the state of
the LSQR solver at any given time.
*/
#include "BelosConfigDefs.hpp"
#include "BelosTypes.hpp"
#include "BelosIteration.hpp"
namespace Belos {
//! @name LSQRIteration Structures
//@{
/** \brief 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.
*/
template <class ScalarType, class MV>
struct LSQRIterationState {
/*! \brief Bidiagonalization vector. */
Teuchos::RCP<const MV> U;
/*! \brief Bidiagonalization vector. */
Teuchos::RCP<const MV> V;
/*! \brief The search direction vector. */
Teuchos::RCP<const MV> W;
/*! \brief The damping value. */
typename Teuchos::ScalarTraits<ScalarType>::magnitudeType lambda;
/*! \brief The current residual norm. */
ScalarType resid_norm;
/*! \brief An approximation to the Frobenius norm of A. */
ScalarType frob_mat_norm;
/*! \brief An approximation to the condition number of A. */
ScalarType mat_cond_num;
/*! \brief An estimate of the norm of A^T*resid. */
ScalarType mat_resid_norm;
/*! \brief An estimate of the norm of the solution. */
ScalarType sol_norm;
/*! \brief The norm of the RHS vector b. */
ScalarType bnorm;
LSQRIterationState() : U(Teuchos::null), V(Teuchos::null),
W(Teuchos::null), lambda(0.0),
resid_norm(0.0), frob_mat_norm(0.0),
mat_cond_num(0.0), mat_resid_norm(0.0),
sol_norm(0.0), bnorm(0.0)
{}
};
//! @name LSQRIteration Exceptions
//@{
/** \brief LSQRIterationInitFailure is thrown when the LSQRIteration object is
* unable to generate an initial iterate in the initialize() routine.
*
* This std::exception is thrown from the initialize() method, which is
* called by the user or from the iterate() method if isInitialized()
* == \c false.
*
* In the case that this std::exception is thrown,
* isInitialized() will be \c false and the user will need to provide
* a new initial iterate to the iteration.
*/
class LSQRIterationInitFailure : public BelosError {public:
LSQRIterationInitFailure(const std::string& what_arg) : BelosError(what_arg)
{}};
/** \brief LSQRIterateFailure is thrown when the LSQRIteration object is unable to
* compute the next iterate in the iterate() routine.
*
* This std::exception is thrown from the iterate() method.
*
*/
class LSQRIterateFailure : public BelosError {public:
LSQRIterateFailure(const std::string& what_arg) : BelosError(what_arg)
{}};
/** \brief LSQRIterationOrthoFailure is thrown when the LSQRIteration object is unable to
* compute independent direction vectors in the iterate() routine.
*
* This std::exception is thrown from the iterate() method.
*
*/
class LSQRIterationOrthoFailure : public BelosError {public:
LSQRIterationOrthoFailure(const std::string& what_arg) : BelosError(what_arg)
{}};
/** \brief LSQRIterationLAPACKFailure is thrown when a nonzero return value is passed back
* from an LAPACK routine.
*
* This std::exception is thrown from the iterate() method.
*
*/
class LSQRIterationLAPACKFailure : public BelosError {public:
LSQRIterationLAPACKFailure(const std::string& what_arg) : BelosError(what_arg)
{}};
//@}
} // end Belos namespace
#endif /* BELOS_LSQR_ITERATION_HPP */
|