Docs @ 4b819a8

Author: MFC Action

documentation/architecture.html

@@ -427,7 +427,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
 <li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
 </ol>
 <p>Follow the pattern of existing modules like <span class="tt">m_body_forces</span> (simple) or <span class="tt">m_viscous</span> (more involved) as a template.</p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-23</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-24</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/case_constraints.html

@@ -1461,7 +1461,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
 </table>
 <hr  />
 <p>💡 <b>Tip:</b> If you encounter a validation error, check the relevant section above or review <a href="https://github.com/MFlowCode/MFC/blob/master/toolchain/mfc/case_validator.py"><span class="tt">case_validator.py</span></a> for complete validation logic.</p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-23</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-24</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

@@ -999,7 +999,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md82"></a>
 Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
 <p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-23</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-24</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/examples.html

@@ -630,7 +630,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md313"></a>
 <p><img src="result-2D_shockdroplet-example.png" alt="" height="400" class="inline"/></p>
 <p>This example case contains an automated convergence test using a 1D, two-component advection case. The case can be run by executing the bash script <span class="tt">./submitJobs.sh</span> in a terminal after enabling execution permissions with <span class="tt">chmod +x ./submitJobs.sh</span> and setting the <span class="tt">ROOT_DIR</span> and <span class="tt">MFC_DIR</span> variables. By default the script runs the case for 6 different grid resolutions with 1st, 3rd, and 5th, order spatial reconstructions. These settings can be modified by editing the variables at the top of the script. You can also run different model equations by setting the <span class="tt">ME</span> variable and different Riemann solvers by setting the <span class="tt">RS</span> variable.</p>
 <p>Once the simulations have been run, you can generate convergence plots with matplotlib by running <span class="tt">python3 plot.py</span> in a terminal. This will generate plots of the L1, L2, and Linf error norms and save the results to <span class="tt">errors.csv</span>.</p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-23</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-24</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/parameters.html

@@ -1605,7 +1605,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md434"></a>
 <div class="line"> </div>
 <div class="line"># Filter by type</div>
 <div class="line">./mfc.sh params -t real weno</div>
-</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-23</div> </div></div><!-- contents -->
+</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-24</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/physics_constraints.html

@@ -656,7 +656,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md485"></a>
 <li>FFT WRT incompatible with cylindrical coordinates</li>
 <li>FFT WRT requires global dimensions divisible by 2</li>
 </ul>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-23</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-24</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

post_process/m__data__input_8f90_source.html

@@ -753,8 +753,8 @@
 <div class="ttc" id="anamespacem__helper_html"><div class="ttname"><a href="namespacem__helper.html">m_helper</a></div><div class="ttdoc">Utility routines for bubble model setup, coordinate transforms, array sampling, and special functions...</div><div class="ttdef"><b>Definition</b> <a href="m__helper_8fpp_8f90_source.html#l00334">m_helper.fpp.f90:334</a></div></div>
 <div class="ttc" id="anamespacem__helper_html_afd343d70a36c65cb7be86a183aa594ac"><div class="ttname"><a href="namespacem__helper.html#afd343d70a36c65cb7be86a183aa594ac">m_helper::s_int_to_str</a></div><div class="ttdeci">elemental subroutine, public s_int_to_str(i, res)</div><div class="ttdoc">Convert an integer to its trimmed string representation.</div><div class="ttdef"><b>Definition</b> <a href="m__helper_8fpp_8f90_source.html#l00735">m_helper.fpp.f90:736</a></div></div>
 <div class="ttc" id="anamespacem__mpi__common_html"><div class="ttname"><a href="namespacem__mpi__common.html">m_mpi_common</a></div><div class="ttdoc">MPI communication layer: domain decomposition, halo exchange, reductions, and parallel I/O setup.</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__common_8fpp_8f90_source.html#l00334">m_mpi_common.fpp.f90:334</a></div></div>
