Docs @ 9478e2d

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-07-04</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-05</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/case_constraints.html

@@ -1462,7 +1462,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-07-04</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-05</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-07-04</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-05</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-07-04</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-05</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-07-04</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-07-05</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-07-04</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-05</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

pre_process/doxygen_crawl.html

@@ -417,6 +417,7 @@
 <a href="namespacem__finite__differences.html#a830833416c226c73bf244dae71884211"/>
 <a href="namespacem__global__parameters.html"/>
 <a href="namespacem__global__parameters.html#a09c7e736980589a2a963352638771622"/>
+<a href="namespacem__global__parameters.html#a0c29ed6effdba5cdf5b43025163ba92b"/>
 <a href="namespacem__global__parameters.html#a0f2d413d9739928f8e1a98f0a5783ab9"/>
 <a href="namespacem__global__parameters.html#a1072f221ca8e41b0ea3240b33374cc1e"/>
 <a href="namespacem__global__parameters.html#a15979aa7789736321146104abdb129ea"/>
@@ -476,6 +477,7 @@
 <a href="namespacem__global__parameters.html#aafb65952c33f1c363d1040bde29734ea"/>
 <a href="namespacem__global__parameters.html#ab125ec98ec617688d2b83daece29b70e"/>
 <a href="namespacem__global__parameters.html#ac0f2b9f46268623e7b3f82f0b222588f"/>
+<a href="namespacem__global__parameters.html#ac3e026ecd5d2a0664c275ad1e2fd253c"/>
 <a href="namespacem__global__parameters.html#ac3fd452ac5e7b6b4a094dccb59ea476b"/>
 <a href="namespacem__global__parameters.html#ac61c3f39815c1f2ae9fafda99202044a"/>
 <a href="namespacem__global__parameters.html#ac88969e65ea0f64b4bd736df5b06eee9"/>
@@ -492,6 +494,7 @@
 <a href="namespacem__global__parameters.html#ae8adbeb16cfec4040a887f2ff80be2fc"/>
 <a href="namespacem__global__parameters.html#af35a3ffea4c1b5eaa15614f76766bcc1"/>
 <a href="namespacem__global__parameters.html#af4fde1224f6c092bc4eda48571000ec7"/>
+<a href="namespacem__global__parameters.html#afa0ba4f0b5d7a4f940ebbf0506d3c3a2"/>
 <a href="namespacem__global__parameters.html#afae3ee499776f2b3712201dec49664b2"/>
 <a href="namespacem__global__parameters.html#afdeeb5a77c2db5d602e79f7fd4bd26d8"/>
 <a href="namespacem__global__parameters.html#afdfa7d87d094d7ded9d41b6c724d159a"/>

pre_process/m__boundary__common_8fpp_8f90_source.html

@@ -1204,7 +1204,7 @@
 <div class="ttc" id="anamespacem__constants_html"><div class="ttname"><a href="namespacem__constants.html">m_constants</a></div><div class="ttdoc">Compile-time constant parameters: default values, tolerances, and physical constants.</div><div class="ttdef"><b>Definition</b> <a href="m__constants_8fpp_8f90_source.html#l00007">m_constants.fpp.f90:7</a></div></div>
 <div class="ttc" id="anamespacem__derived__types_html"><div class="ttname"><a href="namespacem__derived__types.html">m_derived_types</a></div><div class="ttdoc">Shared derived types for field data, patch geometry, bubble dynamics, and MPI I/O structures.</div><div class="ttdef"><b>Definition</b> <a href="m__derived__types_8fpp_8f90_source.html#l00323">m_derived_types.fpp.f90:323</a></div></div>
 <div class="ttc" id="anamespacem__global__parameters_html"><div class="ttname"><a href="namespacem__global__parameters.html">m_global_parameters</a></div><div class="ttdoc">Defines global parameters for the computational domain, simulation algorithm, and initial conditions.</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00019">m_global_parameters.fpp.f90:19</a></div></div>
-<div class="ttc" id="anamespacem__global__parameters_html_a496ef8774198893700cd0ecce1ef8611"><div class="ttname"><a href="namespacem__global__parameters.html#a496ef8774198893700cd0ecce1ef8611">m_global_parameters::bc_io</a></div><div class="ttdeci">logical bc_io</div><div class="ttdoc">whether or not to save BC data</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00073">m_global_parameters.fpp.f90:73</a></div></div>
+<div class="ttc" id="anamespacem__global__parameters_html_a496ef8774198893700cd0ecce1ef8611"><div class="ttname"><a href="namespacem__global__parameters.html#a496ef8774198893700cd0ecce1ef8611">m_global_parameters::bc_io</a></div><div class="ttdeci">logical bc_io</div><div class="ttdoc">whether or not to save BC data</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00076">m_global_parameters.fpp.f90:76</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">Broadcasts user inputs and decomposes the domain across MPI ranks for pre-processing.</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>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->

pre_process/m__boundary__conditions_8fpp_8f90_source.html

@@ -499,12 +499,12 @@
 <div class="ttc" id="anamespacem__delay__file__access_html"><div class="ttname"><a href="namespacem__delay__file__access.html">m_delay_file_access</a></div><div class="ttdoc">Rank-staggered file access delays to prevent I/O contention on parallel file systems.</div><div class="ttdef"><b>Definition</b> <a href="m__delay__file__access_8f90_source.html#l00006">m_delay_file_access.f90:6</a></div></div>
 <div class="ttc" id="anamespacem__derived__types_html"><div class="ttname"><a href="namespacem__derived__types.html">m_derived_types</a></div><div class="ttdoc">Shared derived types for field data, patch geometry, bubble dynamics, and MPI I/O structures.</div><div class="ttdef"><b>Definition</b> <a href="m__derived__types_8fpp_8f90_source.html#l00323">m_derived_types.fpp.f90:323</a></div></div>
 <div class="ttc" id="anamespacem__global__parameters_html"><div class="ttname"><a href="namespacem__global__parameters.html">m_global_parameters</a></div><div class="ttdoc">Defines global parameters for the computational domain, simulation algorithm, and initial conditions.</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00019">m_global_parameters.fpp.f90:19</a></div></div>
-<div class="ttc" id="anamespacem__global__parameters_html_a2d3a5d211f996a1fff3238a8b7fe5fe7"><div class="ttname"><a href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">m_global_parameters::bc_z</a></div><div class="ttdeci">type(int_bounds_info) bc_z</div><div class="ttdoc">Boundary conditions in the x-, y- and z-coordinate directions.</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00063">m_global_parameters.fpp.f90:63</a></div></div>
+<div class="ttc" id="anamespacem__global__parameters_html_a2d3a5d211f996a1fff3238a8b7fe5fe7"><div class="ttname"><a href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">m_global_parameters::bc_z</a></div><div class="ttdeci">type(int_bounds_info) bc_z</div><div class="ttdoc">Boundary conditions in the x-, y- and z-coordinate directions.</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00066">m_global_parameters.fpp.f90:66</a></div></div>
 <div class="ttc" id="anamespacem__global__parameters_html_a353ab56efc0b78fea27c11158c2cf536"><div class="ttname"><a href="namespacem__global__parameters.html#a353ab56efc0b78fea27c11158c2cf536">m_global_parameters::y_cc</a></div><div class="ttdeci">real(wp), dimension(:), allocatable y_cc</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00047">m_global_parameters.fpp.f90:47</a></div></div>
 <div class="ttc" id="anamespacem__global__parameters_html_a383c6ff025d4ea09ddd4e2356042d86b"><div class="ttname"><a href="namespacem__global__parameters.html#a383c6ff025d4ea09ddd4e2356042d86b">m_global_parameters::proc_rank</a></div><div class="ttdeci">integer proc_rank</div><div class="ttdoc">Rank of the local processor Number of cells in the x-, y- and z-coordinate directions.</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00039">m_global_parameters.fpp.f90:39</a></div></div>
-<div class="ttc" id="anamespacem__global__parameters_html_a7a7bb7c9caddde4f86bd27169b0f150d"><div class="ttname"><a href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">m_global_parameters::bc_y</a></div><div class="ttdeci">type(int_bounds_info) bc_y</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00063">m_global_parameters.fpp.f90:63</a></div></div>
+<div class="ttc" id="anamespacem__global__parameters_html_a7a7bb7c9caddde4f86bd27169b0f150d"><div class="ttname"><a href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">m_global_parameters::bc_y</a></div><div class="ttdeci">type(int_bounds_info) bc_y</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00066">m_global_parameters.fpp.f90:66</a></div></div>
 <div class="ttc" id="anamespacem__global__parameters_html_a7f28c6009b6b3031436d2f1ad6228555"><div class="ttname"><a href="namespacem__global__parameters.html#a7f28c6009b6b3031436d2f1ad6228555">m_global_parameters::x_cc</a></div><div class="ttdeci">real(wp), dimension(:), allocatable x_cc</div><div class="ttdoc">Locations of cell-centers (cc) in x-, y- and z-directions, respectively.</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00047">m_global_parameters.fpp.f90:47</a></div></div>
-<div class="ttc" id="anamespacem__global__parameters_html_a91304734742c36abcb4dbf0712545344"><div class="ttname"><a href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">m_global_parameters::bc_x</a></div><div class="ttdeci">type(int_bounds_info) bc_x</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00063">m_global_parameters.fpp.f90:63</a></div></div>
+<div class="ttc" id="anamespacem__global__parameters_html_a91304734742c36abcb4dbf0712545344"><div class="ttname"><a href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">m_global_parameters::bc_x</a></div><div class="ttdeci">type(int_bounds_info) bc_x</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00066">m_global_parameters.fpp.f90:66</a></div></div>
 <div class="ttc" id="anamespacem__global__parameters_html_a9efba3343251f7bc76bf9c7c6613b41e"><div class="ttname"><a href="namespacem__global__parameters.html#a9efba3343251f7bc76bf9c7c6613b41e">m_global_parameters::z_cc</a></div><div class="ttdeci">real(wp), dimension(:), allocatable z_cc</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00047">m_global_parameters.fpp.f90:47</a></div></div>
 <div class="ttc" id="astructm__derived__types_1_1bounds__info_html"><div class="ttname"><a href="structm__derived__types_1_1bounds__info.html">m_derived_types::bounds_info</a></div><div class="ttdoc">Derived type adding beginning (beg) and end bounds info as attributes.</div><div class="ttdef"><b>Definition</b> <a href="m__derived__types_8fpp_8f90_source.html#l00538">m_derived_types.fpp.f90:538</a></div></div>
 <div class="ttc" id="astructm__derived__types_1_1integer__field_html"><div class="ttname"><a href="structm__derived__types_1_1integer__field.html">m_derived_types::integer_field</a></div><div class="ttdoc">Derived type annexing an integer scalar field (SF).</div><div class="ttdef"><b>Definition</b> <a href="m__derived__types_8fpp_8f90_source.html#l00347">m_derived_types.fpp.f90:347</a></div></div>