Belos Package Browser (Single Doxygen Collection) Development
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_ParameterList.hpp"
00053 #include "Teuchos_RCP.hpp"
00054 #include "Teuchos_Array.hpp"
00055 
00056 namespace Belos {
00057 
00058 template <class ScalarType, class MV, class OP>
00059 class LinearProblem;
00060 
00061 template <class ScalarType>
00062 class OutputManager;
00063 
00064 template <class ScalarType, class MV, class OP>
00065 class StatusTest;
00066 
00067 template <class ScalarType, class MV, class OP>
00068 class MatOrthoManager;
00069 
00070 template<class ScalarType, class MV, class OP>
00071 class Iteration {
00072 
00073   public:
00074 
00076 
00077 
00079   Iteration() {};
00080 
00082   virtual ~Iteration() {};
00084 
00085 
00087 
00088   
00092   virtual void iterate() = 0;
00093 
00097   virtual void initialize() = 0;
00098 
00100 
00101   
00103 
00104 
00106   virtual int getNumIters() const = 0;
00107   
00109   virtual void resetNumIters( int iter = 0 ) = 0;
00110 
00113   virtual Teuchos::RCP<const MV> getNativeResiduals( std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> *norms ) const = 0;
00114 
00116 
00119   virtual Teuchos::RCP<MV> getCurrentUpdate() const = 0;
00120 
00122 
00123 
00124   
00126 
00127 
00129   virtual const LinearProblem<ScalarType,MV,OP>& getProblem() const = 0;
00130 
00132   virtual int getBlockSize() const = 0;
00133   
00135   virtual void setBlockSize(int blockSize) = 0;
00136 
00138   virtual bool isInitialized() = 0;
00139 
00141 
00142 };
00143 
00144 } // end Belos namespace
00145 
00146 #endif /* BELOS_ITERATION_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines