sunlinsol_wrapper.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (C) 2021 - 2023 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE.md at
// the top level directory of deal.II.
//
// ---------------------------------------------------------------------
 
 
#ifndef dealii_sundials_sunlinsol_wrapper_h
#define dealii_sundials_sunlinsol_wrapper_h
 
#include <deal.II/base/config.h>
 
#ifdef DEAL_II_WITH_SUNDIALS
 
#  include <sundials/sundials_linearsolver.h>
 
#  include <exception>
#  include <functional>
#  include <memory>
 
DEAL_II_NAMESPACE_OPEN
 
namespace SUNDIALS
{
#  ifndef DOXYGEN
  // forward declarations
  namespace internal
  {
    template <typename VectorType>
    struct LinearSolverContent;
  }
#  endif
 
  template <typename VectorType>
  struct SundialsOperator
  {
    void
    vmult(VectorType &dst, const VectorType &src) const;
 
#  if DEAL_II_SUNDIALS_VERSION_GTE(6, 0, 0)
    SundialsOperator(void *A_data, ATimesFn a_times_fn, SUNContext linsol_ctx);
#  else
    SundialsOperator(void *A_data, ATimesFn a_times_fn);
#  endif
 
  private:
    void *A_data;
 
    ATimesFn a_times_fn;
 
#  if DEAL_II_SUNDIALS_VERSION_GTE(6, 0, 0)
    SUNContext linsol_ctx;
#  endif
  };
 
 
 
  template <typename VectorType>
  struct SundialsPreconditioner
  {
    void
    vmult(VectorType &dst, const VectorType &src) const;
 
#  if DEAL_II_SUNDIALS_VERSION_GTE(6, 0, 0)
    SundialsPreconditioner(void *     P_data,
                           PSolveFn   p_solve_fn,
                           SUNContext linsol_ctx,
                           double     tol);
#  else
    SundialsPreconditioner(void *P_data, PSolveFn p_solve_fn, double tol);
#  endif
 
  private:
    void *P_data;
 
    PSolveFn p_solve_fn;
 
#  if DEAL_II_SUNDIALS_VERSION_GTE(6, 0, 0)
    SUNContext linsol_ctx;
#  endif
 
    double tol;
  };
 
  template <typename VectorType>
  using LinearSolveFunction =
    std::function<void(SundialsOperator<VectorType> &      op,
                       SundialsPreconditioner<VectorType> &prec,
                       VectorType &                        x,
                       const VectorType &                  b,
                       double                              tol)>;
 
  namespace internal
  {
    template <typename VectorType>
    class LinearSolverWrapper
    {
    public:
      explicit LinearSolverWrapper(
        const LinearSolveFunction<VectorType> &lsolve,
        std::exception_ptr &                   pending_exception
#  if DEAL_II_SUNDIALS_VERSION_GTE(6, 0, 0)
        ,
        SUNContext linsol_ctx
#  endif
      );
 
      ~LinearSolverWrapper();
 
      operator SUNLinearSolver();
 
    private:
      SUNLinearSolver                                  sun_linear_solver;
      std::unique_ptr<LinearSolverContent<VectorType>> content;
    };
  } // namespace internal
} // namespace SUNDIALS
 
DEAL_II_NAMESPACE_CLOSE
 
#endif
#endif