Skip to content

Commit 699a3c9

Browse files
author
MFC Action
committed
Docs @ a4a5d3c
1 parent ed5159f commit 699a3c9

48 files changed

Lines changed: 677 additions & 1492 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

documentation/architecture.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
429429
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
430430
</ol>
431431
<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>
432-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-15</div> </div></div><!-- contents -->
432+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-16</div> </div></div><!-- contents -->
433433
</div><!-- PageDoc -->
434434
</div><!-- doc-content -->
435435
<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
@@ -1516,7 +1516,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
15161516
</table>
15171517
<hr />
15181518
<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>
1519-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-15</div> </div></div><!-- contents -->
1519+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-16</div> </div></div><!-- contents -->
15201520
</div><!-- PageDoc -->
15211521
</div><!-- doc-content -->
15221522
<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
@@ -999,7 +999,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md82"></a>
999999
<h3 class="doxsection"><a class="anchor" id="autotoc_md83"></a>
10001000
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
10011001
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
1002-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-15</div> </div></div><!-- contents -->
1002+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-16</div> </div></div><!-- contents -->
10031003
</div><!-- PageDoc -->
10041004
</div><!-- doc-content -->
10051005
<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
@@ -630,7 +630,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md313"></a>
630630
<ul>
631631
<li>Papanastasiou, T. C. (1987). Flows of materials with yield. <em>J. Rheol.</em> 31, 385.</li>
632632
</ul>
633-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-15</div> </div></div><!-- contents -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-16</div> </div></div><!-- contents -->
634634
</div><!-- PageDoc -->
635635
</div><!-- doc-content -->
636636
<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
@@ -1779,7 +1779,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md449"></a>
17791779
<div class="line"> </div>
17801780
<div class="line"># Filter by type</div>
17811781
<div class="line">./mfc.sh params -t real weno</div>
1782-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-15</div> </div></div><!-- contents -->
1782+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-16</div> </div></div><!-- contents -->
17831783
</div><!-- PageDoc -->
17841784
</div><!-- doc-content -->
17851785
<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
@@ -705,7 +705,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md506"></a>
705705
<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>
706706
<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>
707707
</ul>
708-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-15</div> </div></div><!-- contents -->
708+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-16</div> </div></div><!-- contents -->
709709
</div><!-- PageDoc -->
710710
</div><!-- doc-content -->
711711
<div id="page-nav" class="page-nav-panel">

simulation/doxygen_crawl.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1516,7 +1516,6 @@
15161516
<a href="namespacem__sim__helpers.html#a3d187753f4e292887a3030707059b421"/>
15171517
<a href="namespacem__sim__helpers.html#a4d9544afc8bb29583e9448d133880e5a"/>
15181518
<a href="namespacem__sim__helpers.html#aa641aecbabcfd37456c476ac6d8549a8"/>
1519-
<a href="namespacem__sim__helpers.html#ae1073a6c7bde04f4502e8f93f81698dd"/>
15201519
<a href="namespacem__start__up.html"/>
15211520
<a href="namespacem__start__up.html#a191081d40ca4d71652c77df4c3bad640"/>
15221521
<a href="namespacem__start__up.html#a1bf604b2afd7b81737153114d92e7c80"/>

