Teko_NeumannSeriesPreconditionerFactoryDecl.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_NeumannSeriesPreconditionerFactoryDecl_hpp__
#define __Teko_NeumannSeriesPreconditionerFactoryDecl_hpp__

#include "Teuchos_ParameterListAcceptor.hpp"

// Thyra includes
#include "Thyra_PreconditionerFactoryBase.hpp"

// Teko includes
#include "Teko_Utilities.hpp"

namespace Teko {

using Teuchos::RCP;

template <typename ScalarT>
class NeumannSeriesPreconditionerFactory
    : public virtual Thyra::PreconditionerFactoryBase<ScalarT> {
 public:
  NeumannSeriesPreconditionerFactory();

  bool isCompatible(const Thyra::LinearOpSourceBase<ScalarT> &fwdOpSrc) const;

  RCP<Thyra::PreconditionerBase<ScalarT> > createPrec() const;

  void initializePrec(const RCP<const Thyra::LinearOpSourceBase<ScalarT> > &fwdOpSrc,
                      const RCP<const Thyra::MultiVectorBase<ScalarT> > &solnVec,
                      Thyra::PreconditionerBase<ScalarT> *precOp,
                      const Thyra::ESupportSolveUse supportSolveUse) const;

  void initializePrec(const RCP<const Thyra::LinearOpSourceBase<ScalarT> > &fwdOpSrc,
                      Thyra::PreconditionerBase<ScalarT> *precOp,
                      const Thyra::ESupportSolveUse supportSolveUse) const;

  void uninitializePrec(Thyra::PreconditionerBase<ScalarT> *prec,
                        RCP<const Thyra::LinearOpSourceBase<ScalarT> > *fwdOpSrc,
                        Thyra::ESupportSolveUse *supportSolveUse) const;


  void setParameterList(Teuchos::RCP<Teuchos::ParameterList> const &paramList);

  Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();

  Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();

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

  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;


  std::string description() const;


 protected:
  Teuchos::RCP<Teuchos::ParameterList> paramList_;

  int numberOfTerms_;
  Teko::DiagonalType scalingType_;
};

}  // end namespace Teko

#endif