BelosGmresBaseIteration.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_GmresBaseIteration_hpp
#define __Belos_GmresBaseIteration_hpp


#include "BelosIteration.hpp"
#include "BelosGmresBaseFactory.hpp"

namespace Belos {

  template<class Scalar, class MV, class OP>
  class GmresBaseIteration : public Iteration<Scalar, MV, OP> {
  private:
    typedef GmresBase<Scalar, MV, OP> impl_type;
    
  public:
    typedef Scalar scalar_type;
    typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitude_type;
    typedef MV multivector_type;
    typedef OP operator_type;

    void 
    iterate() 
    {
      // GmresBaseIteration is an Iteration subclass, and the status
      // checks (should) only call Iteration methods to get the
      // information they want.  We add another "status test," which
      // ensures that GMRES doesn't exceed the maximum number of
      // iterations allowed (for storage of the basis vectors).  The
      // status test will also perform intermediate output via the
      // OutputManager object.
      while (stest_->checkStatus(this) != Passed && impl_->canAdvance()) {
  impl_->advance();
      }
    }

    void initialize();

    int getNumIters() const { return impl_->getNumIters() + 1; }
    
    void resetNumIters (int iter = 0) { 
      TEUCHOS_TEST_FOR_EXCEPTION(iter < 0, std::invalid_argument, "Belos::GmresBaseIter"
       "ation::resetNumIters: iter = " << iter << " is "
       "invalid; only nonnegative values are allowed.");
      impl_->backOut (iter); 
    }

    void restart () { 
      TEUCHOS_TEST_FOR_EXCEPTION(impl_.is_null(), std::logic_error, 
       "Belos::GmresBaseIteration::restart(): GmresBase "
       "subclass instance is null.");
      impl_->restart ();
    }
    
    Teuchos::RCP<const MV> 
    getNativeResiduals (std::vector<magnitude_type>* norms) const
    {
      using Teuchos::RCP;

      RCP<const MV> nativeResVec = impl_->currentNativeResidualVector ();
      const magnitude_type nativeResNorm = impl_->currentNativeResidualNorm ();
      if (norms != NULL)
  {
    // This should always be 1
    const int blockSize = getBlockSize();
    TEUCHOS_TEST_FOR_EXCEPTION(blockSize != 1, std::logic_error,
           "This implementation of Arnoldi/GMRES only "
           "supports a block size of 1, but the current "
           "block size is " << blockSize << ".");
    // Silence the compiler error about comparing signed and unsigned.
    if (norms->size() < (unsigned int) blockSize)
      norms->resize (blockSize);
    for (int k = 0; k < blockSize; ++k)
      (*norms)[k] = nativeResNorm;
  }
      return nativeResVec;
    }

    Teuchos::RCP<MV> getCurrentUpdate() const { 
      return impl_->getCurrentUpdate();
    }

    const LinearProblem<Scalar, MV, OP>& getProblem() const { return *lp_; }

    int getBlockSize() const { return 1; }

    void setBlockSize (int blockSize) {
      TEUCHOS_TEST_FOR_EXCEPTION(blockSize != 1, std::invalid_argument,
       "Belos::GmresBaseIteration::setBlockSize: blockSize = " 
       << blockSize << " is invalid; only blockSize = 1 is "
       "allowed for this iteration.");
    }

    bool isInitialized() {
      return ! impl_.is_null();
    }

    GmresBaseIteration (const Teuchos::RCP<LinearProblem<Scalar, MV, OP> >& problem,
      const Teuchos::RCP<const OrthoManager<Scalar, MV> >& ortho,
      const Teuchos::RCP<OutputManager<Scalar> >& printer,
      const Teuchos::RCP<StatusTest<Scalar, MV, OP> >& tester,
      const Teuchos::RCP<const Teuchos::ParameterList >& params);
    
    virtual ~GmresBaseIteration() {}

    void
    updateSolution ()
    {
      impl_->updateSolution ();
    }

  private:
    mutable Teuchos::RCP<GmresBase<Scalar, MV, OP> > impl_;

    //
    Teuchos::RCP<LinearProblem<Scalar, MV, OP> > lp_;
    Teuchos::RCP<const OrthoManager<Scalar, MV> > ortho_;
    Teuchos::RCP<OutputManager<Scalar> > outMan_;
    Teuchos::RCP<StatusTest<Scalar, MV, OP> > stest_;
    Teuchos::RCP<const Teuchos::ParameterList> params_;

    static Teuchos::RCP<LinearProblem<Scalar, MV, OP> >
    validatedProblem (const Teuchos::RCP<LinearProblem<Scalar, MV, OP> >& problem);
  };

  template<class Scalar, class MV, class OP>
  GmresBaseIteration<Scalar,MV,OP>::
  GmresBaseIteration (const Teuchos::RCP<LinearProblem<Scalar, MV, OP> >& problem,
          const Teuchos::RCP<const OrthoManager<Scalar, MV> >& ortho,
          const Teuchos::RCP<OutputManager<Scalar> >& printer,
          const Teuchos::RCP<StatusTest<Scalar, MV, OP> >& tester,
          const Teuchos::RCP<const Teuchos::ParameterList>& params) :
    lp_ (validatedProblem (problem)),
    ortho_ (ortho), 
    outMan_ (printer), 
    stest_ (tester), 
    params_ (params)
  {
    initialize();
  }

  template<class Scalar, class MV, class OP>
  void
  GmresBaseIteration<Scalar,MV,OP>::initialize ()
  {
    if (! isInitialized())
      {
  typedef GmresBaseFactory<Scalar, MV, OP> factory_type;
  impl_ = factory_type::create (lp_, ortho_, outMan_, params_);
      }
  }

  template<class Scalar, class MV, class OP>
  Teuchos::RCP<LinearProblem<Scalar, MV, OP> >
  GmresBaseIteration<Scalar,MV,OP>::
  validatedProblem (const Teuchos::RCP<LinearProblem<Scalar, MV, OP> >& problem)
  {
    const char prefix[] = "Belos::GmresBaseIteration constructor: ";
    TEUCHOS_TEST_FOR_EXCEPTION(problem.is_null(), std::invalid_argument,
           prefix << "The linear problem (Belos::LinearProblem "
           "instance) that you want me to solve is null.");
    if (! problem->isProblemSet())
      {
  const bool notInitialized = problem->getOperator().is_null() || 
    problem->getRHS().is_null() || problem->getLHS().is_null();
  TEUCHOS_TEST_FOR_EXCEPTION(notInitialized, std::invalid_argument,
         prefix << "The given linear problem (Belos::Linear"
         "Problem) instance is not fully initialized: "
         << (problem->getOperator().is_null() ? "the operator A is null; " : "")
         << (problem->getRHS().is_null() ? "the right-hand side B is null; " : "")
         << (problem->getLHS().is_null() ? "the initial guess X is null" : "")
         << ".");
  if (! problem->isProblemSet())
    problem->setProblem();
  TEUCHOS_TEST_FOR_EXCEPTION(! problem->isProblemSet(), std::logic_error,
         prefix << "Although the given LinearProblem instance "
         "has non-null operator (matrix A), right-hand side B,"
         " and initial guess X, and although its setProblem() "
         "method has been called, its isProblemSet() method "
         "returns false.  This should not happen.");
      }
    return problem;
  }

} // namespace Belos

#endif // __Belos_GmresBaseIteration_hpp