C and Fortran API for Interpolator

.github/workflows/cmake-test.yml

@@ -82,7 +82,9 @@ jobs:
       with:
         repo-name: 'omega_h'
         repo-path: 'SCOREC/omega_h'
-        repo-ref: 'scorec-v11.0.0'
+        # set this to a version number when the following issue is closed
+        # https://github.com/SCOREC/omega_h/issues/195
+        repo-ref: 'f1eae45f11a166b3f01e2dace233643711ec92be'
         cache: true
         options: '-DCMAKE_CXX_COMPILER=`which mpicxx`
                   -DCMAKE_C_COMPILER=`which mpicc`
@@ -98,7 +100,7 @@ jobs:
       with:
         repo-name: 'meshFields'
         repo-path: 'SCOREC/meshFields'
-        repo-ref: ''
+        repo-ref: 'b1482bbba288df210784b2345eae08e34faabdc4'
         cache: true
         options: '-DCMAKE_CXX_COMPILER=`which mpicxx`
                   -DCMAKE_C_COMPILER=`which mpicc`
@@ -220,16 +222,25 @@ jobs:
       run: ctest --test-dir ${{ runner.temp }}/build-pcms --output-on-failure
 
     - name: Print Test
+      if: always()
       run: cat ${{ runner.temp }}/build-pcms/Testing/Temporary/LastTest.log
 
     - name: Test PCMS Installation
       shell: bash
       run: |
         # Configure and build the test
         # it should only ask for pcms_DIR/ROOT to find all dependencies
+        ls ${{ runner.temp }}/build-pcms/install/lib/cmake/pcms
+        echo "-------- PCMS CONFIG -------------"
+        cat ${{ runner.temp }}/build-pcms/install/lib/cmake/pcms/pcms-config.cmake
+        echo "-------- PCMS TARGETS -------------"
+        cat ${{ runner.temp }}/build-pcms/install/lib/cmake/pcms/pcms-targets.cmake
+        echo "-------- PCMS INTERPOLATOR TARGETS -------------"
+        cat ${{ runner.temp }}/build-pcms/install/lib/cmake/pcms/pcms_interpolator-targets.cmake
+        export VERBOSE=1
         cmake \
           -B ${{github.workspace}}/examples/external-usage-example/build \
           -S ${{github.workspace}}/examples/external-usage-example/ \
           -Dpcms_DIR=${{ runner.temp }}/build-pcms/install/lib/cmake/pcms \
-
+          --debug-output
         cmake --build ${{github.workspace}}/examples/external-usage-example/build

config.cmake.in

@@ -3,6 +3,7 @@
 include(CMakeFindDependencyMacro)
 find_dependency(redev CONFIG HINTS @redev_DIR@)
 find_dependency(Kokkos CONFIG HINTS @Kokkos_DIR@)
+find_dependency(KokkosKernels CONFIG HINTS @KokkosKernels_DIR@)
 find_dependency(meshfields CONFIG HINTS @meshfields_DIR@)
 find_dependency(ADIOS2 CONFIG HINTS @ADIOS2_DIR@)
 find_dependency(MPI)
@@ -16,14 +17,20 @@ if(@PCMS_ENABLE_OMEGA_H@)
 endif()
 
 include("${CMAKE_CURRENT_LIST_DIR}/pcms_core-targets.cmake")
+include("${CMAKE_CURRENT_LIST_DIR}/pcms_interpolator-targets.cmake")
+
 if(@PCMS_ENABLE_C@)
+    include("${CMAKE_CURRENT_LIST_DIR}/pcms_capi_core-targets.cmake")
+    include("${CMAKE_CURRENT_LIST_DIR}/pcms_capi_interpolator-targets.cmake")
     include("${CMAKE_CURRENT_LIST_DIR}/pcms_capi-targets.cmake")
 endif()
+
 if(@PCMS_ENABLE_Fortran@)
+    include("${CMAKE_CURRENT_LIST_DIR}/pcms_fortranapi_core-targets.cmake")
+    include("${CMAKE_CURRENT_LIST_DIR}/pcms_fortranapi_interpolator-targets.cmake")
     include("${CMAKE_CURRENT_LIST_DIR}/pcms_fortranapi-targets.cmake")
 endif()
 
 include("${CMAKE_CURRENT_LIST_DIR}/pcms-targets.cmake")
-include("${CMAKE_CURRENT_LIST_DIR}/pcms_interpolator-targets.cmake")
 # must be called at the end of the config file
 check_required_components(pcms)

src/CMakeLists.txt

@@ -138,6 +138,7 @@ if(PCMS_ENABLE_Fortran)
 endif()
 
 add_subdirectory(pcms/interpolator)
