Teko_SmootherPreconditionerFactory.hpp

// @HEADER
// *****************************************************************************
//      Teko: A package for block and physics based preconditioning
//
// Copyright 2010 NTESS and the Teko contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @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