Docs @ 492f4c5

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

documentation/case_constraints.html

@@ -808,6 +808,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
 <li>When enabled, requires: <span class="tt">num_ibs</span></li>
 </ul>
 <p><b>Requirements</b> (errors):</p><ul>
+<li>fd_order must be specified for ib</li>
 <li>Immersed Boundaries do not work in 1D (requires n &gt; 0)</li>
 <li>ib_state_wrt requires ib to be enabled</li>
 </ul>
@@ -1461,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-06-24</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-25</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-24</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-25</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-24</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-25</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/parameters.html

@@ -1288,7 +1288,7 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><span class="tt">hypoelasticity</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Enable hypoelastic model  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">hypoelasticity</span> requires <span class="tt">model_eqns</span> = 2; <span class="tt">hypoelasticity</span> requires HLL Riemann solver (<span class="tt">riemann_solver</span> = 1)  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">ib</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Enable immersed boundary method  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">Immersed Boundaries do not work in 1D (requires n &gt; 0); <span class="tt">num_ibs</span> must be &gt;= 1 when <span class="tt">ib</span> is enabled (or specify at least one <span class="tt">particle_cloud</span> with <span class="tt">num_particles</span> &gt; 0); <span class="tt">num_ibs</span> must be &lt;= <span class="tt">num_ib_patches_max</span> (<span class="tt">num_ib_patches_max_namelist</span> in <span class="tt">m_constants</span>.fpp)  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">ib</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Enable immersed boundary method  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">fd_order</span> must be specified for <span class="tt">ib</span>; Immersed Boundaries do not work in 1D (requires n &gt; 0); <span class="tt">num_ibs</span> must be &gt;= 1 when <span class="tt">ib</span> is enabled (or specify at least one <span class="tt">particle_cloud</span> with <span class="tt">num_particles</span> &gt; 0)  </td></tr>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><span class="tt">ib_coefficient_of_friction</span>  </td><td class="markdownTableBodyNone">Real  </td><td class="markdownTableBodyNone">coefficient of friction used in IB collisions  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">Immersed boundary parameter  </td></tr>
 <tr class="markdownTableRowOdd">
@@ -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-24</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-25</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-24</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-25</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

simulation/doxygen_crawl.html

@@ -663,10 +663,7 @@
 <a href="namespacem__derived__variables.html#a2ad32df44939f53838dc6fe272c28ccb"/>
 <a href="namespacem__derived__variables.html#a3eb66e46af47e787f79a01e2236779b0"/>
 <a href="namespacem__derived__variables.html#a4a361321ed7068d74220d79b0a14e6c4"/>
-<a href="namespacem__derived__variables.html#a4db3866184ab1811002aec3e6e22c40a"/>
-<a href="namespacem__derived__variables.html#a7124df0982c30315cf6638596693f7ce"/>
 <a href="namespacem__derived__variables.html#a77b3f12eca15a93f0bbe8881f6bbcfd4"/>
-<a href="namespacem__derived__variables.html#a7bf1c5799ea6a39a4be055ecd66b6b8b"/>
 <a href="namespacem__derived__variables.html#ad5dfada9c933c6a4d3f9b41a8b7a98f9"/>
 <a href="namespacem__derived__variables.html#ade7f2b3caf70e9839dbcd5937a6fc982"/>
 <a href="namespacem__derived__variables.html#ae5f6b78c6e67bce7d4f9c6814b8fbd2b"/>
@@ -738,6 +735,7 @@
 <a href="namespacem__global__parameters.html#a33b4272ac0c75aff15851f9dfa6a9d14"/>
 <a href="namespacem__global__parameters.html#a383c6ff025d4ea09ddd4e2356042d86b"/>
 <a href="namespacem__global__parameters.html#a38a29138166e436370b8d57be3207692"/>
+<a href="namespacem__global__parameters.html#a38a6274bd913eb525dc43fec88c798b8"/>
 <a href="namespacem__global__parameters.html#a39f8f9e370fa12d18d6c6e666dc2a561"/>
 <a href="namespacem__global__parameters.html#a412b521f53489c6e3924ac69de0495ac"/>
 <a href="namespacem__global__parameters.html#a46a3e8a6405a0008a7f34bcfc648b20f"/>
@@ -780,6 +778,7 @@
 <a href="namespacem__global__parameters.html#a8780eea6af1d24812fe7a3872e178a58"/>
 <a href="namespacem__global__parameters.html#a8b9e56ff9c0da6dca164f0445c3fa77b"/>
 <a href="namespacem__global__parameters.html#a8d92e6693bd3b6bd68e024d00437dfa3"/>
+<a href="namespacem__global__parameters.html#a8defd37e7bf484d0e0891affbb5427c9"/>
 <a href="namespacem__global__parameters.html#a8ed3dee47bbaa5de7ae564ca9d770404"/>
 <a href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344"/>
 <a href="namespacem__global__parameters.html#a9319da4e5fa3c04c6d8e169d85523fdf"/>
@@ -811,6 +810,7 @@
 <a href="namespacem__global__parameters.html#ad263edf3b1c7617112e716c12e2980f8"/>
 <a href="namespacem__global__parameters.html#ad48aea41066f34a5b868bb5d83767eef"/>
 <a href="namespacem__global__parameters.html#ad4e160df8d0de7ea1801a1ca29f8e9b0"/>
+<a href="namespacem__global__parameters.html#ad5246d5c36c96abd9862971f720b7383"/>
 <a href="namespacem__global__parameters.html#ad76c4758994b52559f478d251dc0cba5"/>
 <a href="namespacem__global__parameters.html#ad80f68aac31aa898ab2d7729f60e375f"/>
 <a href="namespacem__global__parameters.html#adab11dab474410541d4c37725bea01e1"/>

simulation/m__boundary__primitives_8fpp_8f90_source.html

@@ -1761,7 +1761,7 @@
 <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#l00469">m_global_parameters.fpp.f90:469</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#l00469">m_global_parameters.fpp.f90:469</a></div></div>
 <div class="ttc" id="anamespacem__global__parameters_html_a9544f569916da49084e78b52371ad9e6"><div class="ttname"><a href="namespacem__global__parameters.html#a9544f569916da49084e78b52371ad9e6">m_global_parameters::z_cc</a></div><div class="ttdeci">real(wp), dimension(:), allocatable, target z_cc</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00399">m_global_parameters.fpp.f90:399</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#l00738">m_global_parameters.fpp.f90:738</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#l00756">m_global_parameters.fpp.f90:756</a></div></div>
 <div class="ttc" id="astructm__derived__types_1_1scalar__field_html"><div class="ttname"><a href="structm__derived__types_1_1scalar__field.html">m_derived_types::scalar_field</a></div><div class="ttdoc">Derived type annexing a scalar field (SF).</div><div class="ttdef"><b>Definition</b> <a href="m__derived__types_8fpp_8f90_source.html#l00337">m_derived_types.fpp.f90:337</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->