+target_link_libraries(pcms_pcms INTERFACE pcms::interpolator)
 
 install(
   TARGETS pcms_pcms

src/pcms/capi/CMakeLists.txt

@@ -1,22 +1,45 @@
-add_library(pcms_capi client.cpp kokkos.cpp)
-add_library(pcms::capi ALIAS pcms_capi)
+add_library(pcms_capi_core client.cpp kokkos.cpp)
+add_library(pcms::capi::core ALIAS pcms_capi_core)
+
 target_link_libraries(
-  pcms_capi
+  pcms_capi_core
   PUBLIC MPI::MPI_C
   PRIVATE pcms::core)
 
 target_include_directories(
-  pcms_capi
+  pcms_capi_core
   PUBLIC "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/../..>" # this makes our
                                                                 # include path
                                                                 # pcms/capi
          "$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/pcms/capi>")
 
-set(CAPI_HEADERS ${CMAKE_CURRENT_SOURCE_DIR}/client.h
+set(CAPI_CORE_HEADERS ${CMAKE_CURRENT_SOURCE_DIR}/client.h
                  ${CMAKE_CURRENT_SOURCE_DIR}/kokkos.h)
 set_target_properties(
-  pcms_capi PROPERTIES PUBLIC_HEADER "${CAPI_HEADERS}" OUTPUT_NAME pcmscapi
-                       EXPORT_NAME capi)
+  pcms_capi_core PROPERTIES PUBLIC_HEADER "${CAPI_CORE_HEADERS}" OUTPUT_NAME pcmscapicore
+             EXPORT_NAME capi::core)
+
+add_library(pcms_capi_interpolator mesh.cpp interpolator.cpp kokkos.cpp)
+add_library(pcms::capi::interpolator ALIAS pcms_capi_interpolator)
+target_link_libraries(pcms_capi_interpolator PUBLIC MPI::MPI_C PRIVATE pcms::interpolator)
+target_include_directories(pcms_capi_interpolator
+        PUBLIC
+        "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/../..>" # this makes the module path cpms/capi
+        "$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/pcms/capi>")
+set(CAPI_INTERPOLATOR_HEADERS ${CMAKE_CURRENT_SOURCE_DIR}/interpolator.h
+                     ${CMAKE_CURRENT_SOURCE_DIR}/mesh.h)
+set_target_properties(pcms_capi_interpolator
+  PROPERTIES PUBLIC_HEADERS "${CAPI_INTERPOLATOR_HEADERS}"
+             OUTPUT_NAME pcmscapiinterpolator
+             EXPORT_NAME capi::interpolator)
+
+# high level interface target
+add_library(pcms_capi INTERFACE)
+add_library(pcms::capi ALIAS pcms_capi)
+set_target_properties(pcms_capi PROPERTIES EXPORT_NAME capi)
+# link capi libraries to a high level interface library
+target_link_libraries(pcms_capi INTERFACE pcms::capi::core)
+target_link_libraries(pcms_capi INTERFACE pcms::capi::interpolator)
 install(
   TARGETS pcms_capi
   EXPORT pcms_capi-targets
@@ -25,8 +48,37 @@ install(
   RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
   INCLUDES
   DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
-  PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/pcms/capi/)
+  PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/pcms)
 install(
   EXPORT pcms_capi-targets
   NAMESPACE pcms::
   DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/pcms)
+
+# library targets
+install(
+  TARGETS pcms_capi_core
+  EXPORT pcms_capi_core-targets
+  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+  ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+  RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+  INCLUDES
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+  PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/pcms/capi/)
+install(
+  EXPORT pcms_capi_core-targets
+  NAMESPACE pcms::
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/pcms)
+
+install(
+  TARGETS pcms_capi_interpolator
+  EXPORT pcms_capi_interpolator-targets
+  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+  ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+  RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+  INCLUDES
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+  PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/pcms/capi/)
+install(
+  EXPORT pcms_capi_interpolator-targets
+  NAMESPACE pcms::
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/pcms)

src/pcms/capi/interpolator.cpp

@@ -0,0 +1,134 @@
+//
+// Created by hasanm4 on 2/17/25.
+//
+#include <pcms/capi/kokkos.h>
+#include <pcms/capi/interpolator.h>
+#include <pcms/interpolator/interpolation_base.h>
+#include <Omega_h_file.hpp>
+#include <Omega_h_library.hpp>
+#include <Omega_h_mesh.hpp>
+#include <pcms/print.h>
+
+//[[nodiscard]]
+PcmsInterpolatorHandle pcms_create_interpolator(PcmsOmegaHMeshHandle oh_mesh,
+                                                double radius)
+{
+  auto* source_mesh = reinterpret_cast<Omega_h::Mesh*>(oh_mesh.mesh_handle);
+  auto* interpolator = new MLSMeshInterpolation(*source_mesh, radius);
+  return {reinterpret_cast<void*>(interpolator)};
+}
+
+PcmsInterpolatorHandle pcms_create_point_based_interpolator(
+  void* source_points, int source_points_size, void* target_points,
+  int target_points_size, double radius, int degree, int min_req_supports,
+  double lambda, double decay_factor)
+{
+
+  auto source_points_view = pcms::Rank1View<double, pcms::HostMemorySpace>(
+    reinterpret_cast<double*>(source_points), source_points_size);
+  auto target_points_view = pcms::Rank1View<double, pcms::HostMemorySpace>(
+    reinterpret_cast<double*>(target_points), target_points_size);
+  auto* interpolator = new MLSPointCloudInterpolation(
+    source_points_view, target_points_view, 2, radius, min_req_supports, degree,
+    true, lambda, decay_factor);
+  return {reinterpret_cast<void*>(interpolator)};
+}
+
+Omega_h::HostRead<Omega_h::Real> read_mesh_centroids(const char* mesh_filename,
+                                                     int& num_elements)
+{
+  auto fname = std::string(mesh_filename);
+  fname = fname.erase(fname.find_last_not_of(" \n\r\t") + 1);
+  pcms::printInfo("The interpolator got dg2 mesh file: %s\n", fname.c_str());
+  auto mesh_lib = Omega_h::Library(nullptr, nullptr, MPI_COMM_SELF);
+  auto mesh = Omega_h::binary::read(fname, mesh_lib.world());
+  auto elem_centroids = getCentroids(mesh);
+  num_elements = mesh.nelems();
+  OMEGA_H_CHECK_PRINTF(num_elements * 2 == elem_centroids.size(),
+                       "Mesh element centroids size does not match the number "
+                       "of elements %d != %d\n",
+                       num_elements * 2, elem_centroids.size());
+
+  pcms::printInfo("Number of element centroids: %d\n",
+                  elem_centroids.size() / 2);
+  OMEGA_H_CHECK_PRINTF(mesh.dim() == 2, "Mesh dimension is not 2D %d\n",
+                       mesh.dim());
+
+  return {elem_centroids};
+}
+
+void write_void_int_pointer(void* pointer, int value)
+{
+  if (pointer) {
+    int* dg2_elem_count_int = reinterpret_cast<int*>(pointer);
+    *dg2_elem_count_int = value;
+  } else {
+    pcms::printError("Error: NULL pointer provided to write integer value\n");
+  }
+}
+
+PcmsInterpolatorHandle pcms_create_degas2xgcnode_interpolator(
+  void* target_points, int target_points_size, const char* dg2_mesh_filename,
+  double radius, void* dg2_elem_count, int degree, int min_req_supports,
+  double lambda, double decay_factor)
+{
+  // same as above pcms_create_degas2xgc_interpolator but the target points are
+  // provided by the user this is useful when the corresponding xgc mesh is not
+  // available
+
+  int dg2_num_elems = 0;
+  Omega_h::HostRead<Omega_h::Real> dg2_elem_centroids_host =
+    read_mesh_centroids(dg2_mesh_filename, dg2_num_elems);
+  write_void_int_pointer(dg2_elem_count, dg2_num_elems);
+
+  return pcms_create_point_based_interpolator(
+    (void*)dg2_elem_centroids_host.data(), dg2_elem_centroids_host.size(),
+    target_points, target_points_size, radius, degree, min_req_supports, lambda,
+    decay_factor);
+}
+
+PcmsInterpolatorHandle pcms_create_xgcnodedegas2_interpolator(
+  const char* dg2_mesh_filename, void* source_points, int source_points_size,
+  double radius, void* dg2_elem_count, int degree, int min_req_supports,
+  double lambda, double decay_factor)
+{
+  int dg2_num_elems = 0;
+  Omega_h::HostRead<Omega_h::Real> dg2_elem_centroids_host =
+    read_mesh_centroids(dg2_mesh_filename, dg2_num_elems);
+  write_void_int_pointer(dg2_elem_count, dg2_num_elems);
+
+  return pcms_create_point_based_interpolator(
+    source_points, source_points_size, (void*)dg2_elem_centroids_host.data(),
+    dg2_elem_centroids_host.size(), radius, degree, min_req_supports, lambda,
+    decay_factor);
+}
+
+void pcms_destroy_interpolator(PcmsInterpolatorHandle interpolator)
+{
+  if (interpolator.pointer != nullptr) {
+    delete reinterpret_cast<InterpolationBase*>(interpolator.pointer);
+  }
+}
+
+void pcms_interpolate(PcmsInterpolatorHandle interpolator, void* input,
+                      int input_size, void* output, int output_size)
+{
+  auto* mls_interpolator =
+    reinterpret_cast<InterpolationBase*>(interpolator.pointer);
+
+  OMEGA_H_CHECK_PRINTF(
+    input_size == mls_interpolator->getSourceSize(),
+    "Input array size does not match the source size %d != %zu\n", input_size,
+    mls_interpolator->getSourceSize());
+  OMEGA_H_CHECK_PRINTF(
+    output_size == mls_interpolator->getTargetSize(),
+    "Output array size does not match the target size %d != %zu\n", output_size,
+    mls_interpolator->getTargetSize());
+
+  pcms::Rank1View<double, pcms::HostMemorySpace> input_array(
+    reinterpret_cast<double*>(input), input_size);
+  pcms::Rank1View<double, pcms::HostMemorySpace> output_array(
+    reinterpret_cast<double*>(output), output_size);
+
+  mls_interpolator->eval(input_array, output_array);
+}