Merge remote-tracking branch 'upstream/master' into tuoSetup

Author: wilfonba

.github/workflows/docs.yml

@@ -34,6 +34,14 @@ jobs:
         cmake -S . -B build -G Ninja --install-prefix=$(pwd)/build/install -D MFC_DOCUMENTATION=ON
         ninja -C build install
 
+    - name: Upload Built Documentation Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: mfc-docs
+        path: build/install/docs/mfc
+        if-no-files-found: error
+        retention-days: 7
+
     # From here https://github.com/cicirello/generate-sitemap
     - name: Generate the sitemap
       id: sitemap

.github/workflows/frontier/submit.sh

@@ -48,7 +48,7 @@ job_slug="$job_slug"
 job_device="$2"
 job_interface="$3"
 
-. ./mfc.sh load -c f -m g
+. ./mfc.sh load -c f -m $([ "$2" = "gpu" ] && echo "g" || echo "c")
 
 $sbatch_script_contents
 

.github/workflows/frontier/test.sh

@@ -16,5 +16,5 @@ fi
 if [ "$job_device" = "gpu" ]; then
     ./mfc.sh test -a --rdma-mpi --max-attempts 3 -j $ngpus $device_opts -- -c frontier
 else
-    ./mfc.sh test -a --max-attempts 3 -j 32 -- -c frontier
+    ./mfc.sh test -a --max-attempts 3 -j 32 --no-gpu -- -c frontier
 fi

.github/workflows/lint-toolchain.yml

@@ -11,6 +11,11 @@ jobs:
     - uses: actions/checkout@v4
 
     - name: MFC Python setup
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.14'
+    
+    - name: Initialize MFC
       run: ./mfc.sh init
 
     - name: Lint the toolchain

.github/workflows/phoenix/submit-bench.sh

@@ -42,7 +42,7 @@ sbatch <<EOT
 #SBATCH --account=gts-sbryngelson3 # charge account
 #SBATCH -N1                        # Number of nodes required
 $sbatch_device_opts
-#SBATCH -t 02:00:00                # Duration of the job (Ex: 15 mins)
+#SBATCH -t 03:00:00                # Duration of the job (Ex: 15 mins)
 #SBATCH -q embers                  # QOS Name
 #SBATCH -o$job_slug.out            # Combined output and error messages file
 #SBATCH -W                         # Do not exit until the submitted job terminates.

.github/workflows/test.yml

@@ -48,11 +48,6 @@ jobs:
       - name: Clone
         uses: actions/checkout@v4
 
-      - name: Set up Python 3.13
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.13'
-
       - name: Setup MacOS
         if:   matrix.os == 'macos'
         run:  |
@@ -81,6 +76,10 @@ jobs:
           source /opt/intel/oneapi/setvars.sh
           printenv >> $GITHUB_ENV
 
+      - name: Set up Python 3.14
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.14'
 
       - name: Build
         run:  |

.gitignore

@@ -19,6 +19,9 @@ __pycache__
 
 *.egg-info
 
+# Auto-generated version file
+toolchain/mfc/_version.py
+
 .DS_Store
 
 /tests/*/**
@@ -33,6 +36,7 @@ docs/*/initial*
 docs/*/result*
 docs/documentation/*-example.png
 docs/documentation/examples.md
+docs/documentation/case_constraints.md
 
 examples/*batch/*/
 examples/**/D/*

.lychee.toml

@@ -15,3 +15,6 @@ retry_wait_time = 4
 accept = ["200", "429"]
 
 verbose = "error"
+
+# Exclude sitemap from link checking (it contains pre-publish production URLs)
+exclude_path = ["**/sitemap.txt"]

CMakeLists.txt

@@ -652,6 +652,18 @@ if (MFC_DOCUMENTATION)
         VERBATIM
     )
 
+    # Generate case_constraints.md from case_validator.py and examples/
+    add_custom_command(
+        OUTPUT  "${CMAKE_CURRENT_SOURCE_DIR}/docs/documentation/case_constraints.md"
+        DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/toolchain/mfc/gen_case_constraints_docs.py"
+                "${CMAKE_CURRENT_SOURCE_DIR}/toolchain/mfc/case_validator.py"
+                "${examples_DOCs}"
+        COMMAND "bash" "${CMAKE_CURRENT_SOURCE_DIR}/docs/gen_constraints.sh"
+                       "${CMAKE_CURRENT_SOURCE_DIR}"
+        COMMENT "Generating case_constraints.md"
+        VERBATIM
+    )
+
     file(GLOB common_DOCs CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/docs/*")
 
     # GEN_DOCS: Given a target name (herein <target>), this macro sets up a
@@ -685,8 +697,10 @@ if (MFC_DOCUMENTATION)
             "${CMAKE_CURRENT_BINARY_DIR}/${target}-Doxyfile" @ONLY)
 
         set(opt_example_dependency "")
+        set(opt_constraints_dependency "")
         if (${target} STREQUAL documentation)
             set(opt_example_dependency "${CMAKE_CURRENT_SOURCE_DIR}/docs/documentation/examples.md")
+            set(opt_constraints_dependency "${CMAKE_CURRENT_SOURCE_DIR}/docs/documentation/case_constraints.md")
         endif()
 
         file(GLOB_RECURSE ${target}_DOCs CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/docs/${target}/*")
@@ -696,6 +710,7 @@ if (MFC_DOCUMENTATION)
             OUTPUT  "${CMAKE_CURRENT_BINARY_DIR}/${target}/html/index.html"
             DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/${target}-Doxyfile"
                     "${opt_example_dependency}"
+                    "${opt_constraints_dependency}"
                     "${${target}_SRCs}" "${${target}_DOCs}"
             COMMAND "${DOXYGEN_EXECUTABLE}" "${target}-Doxyfile"
             WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"

docs/documentation/case.md

@@ -68,6 +68,15 @@ For example, to run the `scaling` case in "weak-scaling" mode:
 
 ## Parameters
 
+## Feature Compatibility
+
+Before diving into parameter details, check the **[Feature Compatibility Guide](case_constraints.md)** to understand:
+- Which features work together (MHD, bubbles, phase change, etc.)
+- Common configuration patterns with copy-paste examples
+- Requirements for each model equation and Riemann solver
+
+💡 **Tip:** If you get a validation error, the compatibility guide explains what each parameter requires.
+
 There are multiple sets of parameters that must be specified in the python input file:
 1. [Runtime Parameters](#1-runtime)
 2. [Computational Domain Parameters](#2-computational-domain)
@@ -745,6 +754,7 @@ Details of the transducer acoustic source model can be found in [Maeda and Colon
 | `mu_v` †	        | Real 		|	Viscosity |
 | `k_v` †	          | Real 		|	Thermal conductivity |
 | `cp_v` †	        | Real 		|	Specific heat capacity |
+| `D_v` †           | Real    | Vapor diffusivity in the gas |
 
 These options work only for gas-liquid two-component flows.
 Component indexes are required to be 1 for liquid and 2 for gas.
@@ -836,7 +846,6 @@ When ``polytropic = 'F'``, the gas compression is modeled as non-polytropic due
 | `T0`                  | Real    | Reference temperature                                     |
 | `x0`                  | Real    | Reference length                                          |
 | `Thost`               | Real    | Temperature of the surrounding liquid (host)              |
-| `diffcoefvap`         | Real    | Vapor diffusivity in the gas                              |
 
 - `nBubs_glb` Total number of bubbles. Their initial conditions need to be specified in the ./input/lag_bubbles.dat file. See the example cases for additional information.