navigator_base.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/detail/qualifiers.hpp"
#include "detray/definitions/indexing.hpp"
#include "detray/definitions/navigation.hpp"
#include "detray/definitions/units.hpp"
#include "detray/geometry/surface.hpp"
#include "detray/navigation/detail/intersection_kernel.hpp"
#include "detray/navigation/detail/navigation_functions.hpp"
#include "detray/navigation/intersection/intersection.hpp"
#include "detray/navigation/intersection/ray_intersector.hpp"
#include "detray/navigation/navigation_config.hpp"
#include "detray/navigation/navigation_state.hpp"
#include "detray/utils/logging.hpp"
 
namespace detray {

template <typename navigator_impl_t>
class navigator_base {
 public:
  template <typename track_t, typename nav_state_t, typename context_t>
  DETRAY_HOST_DEVICE constexpr void init(
      const track_t &track, nav_state_t &navigation,
      const navigation::config &cfg, const context_t &ctx,
      const bool resolve_overstepping = false) const {
    // Run local navigation in the current volume
    navigation::local_navigation(track, navigation, cfg, ctx,
                                 resolve_overstepping);
 
    DETRAY_VERBOSE_HOST("Status: " << navigation.status() << " (next sf.: "
                                   << navigation.next_surface().index() << ")");
    if (navigation.is_on_surface()) {
      DETRAY_VERBOSE_HOST("-> Current surface: "
                          << navigation.current_surface().index()
                          << ", has material: " << std::boolalpha
                          << navigation.current_surface().has_material()
                          << std::noboolalpha);
    }
    DETRAY_VERBOSE_HOST_DEVICE("Update complete: dist to next %f mm",
                               navigation());
  }

  template <typename track_t, typename nav_state_t, typename context_t>
  DETRAY_HOST_DEVICE DETRAY_INLINE constexpr bool update(
      const track_t &track, nav_state_t &navigation,
      const navigation::config &cfg, const context_t &ctx) const {
    assert(navigation.is_alive());
    assert(!track.is_invalid());
 
    // Update was completely successful (most likely case)
    if (navigation.trust_level() == navigation::trust_level::e_full) {
      DETRAY_VERBOSE_HOST_DEVICE(
          "-> Full trust, nothing left to do: dist to next %f mm",
          navigation());
      return false;
    }
 
    // Candidates are re-evaluated based on the current trust level.
    // Should result in 'full trust'
    constexpr const navigator_impl_t navigation_impl{};
    bool is_init = navigation_impl.update_impl(track, navigation, cfg, ctx);
 
    // Otherwise: if we encountered a portal, perform volume switch
    if (navigation.is_on_portal()) {
      navigation::volume_switch(track, navigation, cfg, ctx);
      is_init = true;
 
      // Reached end of detector
      if (!navigation.is_alive()) {
        return false;
      }
    }
    // If no trust could be restored during the update, try to rescue the
    // navigation stream by re-initializing with loose tolerances
    if (navigation.trust_level() != navigation::trust_level::e_full ||
        navigation.cache_exhausted()) {
      is_init = true;
      navigation::init_loose_cfg(track, navigation, cfg, ctx);
 
      navigation.run_inspector(cfg, track.pos(), track.dir(), "Re-init: ");
    }
 
    DETRAY_VERBOSE_HOST("Status: " << navigation.status() << " (vol.:"
                                   << navigation.volume() << ", next sf.: "
                                   << navigation.next_surface().index() << ")");
    if (navigation.is_on_surface()) {
      DETRAY_VERBOSE_HOST("-> Current surface: "
                          << navigation.current_surface().index()
                          << ", has material: " << std::boolalpha
                          << navigation.current_surface().has_material()
                          << std::noboolalpha);
    }
    DETRAY_VERBOSE_HOST_DEVICE("Update complete: dist to next %f mm",
                               navigation());
 
    return is_init;
  }
};
 
}  // namespace detray