-<div class="ttc" id="anamespacem__mpi__common_html_a04cfc0bdb377a0ce2f9fd478e4bb3807"><div class="ttname"><a href="namespacem__mpi__common.html#a04cfc0bdb377a0ce2f9fd478e4bb3807">m_mpi_common::s_mpi_abort</a></div><div class="ttdeci">impure subroutine s_mpi_abort(prnt, code)</div><div class="ttdoc">The subroutine terminates the MPI execution environment.</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__common_8fpp_8f90_source.html#l00877">m_mpi_common.fpp.f90:878</a></div></div>
-<div class="ttc" id="anamespacem__mpi__common_html_a1073fc1fcb6f3b9394606d5c9285e9f0"><div class="ttname"><a href="namespacem__mpi__common.html#a1073fc1fcb6f3b9394606d5c9285e9f0">m_mpi_common::s_mpi_barrier</a></div><div class="ttdeci">impure subroutine s_mpi_barrier</div><div class="ttdoc">Halts all processes until all have reached barrier.</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__common_8fpp_8f90_source.html#l00908">m_mpi_common.fpp.f90:909</a></div></div>
+<div class="ttc" id="anamespacem__mpi__common_html_a04cfc0bdb377a0ce2f9fd478e4bb3807"><div class="ttname"><a href="namespacem__mpi__common.html#a04cfc0bdb377a0ce2f9fd478e4bb3807">m_mpi_common::s_mpi_abort</a></div><div class="ttdeci">impure subroutine s_mpi_abort(prnt, code)</div><div class="ttdoc">The subroutine terminates the MPI execution environment.</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__common_8fpp_8f90_source.html#l00876">m_mpi_common.fpp.f90:877</a></div></div>
+<div class="ttc" id="anamespacem__mpi__common_html_a1073fc1fcb6f3b9394606d5c9285e9f0"><div class="ttname"><a href="namespacem__mpi__common.html#a1073fc1fcb6f3b9394606d5c9285e9f0">m_mpi_common::s_mpi_barrier</a></div><div class="ttdeci">impure subroutine s_mpi_barrier</div><div class="ttdoc">Halts all processes until all have reached barrier.</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__common_8fpp_8f90_source.html#l00907">m_mpi_common.fpp.f90:908</a></div></div>
 <div class="ttc" id="anamespacem__mpi__common_html_a2e27b3212956af624c8da826f0c2c529"><div class="ttname"><a href="namespacem__mpi__common.html#a2e27b3212956af624c8da826f0c2c529">m_mpi_common::s_initialize_mpi_data</a></div><div class="ttdeci">impure subroutine s_initialize_mpi_data(q_cons_vf, ib_markers, beta)</div><div class="ttdoc">Set up MPI I/O data views and variable pointers for parallel file output.</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__common_8fpp_8f90_source.html#l00532">m_mpi_common.fpp.f90:533</a></div></div>
 <div class="ttc" id="anamespacem__mpi__common_html_a564644bad898d940dc6caea3297bb424"><div class="ttname"><a href="namespacem__mpi__common.html#a564644bad898d940dc6caea3297bb424">m_mpi_common::s_initialize_mpi_data_ds</a></div><div class="ttdeci">subroutine s_initialize_mpi_data_ds(q_cons_vf)</div><div class="ttdoc">Set up MPI I/O data views for downsampled (coarsened) parallel file output.</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__common_8fpp_8f90_source.html#l00613">m_mpi_common.fpp.f90:614</a></div></div>
 <div class="ttc" id="anamespacem__mpi__proxy_html"><div class="ttname"><a href="namespacem__mpi__proxy.html">m_mpi_proxy</a></div><div class="ttdoc">MPI gather and scatter operations for distributing post-process grid and flow-variable data.</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__proxy_8fpp_8f90_source.html#l00007">m_mpi_proxy.fpp.f90:7</a></div></div>