sundials_handle.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) 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_sundials_handle_h
#define dealii_sundials_sundials_handle_h
 
#include <deal.II/base/config.h>
 
#ifdef DEAL_II_WITH_SUNDIALS
 
#  include <deal.II/base/exceptions.h>
 
#  ifdef DEAL_II_HAVE_CXX20
#    include <concepts>
#  endif
#  include <utility>
 
#endif
 
DEAL_II_NAMESPACE_OPEN
 
#ifdef DEAL_II_WITH_SUNDIALS
namespace SUNDIALS
{
  namespace internal
  {
#  if defined(DEAL_II_HAVE_CXX20)
    template <typename T>
    concept SundialsTraits = requires(typename T::Handle h) {
      {
        T::free(h)
      } -> std::same_as<void>;
    };
#  endif
 
    template <typename Traits>
    DEAL_II_CXX20_REQUIRES(SundialsTraits<Traits>)
    class SundialsHandle
    {
    public:
      using Handle = typename Traits::Handle;
 
      explicit SundialsHandle(Handle handle)
        : handle(handle)
      {
        AssertThrow(handle != nullptr,
                    ExcMessage("SUNDIALS failed to create an object."));
      }
 
      ~SundialsHandle()
      {
        reset();
      }
 
      SundialsHandle(const SundialsHandle &) = delete;
      SundialsHandle &
      operator=(const SundialsHandle &) = delete;
 
      SundialsHandle(SundialsHandle &&other) noexcept
        : handle(std::exchange(other.handle, nullptr))
      {}
 
      SundialsHandle &
      operator=(SundialsHandle &&other) noexcept
      {
        if (this != &other)
          {
            reset();
            handle = std::exchange(other.handle, nullptr);
          }
        return *this;
      }
 
      operator Handle() const
      {
        return handle;
      }
 
    private:
      void
      reset() noexcept
      {
        if (handle != nullptr)
          {
            Traits::free(handle);
            handle = nullptr;
          }
      }
 
      Handle handle;
    };
  } // namespace internal
} // namespace SUNDIALS
#endif
 
DEAL_II_NAMESPACE_CLOSE
#endif