Teko_SmootherPreconditionerFactory.hpp

/*
// @HEADER
//
// ***********************************************************************
//
//      Teko: A package for block and physics based preconditioning
//                  Copyright 2010 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 Eric C. Cyr (eccyr@sandia.gov)
//
// ***********************************************************************
//
// @HEADER

*/

#ifndef __Teko_SmootherPreconditionerFactory_hpp__
#define __Teko_SmootherPreconditionerFactory_hpp__

// Teko includes
#include "Teko_PreconditionerFactory.hpp"
#include "Teko_ImplicitLinearOp.hpp"
#include "Teko_RequestHandlerContainer.hpp"

namespace Teko {

class SmootherLinearOp : public ImplicitLinearOp, public RequestHandlerContainer {
 public:
  SmootherLinearOp(const LinearOp &A, const LinearOp &invM, unsigned int applications,
                   bool useDestAsInitialGuess = false);
  SmootherLinearOp(const LinearOp &A, const LinearOp &invM, unsigned int applications,
                   unsigned int block);

  virtual VectorSpace range() const { return invM_->range(); }

  virtual VectorSpace domain() const { return invM_->domain(); }

  virtual void implicitApply(const MultiVector &x, MultiVector &y, const double alpha = 1.0,
                             const double beta = 0.0) const;

  virtual void setRequestHandler(const Teuchos::RCP<RequestHandler> &rh);

  virtual Teuchos::RCP<RequestHandler> getRequestHandler() const;

 private:
  // enum describing initial guess type
  typedef enum {
    Unspecified,
    RequestInitialGuess,
    DestAsInitialGuess,
    NoInitialGuess
  } InitialGuessType;

  LinearOp A_;                         // forward operator
  LinearOp invM_;                      // preconditioner
  unsigned int applications_;          // how much smoothing is required
  InitialGuessType initialGuessType_;  // type of initial guess to use

  // for producing an initial guess
  Teuchos::RCP<RequestMesg> requestMesg_;

  // used by RequestHandlerContainer interface
  Teuchos::RCP<RequestHandler> requestHandler_;

  SmootherLinearOp();                          // hide me
  SmootherLinearOp(const SmootherLinearOp &);  // hide me
};

LinearOp buildSmootherLinearOp(const LinearOp &A, const LinearOp &invM, unsigned int applications,
                               bool useDestAsInitialGuess = false);
LinearOp buildSmootherLinearOp(const LinearOp &A, const LinearOp &invM, unsigned int applications,
                               unsigned int initialGuessBlock);

class SmootherPreconditionerFactory : public virtual Teko::PreconditionerFactory {
 public:
  SmootherPreconditionerFactory();

  virtual LinearOp buildPreconditionerOperator(LinearOp &lo, PreconditionerState &state) const;



  virtual void initializeFromParameterList(const Teuchos::ParameterList &settings);


 private:
  // enum describing initial guess type
  typedef enum {
    Unspecified,
    RequestInitialGuess,
    DestAsInitialGuess,
    NoInitialGuess
  } InitialGuessType;

  // parameters specifying behavior of smoother operator
  unsigned int sweepCount_;
  InitialGuessType initialGuessType_;
  unsigned int initialGuessBlock_;

  // prectionditioner to use as residual correction in smoother
  Teuchos::RCP<Teko::InverseFactory> precFactory_;
};

}  // end namespace Teko

#endif