BelosLSQRIteration.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                 Belos: Block Linear Solvers Package
//
// Copyright 2004-2016 NTESS and the Belos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef BELOS_LSQR_ITERATION_HPP
#define BELOS_LSQR_ITERATION_HPP

#include "BelosConfigDefs.hpp"
#include "BelosTypes.hpp"
#include "BelosIteration.hpp"

namespace Belos {


  
  template <class ScalarType, class MV>
  struct LSQRIterationState {

    Teuchos::RCP<const MV> U;

    Teuchos::RCP<const MV> V;

    Teuchos::RCP<const MV> W;

    typename Teuchos::ScalarTraits<ScalarType>::magnitudeType lambda;

    ScalarType resid_norm;

    ScalarType frob_mat_norm;

    ScalarType mat_cond_num;

    ScalarType mat_resid_norm;

    ScalarType sol_norm;

    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)
    {}
  };


  
class LSQRIterateFailure : public BelosError {public:
      LSQRIterateFailure(const std::string& what_arg) : BelosError(what_arg)
    {}};
  

} // end Belos namespace


#endif /* BELOS_LSQR_ITERATION_HPP */