Fourier Transforms

.github/workflows/ci-extended.yml

@@ -58,11 +58,14 @@ jobs:
           fi
 
       - name: Configure
+        env:
+          ENABLE_FFT: ${{ matrix.parallel == 'mpi' && 'ON' || 'OFF' }}
         run: |
           cmake -B build \
             -DCMAKE_BUILD_TYPE=Release \
             -DENABLE_ASAN=${{ steps.cmake-vars.outputs.enable_asan }} \
-            -DMACHINE_VARIANT=${{ matrix.device }}-${{ matrix.parallel }}
+            -DMACHINE_VARIANT=${{ matrix.device }}-${{ matrix.parallel }} \
+            -DPARTHENON_ENABLE_FFT=${ENABLE_FFT}
 
       - name: Build
         run: cmake --build build
@@ -153,6 +156,8 @@ jobs:
           key: gold-standard
 
       - name: Configure
+        env:
+          ENABLE_FFT: ${{ matrix.parallel == 'mpi' && 'ON' || 'OFF' }}
         run: |
           git config --global --add safe.directory $(pwd)
           # The extra CMAKE_PREFIX_PATH seems to be required for current rocm6.2 and 7.2, see
@@ -163,7 +168,8 @@ jobs:
             -DCMAKE_BUILD_TYPE=Release \
             -DMACHINE_VARIANT=hip-${{ matrix.parallel }} \
             -DCMAKE_PREFIX_PATH=/opt/rocm-7.2.4 \
-            -DCMAKE_CXX_COMPILER=hipcc
+            -DCMAKE_CXX_COMPILER=hipcc \
+            -DPARTHENON_ENABLE_FFT=${ENABLE_FFT}
 
       - name: Build
         run: cmake --build build

CHANGELOG.md

@@ -5,6 +5,7 @@
 ## Current develop
 
 ### Added (new features/APIs/variables/...)
+- [[PR 1403]](https://github.com/parthenon-hpc-lab/parthenon/pull/1403) Add interface for Fourier transforms on uniform meshes via heFFTe
 - [[PR 1408]](https://github.com/parthenon-hpc-lab/parthenon/pull/1408) Add GetAsUnresolvedString() method to ParameterInput
 - [[PR 1050]](https://github.com/parthenon-hpc-lab/parthenon/pull/1050) Add support for OpenPMD/ADIOS2 output (incl slices and coarsened dumps)
 - [[PR 1271]](https://github.com/parthenon-hpc-lab/parthenon/pull/1271) Add option to set a minimum number of teams for boundary communication kernels

CMakeLists.txt

@@ -75,6 +75,9 @@ else()
     OFF)
 endif()
 
+option(PARTHENON_ENABLE_FFT "Enable Parthenon FFT functionality" OFF)
+option(PARTHENON_USE_SYSTEM_HEFFTE "Use system-installed heFFTe instead of fetching it" OFF)
+
 # Check if we are using Parthenon as a subproject
 set(_parthenon_is_toplevel OFF)
 if (CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
@@ -492,7 +495,42 @@ set(CMAKE_INSTALL_INCLUDEDIR "${CMAKE_INSTALL_INCLUDEDIR}/parthenon")
 set(DOC_GEN_PATH "${CMAKE_SOURCE_DIR}/doc/sphinx/src/generated" CACHE STRING
   "Path to save generated data for docs.")
 
+if (PARTHENON_ENABLE_FFT)
+  if(NOT ENABLE_MPI)
+    message(FATAL_ERROR
+      "PARTHENON_ENABLE_FFT requires MPI because the heFFTe backend uses "
+      "an MPI communicator. Reconfigure without PARTHENON_DISABLE_MPI=ON.")
+  endif()
+  if (PARTHENON_USE_SYSTEM_HEFFTE)
+    find_package(Heffte REQUIRED)
+    if (NOT Heffte_FOUND)
+      message(FATAL_ERROR "heFFTe requested to be used from the environment but it was "
+        "not found. Either append the path to the installed heFFTe lib via "
+        "Heffte_DIR or CMAKE_PREFIX_PATH, or use the version fetched by Parthenon by "
+        "keeping PARTHENON_USE_SYSTEM_HEFFTE=OFF")
+    endif()
+  else()
+    include(FetchContent)
+    set(Heffte_ENABLE_CUDA ${Kokkos_ENABLE_CUDA} CACHE BOOL "Enable CUDA for heFFTe" FORCE)
+    set(Heffte_ENABLE_ROCM ${Kokkos_ENABLE_HIP}  CACHE BOOL "Enable ROCm for heFFTe" FORCE)
+    FetchContent_Declare(Heffte
+      GIT_REPOSITORY "https://github.com/icl-utk-edu/heffte.git"
+      GIT_TAG        "4d8d459")  # current (Jul26) GitHub `master` (from Nov25)
+    FetchContent_MakeAvailable(Heffte)
+    if (NOT TARGET Heffte::Heffte)
+      add_library(Heffte::Heffte ALIAS Heffte)
+    endif()
+    install(TARGETS Heffte EXPORT parthenonTargets)
+  endif()
+endif()
+
 add_subdirectory(src)
+
+if (PARTHENON_ENABLE_FFT)
+  target_link_libraries(parthenon PRIVATE Heffte::Heffte)
+  target_compile_definitions(parthenon PUBLIC PARTHENON_ENABLE_FFT)
+endif()
+
 add_subdirectory(example)
 add_subdirectory(benchmarks)
 

README.md

@@ -42,6 +42,7 @@ Parthenon -- a performance portable block-structured adaptive mesh refinement fr
 * OpenPMD and ADIOS2 (for outputs)
 * HDF5 (for outputs)
 * Ascent (for in situ visualization and analysis)
+* heFFTe (for performing Fourier transforms on uniform meshes)
 
 ## Other
 

doc/sphinx/src/chapters/advanced_features.rst

@@ -12,3 +12,4 @@ and solvers.
    ../interface/sparse
    ../integrators
    ../solvers
+   ../fourier_transforms