access_traits.cc

Go to the documentation of this file.

// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2021 - 2025 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Part of the source code is dual licensed under Apache-2.0 WITH
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
// governing the source code and code contributions can be found in
// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
//
// ------------------------------------------------------------------------
 
#include <deal.II/arborx/access_traits.h>
 
#ifdef DEAL_II_WITH_ARBORX
 
DEAL_II_NAMESPACE_OPEN
 
namespace ArborXWrappers
{
#  if ARBORX_VERSION_MAJOR < 2
 
  namespace
  {
    template <int dim, typename Number>
    ::Point<3, float>
    to_3d_float_point(::Point<dim, Number> p)
    {
      static_assert(dim >= 1 && dim <= 3);
      if (dim == 1)
        return Point<3, float>(p[0], 0.f, 0.f);
      else if (dim == 2)
        return Point<3, float>(p[0], p[1], 0.f);
      else
        return Point<3, float>(p[0], p[1], p[2]);
    }
  } // namespace
 
  // ------------------- PointPredicate ------------------- //
  template <int dim, typename Number>
  PointPredicate::PointPredicate(
    const std::vector<::Point<dim, Number>> &dim_points)
  {
    const unsigned int size = dim_points.size();
    points.reserve(size);
    for (unsigned int i = 0; i < size; ++i)
      points.emplace_back(to_3d_float_point(dim_points[i]));
  }
 
 
 
  std::size_t
  PointPredicate::size() const
  {
    return points.size();
  }
 
 
 
  const ::Point<3, float> &
  PointPredicate::get(unsigned int i) const
  {
    return points[i];
  }
 
 
 
  template <int dim, typename Number>
  PointIntersectPredicate::PointIntersectPredicate(
    const std::vector<::Point<dim, Number>> &points)
    : PointPredicate(points)
  {}
 
 
 
  template <int dim, typename Number>
  PointNearestPredicate::PointNearestPredicate(
    const std::vector<::Point<dim, Number>> &points,
    const unsigned int                             n_nearest_neighbors)
    : PointPredicate(points)
    , n_nearest_neighbors(n_nearest_neighbors)
  {}
 
 
 
  unsigned int
  PointNearestPredicate::get_n_nearest_neighbors() const
  {
    return n_nearest_neighbors;
  }
 
  // ------------------- BoundingBoxPredicate ------------------- //
  template <int dim, typename Number>
  BoundingBoxPredicate::BoundingBoxPredicate(
    const std::vector<::BoundingBox<dim, Number>> &bb)
  {
    const unsigned int size = bb.size();
    bounding_boxes.reserve(size);
    ::Point<3, float> min_corner_arborx(0., 0., 0.);
    ::Point<3, float> max_corner_arborx(0., 0., 0.);
    for (unsigned int i = 0; i < size; ++i)
      {
        auto boundary_points                  = bb[i].get_boundary_points();
        ::Point<dim, Number> min_corner = boundary_points.first;
        ::Point<dim, Number> max_corner = boundary_points.second;
        for (unsigned int d = 0; d < dim; ++d)
          {
            min_corner_arborx[d] = static_cast<float>(min_corner[d]);
            max_corner_arborx[d] = static_cast<float>(max_corner[d]);
          }
        bounding_boxes.emplace_back(
          std::make_pair(min_corner_arborx, max_corner_arborx));
      }
  }
 
 
 
  std::size_t
  BoundingBoxPredicate::size() const
  {
    return bounding_boxes.size();
  }
 
 
 
  const ::BoundingBox<3, float> &
  BoundingBoxPredicate::get(unsigned int i) const
  {
    return bounding_boxes[i];
  }
 
 
 
  template <int dim, typename Number>
  BoundingBoxIntersectPredicate::BoundingBoxIntersectPredicate(
    const std::vector<::BoundingBox<dim, Number>> &bounding_boxes)
    : BoundingBoxPredicate(bounding_boxes)
  {}
 
 
 
