HypreInterface.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_LINEARALGEBRA_INTERFACES_HYPREINTERFACE_HPP_
#define GEOS_LINEARALGEBRA_INTERFACES_HYPREINTERFACE_HPP_
 
#include "linearAlgebra/interfaces/hypre/HypreMatrix.hpp"
#include "linearAlgebra/interfaces/hypre/HypreVector.hpp"
#include "linearAlgebra/common/PreconditionerBase.hpp"
#include "linearAlgebra/common/LinearSolverBase.hpp"
 
#include <memory>
 
namespace geos
{
 
struct HypreInterface
{
  static void initialize();
 
  static void finalize();
 
  static std::unique_ptr< LinearSolverBase< HypreInterface > >
  createSolver( LinearSolverParameters params );
 
  static std::unique_ptr< PreconditionerBase< HypreInterface > >
  createPreconditioner( LinearSolverParameters params );
 
  static std::unique_ptr< PreconditionerBase< HypreInterface > >
  createPreconditioner( LinearSolverParameters params,
                        arrayView1d< HypreVector const > nearNullKernel );
 
  using ParallelMatrix = HypreMatrix;
 
  using ParallelVector = HypreVector;
 
};
 
} /* namespace geos */
 
#endif /*GEOS_LINEARALGEBRA_INTERFACES_HYPREINTERFACE_HPP_*/