Belos Package Browser (Single Doxygen Collection) Development
BelosLSQRIteration.hpp
Go to the documentation of this file.
00001 //@HEADER
00002 // ************************************************************************
00003 //
00004 //                 Belos: Block Linear Solvers Package
00005 //                  Copyright 2004 Sandia Corporation
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ************************************************************************
00040 //@HEADER
00041 
00042 #ifndef BELOS_LSQR_ITERATION_HPP
00043 #define BELOS_LSQR_ITERATION_HPP
00044 
00050 #include "BelosConfigDefs.hpp"
00051 #include "BelosTypes.hpp"
00052 #include "BelosIteration.hpp"
00053 
00054 namespace Belos {
00055 
00057 
00058   
00064   template <class ScalarType, class MV>
00065   struct LSQRIterationState {
00066 
00068     Teuchos::RCP<const MV> U;
00069 
00071     Teuchos::RCP<const MV> V;
00072 
00074     Teuchos::RCP<const MV> W;
00075 
00077     typename Teuchos::ScalarTraits<ScalarType>::magnitudeType lambda;
00078 
00080     ScalarType resid_norm;
00081 
00083     ScalarType frob_mat_norm;
00084 
00086     ScalarType mat_cond_num;
00087 
00089     ScalarType mat_resid_norm;
00090 
00092     ScalarType sol_norm;
00093 
00095     ScalarType bnorm;
00096     
00097     LSQRIterationState() : U(Teuchos::null), V(Teuchos::null), 
00098          W(Teuchos::null), lambda(0.0), 
00099          resid_norm(0.0), frob_mat_norm(0.0),
00100          mat_cond_num(0.0), mat_resid_norm(0.0),
00101          sol_norm(0.0), bnorm(0.0)
00102     {}
00103   };
00104 
00106 
00107   
00119 class LSQRIterationInitFailure : public BelosError {public:
00120       LSQRIterationInitFailure(const std::string& what_arg) : BelosError(what_arg)
00121     {}};
00122 
00129 class LSQRIterateFailure : public BelosError {public:
00130       LSQRIterateFailure(const std::string& what_arg) : BelosError(what_arg)
00131     {}};
00132   
00139 class LSQRIterationOrthoFailure : public BelosError {public:
00140       LSQRIterationOrthoFailure(const std::string& what_arg) : BelosError(what_arg)
00141     {}};
00142 
00149 class LSQRIterationLAPACKFailure : public BelosError {public:
00150       LSQRIterationLAPACKFailure(const std::string& what_arg) : BelosError(what_arg)
00151     {}};
00152   
00154 
00155 } // end Belos namespace
00156 
00157 
00158 #endif /* BELOS_LSQR_ITERATION_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines