Merge pull request #225 from ExCALIBUR-NEPTUNE/stp/cmake_refactor_to_…

…merge cmake refactor
ExCALIBUR-NEPTUNE · Apr 17, 2024 · b411422 · b411422
2 parents 4ef5077 + 4b5e41f
commit b411422
Show file tree

Hide file tree

Showing 18 changed files with 144 additions and 91 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
-build
+build*/
 bin
 lib
 thirdparty/
@@ -37,3 +37,7 @@ example-runs
 **/*_xml/
 **/*.chk
 **/*.btr
+
+#compile commands
+compile_commands.json
+.cache
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.21)
+cmake_minimum_required(VERSION 3.24)
 
 project(
   NESO
@@ -16,23 +16,33 @@ option(ENABLE_NESO_TESTS
 include(cmake/Sanitizers.cmake)
 include(cmake/CheckFileList.cmake)
 
+
+
 # ##############################################################################
 # Find dependencies
 # ##############################################################################
-find_package(SYCL REQUIRED)
-if(SYCL_FOUND)
-  message(STATUS "Using SYCL implementation ${SYCL_IMPLEMENTATION}")
-  if(hipSYCL_FOUND)
-    set(HIPSYCL_TARGETS "omp")
-    set(SYCL_FLAG NESO_HIPSYCL)
-  elseif(SYCL_IMPLEMENTATION STREQUAL "IntelDPCPP")
-    set(SYCL_FLAG NESO_DPCPP)
-  endif()
-endif()
 
-# Use a custom FindNektar++ script to provide an interface target
+#USE -DNESO_SYCL_VENDOR to chose implementation at gen time
+set(NESO_SYCL_VENDOR "Default" CACHE STRING "SYCL vendor to look for - required
+if present")
+set(NESO_SYCL_VERSION "" CACHE STRING "SYCL version to look for")
+include(cmake/SYCL.cmake)
+if (NESO_SYCL_VENDOR MATCHES "Default")
+    find_sycl()
+else()
+    find_sycl(${NESO_SYCL_VENDOR} ${NESO_SYCL_VERSION})
+endif()
+#
+# Use a custom FindNektar++ script to vide an interface target
 find_package(Nektar++ REQUIRED)
 
+#Add the NESO-Particles dependencies
+find_package(NESO-Particles REQUIRED)
+#Alternativly just use as submodule
+#option(ENABLE_NESO_PARTICLES_TESTS OFF)
+#add_subdirectory(neso-particles)
+#include(neso-particles/cmake/restrict-keyword.cmake)
+
 find_package(FFT REQUIRED)
 if(FFT_FOUND)
   message(STATUS "USING FFT implementation ${FFT_IMPLEMENTATION}")
@@ -229,7 +239,10 @@ target_compile_options(${NESO_LIBRARY_NAME} PRIVATE ${BUILD_TYPE_COMPILE_FLAGS})
 target_link_options(${NESO_LIBRARY_NAME} PUBLIC ${BUILD_TYPE_LINK_FLAGS})
 target_link_libraries(
   ${NESO_LIBRARY_NAME}
-  PUBLIC Nektar++::nektar++ fft::fft
+  PUBLIC 
+     Nektar++::nektar++ 
+     fft::fft
+     NESO-Particles::NESO-Particles
   PRIVATE ${TEST_LIBRARIES})
 add_sycl_to_target(TARGET ${NESO_LIBRARY_NAME} SOURCES ${LIB_SRC_FILES})
 
@@ -249,12 +262,7 @@ add_sycl_to_target(TARGET ${PROJECT_NAME} SOURCES ${MAIN_SRC})
 
 # find MPI
 find_package(MPI REQUIRED)
-# Add the NESO-Particles dependencies
-find_package(NESO-PARTICLES REQUIRED)
 
-target_link_libraries(${NESO_LIBRARY_NAME} PUBLIC ${NESO_PARTICLES_LIBRARIES})
-target_include_directories(${NESO_LIBRARY_NAME}
-                           PUBLIC ${NESO_PARTICLES_INCLUDE_PATH})
 
 # Solvers
 add_subdirectory(solvers)
@@ -306,8 +314,8 @@ install(
     ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}_cmake/NESOConfigVersion.cmake
     ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}_cmake/NESOConfig.cmake
     ${CMAKE_CURRENT_SOURCE_DIR}/cmake/FindFFT.cmake
-    ${CMAKE_CURRENT_SOURCE_DIR}/cmake/FindSYCL.cmake
     ${CMAKE_CURRENT_SOURCE_DIR}/cmake/FindNektar++.cmake
+    ${CMAKE_CURRENT_SOURCE_DIR}/cmake/SYCL.cmake
   DESTINATION ${INSTALL_CONFIGDIR})
 
 # ##############################################################################

diff --git a/NESO-Spack b/NESO-Spack
diff --git a/cmake/FindSYCL.cmake b/cmake/FindSYCL.cmake
diff --git a/cmake/NESOConfig.cmake.in b/cmake/NESOConfig.cmake.in
@@ -1,8 +1,10 @@
 get_filename_component(NESO_CMAKE_DIR "${CMAKE_CURRENT_LIST_FILE}" PATH)
 include(CMakeFindDependencyMacro)
 
+include("${NESO_CMAKE_DIR}/SYCL.cmake")
+find_sycl_if_required()
+
 list(APPEND CMAKE_MODULE_PATH ${NESO_CMAKE_DIR})
-find_dependency(SYCL REQUIRED)
 find_dependency(Nektar++ REQUIRED)
 find_dependency(FFT REQUIRED)
 list(REMOVE_AT CMAKE_MODULE_PATH -1)
@@ -11,4 +13,4 @@ if(NOT TARGET NESO::@PROJECT_NAME@)
   include("${NESO_CMAKE_DIR}/@[email protected]")
 endif()
 
-set(NESO_LIBRARIES NESO::@LIBRARY_NAME@)
+set(NESO_LIBRARIES NESO::@NESO_LIBRARY_NAME@)
diff --git a/cmake/SYCL.cmake b/cmake/SYCL.cmake
@@ -0,0 +1,71 @@
+#Macro to find a sycl implimentation
+#Called without arguments will try to find a compiler appropriate sycl
+#With one argument finds that specific implimentation
+#With 2 arguments is as above but second argument is treated like version
+#Not happy with this yet - 
+# - should be able to accept lists of implementaions and versions
+# - and target architectures CPU,GPU etc
+macro(find_sycl)
+    set(SYCL_FOUND FALSE )
+    if (${ARGC} EQUAL 0)
+        #If intel compiler try to find the intel 
+        if (CMAKE_CXX_COMPILER_ID MATCHES "Intel")
+            #TODO IntelDPCPP is deprecated remove
+            list(APPEND candidates "IntelSYCL" "IntelDPCPP")
+            foreach(candidate IN LISTS candidates)
+                find_package(${candidate} QUIET)
+                if(${candidate}_FOUND)
+                    set(SYCL_FOUND TRUE )
+                    set(SYCL_IMPLEMENTATION ${candidate} )
+                    break()
+                endif()
+            endforeach()
+        else()
+            #not intel try one of these
+            list(APPEND candidates "AdaptiveCPP" "hipSYCL")
+            list(APPEND versions   ""            "0.9.4")
+            foreach(candidate version IN ZIP_LISTS candidates versions)
+                find_package(${candidate} ${version} QUIET)
+                if(${candidate}_FOUND)
+                    set(SYCL_FOUND TRUE )
+                    set(SYCL_IMPLEMENTATION ${candidate} )
+                    break()
+                endif()
+            endforeach()
+        endif()
+    elseif (${ARGC} EQUAL 1)
+        find_package(${ARGV0} REQUIRED)
+        if(${ARGV0}_FOUND)
+            set(SYCL_FOUND TRUE )
+            set(SYCL_IMPLEMENTATION ${ARGV0} )
+        endif()
+    elseif (${ARGC} EQUAL 2)
+        find_package(${ARGV0} ${ARGV1} REQUIRED)
+        if(${ARGV0}_FOUND)
+            set(SYCL_FOUND TRUE )
+            set(SYCL_IMPLEMENTATION ${ARGV0} )
+        endif()
+    endif()
+    if (NOT COMMAND add_sycl_to_target) 
+        function(add_sycl_to_target)
+        endfunction()
+    endif()
+    if (SYCL_FOUND) 
+        message(STATUS "Found SYCL implimentation ${SYCL_IMPLEMENTATION}")
+    elseif()
+        message(WARNING "No SYCL implimentation found - "
+            "Proceeding on the assumption that the CXX compiler is a SYCL2020 compiler")
+    endif()
+endmacro()
+
+macro(find_sycl_if_required)
+    if (COMMAND add_sycl_to_target) 
+        #Not perfect method but if in a submodule dont want to use a different
+        #sycl
+        message(STATUS "add_sycl_to_target macro exists")
+    else()
+        message(STATUS "add_sycl_to_target macro NOT FOUND looking for SYCL implementation...")
+        find_sycl()
+    endif()
+endmacro()
+
diff --git a/include/nektar_interface/basis_evaluation.hpp b/include/nektar_interface/basis_evaluation.hpp
@@ -348,7 +348,7 @@ inline void mod_PyrC(const int nummodes, const REAL z, const int k_stride_n,
 
       REAL pn, pnm1, pnm2;
       const int alpha = 2 * p + 2 * q - 3;
-      int maxpq = max(p, q);
+      int maxpq = std::max(p, q);
 
       /*
        * The remaining terms are of the form

diff --git a/include/nektar_interface/geometry_transport/geometry_container_3d.hpp b/include/nektar_interface/geometry_transport/geometry_container_3d.hpp
@@ -8,7 +8,6 @@
 #include <iostream>
 #include <mpi.h>
 
-using namespace std;
 using namespace Nektar;
 using namespace Nektar::SpatialDomains;
 using namespace Nektar::LibUtilities;

diff --git a/include/nektar_interface/geometry_transport/geometry_transport_2d.hpp b/include/nektar_interface/geometry_transport/geometry_transport_2d.hpp
@@ -12,7 +12,6 @@
 
 #include "shape_mapping.hpp"
 
-using namespace std;
 using namespace Nektar;
 using namespace Nektar::SpatialDomains;
 

diff --git a/include/nektar_interface/geometry_transport/geometry_transport_3d.hpp b/include/nektar_interface/geometry_transport/geometry_transport_3d.hpp
@@ -8,7 +8,6 @@
 #include <iostream>
 #include <mpi.h>
 
-using namespace std;
 using namespace Nektar;
 using namespace Nektar::SpatialDomains;
 using namespace Nektar::LibUtilities;

diff --git a/include/nektar_interface/utility_mesh_plotting.hpp b/include/nektar_interface/utility_mesh_plotting.hpp
@@ -44,9 +44,9 @@ class VTKGeometryWriter {
    */
   inline void write(std::string filename) {
     // vertices required
-    std::map<int, shared_ptr<PointGeom>> vertices;
+    std::map<int, std::shared_ptr<PointGeom>> vertices;
     // edges required
-    std::map<int, shared_ptr<Geometry1D>> edges;
+    std::map<int, std::shared_ptr<Geometry1D>> edges;
 
     for (auto &geom : this->geoms) {
       const int num_edges = geom->GetNumEdges();

diff --git a/include/particle_utility/particle_initialisation_line.hpp b/include/particle_utility/particle_initialisation_line.hpp
@@ -98,7 +98,7 @@ class ParticleInitialisationLine {
     NESO::Particles::parallel_advection_initialisation(particle_group);
 
     auto particle_mesh_interface =
-        dynamic_pointer_cast<ParticleMeshInterface>(domain->mesh);
+        std::dynamic_pointer_cast<ParticleMeshInterface>(domain->mesh);
     // Setup map between cell indices
     auto cell_id_translation = std::make_shared<CellIDTranslation>(
         sycl_target, particle_group->cell_id_dat, particle_mesh_interface);

diff --git a/neso-particles b/neso-particles
diff --git a/solvers/Electrostatic2D3V/CMakeLists.txt b/solvers/Electrostatic2D3V/CMakeLists.txt
@@ -11,13 +11,15 @@ add_library(${ELECTROSTATIC_2D3V_LIBRARY_NAME} OBJECT
 
 target_include_directories(
   ${ELECTROSTATIC_2D3V_LIBRARY_NAME}
-  PRIVATE ${MPI_INCLUDE_PATH} ${CMAKE_SOURCE_DIR}/include
-          ${NESO_PARTICLES_INCLUDE_PATH})
+  PRIVATE ${CMAKE_SOURCE_DIR}/include)
+
 
 target_link_libraries(
   ${ELECTROSTATIC_2D3V_LIBRARY_NAME}
-  PRIVATE ${NESO_LIBRARY_NAME} Nektar++::nektar++ ${MPI_LIBRARIES}
-          ${NESO_PARTICLES_LIBRARIES} ${NESO_PARTICLES_LINK_FLAGS})
+  PRIVATE ${NESO_LIBRARY_NAME} 
+          Nektar++::nektar++ 
+          NESO-Particles::NESO-Particles 
+          MPI::MPI_CXX)
 
 # create the solver binary
 file(GLOB Electrostatic2D3VSource
@@ -27,14 +29,15 @@ add_executable(${EXEC_TARGET_NAME} ${Electrostatic2D3VSource})
 
 target_link_libraries(
   ${EXEC_TARGET_NAME}
-  PRIVATE ${ELECTROSTATIC_2D3V_LIBRARY_NAME} Nektar++::nektar++
-          ${MPI_LIBRARIES} ${NESO_PARTICLES_LIBRARIES})
+  PRIVATE ${ELECTROSTATIC_2D3V_LIBRARY_NAME} 
+  Nektar++::nektar++
+  MPI::MPI_CXX 
+  NESO-Particles::NESO-Particles)
 
-add_link_options(${EXEC_TARGET_NAME} PRIVATE ${NESO_PARTICLES_LINK_FLAGS})
 
 target_include_directories(
-  ${EXEC_TARGET_NAME} PRIVATE ${MPI_INCLUDE_PATH} ${CMAKE_SOURCE_DIR}/include
-                              ${NESO_PARTICLES_INCLUDE_PATH})
+    ${EXEC_TARGET_NAME} PRIVATE ${CMAKE_SOURCE_DIR}/include)
+
 
 add_sycl_to_target(TARGET ${EXEC_TARGET_NAME} SOURCES
                    ${Electrostatic2D3VSource})

diff --git a/solvers/H3LAPD/CMakeLists.txt b/solvers/H3LAPD/CMakeLists.txt
@@ -11,12 +11,13 @@ set(SOLVER_LIBS
     CACHE INTERNAL "")
 add_library(${LIBRARY_NAME} OBJECT ${H3LAPD_SRC_FILES})
 target_compile_options(${LIBRARY_NAME} PRIVATE ${BUILD_TYPE_COMPILE_FLAGS})
-target_link_libraries(${LIBRARY_NAME} PRIVATE Nektar++::nektar++)
+target_link_libraries(${LIBRARY_NAME} PRIVATE Nektar++::nektar++
+    NESO-Particles::NESO-Particles)
 # Top-level include dir for nektar-interface headers
 set(TOPLEVEL_INCLUDE_DIR "${INC_DIR}")
 target_include_directories(
   ${LIBRARY_NAME} PUBLIC ${CMAKE_CURRENT_LIST_DIR}
-                         ${NESO_PARTICLES_INCLUDE_PATH} ${TOPLEVEL_INCLUDE_DIR})
+                         ${TOPLEVEL_INCLUDE_DIR})
 
 add_sycl_to_target(TARGET ${LIBRARY_NAME} SOURCES ${H3LAPD_SRC_FILES})
 
