Skip to content

Commit 6a75224

Browse files
author
MFC Action
committed
Docs @ 5e08029
1 parent 554cb15 commit 6a75224

23 files changed

+3556
-3563
lines changed

documentation/architecture.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
401401
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
402402
</ol>
403403
<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>
404-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-22</div> </div></div><!-- contents -->
404+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-23</div> </div></div><!-- contents -->
405405
</div><!-- PageDoc -->
406406
</div><!-- doc-content -->
407407
<div id="page-nav" class="page-nav-panel">

documentation/case_constraints.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1421,7 +1421,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14211421
</table>
14221422
<hr />
14231423
<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>
1424-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-22</div> </div></div><!-- contents -->
1424+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-23</div> </div></div><!-- contents -->
14251425
</div><!-- PageDoc -->
14261426
</div><!-- doc-content -->
14271427
<div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -863,7 +863,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md77"></a>
863863
<h3 class="doxsection"><a class="anchor" id="autotoc_md78"></a>
864864
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
865865
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
866-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-22</div> </div></div><!-- contents -->
866+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-23</div> </div></div><!-- contents -->
867867
</div><!-- PageDoc -->
868868
</div><!-- doc-content -->
869869
<div id="page-nav" class="page-nav-panel">

documentation/examples.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md271"></a>
388388
<h3 class="doxsection"><a class="anchor" id="autotoc_md272"></a>
389389
Final Condition</h3>
390390
<p><img src="result-3D_ibm_bowshock-example.png" alt="" height="400" class="inline"/></p>
391-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-22</div> </div></div><!-- contents -->
391+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-23</div> </div></div><!-- contents -->
392392
</div><!-- PageDoc -->
393393
</div><!-- doc-content -->
394394
<div id="page-nav" class="page-nav-panel">

documentation/parameters.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1524,7 +1524,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md390"></a>
15241524
<div class="line"> </div>
15251525
<div class="line"># Filter by type</div>
15261526
<div class="line">./mfc.sh params -t real weno</div>
1527-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-22</div> </div></div><!-- contents -->
1527+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-23</div> </div></div><!-- contents -->
15281528
</div><!-- PageDoc -->
15291529
</div><!-- doc-content -->
15301530
<div id="page-nav" class="page-nav-panel">

documentation/physics_constraints.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -623,7 +623,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md440"></a>
623623
<li>FFT WRT incompatible with cylindrical coordinates</li>
624624
<li>FFT WRT requires global dimensions divisible by 2</li>
625625
</ul>
626-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-22</div> </div></div><!-- contents -->
626+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-23</div> </div></div><!-- contents -->
627627
</div><!-- PageDoc -->
628628
</div><!-- doc-content -->
629629
<div id="page-nav" class="page-nav-panel">

post_process/m__data__input_8f90_source.html

Lines changed: 380 additions & 381 deletions
Large diffs are not rendered by default.

post_process/m__data__output_8fpp_8f90_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2233,7 +2233,7 @@
22332233
<div class="ttc" id="anamespacem__mpi__proxy_html_aa8376d4fe1d9829af56e78cecfb50d13"><div class="ttname"><a href="namespacem__mpi__proxy.html#aa8376d4fe1d9829af56e78cecfb50d13">m_mpi_proxy::s_mpi_gather_data_extents</a></div><div class="ttdeci">impure subroutine s_mpi_gather_data_extents(q_sf, data_extents)</div><div class="ttdoc">This subroutine gathers the Silo database metadata for the flow variable&#39;s extents as to boost perfor...</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__proxy_8fpp_8f90_source.html#l00562">m_mpi_proxy.fpp.f90:563</a></div></div>
22342234
<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#l00303">m_variables_conversion.fpp.f90:303</a></div></div>
22352235
<div class="ttc" id="anamespacem__variables__conversion_html_a1d9e637b2271cb6db05f932942fd3ffb"><div class="ttname"><a href="namespacem__variables__conversion.html#a1d9e637b2271cb6db05f932942fd3ffb">m_variables_conversion::gammas</a></div><div class="ttdeci">real(wp), dimension(:), allocatable, public gammas</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l00342">m_variables_conversion.fpp.f90:342</a></div></div>
2236-
<div class="ttc" id="anamespacem__variables__conversion_html_a2592c29f5aae1605bdcf12dcf6315748"><div class="ttname"><a href="namespacem__variables__conversion.html#a2592c29f5aae1605bdcf12dcf6315748">m_variables_conversion::s_compute_speed_of_sound</a></div><div class="ttdeci">subroutine s_compute_speed_of_sound(pres, rho, gamma, pi_inf, h, adv, vel_sum, c_c, c, qv)</div><div class="ttdoc">Computes the speed of sound from thermodynamic state variables, supporting multiple equation-of-state...</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l02663">m_variables_conversion.fpp.f90:2664</a></div></div>
2236+
<div class="ttc" id="anamespacem__variables__conversion_html_a2592c29f5aae1605bdcf12dcf6315748"><div class="ttname"><a href="namespacem__variables__conversion.html#a2592c29f5aae1605bdcf12dcf6315748">m_variables_conversion::s_compute_speed_of_sound</a></div><div class="ttdeci">subroutine s_compute_speed_of_sound(pres, rho, gamma, pi_inf, h, adv, vel_sum, c_c, c, qv)</div><div class="ttdoc">Computes the speed of sound from thermodynamic state variables, supporting multiple equation-of-state...</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l02661">m_variables_conversion.fpp.f90:2662</a></div></div>
22372237
<div class="ttc" id="anamespacem__variables__conversion_html_a3115694a0163ff2d8ff01532ecbe6952"><div class="ttname"><a href="namespacem__variables__conversion.html#a3115694a0163ff2d8ff01532ecbe6952">m_variables_conversion::qvs</a></div><div class="ttdeci">real(wp), dimension(:), allocatable, public qvs</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l00342">m_variables_conversion.fpp.f90:342</a></div></div>
22382238
<div class="ttc" id="anamespacem__variables__conversion_html_ab6b053315b36074bfef4aec10b3cb38a"><div class="ttname"><a href="namespacem__variables__conversion.html#ab6b053315b36074bfef4aec10b3cb38a">m_variables_conversion::pi_infs</a></div><div class="ttdeci">real(wp), dimension(:), allocatable, public pi_infs</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l00342">m_variables_conversion.fpp.f90:342</a></div></div>
22392239
<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#l00307">m_derived_types.fpp.f90:307</a></div></div>

