CMake: Prefix options with SUNDIALS_

CHANGELOG.md

@@ -10,6 +10,73 @@
 
 ### Deprecation Notices
 
+Several CMake options have been deprecated in favor of namespaced versions
+prefixed with `SUNDIALS_` to avoid naming collisions in applications that
+include SUNDIALS directly within their CMake builds. Additionally, a consistent
+naming convention (`SUNDIALS_ENABLE`) is now used for all boolean options. The
+table below lists the old CMake option names and the new replacements.
+
+| Old Option                             | New Option                                     |
+|----------------------------------------|------------------------------------------------|
+| `BUILD_ARKODE`                         | `SUNDIALS_ENABLE_ARKODE`                       |
+| `BUILD_CVODE`                          | `SUNDIALS_ENABLE_CVODE`                        |
+| `BUILD_CVODES`                         | `SUNDIALS_ENABLE_CVODES`                       |
+| `BUILD_IDA`                            | `SUNDIALS_ENABLE_IDA`                          |
+| `BUILD_IDAS`                           | `SUNDIALS_ENABLE_IDAS`                         |
+| `BUILD_KINSOL`                         | `SUNDIALS_ENABLE_KINSOL`                       |
+| `ENABLE_MPI`                           | `SUNDIALS_ENABLE_MPI`                          |
+| `ENABLE_OPENMP`                        | `SUNDIALS_ENABLE_OPENMP`                       |
+| `ENABLE_OPENMP_DEVICE`                 | `SUNDIALS_ENABLE_OPENMP_DEVICE`                |
+| `OPENMP_DEVICE_WORKS`                  | `SUNDIALS_ENABLE_OPENMP_DEVICE_CHECKS`         |
+| `ENABLE_PTHREAD`                       | `SUNDIALS_ENABLE_PTHREAD`                      |
+| `ENABLE_CUDA`                          | `SUNDIALS_ENABLE_CUDA`                         |
+| `ENABLE_HIP`                           | `SUNDIALS_ENABLE_HIP`                          |
+| `ENABLE_SYCL`                          | `SUNDIALS_ENABLE_SYCL`                         |
+| `ENABLE_LAPACK`                        | `SUNDIALS_ENABLE_LAPACK`                       |
+| `LAPACK_WORKS`                         | `SUNDIALS_ENABLE_LAPACK_CHECKS`                |
+| `ENABLE_GINKGO`                        | `SUNDIALS_ENABLE_GINKGO`                       |
+| `GINKGO_WORKS`                         | `SUNDIALS_ENABLE_GINKGO_CHECKS`                |
+| `ENABLE_MAGMA`                         | `SUNDIALS_ENABLE_MAGMA`                        |
+| `MAGMA_WORKS`                          | `SUNDIALS_ENABLE_MAGMA_CHECKS`                 |
+| `ENABLE_SUPERLUDIST`                   | `SUNDIALS_ENABLE_SUPERLUDIST`                  |
+| `SUPERLUDIST_WORKS`                    | `SUNDIALS_ENABLE_SUPERLUDIST_CHECKS`           |
+| `ENABLE_SUPERLUMT`                     | `SUNDIALS_ENABLE_SUPERLUMT`                    |
+| `SUPERLUMT_WORKS`                      | `SUNDIALS_ENABLE_SUPERLUMT_CHECKS`             |
+| `ENABLE_KLU`                           | `SUNDIALS_ENABLE_KLU`                          |
+| `KLU_WORKS`                            | `SUNDIALS_ENABLE_KLU_CHECKS`                   |
+| `ENABLE_HYPRE`                         | `SUNDIALS_ENABLE_HYPRE`                        |
+| `HYPRE_WORKS`                          | `SUNDIALS_ENABLE_HYPRE_CHECKS`                 |
+| `ENABLE_PETSC`                         | `SUNDIALS_ENABLE_PETSC`                        |
+| `PETSC_WORKS`                          | `SUNDIALS_ENABLE_PETSC_CHECKS`                 |
+| `ENABLE_TRILINOS`                      | `SUNDIALS_ENABLE_TRILINOS`                     |
+| `ENABLE_RAJA`                          | `SUNDIALS_ENABLE_RAJA`                         |
+| `ENABLE_XBRAID`                        | `SUNDIALS_ENABLE_XBRAID`                       |
+| `XBRAID_WORKS`                         | `SUNDIALS_ENABLE_XBRAID_CHECKS`                |
+| `ENABLE_ONEMKL`                        | `SUNDIALS_ENABLE_ONEMKL`                       |
+| `ONEMKL_WORKS`                         | `SUNDIALS_ENABLE_ONEMKL_CHECKS`                |
+| `ENABLE_CALIPER`                       | `SUNDIALS_ENABLE_CALIPER`                      |
+| `ENABLE_ADIAK`                         | `SUNDIALS_ENABLE_ADIAK`                        |
+| `ENABLE_KOKKOS`                        | `SUNDIALS_ENABLE_KOKKOS`                       |
+| `KOKKOS_WORKS`                         | `SUNDIALS_ENABLE_KOKKOS_CHECKS`                |
+| `ENABLE_KOKKOS_KERNELS`                | `SUNDIALS_ENABLE_KOKKOS_KERNELS`               |
+| `KOKKOS_KERNELS_WORKS`                 | `SUNDIALS_ENABLE_KOKKOS_KERNELS_CHECKS`        |
+| `SUNDIALS_BUILD_WITH_MONITORING`       | `SUNDIALS_ENABLE_MONITORING`                   |
+| `SUNDIALS_BUILD_WITH_PROFILING`        | `SUNDIALS_ENABLE_PROFILING`                    |
+| `BUILD_BENCHMARKS`                     | `SUNDIALS_ENABLE_BENCHMARKS`                   |
+| `BENCHMARKS_INSTALL_PATH`              | `SUNDIALS_BENCHMARKS_INSTALL_PATH`             |
+| `ENABLE_ALL_WARNINGS`                  | `SUNDIALS_ENABLE_ALL_WARNINGS`                 |
+| `ENABLE_WARNINGS_AS_ERRORS`            | `CMAKE_COMPILE_WARNING_AS_ERROR`               |
+| `ENABLE_ADDRESS_SANITIZER`             | `SUNDIALS_ENABLE_ADDRESS_SANITIZER`            |
+| `ENABLE_MEMORY_SANITIZER`              | `SUNDIALS_ENABLE_MEMORY_SANITIZER`             |
+| `ENABLE_LEAK_SANITIZER`                | `SUNDIALS_ENABLE_LEAK_SANITIZER`               |
+| `ENABLE_UNDEFINED_BEHAVIOR_SANITIZER`  | `SUNDIALS_ENABLE_UNDEFINED_BEHAVIOR_SANITIZER` |
+| `EXAMPLES_ENABLE_C`                    | `SUNDIALS_EXAMPLES_ENABLE_C`                   |
+| `EXAMPLES_ENABLE_CXX`                  | `SUNDIALS_EXAMPLES_ENABLE_CXX`                 |
+| `EXAMPLES_ENABLE_F2003`                | `SUNDIALS_EXAMPLES_ENABLE_FORTRAN`             |
+| `EXAMPLES_INSTALL`                     | `SUNDIALS_EXAMPLES_ENABLE_INSTALL`             |
+| `EXAMPLES_INSTALL_PATH`                | `SUNDIALS_EXAMPLES_INSTALL_PATH`               |
+| `SUNDIALS_BUILD_PACKAGE_FUSED_KERNELS` | `SUNDIALS_ENABLE_PACKAGE_FUSED_KERNELS`        |
+
 ## Changes to SUNDIALS in release 7.6.0
 
 ### Major Features

