move common functionality to a utility library

This reorganization will help decouple components. For example, the vmec field needs to use interpolation. With the utility libraries moved to a lower level, we can avoid a circular dependency between pcms::core pcms::interpolator. That is, pcms::core can utilize pcms::interpolator. This is really the first step in a broader re-organization of the pcms::sources to be more modular.

Author: jacobmerson

config.cmake.in

@@ -16,6 +16,7 @@ if(@PCMS_ENABLE_OMEGA_H@)
     find_dependency(Omega_h CONFIG HINTS @Omega_h_DIR@)
 endif()
 
+include("${CMAKE_CURRENT_LIST_DIR}/pcms_utility-targets.cmake")
 include("${CMAKE_CURRENT_LIST_DIR}/pcms_core-targets.cmake")
 include("${CMAKE_CURRENT_LIST_DIR}/pcms_interpolator-targets.cmake")
 

examples/external-usage-example/main.cpp

@@ -1,5 +1,5 @@
 #include <iostream>
-#include <pcms/print.h>
+#include <pcms/utility/print.h>
 
 int main()
 {

src/CMakeLists.txt

@@ -2,10 +2,7 @@
 set(
   PCMS_HEADERS
   pcms.h
-  pcms/arrays.h
-  pcms/assert.h
   pcms/bounding_box.h
-  pcms/common.h
   pcms/coordinate.h
   pcms/coordinate_systems.h
   pcms/coordinate_transform.h
@@ -14,12 +11,6 @@ set(
   pcms/field_communicator.h
   pcms/field_communicator2.h
   pcms/field_evaluation_methods.h
-  pcms/memory_spaces.h
-  pcms/types.h
-  pcms/array_mask.h
-  pcms/inclusive_scan.h
-  pcms/profile.h
-  pcms/print.h
   pcms/partition.h
   pcms/coupler.h
   pcms/coordinate_system.h
@@ -33,8 +24,6 @@ set(
 set(
   PCMS_SOURCES
   pcms.cpp
-  pcms/assert.cpp
-  pcms/print.cpp
   pcms/create_field.cpp
   pcms/adapter/xgc/xgc_field_adapter.h
   pcms/adapter/point_cloud/point_cloud_layout.cpp
@@ -48,6 +37,8 @@ configure_file(pcms/version.h.in pcms/version.h)
 configure_file(pcms/configuration.h.in pcms/configuration.h)
 list(APPEND PCMS_HEADERS ${CMAKE_CURRENT_BINARY_DIR}/pcms/version.h ${CMAKE_CURRENT_BINARY_DIR}/pcms/configuration.h)
 
+add_subdirectory(pcms/utility)
+
 
 if(PCMS_ENABLE_XGC)
   list(APPEND PCMS_SOURCES pcms/adapter/xgc/xgc_reverse_classification.cpp)
@@ -78,7 +69,7 @@ add_library(pcms::core ALIAS pcms_core)
 target_compile_features(pcms_core PUBLIC cxx_std_17)
 target_link_libraries(
   pcms_core PUBLIC meshfields::meshfields redev::redev
-  MPI::MPI_CXX Kokkos::kokkos perfstubs
+  MPI::MPI_CXX Kokkos::kokkos perfstubs pcms::utility
 )
 if(PCMS_ENABLE_OMEGA_H)
   target_link_libraries(pcms_core PUBLIC Omega_h::omega_h)
@@ -91,10 +82,6 @@ if(PCMS_HAS_ASAN)
   )
 endif()
 
-if(PCMS_ENABLE_SPDLOG)
-  target_link_libraries(pcms_core PUBLIC spdlog::spdlog)
-endif()
-
 # export the library
 set_target_properties(pcms_core PROPERTIES PUBLIC_HEADER "${PCMS_HEADERS}")
 target_include_directories(

src/pcms.cpp

@@ -1,5 +1,5 @@
 #include "pcms.h"
-#include "pcms/types.h"
+#include "pcms/utility/types.h"
 
 namespace pcms
 {

src/pcms.h

@@ -2,10 +2,10 @@
 #define PCMS_H_
 
 #include "pcms/configuration.h"
-#include "pcms/common.h"
+#include "pcms/utility/common.h"
+#include "pcms/utility/profile.h"
 #include "pcms/field_communicator.h"
 #include "pcms/adapter/omega_h/omega_h_field.h"
-#include "pcms/profile.h"
 #include "pcms/coupler.h"
 
 #endif

src/pcms/adapter/omega_h/omega_h_field.h

@@ -1,21 +1,21 @@
 #ifndef PCMS_COUPLING_OMEGA_H_FIELD_H
 #define PCMS_COUPLING_OMEGA_H_FIELD_H
-#include "pcms/types.h"
+#include "pcms/utility/types.h"
 #include <Omega_h_mesh.hpp>
 #include "pcms/field.h"
 #include "pcms/coordinate_systems.h"
 #include <Kokkos_Core.hpp>
 #include <array>
-#include <pcms/assert.h>
+#include <pcms/utility/assert.h>
 #include <Omega_h_for.hpp>
-#include "pcms/arrays.h"
-#include "pcms/array_mask.h"
+#include "pcms/utility/arrays.h"
+#include "pcms/utility/array_mask.h"
 #include "pcms/point_search.h"
 #include <redev_variant_tools.h>
 #include <type_traits>
 #include "pcms/transfer_field.h"
-#include "pcms/memory_spaces.h"
-#include "pcms/profile.h"
+#include "pcms/utility/memory_spaces.h"
+#include "pcms/utility/profile.h"
 #include "pcms/partition.h"
 #include <optional>
 

src/pcms/adapter/omega_h/omega_h_field2.h

@@ -6,7 +6,7 @@
 #include <memory>
 
 #include "pcms/adapter/omega_h/omega_h_field_layout.h"
-#include "pcms/types.h"
+#include "pcms/utility/types.h"
 #include "pcms/field.h"
 #include "pcms/coordinate_system.h"
 #include "pcms/point_search.h"

src/pcms/adapter/omega_h/omega_h_field_layout.cpp

@@ -2,8 +2,8 @@
 #include "omega_h_field2.h"
 #include "pcms/adapter/omega_h/omega_h_field_layout.h"
 #include "omega_h_field_layout.h"
-#include "pcms/inclusive_scan.h"
-#include "pcms/profile.h"
+#include "pcms/utility/inclusive_scan.h"
+#include "pcms/utility/profile.h"
 #include <memory>
 
 namespace pcms

src/pcms/adapter/omega_h/omega_h_field_layout.h

@@ -3,7 +3,7 @@
 
 #include <Omega_h_mesh.hpp>
 
-#include "pcms/arrays.h"
+#include "pcms/utility/arrays.h"
 #include "pcms/field_layout.h"
 #include "pcms/coordinate_system.h"
 #include "pcms/field.h"

src/pcms/adapter/point_cloud/point_cloud.cpp

@@ -1,6 +1,6 @@
 #include "point_cloud.h"
-#include "pcms/profile.h"
-#include "pcms/assert.h"
+#include "pcms/utility/profile.h"
+#include "pcms/utility/assert.h"
 
 namespace pcms
 {