post_process/m__derived__variables_8fpp_8f90_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1039,7 +1039,7 @@
10391039
<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#l00303">m_variables_conversion.fpp.f90:303</a></div></div>
10401040
<div class="ttc" id="anamespacem__variables__conversion_html_a1d9e637b2271cb6db05f932942fd3ffb"><div class="ttname"><a href="namespacem__variables__conversion.html#a1d9e637b2271cb6db05f932942fd3ffb">m_variables_conversion::gammas</a></div><div class="ttdeci">real(wp), dimension(:), allocatable, public gammas</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l00342">m_variables_conversion.fpp.f90:342</a></div></div>
10411041
<div class="ttc" id="anamespacem__variables__conversion_html_a1e7161647ea509ddad635906f5ff3478"><div class="ttname"><a href="namespacem__variables__conversion.html#a1e7161647ea509ddad635906f5ff3478">m_variables_conversion::pi_inf_sf</a></div><div class="ttdeci">real(wp), dimension(:, :, :), allocatable, public pi_inf_sf</div><div class="ttdoc">Scalar liquid stiffness function.</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l00386">m_variables_conversion.fpp.f90:386</a></div></div>
1042-
<div class="ttc" id="anamespacem__variables__conversion_html_a2592c29f5aae1605bdcf12dcf6315748"><div class="ttname"><a href="namespacem__variables__conversion.html#a2592c29f5aae1605bdcf12dcf6315748">m_variables_conversion::s_compute_speed_of_sound</a></div><div class="ttdeci">subroutine s_compute_speed_of_sound(pres, rho, gamma, pi_inf, h, adv, vel_sum, c_c, c, qv)</div><div class="ttdoc">Computes the speed of sound from thermodynamic state variables, supporting multiple equation-of-state...</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l02663">m_variables_conversion.fpp.f90:2664</a></div></div>
1042+
<div class="ttc" id="anamespacem__variables__conversion_html_a2592c29f5aae1605bdcf12dcf6315748"><div class="ttname"><a href="namespacem__variables__conversion.html#a2592c29f5aae1605bdcf12dcf6315748">m_variables_conversion::s_compute_speed_of_sound</a></div><div class="ttdeci">subroutine s_compute_speed_of_sound(pres, rho, gamma, pi_inf, h, adv, vel_sum, c_c, c, qv)</div><div class="ttdoc">Computes the speed of sound from thermodynamic state variables, supporting multiple equation-of-state...</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l02661">m_variables_conversion.fpp.f90:2662</a></div></div>
10431043
<div class="ttc" id="anamespacem__variables__conversion_html_a57b0049119eb3c64dbe70a053168c72f"><div class="ttname"><a href="namespacem__variables__conversion.html#a57b0049119eb3c64dbe70a053168c72f">m_variables_conversion::rho_sf</a></div><div class="ttdeci">real(wp), dimension(:, :, :), allocatable, public rho_sf</div><div class="ttdoc">Scalar density function.</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l00384">m_variables_conversion.fpp.f90:384</a></div></div>
10441044
<div class="ttc" id="anamespacem__variables__conversion_html_ab3beeafbdd51bcc99841207a4a5e8b1c"><div class="ttname"><a href="namespacem__variables__conversion.html#ab3beeafbdd51bcc99841207a4a5e8b1c">m_variables_conversion::gamma_sf</a></div><div class="ttdeci">real(wp), dimension(:, :, :), allocatable, public gamma_sf</div><div class="ttdoc">Scalar sp. heat ratio function.</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l00385">m_variables_conversion.fpp.f90:385</a></div></div>
10451045
<div class="ttc" id="anamespacem__variables__conversion_html_ab6b053315b36074bfef4aec10b3cb38a"><div class="ttname"><a href="namespacem__variables__conversion.html#ab6b053315b36074bfef4aec10b3cb38a">m_variables_conversion::pi_infs</a></div><div class="ttdeci">real(wp), dimension(:), allocatable, public pi_infs</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l00342">m_variables_conversion.fpp.f90:342</a></div></div>

0 commit comments

Comments
 (0)