simulation/m__data__output_8fpp_8f90_source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2554,8 +2554,8 @@
25542554
<div class="ttc" id="anamespacem__ibm_html_a9cdfa4b47a00b8b5ef00feb84aa97aef"><div class="ttname"><a href="namespacem__ibm.html#a9cdfa4b47a00b8b5ef00feb84aa97aef">m_ibm::ib_markers</a></div><div class="ttdeci">type(integer_field), public ib_markers</div><div class="ttdef"><b>Definition</b> <a href="m__ibm_8fpp_8f90_source.html#l00347">m_ibm.fpp.f90:347</a></div></div>
25552555
<div class="ttc" id="anamespacem__mpi__proxy_html"><div class="ttname"><a href="namespacem__mpi__proxy.html">m_mpi_proxy</a></div><div class="ttdoc">MPI halo exchange, domain decomposition, and buffer packing/unpacking for the simulation solver.</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__proxy_8fpp_8f90_source.html#l00334">m_mpi_proxy.fpp.f90:334</a></div></div>
25562556
<div class="ttc" id="anamespacem__sim__helpers_html"><div class="ttname"><a href="namespacem__sim__helpers.html">m_sim_helpers</a></div><div class="ttdoc">Simulation helper routines for enthalpy computation, CFL calculation, and stability checks.</div><div class="ttdef"><b>Definition</b> <a href="m__sim__helpers_8fpp_8f90_source.html#l00334">m_sim_helpers.fpp.f90:334</a></div></div>
2557-
<div class="ttc" id="anamespacem__sim__helpers_html_a3c26ca717ef0246e7e32d91b00d6f0da"><div class="ttname"><a href="namespacem__sim__helpers.html#a3c26ca717ef0246e7e32d91b00d6f0da">m_sim_helpers::s_compute_enthalpy</a></div><div class="ttdeci">subroutine, public s_compute_enthalpy(q_prim_vf, pres, rho, gamma, pi_inf, re, h, alpha, vel, vel_sum, qv, j, k, l)</div><div class="ttdoc">Computes enthalpy.</div><div class="ttdef"><b>Definition</b> <a href="m__sim__helpers_8fpp_8f90_source.html#l00426">m_sim_helpers.fpp.f90:427</a></div></div>
2558-
<div class="ttc" id="anamespacem__sim__helpers_html_a4d9544afc8bb29583e9448d133880e5a"><div class="ttname"><a href="namespacem__sim__helpers.html#a4d9544afc8bb29583e9448d133880e5a">m_sim_helpers::s_compute_stability_from_dt</a></div><div class="ttdeci">subroutine, public s_compute_stability_from_dt(vel, c, rho, re_l, j, k, l, icfl, vcfl, rc, ccfl)</div><div class="ttdoc">Computes stability criterion for a specified dt.</div><div class="ttdef"><b>Definition</b> <a href="m__sim__helpers_8fpp_8f90_source.html#l00548">m_sim_helpers.fpp.f90:549</a></div></div>
2557+
<div class="ttc" id="anamespacem__sim__helpers_html_a3c26ca717ef0246e7e32d91b00d6f0da"><div class="ttname"><a href="namespacem__sim__helpers.html#a3c26ca717ef0246e7e32d91b00d6f0da">m_sim_helpers::s_compute_enthalpy</a></div><div class="ttdeci">subroutine, public s_compute_enthalpy(q_prim_vf, pres, rho, gamma, pi_inf, re, h, alpha, vel, vel_sum, qv, j, k, l)</div><div class="ttdoc">Computes enthalpy.</div><div class="ttdef"><b>Definition</b> <a href="m__sim__helpers_8fpp_8f90_source.html#l00384">m_sim_helpers.fpp.f90:385</a></div></div>
2558+
<div class="ttc" id="anamespacem__sim__helpers_html_a4d9544afc8bb29583e9448d133880e5a"><div class="ttname"><a href="namespacem__sim__helpers.html#a4d9544afc8bb29583e9448d133880e5a">m_sim_helpers::s_compute_stability_from_dt</a></div><div class="ttdeci">subroutine, public s_compute_stability_from_dt(vel, c, rho, re_l, j, k, l, icfl, vcfl, rc, ccfl)</div><div class="ttdoc">Computes stability criterion for a specified dt.</div><div class="ttdef"><b>Definition</b> <a href="m__sim__helpers_8fpp_8f90_source.html#l00506">m_sim_helpers.fpp.f90:507</a></div></div>
25592559
<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#l00334">m_variables_conversion.fpp.f90:334</a></div></div>
25602560
<div class="ttc" id="anamespacem__variables__conversion_html_a58c19a9ba2767016cd7c916cd52b8d0e"><div class="ttname"><a href="namespacem__variables__conversion.html#a58c19a9ba2767016cd7c916cd52b8d0e">m_variables_conversion::s_compute_pressure</a></div><div class="ttdeci">subroutine, public s_compute_pressure(energy, alf, dyn_p, pi_inf, gamma, rho, qv, rhoyks, pres, t, stress, mom, g, pres_mag)</div><div class="ttdoc">Compute the pressure from the appropriate equation of state.</div><div class="ttdef"><b>Definition</b> <a href="m__variables__conversion_8fpp_8f90_source.html#l00426">m_variables_conversion.fpp.f90:427</a></div></div>
25612561
<div class="ttc" id="anamespacem__variables__conversion_html_a61487c861a17acf1d2d7bfef6ad85380"><div class="ttname"><a href="namespacem__variables__conversion.html#a61487c861a17acf1d2d7bfef6ad85380">m_variables_conversion::s_compute_speed_of_sound</a></div><div class="ttdeci">subroutine, public s_compute_speed_of_sound(pres, rho, gamma, pi_inf, h, adv, vel_sum, c_c, c, qv)</div><div class="ttdoc">Compute 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#l02529">m_variables_conversion.fpp.f90:2530</a></div></div>

