sunlinsol_wrapper.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 2021 - 2026 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
 
#ifndef dealii_sundials_sunlinsol_wrapper_h
#define dealii_sundials_sunlinsol_wrapper_h
 
#include <deal.II/base/config.h>
 
#ifdef DEAL_II_WITH_SUNDIALS
 
#  include <deal.II/sundials/invocation_context.h>
#  include <deal.II/sundials/sundials_handle.h>
 
#  include <sundials/sundials_linearsolver.h>
#  include <sundials/sundials_nvector.h>
 
#  include <exception>
#  include <functional>
#  include <memory>
 
#endif
 
DEAL_II_NAMESPACE_OPEN
 
#ifdef DEAL_II_WITH_SUNDIALS
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,
                     SUNATimesFn a_times_fn,
                     SUNContext  linsol_ctx);
#  else
    SundialsOperator(void *A_data, ATimesFn a_times_fn);
#  endif
 
  private:
    void *A_data;
 
#  if DEAL_II_SUNDIALS_VERSION_GTE(6, 0, 0)
    SUNATimesFn a_times_fn;
 
    SUNContext linsol_ctx;
#  else
    ATimesFn a_times_fn;
#  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,
                           SUNPSolveFn p_solve_fn,
                           SUNContext  linsol_ctx,
                           double      tol);
#  else
    SundialsPreconditioner(void *P_data, PSolveFn p_solve_fn, double tol);
#  endif
 
  private:
    void *P_data;
 
#  if DEAL_II_SUNDIALS_VERSION_GTE(6, 0, 0)
    SUNPSolveFn p_solve_fn;
 
    SUNContext linsol_ctx;
#  else
    PSolveFn p_solve_fn;
#  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();
 
      LinearSolverWrapper(const LinearSolverWrapper &) = delete;
      LinearSolverWrapper &
      operator=(const LinearSolverWrapper &) = delete;
 
      LinearSolverWrapper(LinearSolverWrapper &&other) noexcept;
      LinearSolverWrapper &
      operator=(LinearSolverWrapper &&other) noexcept;
 
      operator SUNLinearSolver() const;
 
    private:
      SUNLinearSolver                                  sun_linear_solver;
      std::unique_ptr<LinearSolverContent<VectorType>> content;
    };
 
 
 
    struct SundialsLinearSolverTraits
    {
      using Handle = SUNLinearSolver;
 
      static void
      free(Handle solver)
      {
        SUNLinSolFree(solver);
      }
    };
 
    using SundialsLinearSolver = SundialsHandle<SundialsLinearSolverTraits>;
 
    SundialsLinearSolver
    make_spgmr_linear_solver(N_Vector                 y_template,
                             const InvocationContext &inv_ctx);
  } // namespace internal
} // namespace SUNDIALS
 
#endif
 
DEAL_II_NAMESPACE_CLOSE
#endif