cuboid3D.hpp

// This file is part of the ACTS project.
//
// Copyright (C) 2016 CERN for the benefit of the ACTS project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
#pragma once
 
// Project include(s)
#include "detray/definitions/algebra.hpp"
#include "detray/definitions/containers.hpp"
#include "detray/definitions/detail/qualifiers.hpp"
#include "detray/definitions/indexing.hpp"
#include "detray/definitions/math.hpp"
#include "detray/geometry/coordinates/cartesian3D.hpp"
#include "detray/geometry/detail/shape_utils.hpp"
 
// System include(s)
#include <limits>
#include <ostream>
#include <stdexcept>
#include <string_view>
 
namespace detray {

class cuboid3D {
 public:
  static constexpr std::string_view name = "cuboid3D";

  enum boundaries : unsigned int {
    e_min_x = 0u,
    e_min_y = 1u,
    e_min_z = 2u,
    e_max_x = 3u,
    e_max_y = 4u,
    e_max_z = 5u,
    e_size = 6u,
  };

  template <concepts::scalar scalar_t>
  using bounds_type = darray<scalar_t, boundaries::e_size>;

  template <concepts::algebra algebra_t>
  using local_frame_type = cartesian3D<algebra_t>;

  template <typename bool_t>
  using result_type = bool_t;

  static constexpr std::size_t dim{3u};

  template <concepts::scalar scalar_t, concepts::point point_t>
  DETRAY_HOST_DEVICE inline scalar_t min_dist_to_boundary(
      const bounds_type<scalar_t> &bounds, const point_t &loc_p) const {
    const scalar_t min_x_dist =
        math::min(math::fabs(loc_p[0] - bounds[e_min_x]),
                  math::fabs(bounds[e_max_x] - loc_p[0]));
    const scalar_t min_y_dist =
        math::min(math::fabs(loc_p[1] - bounds[e_min_y]),
                  math::fabs(bounds[e_max_y] - loc_p[1]));
    const scalar_t min_z_dist =
        math::min(math::fabs(loc_p[2] - bounds[e_min_z]),
                  math::fabs(bounds[e_max_z] - loc_p[2]));
 
    // Use the chord for the phi distance
    return math::min(math::min(min_x_dist, min_y_dist), min_z_dist);
  }

  template <concepts::algebra algebra_t>
  DETRAY_HOST_DEVICE constexpr result_type<dbool<algebra_t>> check_boundaries(
      const bounds_type<dscalar<algebra_t>> &bounds,
      const dtransform3D<algebra_t> &trf, const dpoint3D<algebra_t> &glob_p,
      const dscalar<algebra_t> tol =
          std::numeric_limits<dscalar<algebra_t>>::epsilon(),
      const dscalar<algebra_t> /*edge_tol*/ = 0.f) const {
    // Get the full local position
    const dpoint3D<algebra_t> loc_p =
        local_frame_type<algebra_t>::global_to_local(trf, glob_p, {});
 
    return check_boundaries(bounds, loc_p, tol);
  }

  template <concepts::scalar scalar_t, concepts::point3D point_t>
  DETRAY_HOST_DEVICE constexpr auto check_boundaries(
      const bounds_type<scalar_t> &bounds, const point_t &loc_p,
      const scalar_t tol = std::numeric_limits<scalar_t>::epsilon(),
      const scalar_t /*edge_tol*/ = 0.f) const {
    return ((bounds[e_min_x] - tol) <= loc_p[0] &&
            (bounds[e_min_y] - tol) <= loc_p[1] &&
            (bounds[e_min_x] - tol) <= loc_p[2] &&
            loc_p[0] <= (bounds[e_max_x] + tol) &&
            loc_p[1] <= (bounds[e_max_y] + tol) &&
            loc_p[2] <= (bounds[e_max_z] + tol));
  }


  template <concepts::scalar scalar_t>
  DETRAY_HOST_DEVICE constexpr scalar_t measure(
      const bounds_type<scalar_t> &bounds) const {
    return volume(bounds);
  }