simulation/m__sim__helpers_8fpp_8f90.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,6 @@
172172
Functions/Subroutines</h2></td></tr>
173173
<tr class="memitem:aa641aecbabcfd37456c476ac6d8549a8" id="r_aa641aecbabcfd37456c476ac6d8549a8"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>) function&#160;</td><td class="memItemRight"><a class="el" href="namespacem__sim__helpers.html#aa641aecbabcfd37456c476ac6d8549a8">m_sim_helpers::f_compute_filtered_dtheta</a> (<a class="el" href="m__phase__change_8fpp_8f90.html#ab59687ec5969af6d5b7b9ba5cf2835aa">k</a>, <a class="el" href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a>)</td></tr>
174174
<tr class="memdesc:aa641aecbabcfd37456c476ac6d8549a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the modified dtheta for Fourier filtering in azimuthal direction. <br /></td></tr>
175-
<tr class="memitem:ae1073a6c7bde04f4502e8f93f81698dd" id="r_ae1073a6c7bde04f4502e8f93f81698dd"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>) function&#160;</td><td class="memItemRight"><a class="el" href="namespacem__sim__helpers.html#ae1073a6c7bde04f4502e8f93f81698dd">m_sim_helpers::f_compute_multidim_cfl_terms</a> (vel, c, <a class="el" href="m__phase__change_8fpp_8f90.html#ace2eaec12668a4d4eedb46c8c99c94f2">j</a>, <a class="el" href="m__phase__change_8fpp_8f90.html#ab59687ec5969af6d5b7b9ba5cf2835aa">k</a>, <a class="el" href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a>)</td></tr>
176-
<tr class="memdesc:ae1073a6c7bde04f4502e8f93f81698dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes inviscid CFL terms for multi-dimensional cases (2D/3D only). <br /></td></tr>
177175
<tr class="memitem:a3c26ca717ef0246e7e32d91b00d6f0da" id="r_a3c26ca717ef0246e7e32d91b00d6f0da"><td class="memItemLeft">subroutine, public&#160;</td><td class="memItemRight"><a class="el" href="namespacem__sim__helpers.html#a3c26ca717ef0246e7e32d91b00d6f0da">m_sim_helpers::s_compute_enthalpy</a> (q_prim_vf, pres, rho, gamma, pi_inf, re, h, alpha, vel, vel_sum, qv, <a class="el" href="m__phase__change_8fpp_8f90.html#ace2eaec12668a4d4eedb46c8c99c94f2">j</a>, <a class="el" href="m__phase__change_8fpp_8f90.html#ab59687ec5969af6d5b7b9ba5cf2835aa">k</a>, <a class="el" href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a>)</td></tr>
178176
<tr class="memdesc:a3c26ca717ef0246e7e32d91b00d6f0da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes enthalpy. <br /></td></tr>
179177
<tr class="memitem:a4d9544afc8bb29583e9448d133880e5a" id="r_a4d9544afc8bb29583e9448d133880e5a"><td class="memItemLeft">subroutine, public&#160;</td><td class="memItemRight"><a class="el" href="namespacem__sim__helpers.html#a4d9544afc8bb29583e9448d133880e5a">m_sim_helpers::s_compute_stability_from_dt</a> (vel, c, rho, re_l, <a class="el" href="m__phase__change_8fpp_8f90.html#ace2eaec12668a4d4eedb46c8c99c94f2">j</a>, <a class="el" href="m__phase__change_8fpp_8f90.html#ab59687ec5969af6d5b7b9ba5cf2835aa">k</a>, <a class="el" href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a>, icfl, vcfl, rc, ccfl)</td></tr>

simulation/m__sim__helpers_8fpp_8f90.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
var m__sim__helpers_8fpp_8f90 =
22
[
33
[ "m_sim_helpers::f_compute_filtered_dtheta", "namespacem__sim__helpers.html#aa641aecbabcfd37456c476ac6d8549a8", null ],
4-
[ "m_sim_helpers::f_compute_multidim_cfl_terms", "namespacem__sim__helpers.html#ae1073a6c7bde04f4502e8f93f81698dd", null ],
54
[ "m_sim_helpers::s_compute_dt_from_cfl", "namespacem__sim__helpers.html#a3d187753f4e292887a3030707059b421", null ],
65
[ "m_sim_helpers::s_compute_enthalpy", "namespacem__sim__helpers.html#a3c26ca717ef0246e7e32d91b00d6f0da", null ],
76
[ "m_sim_helpers::s_compute_stability_from_dt", "namespacem__sim__helpers.html#a4d9544afc8bb29583e9448d133880e5a", null ]

0 commit comments

Comments
 (0)