@@ -31,8 +32,8 @@ target_compile_options(${EXEC_TARGET_NAME} PRIVATE ${BUILD_TYPE_COMPILE_FLAGS})
 # Linker options, target libs
 target_link_options(${EXEC_TARGET_NAME} PRIVATE ${BUILD_TYPE_LINK_FLAGS})
 target_link_libraries(
-  ${EXEC_TARGET_NAME} PRIVATE Nektar++::nektar++ ${NESO_PARTICLES_LIBRARIES}
-                              ${NESO_LIBRARY_NAME})
+    ${EXEC_TARGET_NAME} PRIVATE Nektar++::nektar++
+    NESO-Particles::NESO-Particles ${NESO_LIBRARY_NAME})
 
 add_sycl_to_target(TARGET ${EXEC_TARGET_NAME} SOURCES main.cpp)
 

diff --git a/solvers/SimpleSOL/CMakeLists.txt b/solvers/SimpleSOL/CMakeLists.txt
@@ -1,7 +1,10 @@
 # Identify source files
 set(SIMPLE_SOL_SRC_FILES
-    EquationSystems/SOLSystem.cpp EquationSystems/SOLWithParticlesSystem.cpp
-    Forcing/SourceTerms.cpp SimpleSOL.cpp)
+    EquationSystems/SOLSystem.cpp 
+    EquationSystems/SOLWithParticlesSystem.cpp
+    Forcing/SourceTerms.cpp 
+    SimpleSOL.cpp
+    )
 
 # ============================== Object library ===============================
 # Put solver specific source in an object library so that tests can use it
