Teko_StratimikosFactory.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_StratimikosFactory_hpp__
#define __Teko_StratimikosFactory_hpp__

#include <vector>

#include "Thyra_PreconditionerFactoryBase.hpp"
#include "Teuchos_StandardCompositionMacros.hpp"

#include "Teko_RequestHandler.hpp"
#include "Teko_InverseLibrary.hpp"
#include "Teko_InverseFactory.hpp"

#ifdef TEKO_HAVE_EPETRA
#include "Thyra_EpetraOperatorViewExtractorBase.hpp"
#include "Epetra_Operator.h"
#endif

namespace Teko {

class StratimikosFactory : public Thyra::PreconditionerFactoryBase<double> {
 public:

  StratimikosFactory();

  StratimikosFactory(const Teuchos::RCP<Teko::RequestHandler> &rh);
  StratimikosFactory(const Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder> &builder,
                     const Teuchos::RCP<Teko::RequestHandler> &rh);

#ifdef TEKO_HAVE_EPETRA

  STANDARD_COMPOSITION_MEMBERS(Thyra::EpetraOperatorViewExtractorBase, epetraFwdOpViewExtractor);
#endif



  bool isCompatible(const Thyra::LinearOpSourceBase<double> &fwdOp) const;
  bool applySupportsConj(Thyra::EConj conj) const;
  bool applyTransposeSupportsConj(Thyra::EConj conj) const;
  Teuchos::RCP<Thyra::PreconditionerBase<double> > createPrec() const;
  void initializePrec(const Teuchos::RCP<const Thyra::LinearOpSourceBase<double> > &fwdOp,
                      Thyra::PreconditionerBase<double> *prec,
                      const Thyra::ESupportSolveUse supportSolveUse) const;
  void uninitializePrec(Thyra::PreconditionerBase<double> *prec,
                        Teuchos::RCP<const Thyra::LinearOpSourceBase<double> > *fwdOp,
                        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;

  // ToDo: Add an override of describe(...) to give more detail!


  void initializePrec_Thyra(const Teuchos::RCP<const Thyra::LinearOpSourceBase<double> > &fwdOp,
                            Thyra::PreconditionerBase<double> *prec,
                            const Thyra::ESupportSolveUse supportSolveUse) const;

#ifdef TEKO_HAVE_EPETRA

  void initializePrec_Epetra(const Teuchos::RCP<const Thyra::LinearOpSourceBase<double> > &fwdOp,
                             Thyra::PreconditionerBase<double> *prec,
                             const Thyra::ESupportSolveUse supportSolveUse) const;
#endif

  void setRequestHandler(const Teuchos::RCP<Teko::RequestHandler> &rh) { reqHandler_ = rh; }

  Teuchos::RCP<Teko::RequestHandler> getRequestHandler() const { return reqHandler_; }

  const std::vector<int> &getDecomposition() const { return decomp_; }

 private:
#ifdef TEKO_HAVE_EPETRA

  Teuchos::RCP<Epetra_Operator> buildWrappedEpetraOperator(
      const Teuchos::RCP<const Epetra_Operator> &Jac,
      const Teuchos::RCP<Epetra_Operator> &wrapInput, std::ostream &out) const;

  void buildStridedVectors(const Epetra_Operator &Jac, const std::vector<int> &decomp,
                           std::vector<std::vector<int> > &vars) const;
#endif  // TEKO_HAVE_EPETRA

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

  mutable Teuchos::RCP<Teko::InverseLibrary> invLib_;
  mutable Teuchos::RCP<Teko::InverseFactory> invFactory_;
  Teuchos::RCP<Teko::RequestHandler> reqHandler_;
  mutable std::vector<int> decomp_;
  Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder>
      builder_;  // builder to use for default solvers
};

void addTekoToStratimikosBuilder(Stratimikos::DefaultLinearSolverBuilder &builder,
                                 const std::string &stratName = "Teko");

void addTekoToStratimikosBuilder(Stratimikos::DefaultLinearSolverBuilder &builder,
                                 const Teuchos::RCP<Teko::RequestHandler> &rh,
                                 const std::string &stratName = "Teko");

}  // namespace Teko

#endif