HyprePreconditioner.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_HYPREPRECONDITIONER_HPP
#define GEOSX_HYPREPRECONDITIONER_HPP

#include "linearAlgebra/solvers/PreconditionerBase.hpp"
#include "linearAlgebra/interfaces/hypre/HypreInterface.hpp"
#include "linearAlgebra/utilities/LinearSolverParameters.hpp"

#include <memory>


extern "C" struct hypre_Solver_struct;

using HYPRE_Solver = hypre_Solver_struct *;


namespace geosx
{

struct HyprePrecAuxData;

struct HyprePrecFuncs;

class HyprePreconditioner final : public PreconditionerBase< HypreInterface >
{
public:

  using Base = PreconditionerBase< HypreInterface >;

  using Vector = typename Base::Vector;

  using Matrix = typename Base::Matrix;

  using Base::compute;

  explicit HyprePreconditioner( LinearSolverParameters params,
                                DofManager const * const dofManager = nullptr );

  HyprePreconditioner( LinearSolverParameters params,
                       array1d< HypreVector > const & nearNullKernel,
                       DofManager const * const dofManager = nullptr );

  virtual ~HyprePreconditioner() override;

  void create();

  virtual void compute( Matrix const & mat ) override;

  virtual void apply( Vector const & src, Vector & dst ) const override;

  virtual void clear() override;

  HYPRE_Solver const & unwrapped() const;

  HyprePrecFuncs const & unwrappedFuncs() const;

private:

  void createHyprePreconditioner( DofManager const * const dofManager );

  void createAMG();

  void createMGR( DofManager const * const dofManager );

  void createILU();

  void createILUT();

  LinearSolverParameters m_parameters;

  HYPRE_Solver m_precond;

  HYPRE_Solver aux_precond;

  std::unique_ptr< HyprePrecFuncs > m_functions;

  std::unique_ptr< HyprePrecAuxData > m_auxData;

  DofManager const * const m_dofManager;

  bool m_ready;

  array1d< HypreVector > const * m_nearNullKernel;
};

}

#endif //GEOSX_HYPREPRECONDITIONER_HPP