Docs @ 1343d93

Author: MFC Action

documentation/architecture.html

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

documentation/case.html

@@ -804,6 +804,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
 </ul>
 <p><b>Requirements</b> (errors):</p><ul>
 <li>Immersed Boundaries do not work in 1D (requires n &gt; 0)</li>
+<li>ib_state_wrt requires ib to be enabled</li>
 </ul>
 <p><b>Incompatibilities</b> (errors):</p><ul>
 <li>output_partial_domain is incompatible with certain output flags</li>
@@ -1427,7 +1428,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-03-16</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-17</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/case_constraints.html

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

documentation/cli-reference.html

@@ -388,7 +388,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md273"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md274"></a>
 Final Condition (Density)</h3>
 <p><img src="final-2D_forward_facing_step-example.png" alt="" class="inline"/></p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-16</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-17</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/examples.html

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

documentation/parameters.html

@@ -287,6 +287,7 @@
 <a href="namespacem__data__output.html#a39d0a9b6b516d8b9fd81f5b811bbf509"/>
 <a href="namespacem__data__output.html#a3a7e2018fb2d4b7848d9065cf1e00043"/>
 <a href="namespacem__data__output.html#a3c8518f08e89ad72c7f2658aa5dc971f"/>
+<a href="namespacem__data__output.html#a402f97ee1c8f4c5676d54809d8bdc2bb"/>
 <a href="namespacem__data__output.html#a46f36ecca7ea4f45bba6abddb3b01e7b"/>
 <a href="namespacem__data__output.html#a4938e362ddb09e7557586d185dd6e4f3"/>
 <a href="namespacem__data__output.html#a4b51c66195d7d2c5d6b8b504783621f9"/>
@@ -456,6 +457,7 @@
 <a href="namespacem__global__parameters.html#a6e342ae3eb66f89e0eeb94e11aa42d92"/>
 <a href="namespacem__global__parameters.html#a6ec3255c636f81f84dd7311ed7337fc7"/>
 <a href="namespacem__global__parameters.html#a6ed5e5561c16f30a4010f6612877029d"/>
+<a href="namespacem__global__parameters.html#a6f8626eb3a889b47da44e1d5a903fb0e"/>
 <a href="namespacem__global__parameters.html#a6fe63b247d95292a893cfc1a49bff915"/>
 <a href="namespacem__global__parameters.html#a70be15795fc52175ecd412d80576f0aa"/>
 <a href="namespacem__global__parameters.html#a7297abec8863ecabf95e24ebdae46a17"/>

documentation/physics_constraints.html

@@ -525,14 +525,14 @@
 <div class="ttc" id="anamespacem__checker__common_html_a96fa54018d14ac0ea114fd0805dedd97"><div class="ttname"><a href="namespacem__checker__common.html#a96fa54018d14ac0ea114fd0805dedd97">m_checker_common::s_check_amd</a></div><div class="ttdeci">impure subroutine s_check_amd</div><div class="ttdoc">Checks that simulation parameters stay within AMD GPU compiler limits when case optimization is disab...</div><div class="ttdef"><b>Definition</b> <a href="#l00353">m_checker_common.fpp.f90:354</a></div></div>
 <div class="ttc" id="anamespacem__checker__common_html_abf7ee76feb76e0dfa1301860374be234"><div class="ttname"><a href="namespacem__checker__common.html#abf7ee76feb76e0dfa1301860374be234">m_checker_common::s_check_total_cells</a></div><div class="ttdeci">impure subroutine s_check_total_cells</div><div class="ttdoc">Verifies that the total number of grid cells meets the minimum required by the number of dimensions a...</div><div class="ttdef"><b>Definition</b> <a href="#l00335">m_checker_common.fpp.f90:336</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">Global parameters for the post-process: domain geometry, equation of state, and output database setti...</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_a04cbfd496a4957519236d8be24b343bd"><div class="ttname"><a href="namespacem__global__parameters.html#a04cbfd496a4957519236d8be24b343bd">m_global_parameters::bubbles_euler</a></div><div class="ttdeci">logical bubbles_euler</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00324">m_global_parameters.fpp.f90:324</a></div></div>
+<div class="ttc" id="anamespacem__global__parameters_html_a04cbfd496a4957519236d8be24b343bd"><div class="ttname"><a href="namespacem__global__parameters.html#a04cbfd496a4957519236d8be24b343bd">m_global_parameters::bubbles_euler</a></div><div class="ttdeci">logical bubbles_euler</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00325">m_global_parameters.fpp.f90:325</a></div></div>
 <div class="ttc" id="anamespacem__global__parameters_html_a206f9fba2814a2fd594e9b884e183347"><div class="ttname"><a href="namespacem__global__parameters.html#a206f9fba2814a2fd594e9b884e183347">m_global_parameters::chemistry</a></div><div class="ttdeci">logical, parameter chemistry</div><div class="ttdoc">Chemistry modeling.</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00132">m_global_parameters.fpp.f90:132</a></div></div>
 <div class="ttc" id="anamespacem__global__parameters_html_a2f0b96a5aef3925aa7e3cc816754e17e"><div class="ttname"><a href="namespacem__global__parameters.html#a2f0b96a5aef3925aa7e3cc816754e17e">m_global_parameters::num_fluids</a></div><div class="ttdeci">integer num_fluids</div><div class="ttdoc">Number of different fluids present in the flow.</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00111">m_global_parameters.fpp.f90:111</a></div></div>
-<div class="ttc" id="anamespacem__global__parameters_html_a89fde47fbf14a9c93f6033542fe123db"><div class="ttname"><a href="namespacem__global__parameters.html#a89fde47fbf14a9c93f6033542fe123db">m_global_parameters::bubbles_lagrange</a></div><div class="ttdeci">logical bubbles_lagrange</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00363">m_global_parameters.fpp.f90:363</a></div></div>
+<div class="ttc" id="anamespacem__global__parameters_html_a89fde47fbf14a9c93f6033542fe123db"><div class="ttname"><a href="namespacem__global__parameters.html#a89fde47fbf14a9c93f6033542fe123db">m_global_parameters::bubbles_lagrange</a></div><div class="ttdeci">logical bubbles_lagrange</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00364">m_global_parameters.fpp.f90:364</a></div></div>
 <div class="ttc" id="anamespacem__global__parameters_html_aafb65952c33f1c363d1040bde29734ea"><div class="ttname"><a href="namespacem__global__parameters.html#aafb65952c33f1c363d1040bde29734ea">m_global_parameters::num_procs</a></div><div class="ttdeci">integer num_procs</div><div class="ttdoc">Number of processors.</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00035">m_global_parameters.fpp.f90:35</a></div></div>
 <div class="ttc" id="anamespacem__global__parameters_html_ac040dbf547e6d5de8df08e864d8131e7"><div class="ttname"><a href="namespacem__global__parameters.html#ac040dbf547e6d5de8df08e864d8131e7">m_global_parameters::p</a></div><div class="ttdeci">integer p</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_ac72422e5f77149bd32cf0cfd01a36544"><div class="ttname"><a href="namespacem__global__parameters.html#ac72422e5f77149bd32cf0cfd01a36544">m_global_parameters::n</a></div><div class="ttdeci">integer n</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00046">m_global_parameters.fpp.f90:46</a></div></div>
-<div class="ttc" id="anamespacem__global__parameters_html_ad76c4758994b52559f478d251dc0cba5"><div class="ttname"><a href="namespacem__global__parameters.html#ad76c4758994b52559f478d251dc0cba5">m_global_parameters::nb</a></div><div class="ttdeci">integer nb</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00321">m_global_parameters.fpp.f90:321</a></div></div>
+<div class="ttc" id="anamespacem__global__parameters_html_ad76c4758994b52559f478d251dc0cba5"><div class="ttname"><a href="namespacem__global__parameters.html#ad76c4758994b52559f478d251dc0cba5">m_global_parameters::nb</a></div><div class="ttdeci">integer nb</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00322">m_global_parameters.fpp.f90:322</a></div></div>
 <div class="ttc" id="anamespacem__global__parameters_html_aee38c9d03e9195858a93ec611b605f33"><div class="ttname"><a href="namespacem__global__parameters.html#aee38c9d03e9195858a93ec611b605f33">m_global_parameters::m</a></div><div class="ttdeci">integer m</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00045">m_global_parameters.fpp.f90:45</a></div></div>
 <div class="ttc" id="anamespacem__global__parameters_html_afdeeb5a77c2db5d602e79f7fd4bd26d8"><div class="ttname"><a href="namespacem__global__parameters.html#afdeeb5a77c2db5d602e79f7fd4bd26d8">m_global_parameters::nglobal</a></div><div class="ttdeci">integer(kind=8) nglobal</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00053">m_global_parameters.fpp.f90:53</a></div></div>
 <div class="ttc" id="anamespacem__helper__basic_html"><div class="ttname"><a href="namespacem__helper__basic.html">m_helper_basic</a></div><div class="ttdoc">Basic floating-point utilities: approximate equality, default detection, and coordinate bounds.</div><div class="ttdef"><b>Definition</b> <a href="m__helper__basic_8fpp_8f90_source.html#l00294">m_helper_basic.fpp.f90:294</a></div></div>