Belos Version of the Day
BelosIteration.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_ITERATION_HPP
00043 #define BELOS_ITERATION_HPP
00044 
00049 #include "BelosConfigDefs.hpp"
00050 #include "BelosTypes.hpp"
00051 
00052 #include "Teuchos_Array.hpp"
00053 #include "Teuchos_ParameterList.hpp"
00054 #include "Teuchos_RCP.hpp"
00055 #include "Teuchos_ScalarTraits.hpp"
00056 
00057 
00058 namespace Belos {
00059 
00060 template <class ScalarType, class MV, class OP>
00061 class LinearProblem;
00062 
00063 template <class ScalarType>
00064 class OutputManager;
00065 
00066 template <class ScalarType, class MV, class OP>
00067 class StatusTest;
00068 
00069 template <class ScalarType, class MV, class OP>
00070 class MatOrthoManager;
00071 
00072 template<class ScalarType, class MV, class OP>
00073 class Iteration {
00074 
00075   public:
00076 
00078 
00079 
00081   Iteration() {};
00082 
00084   virtual ~Iteration() {};
00086 
00087 
00089 
00090   
00094   virtual void iterate() = 0;
00095 
00099   virtual void initialize() = 0;
00100 
00102 
00103   
00105 
00106 
00108   virtual int getNumIters() const = 0;
00109   
00111   virtual void resetNumIters( int iter = 0 ) = 0;
00112 
00115   virtual Teuchos::RCP<const MV> getNativeResiduals( std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> *norms ) const = 0;
00116 
00118 
00121   virtual Teuchos::RCP<MV> getCurrentUpdate() const = 0;
00122 
00124 
00125 
00126   
00128 
00129 
00131   virtual const LinearProblem<ScalarType,MV,OP>& getProblem() const = 0;
00132 
00134   virtual int getBlockSize() const = 0;
00135   
00137   virtual void setBlockSize(int blockSize) = 0;
00138 
00140   virtual bool isInitialized() = 0;
00141 
00143 
00144 };
00145 
00146 } // end Belos namespace
00147 
00148 #endif /* BELOS_ITERATION_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines