Docs @ e56a0a1

Author: MFC Action

documentation/architecture.html

@@ -277,7 +277,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md7"></a>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyNone"><span class="tt">m_surface_tension</span>  </td><td class="markdownTableBodyNone">Computes capillary source fluxes and color-function gradients for the diffuse-interface surface tension model  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyNone"><span class="tt">m_bubbles</span>  </td><td class="markdownTableBodyNone">Bubble-dynamics procedures for ensemble- and volume-averaged models  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_bubbles</span>  </td><td class="markdownTableBodyNone">Bubble-dynamics procedures for ensemble- and volume-averaged model  </td></tr>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyNone"><span class="tt">m_bubbles_EE</span>  </td><td class="markdownTableBodyNone">Computes ensemble-averaged (Euler&ndash;Euler) bubble source terms for radius, velocity, pressure, and mass transfer  </td></tr>
 <tr class="markdownTableRowEven">
@@ -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-12</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-13</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-12</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-13</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_md82"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md83"></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-12</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-13</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_md314"></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-12</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-13</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/parameters.html

@@ -1689,7 +1689,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md447"></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-12</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-13</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/physics_constraints.html

@@ -668,7 +668,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md501"></a>
 <li><code class="f90l">patch_icpp(i)%</code><code class="f90r">hcid</code>=hcid requires <span class="tt">files_dir</span> to be set</li>
 <li><code class="f90l">patch_icpp(i)%</code><code class="f90r">hcid</code>=hcid requires <span class="tt">file_extension</span> to be set</li>
 </ul>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-12</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-13</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

simulation/files.html

@@ -164,7 +164,7 @@
 <tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="m__boundary__common_8fpp_8f90_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a><a class="el" href="m__boundary__common_8fpp_8f90.html" target="_self">m_boundary_common.fpp.f90</a></td><td class="desc">Contains module <a class="el" href="namespacem__boundary__common.html" title="Noncharacteristic and processor boundary condition application for ghost cells and buffer regions.">m_boundary_common</a> </td></tr>
 <tr id="row_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="m__boundary__io_8fpp_8f90_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a><a class="el" href="m__boundary__io_8fpp_8f90.html" target="_self">m_boundary_io.fpp.f90</a></td><td class="desc">Contains module <a class="el" href="namespacem__boundary__io.html" title="Boundary condition restart I/O, capillary/IGR buffer population, and grid-variable buffers.">m_boundary_io</a> </td></tr>
 <tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="m__boundary__primitives_8fpp_8f90_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a><a class="el" href="m__boundary__primitives_8fpp_8f90.html" target="_self">m_boundary_primitives.fpp.f90</a></td><td class="desc">Contains module <a class="el" href="namespacem__boundary__primitives.html" title="Per-cell noncharacteristic boundary condition primitives applied in the ghost cells.">m_boundary_primitives</a> </td></tr>
-<tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="m__bubbles_8fpp_8f90_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a><a class="el" href="m__bubbles_8fpp_8f90.html" target="_self">m_bubbles.fpp.f90</a></td><td class="desc">Contains module <a class="el" href="namespacem__bubbles.html" title="Bubble-dynamics procedures for ensemble- and volume-averaged models.">m_bubbles</a> </td></tr>
+<tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="m__bubbles_8fpp_8f90_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a><a class="el" href="m__bubbles_8fpp_8f90.html" target="_self">m_bubbles.fpp.f90</a></td><td class="desc">Contains module <a class="el" href="namespacem__bubbles.html" title="Bubble-dynamics procedures for ensemble- and volume-averaged model.">m_bubbles</a> </td></tr>
 <tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="m__bubbles__EE_8fpp_8f90_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a><a class="el" href="m__bubbles__EE_8fpp_8f90.html" target="_self">m_bubbles_EE.fpp.f90</a></td><td class="desc">Contains module <a class="el" href="namespacem__bubbles__ee.html" title="m_bubbles_ee">m_bubbles_EE</a> </td></tr>
 <tr id="row_7_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="m__bubbles__EL_8fpp_8f90_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a><a class="el" href="m__bubbles__EL_8fpp_8f90.html" target="_self">m_bubbles_EL.fpp.f90</a></td><td class="desc">Contains module <a class="el" href="namespacem__bubbles__el.html" title="m_bubbles_el">m_bubbles_EL</a> </td></tr>
 <tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="m__bubbles__EL__kernels_8fpp_8f90_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a><a class="el" href="m__bubbles__EL__kernels_8fpp_8f90.html" target="_self">m_bubbles_EL_kernels.fpp.f90</a></td><td class="desc">Contains module <a class="el" href="namespacem__bubbles__el__kernels.html" title="m_bubbles_el_kernels">m_bubbles_EL_kernels</a> </td></tr>

simulation/index.html

@@ -170,7 +170,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md1"></a>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><a class="el" href="namespacem__body__forces.html" title="m_body_forces">m_body_forces</a>  </td><td class="markdownTableBodyNone">Computes gravitational and body force source terms for the momentum equations  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><a class="el" href="namespacem__bubbles.html" title="m_bubbles">m_bubbles</a>  </td><td class="markdownTableBodyNone">Bubble-dynamics procedures for ensemble- and volume-averaged models  </td></tr>
+<td class="markdownTableBodyNone"><a class="el" href="namespacem__bubbles.html" title="m_bubbles">m_bubbles</a>  </td><td class="markdownTableBodyNone">Bubble-dynamics procedures for ensemble- and volume-averaged model  </td></tr>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><a class="el" href="namespacem__bubbles__ee.html" title="m_bubbles_ee">m_bubbles_EE</a>  </td><td class="markdownTableBodyNone">Computes ensemble-averaged (Euler&ndash;Euler) bubble source terms for radius, velocity, pressure, and mass transfer  </td></tr>
 <tr class="markdownTableRowOdd">

