Making it possible to compile without Embree enabled

CMakeLists.txt

@@ -111,31 +111,30 @@ if (XDG_ENABLE_GPRT)
 endif()
 
 list(APPEND xdg_sources
-src/geometry/measure.cpp
-src/geometry/plucker.cpp
-src/geometry/closest.cpp
-src/error.cpp
-src/mesh_manager_interface.cpp
-src/ray_tracing_interface.cpp
-src/triangle_intersect.cpp
-src/util/str_utils.cpp
-src/tetrahedron_contain.cpp
-src/config.cpp
-src/xdg.cpp
-src/overlap_check/overlap.cpp
-src/element_face_accessor.cpp
-src/xdg.cpp
+  src/geometry/measure.cpp
+  src/geometry/plucker.cpp
+  src/geometry/closest.cpp
+  src/error.cpp
+  src/mesh_manager_interface.cpp
+  src/ray_tracing_interface.cpp
+  src/util/str_utils.cpp
+  src/overlap_check/overlap.cpp
+  src/element_face_accessor.cpp
+  src/config.cpp
+  src/xdg.cpp
 )
 
 if (XDG_ENABLE_EMBREE)
 list(APPEND xdg_sources
-src/embree/ray_tracer.cpp
+  src/embree/ray_tracer.cpp
+  src/embree/triangle_intersect.cpp
+  src/embree/tetrahedron_contain.cpp
 )
 endif()
 
 if (XDG_ENABLE_GPRT)
 list(APPEND xdg_sources
-src/gprt/ray_tracer.cpp
+  src/gprt/ray_tracer.cpp
 )
 list(APPEND xdg_device_codes
 dbl_deviceCode
@@ -145,16 +144,15 @@ endif()
 
 if (XDG_ENABLE_LIBMESH)
 list(APPEND xdg_sources
-src/libmesh/mesh_manager.cpp
+  src/libmesh/mesh_manager.cpp
 )
 endif()
 
 if (XDG_ENABLE_MOAB)
 list(APPEND xdg_sources
-# MOAB
-src/moab/mesh_manager.cpp
-src/moab/direct_access.cpp
-src/moab/metadata.cpp
+  src/moab/mesh_manager.cpp
+  src/moab/direct_access.cpp
+  src/moab/metadata.cpp
 )
 endif()
 
@@ -190,6 +188,7 @@ endif()
 add_library(xdg SHARED ${xdg_sources})
 
 target_link_libraries(xdg indicators::indicators)
+target_link_libraries(xdg fmt::fmt)
 
 if(XDG_ENABLE_EMBREE)
   # pass precompile definition depending on embree version
@@ -250,7 +249,7 @@ endif()
 # ==========================
 
 if (XDG_ENABLE_EMBREE)
-  target_link_libraries(xdg embree fmt::fmt)
+  target_link_libraries(xdg embree)
 endif()
 
 if (XDG_ENABLE_GPRT)

include/xdg/embree/embree_interface.h

@@ -0,0 +1,10 @@
+
+#ifdef XDG_EMBREE4
+
+#include "xdg/embree/embree4.h"
+
+#elif defined(XDG_EMBREE3)
+
+#include "xdg/embree/embree3.h"
+
+#endif

include/xdg/primitive_ref.h → include/xdg/embree/primitive_ref.h

@@ -2,7 +2,7 @@
 #define _XDG_TRIANGLE_REF_H
 
 #include "xdg/constants.h"
-#include "xdg/embree_interface.h"
+#include "xdg/embree/embree_interface.h"
 #include "xdg/mesh_manager_interface.h"
 
 namespace xdg {

include/xdg/ray.h → include/xdg/embree/ray.h

@@ -8,8 +8,8 @@
 #include "xdg/vec3da.h"
 
 #include "xdg/constants.h"
-#include "xdg/embree_interface.h"
-#include "xdg/primitive_ref.h"
+#include "xdg/embree/embree_interface.h"
+#include "xdg/embree/primitive_ref.h"
 
 namespace xdg {
 

include/xdg/embree/ray_tracer.h

@@ -6,12 +6,12 @@
 #include <unordered_map>
 
 #include "xdg/constants.h"
-#include "xdg/embree_interface.h"
+#include "xdg/embree/embree_interface.h"
 #include "xdg/mesh_manager_interface.h"
-#include "xdg/primitive_ref.h"
-#include "xdg/geometry_data.h"
+#include "xdg/embree/primitive_ref.h"
+#include "xdg/embree/geometry_data.h"
 #include "xdg/ray_tracing_interface.h"
-#include "xdg/ray.h"
+#include "xdg/embree/ray.h"
 #include "xdg/error.h"
 
 namespace xdg {
@@ -21,6 +21,7 @@ class EmbreeRayTracer : public RayTracer {
 public:
   EmbreeRayTracer();
   ~EmbreeRayTracer();
+
   RTLibrary library() const override { return RTLibrary::EMBREE; }
 
   void init() override;

include/xdg/tetrahedron_contain.h → include/xdg/embree/tetrahedron_contain.h

@@ -2,6 +2,7 @@
 #define XDG_TETRAHEDRON_INTERSECT_H
 
 
+#include "xdg/embree/embree_interface.h"
 #include "xdg/vec3da.h"
 
 namespace xdg

include/xdg/gprt/ray_tracer.h

@@ -7,10 +7,7 @@
 
 #include "xdg/constants.h"
 #include "xdg/mesh_manager_interface.h"
-#include "xdg/primitive_ref.h"
-#include "xdg/geometry_data.h"
 #include "xdg/ray_tracing_interface.h"
-#include "xdg/ray.h"
 #include "xdg/error.h"
 #include "gprt/gprt.h"
 #include "shared_structs.h"

include/xdg/ray_tracing_interface.h

@@ -6,10 +6,7 @@
 #include <unordered_map>
 
 #include "xdg/constants.h"
-#include "xdg/embree_interface.h"
 #include "xdg/mesh_manager_interface.h"
-#include "xdg/primitive_ref.h"
-#include "xdg/geometry_data.h"
 
 namespace xdg
 {

include/xdg/xdg.h

@@ -115,8 +115,6 @@ Direction surface_normal(MeshID surface,
   }
 // Private methods
 private:
-  double _triangle_volume_contribution(const PrimitiveRef& triangle) const;
-  double _triangle_area_contribution(const PrimitiveRef& triangle) const;
 
 // Data members
   std::shared_ptr<RayTracer> ray_tracing_interface_ {nullptr};

src/embree/ray_tracer.cpp

@@ -1,8 +1,8 @@
 #include "xdg/embree/ray_tracer.h"
 #include "xdg/error.h"
-#include "xdg/geometry_data.h"
-#include "xdg/ray.h"
-#include "xdg/tetrahedron_contain.h"
+#include "xdg/embree/geometry_data.h"
+#include "xdg/embree/ray.h"
+#include "xdg/embree/tetrahedron_contain.h"
 
 
 namespace xdg {

src/tetrahedron_contain.cpp → src/embree/tetrahedron_contain.cpp

@@ -1,8 +1,8 @@
 #include "xdg/constants.h"
 #include "xdg/ray_tracing_interface.h"
-#include "xdg/ray.h"
+#include "xdg/embree/geometry_data.h"
+#include "xdg/embree/ray.h"
 #include "xdg/vec3da.h"
-
 #include "xdg/util/linalg.h"
 
 namespace xdg

src/triangle_intersect.cpp → src/embree/triangle_intersect.cpp

@@ -1,10 +1,10 @@
 #include <algorithm> // for find
 
 #include "xdg/geometry/closest.h"
-#include "xdg/primitive_ref.h"
-#include "xdg/geometry_data.h"
+#include "xdg/embree/primitive_ref.h"
+#include "xdg/embree/geometry_data.h"
 #include "xdg/geometry/plucker.h"
-#include "xdg/ray.h"
+#include "xdg/embree/ray.h"
 
 namespace xdg
 {

tests/CMakeLists.txt

@@ -14,14 +14,19 @@ test_point_in_volume
 test_normal
 test_measure
 test_no_geom
-test_ray_duals
 test_xdg_interface
-test_tet_containment
 test_tracks
-test_tet_intersection
 test_tally_segments
 )
 
+if (XDG_ENABLE_EMBREE)
+    list (APPEND TEST_NAMES 
+            test_ray_duals 
+            test_tet_containment 
+            test_tet_intersection
+         )
+endif()
+
 if (XDG_ENABLE_MOAB)
     list(APPEND TEST_NAMES test_moab)
 endif()

tests/test_bvh.cpp

@@ -1,11 +1,11 @@
 // for testing
 #include <catch2/catch_test_macros.hpp>
+#include <catch2/generators/catch_generators.hpp>
 
 // xdg includes
 #include "xdg/constants.h"
 #include "xdg/mesh_manager_interface.h"
-#include "xdg/embree/ray_tracer.h"
-
+#include "util.h"
 #include "mesh_mock.h"
 
 using namespace xdg;
@@ -19,30 +19,30 @@ TEST_CASE("Test Mesh BVH")
   REQUIRE(mm->num_surfaces() == 6);
   REQUIRE(mm->num_volume_faces(1) == 12);
 
-  std::shared_ptr<RayTracer> rti = std::make_shared<EmbreeRayTracer>();
-
-  std::unordered_map<MeshID, TreeID> volume_to_scene_map;
-  for (auto volume: mm->volumes()) {
-      auto [volume_tree, element_tree] = rti->register_volume(mm, volume);
-    volume_to_scene_map[volume]= volume_tree;
-  }
-
-  REQUIRE(rti->num_registered_trees() == 2);
-  REQUIRE(rti->num_registered_surface_trees() == 1);
-  REQUIRE(rti->num_registered_element_trees() == 1);
-
-  mm = std::make_shared<MeshMock>();
-  mm->init(); // this should do nothing
-
-  REQUIRE(mm->num_volumes() == 1);
-  REQUIRE(mm->num_surfaces() == 6);
-  REQUIRE(mm->num_volume_faces(1) == 12);
-
-  rti = std::make_shared<EmbreeRayTracer>();
-
-  volume_to_scene_map.clear();
-  for (auto volume: mm->volumes()) {
-    auto [volume_tree, element_tree] = rti->register_volume(mm, volume);
-    volume_to_scene_map[volume] = volume_tree;
+  // Generate one test run per enabled backend
+  auto rt_backend = GENERATE(RTLibrary::EMBREE, RTLibrary::GPRT);
+
+  DYNAMIC_SECTION(fmt::format("Backend = {}", rt_backend)) {
+    check_ray_tracer_supported(rt_backend); // skip if backend not enabled at configuration time
+    auto rti = create_raytracer(rt_backend);
+    REQUIRE(rti);
+
+    std::unordered_map<MeshID, TreeID> volume_to_scene_map;
+    for (auto volume: mm->volumes()) {
+        auto [volume_tree, element_tree] = rti->register_volume(mm, volume);
+      volume_to_scene_map[volume]= volume_tree;
+    }
+
+    // Different expectations for number of registered trees based on backend
+    // until GPRT supports volumetric element trees
+    if (rt_backend == RTLibrary::EMBREE) {
+      REQUIRE(rti->num_registered_trees() == 2);
+      REQUIRE(rti->num_registered_surface_trees() == 1);
+      REQUIRE(rti->num_registered_element_trees() == 1);
+    }
+    else if (rt_backend == RTLibrary::GPRT) {
+      REQUIRE(rti->num_registered_trees() == 1);
+      REQUIRE(rti->num_registered_surface_trees() == 1);
+    }
   }
 }

tests/test_closest.cpp

@@ -11,12 +11,13 @@
 // xdg test includes
 #include "mesh_mock.h"
 #include "util.h"
-#include "xdg/embree/ray_tracer.h"
 
 using namespace xdg;
 
 TEST_CASE("Test Mesh Mock")
 {
+  // skip this test if Embree is not enabled
+  check_ray_tracer_supported(RTLibrary::EMBREE);
   std::shared_ptr<MeshManager> mm = std::make_shared<MeshMock>();
   mm->init(); // this should do nothing, but its good practice to call it
   std::shared_ptr<XDG> xdg = std::make_shared<XDG>(mm);
@@ -178,7 +179,4 @@ TEST_CASE("Closest Point Unit Test")
   closest = closest_location_on_triangle(triangle, p);
   REQUIRE(closest.approx_eq(midpoint));
   REQUIRE_THAT((closest - p).length(), Catch::Matchers::WithinAbs(dist, 1e-6));
-
-
-
 }