BelosIteration.hpp

Go to the documentation of this file.

//@HEADER
// ************************************************************************
//
//                 Belos: Block Linear Solvers Package
//                  Copyright 2004 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
//@HEADER
 
#ifndef BELOS_ITERATION_HPP
#define BELOS_ITERATION_HPP
 
#include "BelosConfigDefs.hpp"
#include "BelosTypes.hpp"
 
#include "Teuchos_Array.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_ScalarTraits.hpp"
 
 
namespace Belos {
 
template <class ScalarType, class MV, class OP>
class LinearProblem;
 
template <class ScalarType>
class OutputManager;
 
template <class ScalarType, class MV, class OP>
class StatusTest;
 
template <class ScalarType, class MV, class OP>
class MatOrthoManager;
 
template<class ScalarType, class MV, class OP>
class Iteration {
 
  public:
 
 
 
  Iteration() {};
 
  virtual ~Iteration() {};
 
 
 
  
  virtual void iterate() = 0;
 
  virtual void initialize() = 0;
 
 
  
 
 
  virtual int getNumIters() const = 0;
  
  virtual void resetNumIters( int iter = 0 ) = 0;
 
  virtual Teuchos::RCP<const MV> getNativeResiduals( std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> *norms ) const = 0;
 
 
  virtual Teuchos::RCP<MV> getCurrentUpdate() const = 0;
 
 
 
  
 
 
  virtual const LinearProblem<ScalarType,MV,OP>& getProblem() const = 0;
 
  virtual int getBlockSize() const = 0;
  
  virtual void setBlockSize(int blockSize) = 0;
 
  virtual bool isInitialized() = 0;
 
 
};
 
} // end Belos namespace
 
#endif /* BELOS_ITERATION_HPP */