VertexCFD_LinearSolvers_Hypre.hpp

// @HEADER
// *****************************************************************************
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//
// Copyright 2009 NTESS and the Ifpack2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef VERTEXFCFD_LINEARSOLVERS_HYPRE_HPP
#define VERTEXFCFD_LINEARSOLVERS_HYPRE_HPP
 
#include <Ifpack2_Details_CanChangeMatrix.hpp>
#include <Ifpack2_Preconditioner.hpp>
 
#include <Tpetra_CrsGraph.hpp>
#include <Tpetra_CrsMatrix.hpp>
#include <Tpetra_Map.hpp>
#include <Tpetra_MultiVector.hpp>
#include <Tpetra_Vector.hpp>
 
#include <HYPREDRV.h>
 
#include <HYPRE.h>
#include <HYPRE_IJ_mv.h>
#include <HYPRE_parcsr_ls.h>
#include <HYPRE_parcsr_mv.h>
#include <_hypre_IJ_mv.h>
#include <_hypre_parcsr_mv.h>
 
namespace VertexCFD
{
namespace LinearSolvers
{
 
//---------------------------------------------------------------------------//
class Hypre : public Ifpack2::Preconditioner<>,
              public Ifpack2::Details::CanChangeMatrix<Tpetra::RowMatrix<>>
{
  public:
    // \name Constructors and destructors
 
    Hypre();
 
    ~Hypre();
 
    // @}
    // @{ Construction methods
    void initialize() override;
 
    bool isInitialized() const { return (is_initialized_); }
 
 
    void compute() override;
 
    bool isComputed() const override { return (is_computed_); }
 
    void setParameters(const Teuchos::ParameterList& parameterlist) override;
 
 
    void setMatrix(const Teuchos::RCP<const Tpetra::RowMatrix<>>& A);
 
    void
    apply(const Tpetra::MultiVector<>& x,
          Tpetra::MultiVector<>& y,
          Teuchos::ETransp mode = Teuchos::NO_TRANS,
          double alpha = Teuchos::ScalarTraits<double>::one(),
          double beta = Teuchos::ScalarTraits<double>::zero()) const override;
 
    Teuchos::RCP<const Tpetra::Map<>> getDomainMap() const override;
 
    Teuchos::RCP<const Tpetra::Map<>> getRangeMap() const override;
 
    bool hasTransposeApply() const override;
 
 
 
    Teuchos::RCP<const Teuchos::Comm<int>> getComm() const;
 
    Teuchos::RCP<const Tpetra::RowMatrix<>> getMatrix() const override;
 
    int getNumInitialize() const override;
 
    int getNumCompute() const override;
 
    int getNumApply() const override;
 
    double getInitializeTime() const override;
 
    double getComputeTime() const override;
 
    double getApplyTime() const override;
 
 
 
    std::string description() const override;
 
    void describe(Teuchos::FancyOStream& out,
                  const Teuchos::EVerbosityLevel verbLevel
                  = Teuchos::Describable::verbLevel_default) const override;
 
 
  private:
    // @{ Private methods
 
    Hypre(const Hypre&);
 
    Hypre& operator=(const Hypre&);
 
    int copyTpetraToHypre();
 
    Teuchos::RCP<const Tpetra::Map<>> makeContiguousColumnMap(
        Teuchos::RCP<const Tpetra::CrsMatrix<>>& Matrix) const;
 
    void destroy();
 
    // Apply only the hypre operator.
    void
    hypreApply(const Tpetra::MultiVector<>& x, Tpetra::MultiVector<>& y) const;
 
    // @}
    // @{ Internal data
    Teuchos::RCP<const Tpetra::RowMatrix<>> A_;
 
    Teuchos::ParameterList List_;
 
    bool is_initialized_;
 
    bool is_computed_;
 
    int num_initialize_;
 
    int num_compute_;
 
    mutable int num_apply_;
 
    double initialize_time_;
 
    double compute_time_;
 
    mutable double apply_time_;
 
    mutable HYPRE_IJMatrix hypre_A_;
 
    mutable HYPRE_IJVector hypre_x_;
    mutable HYPRE_ParVector par_x_;
 
    mutable HYPRE_IJVector hypre_y_;
    mutable HYPRE_ParVector par_y_;
 
    Teuchos::RCP<const Tpetra::Map<>> globally_contiguous_row_map_;
    Teuchos::RCP<const Tpetra::Map<>> globally_contiguous_col_map_;
 
    std::string hypredrive_yaml_;
 
    HYPREDRV_t hypredrv_;
};
 
//---------------------------------------------------------------------------//
 
} // namespace LinearSolvers
} // namespace VertexCFD
 
#endif /* VERTEXFCFD_LINEARSOLVERS_HYPRE_HPP */