HyprePreconditioner.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_HYPREPRECONDITIONER_HPP_
#define GEOS_LINEARALGEBRA_INTERFACES_HYPREPRECONDITIONER_HPP_
 
#include "common/PreconditionerBase.hpp"
#include "linearAlgebra/interfaces/hypre/HypreInterface.hpp"
#include "linearAlgebra/utilities/LinearSolverParameters.hpp"
 
#include <memory>
 
namespace geos
{
 
struct HyprePrecWrapper;
 
struct HypreMGRData;
 
struct HypreNullSpace;
 
class HyprePreconditioner final : public PreconditionerBase< HypreInterface >
{
public:
 
  using Base = PreconditionerBase< HypreInterface >;
 
  using Base::setup;
 
  explicit HyprePreconditioner( LinearSolverParameters params );
 
  HyprePreconditioner( LinearSolverParameters params,
                       arrayView1d< HypreVector > const & nearNullKernel );
 
  virtual ~HyprePreconditioner() override;
 
  virtual void setup( Matrix const & mat ) override;
 
  virtual void apply( Vector const & src, Vector & dst ) const override;
 
  virtual void clear() override;
 
  HyprePrecWrapper const & unwrapped() const;
 
private:
 
  void create( DofManager const * const dofManager );
 
  HypreMatrix const & setupPreconditioningMatrix( HypreMatrix const & mat );
 
  LinearSolverParameters m_params;
 
  HypreMatrix m_precondMatrix;
 
  std::unique_ptr< HyprePrecWrapper > m_precond;
 
  std::unique_ptr< HypreMGRData > m_mgrData;
 
  std::unique_ptr< HypreNullSpace > m_nullSpace;
};
 
}
 
#endif //GEOS_LINEARALGEBRA_INTERFACES_HYPREPRECONDITIONER_HPP_