  template <int dim, typename Number>
  BoundingBoxNearestPredicate::BoundingBoxNearestPredicate(
    const std::vector<::BoundingBox<dim, Number>> &bounding_boxes,
    const unsigned int                                   n_nearest_neighbors)
    : BoundingBoxPredicate(bounding_boxes)
    , n_nearest_neighbors(n_nearest_neighbors)
  {}
 
 
 
  unsigned int
  BoundingBoxNearestPredicate::get_n_nearest_neighbors() const
  {
    return n_nearest_neighbors;
  }
 
  // ------------------- SpherePredicate ------------------- //
  template <int dim, typename Number>
  SpherePredicate::SpherePredicate(
    const std::vector<std::pair<::Point<dim, Number>, Number>>
      &dim_spheres)
  {
    const unsigned int size = dim_spheres.size();
    spheres.reserve(size);
    for (unsigned int i = 0; i < size; ++i)
      {
        // ArborX assumes that the center coordinates and the radius use float
        // and the sphere is 3d
        spheres.emplace_back(to_3d_float_point(dim_spheres[i].first),
                             static_cast<float>(dim_spheres[i].second));
      }
  }
 
 
 
  std::size_t
  SpherePredicate::size() const
  {
    return spheres.size();
  }
 
 
 
  const std::pair<::Point<3, float>, float> &
  SpherePredicate::get(unsigned int i) const
  {
    return spheres[i];
  }
 
 
 
  template <int dim, typename Number>
  SphereIntersectPredicate::SphereIntersectPredicate(
    const std::vector<std::pair<::Point<dim, Number>, Number>> &spheres)
    : SpherePredicate(spheres)
  {}
 
 
 
  template <int dim, typename Number>
  SphereNearestPredicate::SphereNearestPredicate(
    const std::vector<std::pair<::Point<dim, Number>, Number>> &spheres,
    const unsigned int n_nearest_neighbors)
    : SpherePredicate(spheres)
    , n_nearest_neighbors(n_nearest_neighbors)
  {}
 
 
 
  unsigned int
  SphereNearestPredicate::get_n_nearest_neighbors() const
  {
    return n_nearest_neighbors;
  }
#  else
  template <int dim, typename Number>
  PointIntersectPredicate<dim, Number>::PointIntersectPredicate(
    const std::vector<::Point<dim, Number>> &points)
    : points(points)
  {}
 
 
 
  template <int dim, typename Number>
  std::size_t
  PointIntersectPredicate<dim, Number>::size() const
  {
    return points.size();
  }
 
 
 
  template <int dim, typename Number>
  const ::Point<dim, Number> &
  PointIntersectPredicate<dim, Number>::get(unsigned int i) const
  {
    return points[i];
  }
 
 
  template <int dim, typename Number>
  PointNearestPredicate<dim, Number>::PointNearestPredicate(
    const std::vector<::Point<dim, Number>> &points,
    const unsigned int                             n_nearest_neighbors)
    : points(points)
    , n_nearest_neighbors(n_nearest_neighbors)
  {}
 
 
 
  template <int dim, typename Number>
  unsigned int
  PointNearestPredicate<dim, Number>::get_n_nearest_neighbors() const
  {
    return n_nearest_neighbors;
  }
 
 
 
  template <int dim, typename Number>
  std::size_t
  PointNearestPredicate<dim, Number>::size() const
  {
    return points.size();
  }
 
 
 
  template <int dim, typename Number>
  const ::Point<dim, Number> &
  PointNearestPredicate<dim, Number>::get(unsigned int i) const
  {
    return points[i];
  }
 
 
  // ------------------- BoundingBoxPredicate ------------------- //
  template <int dim, typename Number>
  BoundingBoxIntersectPredicate<dim, Number>::BoundingBoxIntersectPredicate(
    const std::vector<::BoundingBox<dim, Number>> &bb)
    : bounding_boxes(bb)
  {}
 
 
 
