Belos Version of the Day
BelosCGIteration.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_CG_ITERATION_HPP
00043 #define BELOS_CG_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 CGIterationState {
00064 
00066     Teuchos::RCP<const MV> R;
00067 
00069     Teuchos::RCP<const MV> Z;
00070 
00072     Teuchos::RCP<const MV> P;
00073 
00075     Teuchos::RCP<const MV> AP;
00076     
00077     CGIterationState() : R(Teuchos::null), Z(Teuchos::null), 
00078         P(Teuchos::null), AP(Teuchos::null)
00079     {}
00080   };
00081 
00083 
00084   
00096   class CGIterationInitFailure : public BelosError {public:
00097     CGIterationInitFailure(const std::string& what_arg) : BelosError(what_arg)
00098     {}};
00099 
00106   class CGIterateFailure : public BelosError {public:
00107     CGIterateFailure(const std::string& what_arg) : BelosError(what_arg)
00108     {}};
00109   
00116   class CGIterationOrthoFailure : public BelosError {public:
00117     CGIterationOrthoFailure(const std::string& what_arg) : BelosError(what_arg)
00118     {}};
00119 
00126   class CGIterationLAPACKFailure : public BelosError {public:
00127     CGIterationLAPACKFailure(const std::string& what_arg) : BelosError(what_arg)
00128     {}};
00129   
00131 
00132 
00133 template<class ScalarType, class MV, class OP>
00134 class CGIteration : virtual public Iteration<ScalarType,MV,OP> {
00135 
00136   public:
00137 
00139 
00140 
00154   virtual void initializeCG(CGIterationState<ScalarType,MV> newstate) = 0;
00155 
00162   virtual CGIterationState<ScalarType,MV> getState() const = 0;
00164 
00165 };
00166 
00167 } // end Belos namespace
00168 
00169 #endif /* BELOS_CG_ITERATION_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines