HypreSolver.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_LINEARALGEBRA_HYPRESOLVER_HPP_
#define GEOSX_LINEARALGEBRA_HYPRESOLVER_HPP_

#include "linearAlgebra/utilities/LinearSolverParameters.hpp"
#include "linearAlgebra/utilities/LinearSolverResult.hpp"

namespace geosx
{

class DofManager;
class HypreVector;
class HypreMatrix;

class HypreSolver
{
public:

  HypreSolver( LinearSolverParameters parameters );

  virtual ~HypreSolver() = default;

  void solve( HypreMatrix & mat,
              HypreVector & sol,
              HypreVector & rhs,
              DofManager const * const dofManager = nullptr );

  LinearSolverResult const & result()
  {
    return m_result;
  }

private:

  LinearSolverParameters m_parameters;
  LinearSolverResult m_result;

  void solve_direct( HypreMatrix & mat,
                     HypreVector & sol,
                     HypreVector & rhs );

  void solve_krylov( HypreMatrix & mat,
                     HypreVector & sol,
                     HypreVector & rhs,
                     DofManager const * const dofManager );

};

} // end geosx namespace

#endif /* HYPRESOLVER_HPP_ */