n_vector.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_n_vector_h
#define dealii_sundials_n_vector_h
 
#include <deal.II/base/config.h>
 
#ifdef DEAL_II_WITH_SUNDIALS
#  include <sundials/sundials_nvector.h>
 
#  include <functional>
#  include <memory>
 
#endif
 
DEAL_II_NAMESPACE_OPEN
 
#ifdef DEAL_II_WITH_SUNDIALS
#  ifndef DOXYGEN
namespace SUNDIALS
{
  namespace internal
  {
    template <typename VectorType>
    class NVectorView;
  }
} // namespace SUNDIALS
#  endif
 
namespace SUNDIALS
{
  namespace internal
  {
#  if DEAL_II_SUNDIALS_VERSION_GTE(6, 0, 0)
    template <typename VectorType>
    NVectorView<VectorType>
    make_nvector_view(VectorType &vector, SUNContext nvector_context);
#  else
    template <typename VectorType>
    NVectorView<VectorType>
    make_nvector_view(VectorType &vector);
#  endif
 
    template <typename VectorType>
    VectorType *
    unwrap_nvector(N_Vector v);
 
    template <typename VectorType>
    const VectorType *
    unwrap_nvector_const(N_Vector v);
 
    template <typename VectorType>
    class NVectorView
    {
    public:
      NVectorView() = default;
 
#  if DEAL_II_SUNDIALS_VERSION_GTE(6, 0, 0)
      NVectorView(VectorType &vector, SUNContext nvector_context);
#  else
      NVectorView(VectorType &vector);
#  endif
 
      NVectorView(NVectorView &&) noexcept = default;
 
      NVectorView &
      operator=(NVectorView &&) noexcept = default;
 
      NVectorView(const NVectorView &) = delete;
 
      NVectorView &
      operator=(const NVectorView &) = delete;
 
      ~NVectorView() = default;
 
      operator N_Vector() const;
 
      N_Vector
      operator->() const;
 
    private:
      std::unique_ptr<_generic_N_Vector, std::function<void(N_Vector)>>
        vector_ptr;
    };
  } // namespace internal
} // namespace SUNDIALS
 
#endif
 
DEAL_II_NAMESPACE_CLOSE
#endif