CMakeLists.txt

@@ -229,7 +229,7 @@ if(_BUILD_EXAMPLES)
 endif()
 
 # Add benchmarks to the build
-if(BUILD_BENCHMARKS)
+if(SUNDIALS_ENABLE_BENCHMARKS)
   include(SundialsSetupBenchmarks)
   add_subdirectory(benchmarks)
 endif()
@@ -260,7 +260,7 @@ install(FILES "${PROJECT_BINARY_DIR}/include/sundials/sundials_config.h"
         DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/sundials")
 
 # install shared Fortran 2003 modules
-if(BUILD_FORTRAN_MODULE_INTERFACE)
+if(SUNDIALS_ENABLE_FORTRAN)
   # While the .mod files get generated for static and shared libraries, they are
   # identical. So only install one set of the .mod files.
   if(BUILD_STATIC_LIBS)

benchmarks/CMakeLists.txt

@@ -26,7 +26,7 @@ endif()
 sundials_option(BENCHMARK_NVECTOR BOOL "NVector benchmarks are on" ON)
 
 # Disable some warnings for benchmarks
-if(ENABLE_ALL_WARNINGS)
+if(SUNDIALS_ENABLE_ALL_WARNINGS)
   set(CMAKE_C_FLAGS
       "${CMAKE_C_FLAGS} -Wno-unused-parameter -Wno-unused-function")
   set(CMAKE_CXX_FLAGS
@@ -37,7 +37,7 @@ endif()
 # Add specific benchmarks
 # ----------------------------------------
 
-if(ENABLE_MPI)
+if(SUNDIALS_ENABLE_MPI)
   add_subdirectory(diffusion_2D)
   add_subdirectory(advection_reaction_3D)
 endif()

benchmarks/advection_reaction_3D/CMakeLists.txt

@@ -15,10 +15,10 @@
 # SUNDIALS Copyright End
 # ---------------------------------------------------------------
 
-if(ENABLE_RAJA)
+if(SUNDIALS_ENABLE_RAJA)
   add_subdirectory(raja)
 endif()
 
-if(ENABLE_KOKKOS AND BUILD_NVECTOR_KOKKOS)
+if(SUNDIALS_ENABLE_KOKKOS AND SUNDIALS_ENABLE_NVECTOR_KOKKOS)
   add_subdirectory(kokkos)
 endif()

benchmarks/advection_reaction_3D/kokkos/CMakeLists.txt

@@ -16,9 +16,9 @@
 # ---------------------------------------------------------------
 
 # Add the build targets for each backend
-if(BUILD_ARKODE
-   AND BUILD_CVODE
-   AND BUILD_IDA)
+if(SUNDIALS_ENABLE_ARKODE
+   AND SUNDIALS_ENABLE_CVODE
+   AND SUNDIALS_ENABLE_IDA)
   foreach(backend ${KOKKOS_EXAMPLES_BACKENDS})
 
     # set benchmark target name
@@ -56,12 +56,14 @@ if(BUILD_ARKODE
 
     install(
       TARGETS ${benchmark_target}
-      DESTINATION "${BENCHMARKS_INSTALL_PATH}/advection_reaction_3D/kokkos")
+      DESTINATION
+        "${SUNDIALS_BENCHMARKS_INSTALL_PATH}/advection_reaction_3D/kokkos")
 
     install(
       FILES README.md ../scripts/compare_error.py ../scripts/compute_error.py
             ../scripts/pickle_solution_output.py
-      DESTINATION "${BENCHMARKS_INSTALL_PATH}/advection_reaction_3D/kokkos")
+      DESTINATION
+        "${SUNDIALS_BENCHMARKS_INSTALL_PATH}/advection_reaction_3D/kokkos")
 
   endforeach()
 endif()

benchmarks/advection_reaction_3D/raja/CMakeLists.txt

@@ -16,9 +16,9 @@
 # SUNDIALS Copyright End
 # ---------------------------------------------------------------
 
-if(BUILD_ARKODE
-   AND BUILD_CVODE
-   AND BUILD_IDA)
+if(SUNDIALS_ENABLE_ARKODE
+   AND SUNDIALS_ENABLE_CVODE
+   AND SUNDIALS_ENABLE_IDA)
 
   if((RAJA_BACKENDS MATCHES "TARGET_OPENMP") OR (RAJA_BACKENDS MATCHES "OPENMP"
                                                 ))
@@ -66,12 +66,16 @@ if(BUILD_ARKODE
             ${MPI_CXX_LIBRARIES}
             ${OTHER_LIBS})
 
-  install(TARGETS advection_reaction_3D_raja
-          DESTINATION "${BENCHMARKS_INSTALL_PATH}/advection_reaction_3D/raja")
+  install(
+    TARGETS advection_reaction_3D_raja
+    DESTINATION "${SUNDIALS_BENCHMARKS_INSTALL_PATH}/advection_reaction_3D/raja"
+  )
 
-  install(FILES README.md ../scripts/compare_error.py
-                ../scripts/compute_error.py ../scripts/pickle_solution_output.py
-          DESTINATION "${BENCHMARKS_INSTALL_PATH}/advection_reaction_3D/raja")
+  install(
+    FILES README.md ../scripts/compare_error.py ../scripts/compute_error.py
+          ../scripts/pickle_solution_output.py
+    DESTINATION "${SUNDIALS_BENCHMARKS_INSTALL_PATH}/advection_reaction_3D/raja"
+  )
 
   foreach(benchmark_tuple ${BENCHMARK_VAR})
     list(GET benchmark_tuple 0 benchmark_args)
@@ -89,7 +93,7 @@ if(BUILD_ARKODE
   # MPI + CUDA
   # ----------------------------------------------------------------------------
 
-  if(BUILD_NVECTOR_CUDA)
+  if(SUNDIALS_ENABLE_NVECTOR_CUDA)
 
     set_source_files_properties(advection_reaction_3D.cpp PROPERTIES LANGUAGE
                                                                      CUDA)
@@ -130,8 +134,10 @@ if(BUILD_ARKODE
     target_compile_definitions(advection_reaction_3D_raja_mpicuda
                                PRIVATE USE_CUDA_NVEC)
 
-    install(TARGETS advection_reaction_3D_raja_mpicuda
-            DESTINATION "${BENCHMARKS_INSTALL_PATH}/advection_reaction_3D/raja")
+    install(
+      TARGETS advection_reaction_3D_raja_mpicuda
+      DESTINATION
+        "${SUNDIALS_BENCHMARKS_INSTALL_PATH}/advection_reaction_3D/raja")
 
     foreach(benchmark_tuple ${BENCHMARK_VAR})
       list(GET benchmark_tuple 0 benchmark_args)
@@ -150,7 +156,7 @@ if(BUILD_ARKODE
   # MPI + HIP
   # ----------------------------------------------------------------------------
 
-  if(BUILD_NVECTOR_HIP)
+  if(SUNDIALS_ENABLE_NVECTOR_HIP)
 
     sundials_add_executable(
       advection_reaction_3D_raja_mpihip
@@ -183,8 +189,10 @@ if(BUILD_ARKODE
     target_compile_definitions(advection_reaction_3D_raja_mpihip
                                PRIVATE USE_HIP_NVEC)
 
-    install(TARGETS advection_reaction_3D_raja_mpihip
-            DESTINATION "${BENCHMARKS_INSTALL_PATH}/advection_reaction_3D/raja")
+    install(
+      TARGETS advection_reaction_3D_raja_mpihip
+      DESTINATION
+        "${SUNDIALS_BENCHMARKS_INSTALL_PATH}/advection_reaction_3D/raja")
 
     foreach(benchmark_tuple ${BENCHMARK_VAR})
       list(GET benchmark_tuple 0 benchmark_args)

benchmarks/diffusion_2D/CMakeLists.txt

@@ -15,9 +15,9 @@
 # SUNDIALS Copyright End
 # ------------------------------------------------------------------------------
 
-if(BUILD_ARKODE
-   OR BUILD_CVODE
-   OR BUILD_IDA)
+if(SUNDIALS_ENABLE_ARKODE
+   OR SUNDIALS_ENABLE_CVODE
+   OR SUNDIALS_ENABLE_IDA)
 
   # Shared sources
   set(shared_sources diffusion_2D.hpp diffusion_2D.cpp
@@ -32,10 +32,11 @@ if(BUILD_ARKODE
   add_subdirectory(mpi_serial)
 
   # MPI + CUDA/HIP
-  if(BUILD_NVECTOR_CUDA OR BUILD_NVECTOR_HIP)
+  if(SUNDIALS_ENABLE_NVECTOR_CUDA OR SUNDIALS_ENABLE_NVECTOR_HIP)
     add_subdirectory(mpi_gpu)
   endif()
 
-  install(FILES README.md DESTINATION "${BENCHMARKS_INSTALL_PATH}/diffusion_2D")
+  install(FILES README.md
+          DESTINATION "${SUNDIALS_BENCHMARKS_INSTALL_PATH}/diffusion_2D")
 
 endif()

benchmarks/diffusion_2D/README.md

@@ -92,7 +92,7 @@ installation guide for more details on configuring, building, and installing.
 ## Running
 
 Based on the configuration, executables for each integrator and backend option
-are built and installed in `<BENCHMARKS_INSTALL_PATH>/diffusion_2D`. The
+are built and installed in `<SUNDIALS_BENCHMARKS_INSTALL_PATH>/diffusion_2D`. The
 executables follow the naming convention `<package>_diffusion_2D_<parallelism>`
 where `<package>` is `arkode`, `cvode`, or `ida` and `<parallelism>` is `mpi` for
 MPI only parallelism, `mpicuda` for MPI + CUDA, and `mpihip` for MPI + HIP.

benchmarks/diffusion_2D/mpi_gpu/CMakeLists.txt

@@ -18,29 +18,29 @@
 # list of tests
 set(tests)
 
-if(BUILD_ARKODE)
-  if(BUILD_NVECTOR_CUDA)
+if(SUNDIALS_ENABLE_ARKODE)
+  if(SUNDIALS_ENABLE_NVECTOR_CUDA)
     list(APPEND tests "arkode\;BENCHMARK_ODE\;USE_CUDA")
   endif()
-  if(BUILD_NVECTOR_HIP)
+  if(SUNDIALS_ENABLE_NVECTOR_HIP)
     list(APPEND tests "arkode\;BENCHMARK_ODE\;USE_HIP")
   endif()
 endif()
 
-if(BUILD_CVODE)
-  if(BUILD_NVECTOR_CUDA)
+if(SUNDIALS_ENABLE_CVODE)
+  if(SUNDIALS_ENABLE_NVECTOR_CUDA)
     list(APPEND tests "cvode\;BENCHMARK_ODE\;USE_CUDA")
   endif()
-  if(BUILD_NVECTOR_HIP)
+  if(SUNDIALS_ENABLE_NVECTOR_HIP)
     list(APPEND tests "cvode\;BENCHMARK_ODE\;USE_HIP")
   endif()
 endif()
 
-if(BUILD_IDA)
-  if(BUILD_NVECTOR_CUDA)
+if(SUNDIALS_ENABLE_IDA)
+  if(SUNDIALS_ENABLE_NVECTOR_CUDA)
     list(APPEND tests "ida\;BENCHMARK_DAE\;USE_CUDA")
   endif()
-  if(BUILD_NVECTOR_HIP)
+  if(SUNDIALS_ENABLE_NVECTOR_HIP)
     list(APPEND tests "ida\;BENCHMARK_DAE\;USE_HIP")
   endif()
 endif()
@@ -113,6 +113,6 @@ foreach(test_tuple ${tests})
   target_link_libraries(${target} PRIVATE ${MPI_CXX_LIBRARIES})
 
   install(TARGETS ${target}
-          DESTINATION "${BENCHMARKS_INSTALL_PATH}/diffusion_2D")
+          DESTINATION "${SUNDIALS_BENCHMARKS_INSTALL_PATH}/diffusion_2D")
 
 endforeach()

benchmarks/diffusion_2D/mpi_serial/CMakeLists.txt

@@ -18,15 +18,15 @@
 # list of tests
 set(tests)
 
-if(BUILD_ARKODE)
+if(SUNDIALS_ENABLE_ARKODE)
   list(APPEND tests "arkode\;BENCHMARK_ODE")
 endif()
 
-if(BUILD_CVODE)
+if(SUNDIALS_ENABLE_CVODE)
   list(APPEND tests "cvode\;BENCHMARK_ODE")
 endif()
 
-if(BUILD_IDA)
+if(SUNDIALS_ENABLE_IDA)
   list(APPEND tests "ida\;BENCHMARK_DAE")
 endif()
 
@@ -57,14 +57,14 @@ foreach(test_tuple ${tests})
   target_link_libraries(${target} PRIVATE sundials_${package}
                                           sundials_nvecparallel MPI::MPI_CXX)
 
-  if(BUILD_SUNLINSOL_SUPERLUDIST)
+  if(SUNDIALS_ENABLE_SUNLINSOL_SUPERLUDIST)
     target_compile_definitions(${target} PRIVATE USE_SUPERLU_DIST)
     target_link_libraries(${target} PRIVATE sundials_sunlinsolsuperludist
                                             sundials_sunmatrixslunrloc)
   endif()
 
   install(TARGETS ${target}
-          DESTINATION "${BENCHMARKS_INSTALL_PATH}/diffusion_2D")
+          DESTINATION "${SUNDIALS_BENCHMARKS_INSTALL_PATH}/diffusion_2D")
 
   sundials_add_benchmark(${target} ${target} diffusion_2D
                          NUM_CORES ${SUNDIALS_BENCHMARK_NUM_CPUS})