@@ -12,12 +15,13 @@ set(SOLVER_LIBS
 add_library(${LIBRARY_NAME} OBJECT ${SIMPLE_SOL_SRC_FILES})
 target_compile_options(${LIBRARY_NAME} PRIVATE ${BUILD_TYPE_COMPILE_FLAGS})
 target_link_libraries(${LIBRARY_NAME} PRIVATE Nektar++::nektar++
+                                              NESO-Particles::NESO-Particles
                                               ${NESO_LIBRARY_NAME})
 # Top-level include dir for nektar-interface headers
 set(TOPLEVEL_INCLUDE_DIR "${INC_DIR}")
 target_include_directories(
   ${LIBRARY_NAME} PUBLIC ${CMAKE_CURRENT_LIST_DIR}
-                         ${NESO_PARTICLES_INCLUDE_PATH} ${TOPLEVEL_INCLUDE_DIR})
+                          ${TOPLEVEL_INCLUDE_DIR})
 
 add_sycl_to_target(TARGET ${LIBRARY_NAME} SOURCES ${SIMPLE_SOL_SRC_FILES})
 
@@ -32,7 +36,7 @@ target_compile_options(${EXEC_TARGET_NAME} PRIVATE ${BUILD_TYPE_COMPILE_FLAGS})
 # Linker options, target libs
 target_link_options(${EXEC_TARGET_NAME} PRIVATE ${BUILD_TYPE_LINK_FLAGS})
 target_link_libraries(
-  ${EXEC_TARGET_NAME} PRIVATE Nektar++::nektar++ ${NESO_PARTICLES_LIBRARIES}
+    ${EXEC_TARGET_NAME} PRIVATE Nektar++::nektar++ NESO-Particles::NESO-Particles 
                               ${NESO_LIBRARY_NAME})
 
 add_sycl_to_target(TARGET ${EXEC_TARGET_NAME} SOURCES main.cpp)