Teko_PreconditionerInverseFactory.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_PreconditionerInverseFactory_hpp__
#define __Teko_PreconditionerInverseFactory_hpp__

#include "Teko_InverseFactory.hpp"

namespace Teko {

class PreconditionerInverseFactory : public InverseFactory {
 public:
  using InverseFactory::buildInverse;
  using InverseFactory::rebuildInverse;



  PreconditionerInverseFactory(
      const Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> >& precFactory,
      const Teuchos::RCP<Teko::RequestHandler>& rh);

  PreconditionerInverseFactory(
      const Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> >& precFactory,
      const Teuchos::RCP<const Teuchos::ParameterList>& xtraParam,
      const Teuchos::RCP<Teko::RequestHandler>& rh);

  PreconditionerInverseFactory(const PreconditionerInverseFactory& pFactory);

  virtual ~PreconditionerInverseFactory() {}

  virtual InverseLinearOp buildInverse(const LinearOp& linearOp) const;

  virtual InverseLinearOp buildInverse(const LinearOp& linearOp,
                                       const PreconditionerState& parentState) const;

  virtual void rebuildInverse(const LinearOp& source, InverseLinearOp& dest) const;

  virtual Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;

  virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;

  virtual bool updateRequestedParameters(const Teuchos::ParameterList& pl);

  virtual std::string toString() const { return precFactory_->description(); }

  Teuchos::RCP<const Thyra::PreconditionerFactoryBase<double> > getPrecFactory() const {
    return precFactory_;
  }

  Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> > getPrecFactory() { return precFactory_; }

  void setupParameterListFromRequestHandler();

 protected:
  Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> > precFactory_;
  Teuchos::RCP<Teuchos::ParameterList> extraParams_;

 private:
  // hide me!
  PreconditionerInverseFactory();
};

}  // namespace Teko

#endif