Belos Package Browser (Single Doxygen Collection) Development
BelosGmresIteration.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_GMRES_ITERATION_HPP
00043 #define BELOS_GMRES_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 GmresIterationState {
00068     int curDim;
00069 
00071     Teuchos::RCP<const MV> V;
00072 
00074     Teuchos::RCP<const MV> Z;
00075 
00082     Teuchos::RCP<const Teuchos::SerialDenseMatrix<int,ScalarType> > H;
00085     Teuchos::RCP<const Teuchos::SerialDenseMatrix<int,ScalarType> > R;
00088     Teuchos::RCP<const Teuchos::SerialDenseMatrix<int,ScalarType> > z;
00089     
00090 
00091     GmresIterationState() : curDim(0), V(Teuchos::null), Z(Teuchos::null),
00092           H(Teuchos::null), R(Teuchos::null), 
00093           z(Teuchos::null)
00094     {}
00095   };
00096 
00098 
00100 
00101   
00113   class GmresIterationInitFailure : public BelosError {public:
00114     GmresIterationInitFailure(const std::string& what_arg) : BelosError(what_arg)
00115     {}};
00116 
00123   class GmresIterationOrthoFailure : public BelosError {public:
00124     GmresIterationOrthoFailure(const std::string& what_arg) : BelosError(what_arg)
00125     {}};
00126 
00133   class GmresIterationLAPACKFailure : public BelosError {public:
00134     GmresIterationLAPACKFailure(const std::string& what_arg) : BelosError(what_arg)
00135     {}};
00136   
00138 
00139 
00140 template<class ScalarType, class MV, class OP>
00141 class GmresIteration : virtual public Iteration<ScalarType,MV,OP> {
00142 
00143   public:
00144 
00146 
00147 
00161   virtual void initializeGmres(GmresIterationState<ScalarType,MV> newstate) = 0;
00162 
00169   virtual GmresIterationState<ScalarType,MV> getState() const = 0;
00171 
00173 
00174 
00176 
00179   virtual void updateLSQR( int dim = -1 ) = 0;
00180 
00182   virtual int getCurSubspaceDim() const = 0; 
00183 
00185   virtual int getMaxSubspaceDim() const = 0;
00186 
00188 
00190 
00191 
00198   virtual void setSize(int blockSize, int numBlocks) = 0;
00199 
00201 
00202 };
00203 
00204 } // end Belos namespace
00205 
00206 #endif /* BELOS_GMRES_ITERATION_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines