Merge branch 'master' into add-modular-precision-update

Author: aricer123

.github/CODEOWNERS

@@ -13,3 +13,5 @@ CMakeLists.txt     @sbryngelson @henryleberre
 .vscode/           @sbryngelson @henryleberre
 .github/workflows/ @sbryngelson @henryleberre
 
+# Spencer H. Bryngelson & Ben Wilfong
+.typos.toml        @sbryngelson @wilfonba

.github/file-filter.yml

@@ -7,7 +7,7 @@ fortran_src: &fortran_src
 
 python_src: &python_src
   - '**/*.py'
-  - 'toolchain/requirements.txt'
+  - 'toolchain/pyproject.toml'
 
 cmakelist: &cmakelist
   - 'CMakeLists.txt'

.github/workflows/cleanness.yml renamed to .github/workflows/cleanliness.yml

@@ -1,10 +1,10 @@
-name: Cleanness
+name: Cleanliness
 
 on: [push, pull_request, workflow_dispatch]
 
 jobs:
-    cleanness:
-        name: Code Cleanness Test
+    cleanliness:
+        name: Code Cleanliness Test
         runs-on: "ubuntu-latest"
         env:
             pr_everything: 0
@@ -25,7 +25,6 @@ jobs:
               run: |
                 sudo apt update -y
                 sudo apt install -y tar wget make cmake gcc g++ python3 python3-dev "openmpi-*" libopenmpi-dev
-                
             
             - name: Build
               run: |
@@ -35,59 +34,67 @@ jobs:
                 sed -i '/\/master\//d' master.txt
             
             - name: Unused Variables Diff
+              continue-on-error: true
               run: |
-                grep -F 'Wunused-variable' master.txt -B 4 > mUnused.txt
-                grep -F 'Wunused-variable' pr.txt -B 4 > prUnused.txt
-                diff prUnused.txt mUnused.txt || true
+                grep -F 'Wunused-variable' master.txt > mUnused.txt
+                grep -F 'Wunused-variable' pr.txt > prUnused.txt
+                diff prUnused.txt mUnused.txt
             
             - name: Unused Dummy Arguments Diff
+              continue-on-error: true
               run: |
-                grep -F 'Wunused-dummy-argument' pr.txt -B 4 > prDummy.txt
-                grep -F 'Wunused-dummy-argument' master.txt -B 4 > mDummy.txt
-                diff prDummy.txt mDummy.txt || true
+                grep -F 'Wunused-dummy-argument' pr.txt > prDummy.txt 
+                grep -F 'Wunused-dummy-argument' master.txt > mDummy.txt
+                diff prDummy.txt mDummy.txt
 
             - name: Unused Value Diff
+              continue-on-error: true
               run: |
-                grep -F 'Wunused-value' pr.txt -B 4 > prUnused_val.txt
-                grep -F 'Wunused-value' master.txt -B 4 > mUnused_val.txt
-                diff prUnused_val.txt mUnused_val.txt || true
+                grep -F 'Wunused-value' pr.txt > prUnused_val.txt
+                grep -F 'Wunused-value' master.txt > mUnused_val.txt
+                diff prUnused_val.txt mUnused_val.txt
 
             - name: Maybe Uninitialized Variables Diff
+              continue-on-error: true
               run: |
-                grep -F 'Wmaybe-uninitialized' pr.txt -B 4 > prMaybe.txt
-                grep -F 'Wmaybe-uninitialized' master.txt -B 4 > mMaybe.txt
-                diff prMaybe.txt mMaybe.txt || true
+                grep -F 'Wmaybe-uninitialized' pr.txt > prMaybe.txt
+                grep -F 'Wmaybe-uninitialized' master.txt > mMaybe.txt
+                diff prMaybe.txt mMaybe.txt
 
 
             - name: Everything Diff
+              continue-on-error: true
               run: |
-                grep '\-W' pr.txt -B 4 > pr_every.txt 
-                grep '\-W' master.txt -B 4 > m_every.txt
-                diff pr_every.txt m_every.txt || true
+                grep '\-W' pr.txt > pr_every.txt
+                grep '\-W' master.txt > m_every.txt
+                diff pr_every.txt m_every.txt
 
             - name: List of Warnings
               run: |
                 cat pr_every.txt
                 
 
             - name: Summary
+              continue-on-error: true
               run: |  
-                pr_variable=$(grep -c -F 'Wunused-variable' pr.txt -B 4)
-                pr_argument=$(grep -c -F 'Wunused-dummy-argument' pr.txt -B 4)
-                pr_value=$(grep -c -F 'Wunused-value' pr.txt -B 4)
-                pr_uninit=$(grep -c -F 'Wmaybe-uninitialized' pr.txt -B 4)
-                pr_everything=$(grep -c '\-W' pr.txt -B 4)
+                pr_variable=$(grep -c -F 'Wunused-variable' pr.txt)
+                pr_argument=$(grep -c -F 'Wunused-dummy-argument' pr.txt)
+                pr_value=$(grep -c -F 'Wunused-value' pr.txt)
+                pr_uninit=$(grep -c -F 'Wmaybe-uninitialized' pr.txt)
+                pr_everything=$(grep -c '\-W' pr.txt)
 
