[CMake] Provide out-of-source build (#768)

* [CMake] Provide out-of-source build

* remove unused code

* update those under tests

* prevent code duplication

* Clean dependency on PRISMS source directory

* installed to a single cmake folder, clean CMakeLists.txt

* fix application build after relocating cmake

* install LICENSE file

* format fix: white space

* fix application build

* bug fix

* bug fix2

* bug fix3

Author: jijn

CMakeLists.txt

@@ -90,19 +90,22 @@ message(STATUS "=========================================================")
 message(STATUS "")
 
 # Generate config.h to enable and disable certain features within the source code.
-set(PRISMS_PF_SOURCE_DIR ${CMAKE_SOURCE_DIR})
+set(PRISMS_PF_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}")
 
 if(ADDITIONAL_DEGREES)
   set(EXPAND_DEGREES "; 3; 4; 5; 6")
 endif()
 
 configure_file(
-  ${CMAKE_SOURCE_DIR}/include/prismspf/config.h.in
-  ${CMAKE_BINARY_DIR}/include/prismspf/config.h
+  ${CMAKE_CURRENT_SOURCE_DIR}/include/prismspf/config.h.in
+  ${CMAKE_CURRENT_BINARY_DIR}/include/prismspf/config.h
 )
 
 # Configure the template arguments file
-configure_file(${CMAKE_SOURCE_DIR}/cmake/templates.in ${CMAKE_BINARY_DIR}/cmake/templates)
+configure_file(
+  ${CMAKE_CURRENT_SOURCE_DIR}/cmake/templates.in
+  ${CMAKE_CURRENT_BINARY_DIR}/cmake/templates
+)
 
 # Add the script files
 add_subdirectory("${CMAKE_SOURCE_DIR}/cmake/scripts")
@@ -276,10 +279,9 @@ foreach(_build ${PRISMS_PF_BUILD_TYPES})
   target_include_directories(
     ${_library}
     PUBLIC
-      $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-      $<INSTALL_INTERFACE:include/prisms_pf>
-    PRIVATE
-      ${CMAKE_BINARY_DIR}/src
+      $<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}/include>
+      $<INSTALL_INTERFACE:include>
+    PRIVATE ${CMAKE_SOURCE_DIR}/src
   )
 
   target_compile_options(
@@ -337,14 +339,36 @@ install(
 
 # Install the headers
 install(
-  DIRECTORY
-    ${CMAKE_CURRENT_SOURCE_DIR}/include/
-  DESTINATION include/prisms_pf
+  DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/
+  DESTINATION include
   FILES_MATCHING
   PATTERN "*.h"
   PATTERN "*.hpp"
 )
 
+# Install the generated config.h
+install(
+  FILES ${CMAKE_CURRENT_BINARY_DIR}/include/prismspf/config.h
+  DESTINATION include/prismspf
+)
+
+# Install the cmake folder
+install(
+  DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/cmake/
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/prisms_pf
+  FILES_MATCHING
+  PATTERN "*.cmake"
+  PATTERN "*.cc"
+  PATTERN "CMakeLists.txt"
+  PATTERN "*.cmake.in" EXCLUDE
+)
+
+# Install the generated Config file
+install(
+  FILES ${CMAKE_CURRENT_BINARY_DIR}/cmake/prisms_pf-config.cmake
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/prisms_pf
+)
+
 # Install the CMake config files
 install(
   EXPORT prisms_pf-targets
@@ -353,9 +377,21 @@ install(
   DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/prisms_pf
 )
 
+# Install the VERSION file
+install(
+  FILES ${CMAKE_CURRENT_SOURCE_DIR}/VERSION
+  DESTINATION .
+)
+
+# Install the LICENSE file
+install(
+  FILES ${CMAKE_CURRENT_SOURCE_DIR}/LICENSE
+  DESTINATION .
+)
+
+# Install the cmake/template file
 install(
-  FILES
-    ${CMAKE_BINARY_DIR}/cmake/prisms_pf-config.cmake
+  FILES "${CMAKE_CURRENT_BINARY_DIR}/cmake/templates"
   DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/prisms_pf
 )
 
@@ -404,9 +440,9 @@ include(${CMAKE_SOURCE_DIR}/cmake/write_config.cmake)
 # Generate configuration file for applications
 include(CMakePackageConfigHelpers)
 configure_package_config_file(
-  ${CMAKE_SOURCE_DIR}/cmake/prisms_pf-config.cmake.in
-  ${CMAKE_BINARY_DIR}/cmake/prisms_pf-config.cmake
-  INSTALL_DESTINATION ${CMAKE_BINARY_DIR}/cmake
+  ${CMAKE_CURRENT_SOURCE_DIR}/cmake/prisms_pf-config.cmake.in
+  ${CMAKE_CURRENT_BINARY_DIR}/cmake/prisms_pf-config.cmake
+  INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/prisms_pf
 )
 
 # Unwrap the compiler compile_commands.json after the build

applications/MgNd_precipitate_single_Bppp/CMakeLists.txt

@@ -5,7 +5,7 @@
 cmake_minimum_required(VERSION 3.18)
 
 # Create a project for the application
-project(myapp CXX)
+project(myapp C CXX)
 
 # Find the PRISMS-PF package
 find_package(
@@ -17,10 +17,10 @@ find_package(
 )
 if(PRISMS_PF_FOUND)
   # Include setup script
-  include(${PRISMS_PF_CORE_DIR}/cmake/setup_application.cmake)
+  include(${PRISMS_PF_CMAKE_DIR}/setup_application.cmake)
 
   # Set up the application
-  prisms_pf_autopilot(${PRISMS_PF_CORE_DIR})
+  prisms_pf_autopilot(${PRISMS_PF_CMAKE_DIR})
 else()
   message(FATAL_ERROR "PRISMS-PF package not found. Please make sure it is in path.")
 endif()

applications/allen_cahn_explicit/CMakeLists.txt

@@ -5,7 +5,7 @@
 cmake_minimum_required(VERSION 3.18)
 
 # Create a project for the application
-project(myapp CXX)
+project(myapp C CXX)
 
 # Find the PRISMS-PF package
 find_package(
@@ -17,10 +17,11 @@ find_package(
 )
 if(PRISMS_PF_FOUND)
   # Include setup script
-  include(${PRISMS_PF_CORE_DIR}/cmake/setup_application.cmake)
+  include(${PRISMS_PF_CMAKE_DIR}/setup_application.cmake)
 
   # Set up the application
-  prisms_pf_autopilot(${PRISMS_PF_CORE_DIR})
+  prisms_pf_autopilot(${PRISMS_PF_CMAKE_DIR})
+
 else()
   message(FATAL_ERROR "PRISMS-PF package not found. Please make sure it is in path.")
 endif()

applications/alloy_solidification/CMakeLists.txt

@@ -5,7 +5,7 @@
 cmake_minimum_required(VERSION 3.18)
 
 # Create a project for the application
-project(myapp CXX)
+project(myapp C CXX)
 
 # Find the PRISMS-PF package
 find_package(
@@ -17,10 +17,27 @@ find_package(
 )
 if(PRISMS_PF_FOUND)
   # Include setup script
-  include(${PRISMS_PF_CORE_DIR}/cmake/setup_application.cmake)
+  include(${PRISMS_PF_CMAKE_DIR}/setup_application.cmake)
 
   # Set up the application
-  prisms_pf_autopilot(${PRISMS_PF_CORE_DIR})
+  prisms_pf_autopilot(${PRISMS_PF_CMAKE_DIR})
+
+  # put the binary in the source folder
+  if(TARGET main-debug)
+    set_target_properties(
+      main-debug
+      PROPERTIES
+      RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}
+    )
+  endif()
+
+  if(TARGET main-release)
+    set_target_properties(
+      main-release
+      PROPERTIES
+      RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}
+    )
+  endif()
 else()
   message(FATAL_ERROR "PRISMS-PF package not found. Please make sure it is in path.")
 endif()

applications/blank/CMakeLists.txt

@@ -5,7 +5,7 @@
 cmake_minimum_required(VERSION 3.18)
 
 # Create a project for the application
-project(myapp CXX)
+project(myapp C CXX)
 
 # Find the PRISMS-PF package
 find_package(
@@ -17,10 +17,10 @@ find_package(
 )
 if(PRISMS_PF_FOUND)
   # Include setup script
-  include(${PRISMS_PF_CORE_DIR}/cmake/setup_application.cmake)
+  include(${PRISMS_PF_CMAKE_DIR}/setup_application.cmake)
 
   # Set up the application
-  prisms_pf_autopilot(${PRISMS_PF_CORE_DIR})
+  prisms_pf_autopilot(${PRISMS_PF_CMAKE_DIR})
 else()
   message(FATAL_ERROR "PRISMS-PF package not found. Please make sure it is in path.")
 endif()

applications/cahn_hilliard_explicit/CMakeLists.txt

@@ -5,7 +5,7 @@
 cmake_minimum_required(VERSION 3.18)
 
 # Create a project for the application
-project(myapp CXX)
+project(myapp C CXX)
 
 # Find the PRISMS-PF package
 find_package(
@@ -17,10 +17,10 @@ find_package(
 )
 if(PRISMS_PF_FOUND)
   # Include setup script
-  include(${PRISMS_PF_CORE_DIR}/cmake/setup_application.cmake)
+  include(${PRISMS_PF_CMAKE_DIR}/setup_application.cmake)
 
   # Set up the application
-  prisms_pf_autopilot(${PRISMS_PF_CORE_DIR})
+  prisms_pf_autopilot(${PRISMS_PF_CMAKE_DIR})
 else()
   message(FATAL_ERROR "PRISMS-PF package not found. Please make sure it is in path.")
 endif()

applications/coupled_allen_cahn_cahn_hilliard/CMakeLists.txt

@@ -5,7 +5,7 @@
 cmake_minimum_required(VERSION 3.18)
 
 # Create a project for the application
-project(myapp CXX)
+project(myapp C CXX)
 
 # Find the PRISMS-PF package
 find_package(
@@ -17,10 +17,10 @@ find_package(
 )
 if(PRISMS_PF_FOUND)
   # Include setup script
-  include(${PRISMS_PF_CORE_DIR}/cmake/setup_application.cmake)
+  include(${PRISMS_PF_CMAKE_DIR}/setup_application.cmake)
 
   # Set up the application
-  prisms_pf_autopilot(${PRISMS_PF_CORE_DIR})
+  prisms_pf_autopilot(${PRISMS_PF_CMAKE_DIR})
 else()
   message(FATAL_ERROR "PRISMS-PF package not found. Please make sure it is in path.")
 endif()

applications/eshelby_inclusion/CMakeLists.txt

@@ -5,7 +5,7 @@
 cmake_minimum_required(VERSION 3.18)
 
 # Create a project for the application
-project(myapp CXX)
+project(myapp C CXX)
 
 # Find the PRISMS-PF package
 find_package(
@@ -17,10 +17,10 @@ find_package(
 )
 if(PRISMS_PF_FOUND)
   # Include setup script
-  include(${PRISMS_PF_CORE_DIR}/cmake/setup_application.cmake)
+  include(${PRISMS_PF_CMAKE_DIR}/setup_application.cmake)
 
   # Set up the application
-  prisms_pf_autopilot(${PRISMS_PF_CORE_DIR})
+  prisms_pf_autopilot(${PRISMS_PF_CMAKE_DIR})
 else()
   message(FATAL_ERROR "PRISMS-PF package not found. Please make sure it is in path.")
 endif()

applications/nucleation/CMakeLists.txt

@@ -5,7 +5,7 @@
 cmake_minimum_required(VERSION 3.18)
 
 # Create a project for the application
-project(myapp CXX)
+project(myapp C CXX)
 
 # Find the PRISMS-PF package
 find_package(
@@ -17,10 +17,10 @@ find_package(
 )
 if(PRISMS_PF_FOUND)
   # Include setup script
-  include(${PRISMS_PF_CORE_DIR}/cmake/setup_application.cmake)
+  include(${PRISMS_PF_CMAKE_DIR}/setup_application.cmake)
 
   # Set up the application
-  prisms_pf_autopilot(${PRISMS_PF_CORE_DIR})
+  prisms_pf_autopilot(${PRISMS_PF_CMAKE_DIR})
 else()
   message(FATAL_ERROR "PRISMS-PF package not found. Please make sure it is in path.")
 endif()

applications/precipitate_evolution/CMakeLists.txt

@@ -5,7 +5,7 @@
 cmake_minimum_required(VERSION 3.18)
 
 # Create a project for the application
-project(myapp CXX)
+project(myapp C CXX)
 
 # Find the PRISMS-PF package
 find_package(
@@ -17,10 +17,10 @@ find_package(
 )
 if(PRISMS_PF_FOUND)
   # Include setup script
-  include(${PRISMS_PF_CORE_DIR}/cmake/setup_application.cmake)
+  include(${PRISMS_PF_CMAKE_DIR}/setup_application.cmake)
 
   # Set up the application
-  prisms_pf_autopilot(${PRISMS_PF_CORE_DIR})
+  prisms_pf_autopilot(${PRISMS_PF_CMAKE_DIR})
 else()
   message(FATAL_ERROR "PRISMS-PF package not found. Please make sure it is in path.")
 endif()