Belos Version of the Day
BelosMinresIteration.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_MINRES_ITERATION_HPP
00043 #define BELOS_MINRES_ITERATION_HPP
00044 
00049 #include "BelosConfigDefs.hpp"
00050 #include "BelosTypes.hpp"
00051 #include "BelosIteration.hpp"
00052 
00053 namespace Belos {
00054 
00056 
00057   
00062   template <class ScalarType, class MV>
00063   struct MinresIterationState {
00064 
00066     Teuchos::RCP<const MV> Y;
00067 
00069     Teuchos::RCP<const MV> R1;
00070 
00072     Teuchos::RCP<const MV> R2;
00073 
00075     Teuchos::RCP<const MV> W;
00076 
00078     Teuchos::RCP<const MV> W1;
00079 
00081     Teuchos::RCP<const MV> W2;
00082 
00083     MinresIterationState() : Y(Teuchos::null),
00084                              R1(Teuchos::null),
00085                              R2(Teuchos::null),
00086                              W(Teuchos::null),
00087                              W1(Teuchos::null),
00088                              W2(Teuchos::null)
00089     {}
00090   };
00091 
00093 
00094   
00106   class MinresIterationInitFailure : public BelosError {public:
00107     MinresIterationInitFailure(const std::string& what_arg) : BelosError(what_arg)
00108     {}};
00109 
00116   class MinresIterateFailure : public BelosError {public:
00117     MinresIterateFailure(const std::string& what_arg) : BelosError(what_arg)
00118     {}};
00119   
00126   class MinresIterationOrthoFailure : public BelosError {public:
00127     MinresIterationOrthoFailure(const std::string& what_arg) : BelosError(what_arg)
00128     {}};
00129 
00136   class MinresIterationLAPACKFailure : public BelosError {public:
00137     MinresIterationLAPACKFailure(const std::string& what_arg) : BelosError(what_arg)
00138     {}};
00139   
00141 
00142 
00143 template<class ScalarType, class MV, class OP>
00144 class MinresIteration : virtual public Iteration<ScalarType,MV,OP> {
00145 
00146   public:
00147 
00149 
00150 
00164   virtual void initializeMinres(MinresIterationState<ScalarType,MV> newstate) = 0;
00165 
00172   virtual MinresIterationState<ScalarType,MV> getState() const = 0;
00174 
00175 };
00176 
00177 } // end Belos namespace
00178 
00179 #endif /* BELOS_MINRES_ITERATION_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines