Docs @ b3fcc2a

Author: MFC Action

documentation/architecture.html

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

documentation/case_constraints.html

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

documentation/cli-reference.html

@@ -994,7 +994,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md81"></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-05-08</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-09</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/examples.html

@@ -388,7 +388,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md276"></a>
 Final Condition</h3>
 <p>This figure shows the isosurface with zero q-criterion.</p>
 <p><img src="result-3D_TaylorGreenVortex-example.png" alt="" height="400" class="inline"/></p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-08</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-09</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/parameters.html

@@ -1577,7 +1577,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md393"></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-05-08</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-05-09</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/physics_constraints.html

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

post_process/m__global__parameters_8fpp_8f90_source.html

@@ -514,20 +514,20 @@
 <div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="preprocessor"></span><span class="preprocessor"># 338 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
 <div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="preprocessor"></span> </div>
 <div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="preprocessor"># 340 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
-<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="preprocessor"></span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_in = .false.</div>
-<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_out = .false.</div>
-<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_in = dflt_real</div>
-<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_out = dflt_real</div>
+<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="preprocessor"></span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_in = .false.</div>
+<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_out = .false.</div>
+<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_in = dflt_real</div>
+<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_out = dflt_real</div>
 <div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="preprocessor"># 340 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
-<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="preprocessor"></span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_in = .false.</div>
-<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_out = .false.</div>
-<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_in = dflt_real</div>
-<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_out = dflt_real</div>
+<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="preprocessor"></span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_in = .false.</div>
+<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_out = .false.</div>
+<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_in = dflt_real</div>
+<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_out = dflt_real</div>
 <div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span><span class="preprocessor"># 340 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
-<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="preprocessor"></span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_in = .false.</div>
-<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_out = .false.</div>
-<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_in = dflt_real</div>
-<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_out = dflt_real</div>
+<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="preprocessor"></span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_in = .false.</div>
+<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_out = .false.</div>
+<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_in = dflt_real</div>
+<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_out = dflt_real</div>
 <div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="preprocessor"># 345 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
 <div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="preprocessor"></span> </div>
 <div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span>        <a class="code hl_variable" href="namespacem__global__parameters.html#a8617063e88a25d9bc5d8aec3189e0862">chem_params</a>%gamma_method = 1</div>

pre_process/m__initial__condition_8fpp_8f90_source.html

@@ -390,9 +390,9 @@
 <div class="ttc" id="anamespacem__perturbation_html"><div class="ttname"><a href="namespacem__perturbation.html">m_perturbation</a></div><div class="ttdoc">Perturbs initial mean flow fields with random noise, mixing-layer instabilities, or simplex noise.</div><div class="ttdef"><b>Definition</b> <a href="m__perturbation_8fpp_8f90_source.html#l00007">m_perturbation.fpp.f90:7</a></div></div>
 <div class="ttc" id="anamespacem__perturbation_html_a2a73896e9dae92c7a3d973e069eef753"><div class="ttname"><a href="namespacem__perturbation.html#a2a73896e9dae92c7a3d973e069eef753">m_perturbation::s_perturb_sphere</a></div><div class="ttdeci">impure subroutine s_perturb_sphere(q_prim_vf)</div><div class="ttdoc">Randomly perturb partial density fields at the interface of a spherical volume fraction region.</div><div class="ttdef"><b>Definition</b> <a href="m__perturbation_8fpp_8f90_source.html#l00033">m_perturbation.fpp.f90:34</a></div></div>
 <div class="ttc" id="anamespacem__perturbation_html_a2f301707648fd0f0f5c215c439cdc171"><div class="ttname"><a href="namespacem__perturbation.html#a2f301707648fd0f0f5c215c439cdc171">m_perturbation::s_perturb_surrounding_flow</a></div><div class="ttdeci">impure subroutine s_perturb_surrounding_flow(q_prim_vf)</div><div class="ttdoc">Add random noise to the velocity and void fraction of the surrounding flow field.</div><div class="ttdef"><b>Definition</b> <a href="m__perturbation_8fpp_8f90_source.html#l00063">m_perturbation.fpp.f90:64</a></div></div>
-<div class="ttc" id="anamespacem__perturbation_html_a9a4020ba748540965324f6c18ae71e7b"><div class="ttname"><a href="namespacem__perturbation.html#a9a4020ba748540965324f6c18ae71e7b">m_perturbation::s_elliptic_smoothing</a></div><div class="ttdeci">impure subroutine s_elliptic_smoothing(q_prim_vf, bc_type, q_t_sf)</div><div class="ttdoc">Iteratively smooth all primitive variable fields using a discrete elliptic (Laplacian) filter.</div><div class="ttdef"><b>Definition</b> <a href="m__perturbation_8fpp_8f90_source.html#l00088">m_perturbation.fpp.f90:89</a></div></div>
-<div class="ttc" id="anamespacem__perturbation_html_ab924ad132a3b19adeaa3494830f63937"><div class="ttname"><a href="namespacem__perturbation.html#ab924ad132a3b19adeaa3494830f63937">m_perturbation::s_perturb_simplex</a></div><div class="ttdeci">subroutine s_perturb_simplex(q_prim_vf)</div><div class="ttdoc">Perturb velocity and volume fraction fields using multi-octave simplex noise.</div><div class="ttdef"><b>Definition</b> <a href="m__perturbation_8fpp_8f90_source.html#l00147">m_perturbation.fpp.f90:148</a></div></div>
-<div class="ttc" id="anamespacem__perturbation_html_afa02cfb00a8406637b02037a5d8a05ae"><div class="ttname"><a href="namespacem__perturbation.html#afa02cfb00a8406637b02037a5d8a05ae">m_perturbation::s_perturb_mixlayer</a></div><div class="ttdeci">subroutine s_perturb_mixlayer(q_prim_vf)</div><div class="ttdoc">Compute velocity perturbations for a temporal mixing layer with a hyperbolic tangent mean streamwise ...</div><div class="ttdef"><b>Definition</b> <a href="m__perturbation_8fpp_8f90_source.html#l00235">m_perturbation.fpp.f90:236</a></div></div>
+<div class="ttc" id="anamespacem__perturbation_html_a9a4020ba748540965324f6c18ae71e7b"><div class="ttname"><a href="namespacem__perturbation.html#a9a4020ba748540965324f6c18ae71e7b">m_perturbation::s_elliptic_smoothing</a></div><div class="ttdeci">impure subroutine s_elliptic_smoothing(q_prim_vf, bc_type, q_t_sf)</div><div class="ttdoc">Iteratively smooth all primitive variable fields using a discrete elliptic (Laplacian) filter.</div><div class="ttdef"><b>Definition</b> <a href="m__perturbation_8fpp_8f90_source.html#l00089">m_perturbation.fpp.f90:90</a></div></div>
+<div class="ttc" id="anamespacem__perturbation_html_ab924ad132a3b19adeaa3494830f63937"><div class="ttname"><a href="namespacem__perturbation.html#ab924ad132a3b19adeaa3494830f63937">m_perturbation::s_perturb_simplex</a></div><div class="ttdeci">subroutine s_perturb_simplex(q_prim_vf)</div><div class="ttdoc">Perturb velocity and volume fraction fields using multi-octave simplex noise.</div><div class="ttdef"><b>Definition</b> <a href="m__perturbation_8fpp_8f90_source.html#l00148">m_perturbation.fpp.f90:149</a></div></div>
+<div class="ttc" id="anamespacem__perturbation_html_afa02cfb00a8406637b02037a5d8a05ae"><div class="ttname"><a href="namespacem__perturbation.html#afa02cfb00a8406637b02037a5d8a05ae">m_perturbation::s_perturb_mixlayer</a></div><div class="ttdeci">subroutine s_perturb_mixlayer(q_prim_vf)</div><div class="ttdoc">Compute velocity perturbations for a temporal mixing layer with a hyperbolic tangent mean streamwise ...</div><div class="ttdef"><b>Definition</b> <a href="m__perturbation_8fpp_8f90_source.html#l00236">m_perturbation.fpp.f90:237</a></div></div>
 <div class="ttc" id="anamespacem__variables__conversion_html"><div class="ttname"><a href="namespacem__variables__conversion.html">m_variables_conversion</a></div><div class="ttdoc">Conservative-to-primitive variable conversion, mixture property evaluation, and pressure computation.</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l00328">m_variables_conversion.fpp.f90:328</a></div></div>
 <div class="ttc" id="anamespacem__variables__conversion_html_a55f61a59d5d979886829dab99e00b4e8"><div class="ttname"><a href="namespacem__variables__conversion.html#a55f61a59d5d979886829dab99e00b4e8">m_variables_conversion::s_initialize_mv</a></div><div class="ttdeci">subroutine, public s_initialize_mv(qk_cons_vf, mv)</div><div class="ttdoc">Initialize bubble mass-vapor values at quadrature nodes from the conserved moment statistics.</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l01168">m_variables_conversion.fpp.f90:1169</a></div></div>
 <div class="ttc" id="anamespacem__variables__conversion_html_a572d64fd75d1710f3dbce61d9b6e6c0d"><div class="ttname"><a href="namespacem__variables__conversion.html#a572d64fd75d1710f3dbce61d9b6e6c0d">m_variables_conversion::s_initialize_pb</a></div><div class="ttdeci">subroutine, public s_initialize_pb(qk_cons_vf, mv, pb)</div><div class="ttdoc">Initialize bubble internal pressures at quadrature nodes using isothermal relations from the Preston ...</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l01207">m_variables_conversion.fpp.f90:1208</a></div></div>