diff --git a/CMakeLists.txt b/CMakeLists.txt
index 90af1219b..cc789f43f 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -35,6 +35,7 @@ option(USE_DAMARIS_LIB "Use the Damaris library for asynchronous I/O?" OFF)
option(USE_GPU_BRIDGE "Enable the GPU bridge (GPU/AMGCL solvers)" ON)
option(USE_TRACY_PROFILER "Enable tracy profiling" OFF)
option(CONVERT_CUDA_TO_HIP "Convert CUDA code to HIP (to run on AMD cards)" OFF)
+option(USE_HYPRE "Use the Hypre library for linear solvers?" OFF)
set(OPM_COMPILE_COMPONENTS "2;3;4;5;6;7" CACHE STRING "The components to compile support for")
# Ensure OPM_COMPILE_COMPONENTS is a list of at least one element
@@ -715,3 +716,17 @@ endif()
install(DIRECTORY doc/man1 DESTINATION ${CMAKE_INSTALL_MANDIR}
FILES_MATCHING PATTERN "*.1")
+
+if(USE_HYPRE)
+ find_package(HYPRE)
+ if(HYPRE_FOUND)
+ set(HAVE_HYPRE 1)
+ else()
+ message(WARNING "Hypre requested but not found. Continuing without Hypre support.")
+ set(USE_HYPRE OFF)
+ endif()
+endif()
+
+if(HYPRE_FOUND)
+ target_link_libraries(opmsimulators PUBLIC HYPRE::HYPRE)
+endif()
diff --git a/CMakeLists_files.cmake b/CMakeLists_files.cmake
index 353567f16..e3ece638b 100644
--- a/CMakeLists_files.cmake
+++ b/CMakeLists_files.cmake
@@ -1156,3 +1156,9 @@ if(dune-alugrid_FOUND)
examples/fracture_discretefracture.cpp
)
endif()
+
+if(HYPRE_FOUND)
+ list(APPEND PUBLIC_HEADER_FILES
+ opm/simulators/linalg/HyprePreconditioner.hpp
+ )
+endif()
diff --git a/opm-simulators-prereqs.cmake b/opm-simulators-prereqs.cmake
index f2c6fb9be..2af64605f 100644
--- a/opm-simulators-prereqs.cmake
+++ b/opm-simulators-prereqs.cmake
@@ -23,6 +23,7 @@ set (opm-simulators_CONFIG_VAR
HAVE_SUITESPARSE_UMFPACK
HAVE_DAMARIS
HAVE_HDF5
+ HAVE_HYPRE
USE_HIP
USE_TRACY
FLOW_INSTANTIATE_FLOAT
@@ -56,6 +57,8 @@ set (opm-simulators_DEPS
# packages from ROCm framework
"rocblas"
"rocsparse"
+ # HYPRE solver library
+ "HYPRE"
# OPM dependency
"opm-common REQUIRED"
"opm-grid REQUIRED"
diff --git a/opm/simulators/linalg/HyprePreconditioner.hpp b/opm/simulators/linalg/HyprePreconditioner.hpp
new file mode 100644
index 000000000..a2e4d50b3
--- /dev/null
+++ b/opm/simulators/linalg/HyprePreconditioner.hpp
@@ -0,0 +1,208 @@
+/*
+ Copyright 2024 SINTEF AS
+ This file is part of the Open Porous Media project (OPM).
+ OPM is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+ OPM is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+ You should have received a copy of the GNU General Public License
+ along with OPM. If not, see .
+*/
+
+#ifndef OPM_HYPRE_PRECONDITIONER_HEADER_INCLUDED
+#define OPM_HYPRE_PRECONDITIONER_HEADER_INCLUDED
+
+#include
+#include
+#include
+
+#include
+#include
+
+#include
+#include
+#include
+
+#include
+#include
+
+namespace Dune {
+
+/// Wrapper for Hypre's BoomerAMG preconditioner
+template
+class HyprePreconditioner : public PreconditionerWithUpdate {
+public:
+ //! \brief The matrix type the preconditioner is for
+ using matrix_type = M;
+ //! \brief The domain type of the preconditioner
+ using domain_type = X;
+ //! \brief The range type of the preconditioner
+ using range_type = Y;
+ //! \brief The field type of the preconditioner
+ using field_type = typename X::field_type;
+
+ // Constructor
+ HyprePreconditioner (const M& A)
+ : A_(A)
+ {
+ OPM_TIMEBLOCK(prec_construct);
+
+ // Initialize Hypre
+ HYPRE_Init();
+
+ // Create the solver (BoomerAMG)
+ HYPRE_BoomerAMGCreate(&solver_);
+
+ // Set some default parameters
+ HYPRE_BoomerAMGSetPrintLevel(solver_, 0); // Reduce output
+ HYPRE_BoomerAMGSetOldDefault(solver_); // Falgout coarsening with modified classical interpolation
+ HYPRE_BoomerAMGSetRelaxType(solver_, 3); // G-S/Jacobi hybrid relaxation
+ HYPRE_BoomerAMGSetRelaxOrder(solver_, 1); // Uses C/F relaxation
+ HYPRE_BoomerAMGSetNumSweeps(solver_, 1); // Sweeps on each level
+ HYPRE_BoomerAMGSetMaxLevels(solver_, 20); // Maximum number of levels
+ HYPRE_BoomerAMGSetTol(solver_, 1e-7); // Convergence tolerance
+
+
+ // Create the vectors
+ const int N = A_.N();
+ HYPRE_IJVectorCreate(MPI_COMM_WORLD, 0, N-1, &x_hypre_);
+ HYPRE_IJVectorCreate(MPI_COMM_WORLD, 0, N-1, &b_hypre_);
+ HYPRE_IJVectorSetObjectType(x_hypre_, HYPRE_PARCSR);
+ HYPRE_IJVectorSetObjectType(b_hypre_, HYPRE_PARCSR);
+ HYPRE_IJVectorInitialize(x_hypre_);
+ HYPRE_IJVectorInitialize(b_hypre_);
+
+ update();
+ }
+
+ // Destructor
+ ~HyprePreconditioner() {
+ if (solver_) {
+ HYPRE_BoomerAMGDestroy(solver_);
+ }
+ if (parcsr_A_) {
+ HYPRE_IJMatrixDestroy(A_hypre_);
+ }
+ HYPRE_Finalize();
+ }
+
+ void update() override {
+ OPM_TIMEBLOCK(prec_update);
+ copyMatrixToHypre();
+ }
+
+ void pre(X& x, Y& b) override {
+ DUNE_UNUSED_PARAMETER(x);
+ DUNE_UNUSED_PARAMETER(b);
+ }
+
+ void apply(X& v, const Y& d) override {
+ OPM_TIMEBLOCK(prec_apply);
+
+ // Copy vectors to Hypre format
+ copyVectorsToHypre(v, d);
+
+ // Apply the preconditioner (one AMG V-cycle)
+ HYPRE_BoomerAMGSolve(solver_, parcsr_A_, par_b_, par_x_);
+
+ // Copy result back
+ copyVectorFromHypre(v);
+ }
+
+ void post(X& x) override {
+ DUNE_UNUSED_PARAMETER(x);
+ }
+
+ SolverCategory::Category category() const override {
+ return SolverCategory::sequential;
+ }
+
+ bool hasPerfectUpdate() const override
+ {
+ // The Hypre preconditioner can depend on the values of the matrix, so it must be recreated
+ return false;
+ }
+
+private:
+ void copyMatrixToHypre() {
+ const int N = A_.N();
+ HYPRE_IJMatrixCreate(MPI_COMM_WORLD, 0, N-1, 0, N-1, &A_hypre_);
+ HYPRE_IJMatrixSetObjectType(A_hypre_, HYPRE_PARCSR);
+ HYPRE_IJMatrixInitialize(A_hypre_);
+
+ // Copy values from Dune matrix to Hypre matrix
+ for (auto row = A_.begin(); row != A_.end(); ++row) {
+ int i = row.index();
+ std::vector cols;
+ std::vector vals;
+
+ for (auto col = row->begin(); col != row->end(); ++col) {
+ cols.push_back(col.index());
+ vals.push_back(*col);
+ }
+
+ int ncols = cols.size();
+ HYPRE_IJMatrixSetValues(A_hypre_, 1, &ncols, &i, cols.data(), vals.data());
+ }
+
+ HYPRE_IJMatrixAssemble(A_hypre_);
+ HYPRE_IJMatrixGetObject(A_hypre_, (void**)&parcsr_A_);
+
+ // Setup the solver with the new matrix
+ HYPRE_BoomerAMGSetup(solver_, parcsr_A_, par_b_, par_x_);
+ }
+
+ void copyVectorsToHypre(const X& v, const Y& d) {
+ const int N = A_.N();
+
+ // Copy values
+ std::vector indices(N);
+ std::vector x_vals(N);
+ std::vector b_vals(N);
+
+ for (int i = 0; i < N; ++i) {
+ indices[i] = i;
+ x_vals[i] = v[i];
+ b_vals[i] = d[i];
+ }
+
+ HYPRE_IJVectorSetValues(x_hypre_, N, indices.data(), x_vals.data());
+ HYPRE_IJVectorSetValues(b_hypre_, N, indices.data(), b_vals.data());
+
+ HYPRE_IJVectorGetObject(x_hypre_, (void**)&par_x_);
+ HYPRE_IJVectorGetObject(b_hypre_, (void**)&par_b_);
+ }
+
+ void copyVectorFromHypre(X& v) {
+ const int N = A_.N();
+ std::vector indices(N);
+ std::vector vals(N);
+
+ for (int i = 0; i < N; ++i) {
+ indices[i] = i;
+ }
+
+ HYPRE_IJVectorGetValues(x_hypre_, N, indices.data(), vals.data());
+
+ for (int i = 0; i < N; ++i) {
+ v[i] = vals[i];
+ }
+ }
+
+ const M& A_;
+ HYPRE_Solver solver_ = nullptr;
+ HYPRE_IJMatrix A_hypre_ = nullptr;
+ HYPRE_ParCSRMatrix parcsr_A_ = nullptr;
+ HYPRE_IJVector x_hypre_ = nullptr;
+ HYPRE_IJVector b_hypre_ = nullptr;
+ HYPRE_ParVector par_x_ = nullptr;
+ HYPRE_ParVector par_b_ = nullptr;
+};
+
+} // namespace Dune
+
+#endif
diff --git a/opm/simulators/linalg/PreconditionerFactory_impl.hpp b/opm/simulators/linalg/PreconditionerFactory_impl.hpp
index c53c069e7..7b4e85285 100644
--- a/opm/simulators/linalg/PreconditionerFactory_impl.hpp
+++ b/opm/simulators/linalg/PreconditionerFactory_impl.hpp
@@ -49,6 +49,10 @@
// Include all cuistl/GPU preconditioners inside of this headerfile
#include
+#if HAVE_HYPRE
+#include
+#endif
+
namespace Opm {
@@ -543,6 +547,13 @@ struct StandardPreconditioners {
return getRebuildOnUpdateWrapper>(op, crit, parms);
}
});
+ // Only add Hypre for scalar matrices
+ if constexpr (M::block_type::rows == 1 && M::block_type::cols == 1) {
+ F::addCreator("HypreBoomerAMG", [](const O& op, const P& prm, const std::function&, std::size_t) {
+ DUNE_UNUSED_PARAMETER(prm);
+ return std::make_shared>(op.getmat());
+ });
+ }
}
if constexpr (std::is_same_v>) {
F::addCreator(