-                master_variable=$(grep -c -F 'Wunused-variable' master.txt -B 4)
-                master_argument=$(grep -c -F 'Wunused-dummy-argument' master.txt -B 4)
-                master_value=$(grep -c -F 'Wunused-value' master.txt -B 4)
-                master_uninit=$(grep -c -F 'Wmaybe-uninitialized' master.txt -B 4)
-                master_everything=$(grep -c '\-W' master.txt -B 4)    
+                master_variable=$(grep -c -F 'Wunused-variable' master.txt)
+                master_argument=$(grep -c -F 'Wunused-dummy-argument' master.txt)
+                master_value=$(grep -c -F 'Wunused-value' master.txt)
+                master_uninit=$(grep -c -F 'Wmaybe-uninitialized' master.txt)
+                master_everything=$(grep -c '\-W' master.txt  )    
 
                 echo "pr_everything=$pr_everything" >> $GITHUB_ENV
                 echo "master_everything=$master_everything" >> $GITHUB_ENV
 
-                echo "Difference is how many warnings were added or removed from master to pr, negative numbers are better since you are removing warnings" 
+                echo "Difference is how many warnings were added or removed from master to PR."
+                echo "Negative numbers are better since you are removing warnings." 
+                echo " "
                 echo "Unused Variable Count: $pr_variable, Difference: $((pr_variable - master_variable))"
                 echo "Unused Dummy Argument: $pr_argument, Difference: $((pr_argument - master_argument))"
                 echo "Unused Value: $pr_value, Difference: $((pr_value - master_value))"
@@ -99,6 +106,5 @@ jobs:
               if: env.pr_everything > env.master_everything 
               run: |
                 echo "Difference between warning count in PR is greater than in master."
-                exit 1
 
 

CMakeLists.txt