simulation/m__acoustic__src_8fpp_8f90_source.html

@@ -2027,7 +2027,7 @@
 <div class="ttc" id="anamespacem__acoustic__src_html_af58a9cc009161a0f1be2309bcede4efa"><div class="ttname"><a href="namespacem__acoustic__src.html#af58a9cc009161a0f1be2309bcede4efa">m_acoustic_src::gauss_sigma_dist</a></div><div class="ttdeci">real(wp), dimension(:), allocatable gauss_sigma_dist</div><div class="ttdef"><b>Definition</b> <a href="#l00376">m_acoustic_src.fpp.f90:376</a></div></div>
 <div class="ttc" id="anamespacem__acoustic__src_html_af5e2e879f79f1087ba9ce6f338a47478"><div class="ttname"><a href="namespacem__acoustic__src.html#af5e2e879f79f1087ba9ce6f338a47478">m_acoustic_src::delay</a></div><div class="ttdeci">real(wp), dimension(:), allocatable delay</div><div class="ttdef"><b>Definition</b> <a href="#l00376">m_acoustic_src.fpp.f90:376</a></div></div>
 <div class="ttc" id="anamespacem__acoustic__src_html_affc5ba7a8ae9157c5fb768605457a7c4"><div class="ttname"><a href="namespacem__acoustic__src.html#affc5ba7a8ae9157c5fb768605457a7c4">m_acoustic_src::mom_src</a></div><div class="ttdeci">real(wp), dimension(:,:,:,:), allocatable mom_src</div><div class="ttdef"><b>Definition</b> <a href="#l00455">m_acoustic_src.fpp.f90:455</a></div></div>
-<div class="ttc" id="anamespacem__bubbles_html"><div class="ttname"><a href="namespacem__bubbles.html">m_bubbles</a></div><div class="ttdoc">Bubble-dynamics procedures for ensemble- and volume-averaged models.</div><div class="ttdef"><b>Definition</b> <a href="m__bubbles_8fpp_8f90_source.html#l00323">m_bubbles.fpp.f90:323</a></div></div>
+<div class="ttc" id="anamespacem__bubbles_html"><div class="ttname"><a href="namespacem__bubbles.html">m_bubbles</a></div><div class="ttdoc">Bubble-dynamics procedures for ensemble- and volume-averaged model.</div><div class="ttdef"><b>Definition</b> <a href="m__bubbles_8fpp_8f90_source.html#l00323">m_bubbles.fpp.f90:323</a></div></div>
 <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__constants_html_a36d9e57f65f9235b1e7b4abb690345a6"><div class="ttname"><a href="namespacem__constants.html#a36d9e57f65f9235b1e7b4abb690345a6">m_constants::dflt_int</a></div><div class="ttdeci">integer, parameter dflt_int</div><div class="ttdoc">Default integer value.</div><div class="ttdef"><b>Definition</b> <a href="m__constants_8fpp_8f90_source.html#l00023">m_constants.fpp.f90:23</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>

simulation/m__bubbles_8fpp_8f90.html

@@ -158,15 +158,15 @@
 </div><!--header-->
 <div class="contents">
 
-<p>Contains module <a class="el" href="namespacem__bubbles.html" title="Bubble-dynamics procedures for ensemble- and volume-averaged models.">m_bubbles</a>.  
+<p>Contains module <a class="el" href="namespacem__bubbles.html" title="Bubble-dynamics procedures for ensemble- and volume-averaged model.">m_bubbles</a>.  
 <a href="#details">More...</a></p>
 
 <p><a href="m__bubbles_8fpp_8f90_source.html">Go to the source code of this file.</a></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 id="header-namespaces" class="groupheader"><a id="namespaces" name="namespaces"></a>
 Modules</h2></td></tr>
 <tr class="memitem:m_5Fbubbles" id="r_m_5Fbubbles"><td class="memItemLeft">module &#160;</td><td class="memItemRight"><a class="el" href="namespacem__bubbles.html">m_bubbles</a></td></tr>
-<tr class="memdesc:namespacem__bubbles"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bubble-dynamics procedures for ensemble- and volume-averaged models. <br /></td></tr>
+<tr class="memdesc:namespacem__bubbles"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bubble-dynamics procedures for ensemble- and volume-averaged model. <br /></td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
 Functions/Subroutines</h2></td></tr>
@@ -215,7 +215,7 @@
 <tr class="memdesc:a8c1051ebc96b54711f3ceec1cb093f76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bubble wall properties (Ando 2010).  <br /></td></tr>
 </table>
 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>Contains module <a class="el" href="namespacem__bubbles.html" title="Bubble-dynamics procedures for ensemble- and volume-averaged models.">m_bubbles</a>. </p>
+<div class="textblock"><p>Contains module <a class="el" href="namespacem__bubbles.html" title="Bubble-dynamics procedures for ensemble- and volume-averaged model.">m_bubbles</a>. </p>
 
 <p class="definition">Definition in file <a class="el" href="m__bubbles_8fpp_8f90_source.html">m_bubbles.fpp.f90</a>.</p>
 </div></div><!-- contents -->