  template <concepts::scalar scalar_t>
  DETRAY_HOST_DEVICE constexpr scalar_t volume(
      const bounds_type<scalar_t> &bounds) const {
    return (bounds[e_max_x] - bounds[e_min_x]) *
           (bounds[e_max_y] - bounds[e_min_y]) *
           (bounds[e_max_z] - bounds[e_min_z]);
  }

  template <concepts::scalar scalar_t>
  DETRAY_HOST_DEVICE constexpr bounds_type<scalar_t> merge(
      const bounds_type<scalar_t> &bounds,
      const bounds_type<scalar_t> &o_bounds) const {
    bounds_type<scalar_t> new_bounds{};
 
    new_bounds[e_min_x] = math::min(bounds[e_min_x], o_bounds[e_min_x]);
    new_bounds[e_min_y] = math::min(bounds[e_min_y], o_bounds[e_min_y]);
    new_bounds[e_min_z] = math::min(bounds[e_min_z], o_bounds[e_min_z]);
    new_bounds[e_max_x] = math::max(bounds[e_max_x], o_bounds[e_max_x]);
    new_bounds[e_max_y] = math::max(bounds[e_max_y], o_bounds[e_max_y]);
    new_bounds[e_max_z] = math::max(bounds[e_max_z], o_bounds[e_max_z]);
 
    return new_bounds;
  }

  template <concepts::algebra algebra_t>
  DETRAY_HOST_DEVICE inline darray<dscalar<algebra_t>, 6> local_min_bounds(
      const bounds_type<dscalar<algebra_t>> &bounds,
      const dscalar<algebra_t> env =
          std::numeric_limits<dscalar<algebra_t>>::epsilon()) const {
    assert(env > 0.f);
    bounds_type<dscalar<algebra_t>> o_bounds{bounds};
    for (unsigned int i{0}; i < 3u; ++i) {
      o_bounds[i] -= env;
      o_bounds[i + 3u] += env;
    }
    return o_bounds;
  }

  template <concepts::algebra algebra_t>
  DETRAY_HOST_DEVICE dpoint3D<algebra_t> centroid(
      const bounds_type<dscalar<algebra_t>> &bounds) const {
    return 0.5f * dpoint3D<algebra_t>{bounds[e_min_x] + bounds[e_max_x],
                                      bounds[e_min_y] + bounds[e_max_y],
                                      bounds[e_min_z] + bounds[e_max_z]};
  }

  template <concepts::algebra algebra_t>
  DETRAY_HOST dvector<dpoint3D<algebra_t>> vertices(
      const bounds_type<dscalar<algebra_t>> & /*unused*/,
      dindex /*unused*/) const {
    throw std::runtime_error(
        "Vertex generation for cuboids is not implemented");
    return {};
  }

  template <concepts::scalar scalar_t>
  DETRAY_HOST constexpr bool check_consistency(
      const bounds_type<scalar_t> &bounds, std::ostream &os) const {
    constexpr auto tol{10.f * std::numeric_limits<scalar_t>::epsilon()};
 
    if (bounds[e_min_x] >= bounds[e_max_x] ||
        math::fabs(bounds[e_min_x] - bounds[e_max_x]) < tol) {
      os << "DETRAY ERROR (HOST): Min x must be smaller than max x.";
      return false;
    }
    if (bounds[e_min_y] >= bounds[e_max_y] ||
        math::fabs(bounds[e_min_y] - bounds[e_max_y]) < tol) {
      os << "DETRAY ERROR (HOST): Min y must be smaller than max y.";
      return false;
    }
    if (bounds[e_min_z] >= bounds[e_max_z] ||
        math::fabs(bounds[e_min_z] - bounds[e_max_z]) < tol) {
      os << "DETRAY ERROR (HOST): Min z must be smaller than max z.";
      return false;
    }
 
    return true;
  }
};
 
}  // namespace detray