  template <int dim, typename Number>
  std::size_t
  BoundingBoxIntersectPredicate<dim, Number>::size() const
  {
    return bounding_boxes.size();
  }
 
 
 
  template <int dim, typename Number>
  const ::BoundingBox<dim, Number> &
  BoundingBoxIntersectPredicate<dim, Number>::get(unsigned int i) const
  {
    return bounding_boxes[i];
  }
 
 
 
  template <int dim, typename Number>
  BoundingBoxNearestPredicate<dim, Number>::BoundingBoxNearestPredicate(
    const std::vector<::BoundingBox<dim, Number>> &bounding_boxes,
    const unsigned int                                   n_nearest_neighbors)
    : bounding_boxes(bounding_boxes)
    , n_nearest_neighbors(n_nearest_neighbors)
  {}
 
 
 
  template <int dim, typename Number>
  unsigned int
  BoundingBoxNearestPredicate<dim, Number>::get_n_nearest_neighbors() const
  {
    return n_nearest_neighbors;
  }
 
 
 
  template <int dim, typename Number>
  std::size_t
  BoundingBoxNearestPredicate<dim, Number>::size() const
  {
    return bounding_boxes.size();
  }
 
 
 
  template <int dim, typename Number>
  const ::BoundingBox<dim, Number> &
  BoundingBoxNearestPredicate<dim, Number>::get(unsigned int i) const
  {
    return bounding_boxes[i];
  }
 
  // ------------------- SpherePredicate ------------------- //
  template <int dim, typename Number>
  SphereIntersectPredicate<dim, Number>::SphereIntersectPredicate(
    const std::vector<std::pair<::Point<dim, Number>, Number>> &spheres)
    : spheres(spheres)
  {}
 
 
 
  template <int dim, typename Number>
  std::size_t
  SphereIntersectPredicate<dim, Number>::size() const
  {
    return spheres.size();
  }
 
 
 
  template <int dim, typename Number>
  const std::pair<::Point<dim, Number>, Number> &
  SphereIntersectPredicate<dim, Number>::get(unsigned int i) const
  {
    return spheres[i];
  }
 
 
 
  template <int dim, typename Number>
  SphereNearestPredicate<dim, Number>::SphereNearestPredicate(
    const std::vector<std::pair<::Point<dim, Number>, Number>> &spheres,
    const unsigned int n_nearest_neighbors)
    : spheres(spheres)
    , n_nearest_neighbors(n_nearest_neighbors)
  {}
 
 
 
  template <int dim, typename Number>
  unsigned int
  SphereNearestPredicate<dim, Number>::get_n_nearest_neighbors() const
  {
    return n_nearest_neighbors;
  }
 
 
 
  template <int dim, typename Number>
  std::size_t
  SphereNearestPredicate<dim, Number>::size() const
  {
    return spheres.size();
  }
 
 
 
  template <int dim, typename Number>
  const std::pair<::Point<dim, Number>, Number> &
  SphereNearestPredicate<dim, Number>::get(unsigned int i) const
  {
    return spheres[i];
  }
#  endif
} // namespace ArborXWrappers
 
 
DEAL_II_NAMESPACE_CLOSE
 
namespace ArborX
{
#  if ARBORX_VERSION_MAJOR < 2
  namespace
  {
    template <int dim, typename Number>
    Point
    to_arborx_point(::Point<dim, Number> p)
    {
      static_assert(dim >= 1 && dim <= 3);
      if (dim == 1)
        return {float(p[0]), 0.f, 0.f};
      else if (dim == 2)
        return {float(p[0]), float(p[1]), 0.f};
      else
        return {float(p[0]), float(p[1]), float(p[2])};
    }
  } // namespace
 
 
 
