HypreSolver.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_HYPRESOLVER_HPP_
#define GEOS_LINEARALGEBRA_INTERFACES_HYPRESOLVER_HPP_
 
#include "linearAlgebra/interfaces/hypre/HypreInterface.hpp"
#include "linearAlgebra/interfaces/hypre/HyprePreconditioner.hpp"
#include "common/LinearSolverBase.hpp"
 
namespace geos
{
 
class DofManager;
 
struct HypreSolverWrapper;
 
class HypreSolver final : public LinearSolverBase< HypreInterface >
{
public:
 
  using Base = LinearSolverBase< HypreInterface >;
 
  explicit HypreSolver( LinearSolverParameters parameters );
 
  virtual ~HypreSolver() override;
 
  virtual void setup( HypreMatrix const & mat ) override;
 
  virtual void apply( HypreVector const & src,
                      HypreVector & dst ) const override;
 
  virtual void solve( HypreVector const & rhs,
                      HypreVector & sol ) const override;
 
  virtual void clear() override;
 
private:
 
  int doSolve( HypreVector const & rhs, HypreVector & sol ) const;
 
  using Base::m_params;
  using Base::m_result;
 
  HyprePreconditioner m_precond;
 
  std::unique_ptr< HypreSolverWrapper > m_solver;
};
 
} // end geos namespace
 
#endif /* HYPRESOLVER_HPP_ */