Thyra_MueLuTpetraQ2Q1PreconditionerFactory_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//        MueLu: A package for multigrid based preconditioning
//
// Copyright 2012 NTESS and the MueLu contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef THYRA_MUELU_TPETRA_Q2Q1PRECONDITIONER_FACTORY_DECL_HPP
#define THYRA_MUELU_TPETRA_Q2Q1PRECONDITIONER_FACTORY_DECL_HPP
#ifdef HAVE_MUELU_EXPERIMENTAL

#include "Thyra_PreconditionerFactoryBase.hpp"

#include <Tpetra_KokkosCompat_DefaultNode.hpp>

#include <Teko_Utilities.hpp>
#include <Xpetra_Matrix_fwd.hpp>

#include "MueLu_FactoryBase.hpp"

namespace Thyra {

template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class MueLuTpetraQ2Q1PreconditionerFactory : public PreconditionerFactoryBase<Scalar> {
 private:
  typedef Scalar SC;
  typedef LocalOrdinal LO;
  typedef GlobalOrdinal GO;
  typedef Node NO;

 public:

  MueLuTpetraQ2Q1PreconditionerFactory();


  bool isCompatible(const LinearOpSourceBase<SC>& fwdOp) const;
  Teuchos::RCP<PreconditionerBase<SC> > createPrec() const;
  void initializePrec(const Teuchos::RCP<const LinearOpSourceBase<SC> >& fwdOp, PreconditionerBase<SC>* prec, const ESupportSolveUse supportSolveUse) const;
  void uninitializePrec(PreconditionerBase<SC>* prec, Teuchos::RCP<const LinearOpSourceBase<SC> >* fwdOp, ESupportSolveUse* supportSolveUse) const;


  void setParameterList(const Teuchos::RCP<Teuchos::ParameterList>& paramList);
  Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
  Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
  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!


 private:
  Teuchos::RCP<MueLu::TpetraOperator<SC, LO, GO, NO> >
  Q2Q1MkPrecond(const ParameterList& paramList,
                const Teuchos::RCP<Tpetra::MultiVector<SC, LO, GO, NO> >& velCoords,
                const Teuchos::RCP<Tpetra::MultiVector<SC, LO, GO, NO> >& presCoords,
                const Teuchos::ArrayRCP<LO>& p2vMap,
                const Teko::LinearOp& thA11, const Teko::LinearOp& thA12, const Teko::LinearOp& thA21, const Teko::LinearOp& thA11_9Pt) const;

  Teuchos::RCP<Xpetra::Matrix<SC, LO, GO, NO> > Absolute(const Xpetra::Matrix<SC, LO, GO, NO>& A) const;
  Teuchos::RCP<Xpetra::Matrix<SC, LO, GO, NO> > FilterMatrix(Xpetra::Matrix<SC, LO, GO, NO>& A, Xpetra::Matrix<SC, LO, GO, NO>& Pattern, SC dropTol) const;

  void SetDependencyTree(MueLu::FactoryManager<SC, LO, GO, NO>& M, const ParameterList& paramList) const;
  void SetBlockDependencyTree(MueLu::FactoryManager<SC, LO, GO, NO>& M, LO row, LO col, const std::string& mode, const ParameterList& paramList) const;

  RCP<MueLu::FactoryBase> GetSmoother(const std::string& type, const ParameterList& paramList, bool coarseSolver) const;

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

}  // namespace Thyra
#endif
#endif  // THYRA_MUELU_TPETRA_Q2Q1PRECONDITIONER_FACTORY_DECL_HPP