  // ------------------- Point Primitives AccessTraits ------------------- //
  template <int dim, typename Number>
  std::size_t
  AccessTraits<std::vector<::Point<dim, Number>>, PrimitivesTag>::size(
    const std::vector<::Point<dim, Number>> &v)
  {
    return v.size();
  }
 
 
 
  template <int dim, typename Number>
  Point
  AccessTraits<std::vector<::Point<dim, Number>>, PrimitivesTag>::get(
    const std::vector<::Point<dim, Number>> &v,
    std::size_t                                    i)
  {
    // ArborX assumes that the point coordinates use float and that the point
    // is 3d
    return to_arborx_point(v[i]);
  }
 
 
 
  // ----------------- BoundingBox Primitives AccessTraits ----------------- //
  template <int dim, typename Number>
  std::size_t
  AccessTraits<std::vector<::BoundingBox<dim, Number>>, PrimitivesTag>::
    size(const std::vector<::BoundingBox<dim, Number>> &v)
  {
    return v.size();
  }
 
 
 
  template <int dim, typename Number>
  Box
  AccessTraits<std::vector<::BoundingBox<dim, Number>>, PrimitivesTag>::
    get(const std::vector<::BoundingBox<dim, Number>> &v, std::size_t i)
  {
    const auto boundary_points                  = v[i].get_boundary_points();
    const ::Point<dim, Number> min_corner = boundary_points.first;
    const ::Point<dim, Number> max_corner = boundary_points.second;
    // ArborX assumes that the bounding box coordinates use float and that the
    // bounding box is 3d
    return {to_arborx_point(min_corner), to_arborx_point(max_corner)};
  }
 
 
 
  // ---------------------- Sphere Primitives AccessTraits ----------------- //
  template <int dim, typename Number>
  std::size_t
  AccessTraits<std::vector<std::pair<::Point<dim, Number>, Number>>,
               PrimitivesTag>::
    size(const std::vector<std::pair<::Point<dim, Number>, Number>> &v)
  {
    return v.size();
  }
 
 
 
  template <int dim, typename Number>
  Sphere
  AccessTraits<std::vector<std::pair<::Point<dim, Number>, Number>>,
               PrimitivesTag>::
    get(const std::vector<std::pair<::Point<dim, Number>, Number>> &v,
        std::size_t                                                       i)
  {
    // ArborX assumes that the center coordinates and the radius use float and
    // the sphere is 3d
    return {to_arborx_point(v[i].first), static_cast<float>(v[i].second)};
  }
 
#  else
  template <typename T>
  std::size_t
  AccessTraits<
    std::vector<T>,
    std::enable_if_t<
      std::is_same_v<T, ::Point<T::dimension, float>> ||
      std::is_same_v<T, ::Point<T::dimension, double>> ||
      std::is_same_v<T, ::BoundingBox<T::dimension, float>> ||
      std::is_same_v<T, ::BoundingBox<T::dimension, double>> ||
      std::is_same_v<T, std::pair<::Point<T::dimension, float>, float>> ||
      std::is_same_v<T,
                     std::pair<::Point<T::dimension, double>, double>>>>::
    size(const std::vector<T> &v)
  {
    return v.size();
  }
 
 
 
  template <typename T>
  T
  AccessTraits<
    std::vector<T>,
    std::enable_if_t<
      std::is_same_v<T, ::Point<T::dimension, float>> ||
      std::is_same_v<T, ::Point<T::dimension, double>> ||
      std::is_same_v<T, ::BoundingBox<T::dimension, float>> ||
      std::is_same_v<T, ::BoundingBox<T::dimension, double>> ||
      std::is_same_v<T, std::pair<::Point<T::dimension, float>, float>> ||
      std::is_same_v<T,
                     std::pair<::Point<T::dimension, double>, double>>>>::
    get(const std::vector<T> &v, std::size_t i)
  {
    return v[i];
  }
#  endif
} // namespace ArborX
 
// ----------------------- Instantiations --------------------//
#  include "arborx/access_traits.inst"
 
#endif