Merge branch 'master' into amr

Author: camierjs

.github/workflows/build-and-test.yml

@@ -16,7 +16,7 @@ env:
 
 jobs:
   build-and-test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
     # Checkout Remhos in "remhos" subdirectory. Final path: /home/runner/work/remhos/remhos/remhos
@@ -35,14 +35,14 @@ jobs:
     # Install will only run on cache miss.
     - name: cache hypre
       id: hypre-cache
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       with:
         path: ${{ env.HYPRE_TOP_DIR }}
         key: ${{ runner.os }}-build-${{ env.HYPRE_TOP_DIR }}-v2
 
     - name: build Hypre
       if: steps.hypre-cache.outputs.cache-hit != 'true'
-      uses: mfem/github-actions/build-hypre@master
+      uses: mfem/github-actions/build-hypre@v2.5
       with:
         archive: ${{ env.HYPRE_ARCHIVE }}
         dir: ${{ env.HYPRE_TOP_DIR }}
@@ -51,14 +51,14 @@ jobs:
     # Install will only run on cache miss.
     - name: cache metis
       id: metis-cache
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       with:
         path: ${{ env.METIS_TOP_DIR }}
         key: ${{ runner.os }}-build-${{ env.METIS_TOP_DIR }}-v2
 
     - name: build metis
       if: steps.metis-cache.outputs.cache-hit != 'true'
-      uses: mfem/github-actions/build-metis@master
+      uses: mfem/github-actions/build-metis@v2.5
       with:
         archive: ${{ env.METIS_ARCHIVE }}
         dir: ${{ env.METIS_TOP_DIR }}
@@ -80,20 +80,21 @@ jobs:
     # Install will only run on cache miss.
     - name: cache mfem
       id: mfem-cache
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       with:
         path: ${{ env.MFEM_TOP_DIR }}
         key: ${{ runner.os }}-build-${{ env.MFEM_TOP_DIR }}-${{ env.MFEM_COMMIT }}-v3
 
     - name: build mfem
       if: steps.mfem-cache.outputs.cache-hit != 'true'
-      uses: mfem/github-actions/build-mfem@master
+      uses: mfem/github-actions/build-mfem@v2.5
       with:
         os: ${{ runner.os }}
         hypre-dir: ${{ env.HYPRE_TOP_DIR }}
         metis-dir: ${{ env.METIS_TOP_DIR }}
         mfem-dir: ${{ env.MFEM_TOP_DIR }}
         mfem-branch: ${{ env.MFEM_BRANCH }}
+        library-only: 'true'
 
     - name: build Remhos
       run: |
@@ -115,7 +116,7 @@ jobs:
 
     - name: Archive test results patch
       if: always()
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v4
       with:
         name: baseline-patch
         path: remhos/baseline.patch

.gitignore

@@ -0,0 +1,10 @@
+remhos
+*.dat
+*.mesh
+*.o
+*.gf
+*.svg
+.DS_Store
+/build/
+/.cache/
+/.vscode/

CMakeLists.txt

@@ -0,0 +1,85 @@
+cmake_minimum_required(VERSION 3.18)
+
+set(project remhos)
+project(${project} LANGUAGES CXX)
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_COMPILER_LAUNCHER ccache)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+# CXX flags *******************************************************************
+if (CMAKE_BUILD_TYPE STREQUAL "Debug")
+    add_compile_options(-fsanitize=address -O0)
+    add_link_options(-fsanitize=address)
+endif()
+
+# remove -DNDEBUG from default RelWithDebInfo flags
+set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "-O2" CACHE STRING "" FORCE)
+
+# Verbosity options ***********************************************************
+set(CMAKE_VERBOSE_MAKEFILE OFF CACHE BOOL "" FORCE)
+# set(CUDA_VERBOSE_BUILD OFF CACHE BOOL "" FORCE)
+
+# Include paths ***************************************************************
+include_directories(${CMAKE_CURRENT_SOURCE_DIR})
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/../mfem)
+if (${CMAKE_SYSTEM_NAME} MATCHES "Linux")
+include_directories(/usr/include/hypre /usr/include)
+elseif(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
+include_directories(/opt/homebrew/opt/fmt/include
+                    /opt/homebrew/opt/openmpi/include
+                    /opt/homebrew/opt/metis/include
+                    /opt/homebrew/opt/hypre/include)
+add_compile_definitions(MFEM_USE_CMAKE_TESTS)
+else()
+    message(FATAL_ERROR "Unsupported system")
+endif()
+
+# Copy mesh files *************************************************************
+file(GLOB SRC_MESH_FILES LIST_DIRECTORIES false data/*.mesh)
+set(BUILD_DATA_DIR ${CMAKE_CURRENT_BINARY_DIR}/data)
+add_custom_command(OUTPUT data_is_copied
+    COMMAND ${CMAKE_COMMAND} -E make_directory ${BUILD_DATA_DIR}
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${SRC_MESH_FILES} ${BUILD_DATA_DIR}
+    COMMAND ${CMAKE_COMMAND} -E touch data_is_copied
+    COMMENT "Copying mesh files ...")
+add_custom_target(copy_mesh_files DEPENDS data_is_copied)
+
+# Library source files ********************************************************
+add_library(Remhos STATIC remhos.cpp remhos_fct.cpp 
+                          remhos_ho.cpp remhos_lo.cpp 
+                          remhos_mono.cpp remhos_sync.cpp 
+                          remhos_tools.cpp)
+
+# Testing options *************************************************************
+enable_testing()
+function(add_remhos_test name)
+    set(file ${name}.cpp)
+    set(target ${name})
+    list(LENGTH ARGN ARGN_COUNT)
+    if(ARGN_COUNT GREATER 0) 
+        list(GET ARGN 0 extra)
+        string(APPEND name "_" ${extra})
+        string(APPEND target "_" ${extra})
+    endif()
+    message(STATUS "Adding target: ${target}")
+    add_executable(${target} ${file})
+    add_dependencies(${target} copy_mesh_files)
+    target_link_libraries(${target} Remhos -lmpi -lmfem -lhypre -lmetis -lfmt)
+if (${CMAKE_SYSTEM_NAME} MATCHES "Linux")
+    target_link_directories(${target} PUBLIC /usr/lib/x86_64-linux-gnu) 
+elseif(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
+    target_link_directories(${target} PUBLIC /opt/homebrew/opt/openmpi/lib
+                                          /opt/homebrew/opt/metis/lib
+                                          /opt/homebrew/opt/hypre/lib
+                                          /opt/homebrew/opt/fmt/lib) 
+endif()
+    target_link_directories(${target} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/../mfem)
+    message(STATUS "Adding test: ${target}_n1")
+    add_test(NAME ${target}_n1  COMMAND mpirun -n 1 ${target} ${extra})
+    message(STATUS "Adding test: ${target}_n3")
+    add_test(NAME ${target}_n3 COMMAND mpirun -n 3 ${target})
+endfunction()
+
+add_remhos_test(remhos_main)
+add_remhos_test(remhos_tests)

README.md

@@ -233,7 +233,7 @@ Alternatively, verify the final mass (`mass`) and maximum value (`max`) for the
 7.  `mpirun -np 8 remhos -m ./data/periodic-cube.mesh -p 0 -rs 1 -o 2 -dt 0.014 -tf 8 -ho 1 -lo 4 -fct 2`
 8.  `mpirun -np 8 remhos -m ../mfem/data/ball-nurbs.mesh -p 1 -rs 1 -dt 0.02 -tf 3 -ho 1 -lo 4 -fct 2`
 9.  `mpirun -np 8 remhos -m ./data/inline-quad.mesh -p 14 -rs 1 -dt 0.001 -tf 0.75 -ho 1 -lo 4 -fct 2`
-10. `mpirun -np 8 remhos -m ./data/inline-quad.mesh -p 14 -rs 2 -dt 0.005 -tf 0.75 -ho 3 -lo 1 -fct 1 -ps`
+10. `mpirun -np 8 remhos -m ./data/inline-quad.mesh -p 14 -rs 3 -dt 0.005 -tf 0.75 -ho 1 -lo 5 -fct 4 -ps -s 13`
 11. `mpirun -np 8 remhos -m ./data/cube01_hex.mesh -p 10 -rs 1 -o 2 -dt 0.02 -tf 0.8 -ho 1 -lo 4 -fct 2`
 12. `mpirun -np 8 remhos -m ./data/inline-quad.mesh -p 7 -rs 3 -o 1 -dt 0.01 -tf 20 -mono 1 -si 2`
 13. `mpirun -np 8 remhos -m ./data/inline-quad.mesh -p 6 -rs 2 -o 1 -dt 0.01 -tf 20 -mono 1 -si 1`
@@ -250,7 +250,7 @@ Alternatively, verify the final mass (`mass`) and maximum value (`max`) for the
 |  7. | 0.9607429525 | 0.7678305756 |
 |  8. | 0.8087104604 | 0.9999889315 |
 |  9. | 0.08479546709| 0.8156091428 |
-| 10. | 0.08980397023| 0.9886734209 |
+| 10. | 0.09317738757| 0.9994170644 |
 | 11. | 0.1197294512 | 0.9990312449 |
 | 12. | 0.1570667907 | 0.9987771164 |
 | 13. | 0.3182739921 | 1            |
@@ -260,7 +260,19 @@ round-off distance from the above reference values.
 
 ## Performance Timing and FOM
 
-To appear soon.
+Performance is tracked only for the configuration `-ho 3 -lo 5 -fct 2`.
+This configuration supports partial assembly and GPU execution.
+Remhos reports several FOMs in the terminal, based on the distinct phases of an
+advection-based remap calculation. All FOMs are reported in
+`(megaDOFs x time steps) per second`, reflecting the throughput of the calculation.
+
+- FOM RHS: construction of the right-hand side of the system.
+- FOM INV: inverting the high-order operator, which is used to obtain a
+           high-order unbounded (HO) solution.
+- FOM LO:  computation of the low-order bounded (LO) approximation of the solution.
+- FOM FCT: computation of the FCT solution, combining the LO and HO solutions to
+           obtain a bounded high-order solution.
+- **FOM**: performance metric combining all the above phases.
 
 ## Versions
 
@@ -276,7 +288,7 @@ comment in the [issue tracker](https://github.com/CEED/Remhos/issues).
 The following copyright applies to each file in the CEED software suite,
 unless otherwise stated in the file:
 
-> Copyright (c) 2017, Lawrence Livermore National Security, LLC. Produced at the
+> Copyright (c) 2026, Lawrence Livermore National Security, LLC. Produced at the
 > Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights reserved.
 
 See files LICENSE and NOTICE for details.