@@ -76,8 +76,8 @@ elseif ((CMAKE_Fortran_COMPILER_ID STREQUAL "NVHPC") OR (CMAKE_Fortran_COMPILER_
         message(FATAL_ERROR "ERROR: When using NVHPC, v21.7 or newer is required to build MFC.\n${__err_msg}")
     endif()
 
-    if ((CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 23.11) AND (CMAKE_BUILD_TYPE STREQUAL "Debug") AND MFC_OpenACC)
-        message(FATAL_ERROR "ERROR: When using NVHPC, MFC with Debug and GPU options requires NVHPC v23.11 or newer.\n${__err_msg}")
+    if ((CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 24.5) AND (CMAKE_BUILD_TYPE STREQUAL "Debug") AND MFC_OpenACC)
+        message(FATAL_ERROR "ERROR: When using NVHPC, MFC with Debug and GPU options requires NVHPC v24.5 or newer.\n${__err_msg}")
     endif()
 elseif (CMAKE_Fortran_COMPILER_ID STREQUAL "AppleClang" OR CMAKE_C_COMPILER_ID STREQUAL "AppleClang")
     message(FATAL_ERROR "ERROR: MFC does not support the Apple Clang compilers. Please consult the documentation.\n${__err_msg}")
@@ -223,7 +223,9 @@ if (CMAKE_BUILD_TYPE STREQUAL "Release")
     # Enable LTO/IPO if supported
     if (CMAKE_Fortran_COMPILER_ID STREQUAL "NVHPC")
         if (MFC_Unified)
-            message(STATUS "IPO is not available with NVHPC using Unified Memory")
+            message(STATUS "LTO/IPO is not available with NVHPC using Unified Memory")
+        elseif(CMAKE_Fortran_COMPILER_VERSION VERSION_LESS "23.11")
+            message(STATUS "LTO/IPO is not supported in NVHPC Version < 23.11. Use a newer version of NVHPC for best performance.")
         else()
             message(STATUS "Performing IPO using -Mextract followed by -Minline")
             set(NVHPC_USE_TWO_PASS_IPO TRUE)

README.md

@@ -68,7 +68,7 @@ cd MFC
 ```
 and be sure MFC knows where to find Boost by appending to your dotfiles and sourcing them again
 ```shell
-echo -e 'export BOOST_INCLUDE=/opt/homebrew/' | tee -a ~/.bash_profile ~/.zshrc
+echo -e "export BOOST_INCLUDE='$(brew --prefix --installed boost)/include'" | tee -a ~/.bash_profile ~/.zshrc
 . ~/.bash_profile 2>/dev/null || . ~/.zshrc 2>/dev/null
 ! [ -z "${BOOST_INCLUDE+x}" ] && echo 'Environment is ready!' || echo 'Error: $BOOST_INCLUDE is unset. Please adjust the previous commands to fit with your environment.'
 ```
@@ -132,7 +132,7 @@ They are organized below. Just click the drop-downs!
 
 * Shock and interface capturing schemes
 	* First-order upwinding
- 	* WENO reconstructions of order 3 and 5
+ 	* WENO reconstructions of order 3, 5, and 7
   	* WENO variants: WENO-JS, WENO-M, WENO-Z, TENO
    	* Monotonicity-preserving reconstructions
 	* Reliable handling of high density ratios

benchmarks/5eq_rk3_weno3_hllc/case.py

@@ -14,11 +14,13 @@
     description="This MFC case was created for the purposes of benchmarking MFC.",
     formatter_class=argparse.ArgumentDefaultsHelpFormatter)
 
-parser.add_argument("dict", type=str, metavar="DICT", help=argparse.SUPPRESS)
-parser.add_argument("gbpp", type=int, metavar="MEM", default=16, help="Adjusts the problem size per rank to fit into [MEM] GB of GPU memory per GPU.")
+parser.add_argument("--mfc", type=json.loads, default='{}', metavar="DICT",
+                    help="MFC's toolchain's internal state.")
+parser.add_argument("--gbpp", type=int, metavar="MEM", default=16,
+                    help="Adjusts the problem size per rank to fit into [MEM] GB of GPU memory per GPU.")
 
 ARGS = vars(parser.parse_args())
-DICT = json.loads(ARGS["dict"])
+DICT = ARGS["mfc"]
 
 size = 1 if DICT["gpu"] else 0
 

benchmarks/hypo_hll/case.py

@@ -12,11 +12,13 @@
     description="This MFC case was created for the purposes of benchmarking MFC.",
     formatter_class=argparse.ArgumentDefaultsHelpFormatter)
 
-parser.add_argument("dict", type=str, metavar="DICT", help=argparse.SUPPRESS)
-parser.add_argument("gbpp", type=int, metavar="MEM", default=16, help="Adjusts the problem size per rank to fit into [MEM] GB of GPU memory per GPU.")
+parser.add_argument("--mfc", type=json.loads, default='{}', metavar="DICT",
+                    help="MFC's toolchain's internal state.")
+parser.add_argument("--gbpp", type=int, metavar="MEM", default=16,
+                    help="Adjusts the problem size per rank to fit into [MEM] GB of GPU memory per GPU.")
 
 ARGS = vars(parser.parse_args())
-DICT = json.loads(ARGS["dict"])
+DICT = ARGS["mfc"]
 
 size = 1 if DICT["gpu"] else 0
 

benchmarks/ibm/case.py

@@ -11,11 +11,13 @@
     description="This MFC case was created for the purposes of benchmarking MFC.",
     formatter_class=argparse.ArgumentDefaultsHelpFormatter)
 
-parser.add_argument("dict", type=str, metavar="DICT", help=argparse.SUPPRESS)
-parser.add_argument("gbpp", type=int, metavar="MEM", default=16, help="Adjusts the problem size per rank to fit into [MEM] GB of GPU memory per GPU.")
+parser.add_argument("--mfc", type=json.loads, default='{}', metavar="DICT",
+                    help="MFC's toolchain's internal state.")
+parser.add_argument("--gbpp", type=int, metavar="MEM", default=16,
+                    help="Adjusts the problem size per rank to fit into [MEM] GB of GPU memory per GPU.")
 
 ARGS = vars(parser.parse_args())
-DICT = json.loads(ARGS["dict"])
+DICT = ARGS["mfc"]
 
 size = 1 if DICT["gpu"] else 0
 

benchmarks/viscous_weno5_sgb_acoustic/case.py

@@ -16,11 +16,13 @@
     description="This MFC case was created for the purposes of benchmarking MFC.",
     formatter_class=argparse.ArgumentDefaultsHelpFormatter)
 
-parser.add_argument("dict", type=str, metavar="DICT", help=argparse.SUPPRESS)
-parser.add_argument("gbpp", type=int, metavar="MEM", default=16, help="Adjusts the problem size per rank to fit into [MEM] GB of GPU memory per GPU.")
+parser.add_argument("--mfc", type=json.loads, default='{}', metavar="DICT",
+                    help="MFC's toolchain's internal state.")
+parser.add_argument("--gbpp", type=int, metavar="MEM", default=16,
+                    help="Adjusts the problem size per rank to fit into [MEM] GB of GPU memory per GPU.")
 
 ARGS = vars(parser.parse_args())
-DICT = json.loads(ARGS["dict"])
+DICT = ARGS["mfc"]
 
 size = 1 if DICT["gpu"] else 0