Skip to content

Commit cb20948

Browse files
author
MFC Action
committed
Docs @ 55e6081
1 parent 7a42202 commit cb20948

183 files changed

Lines changed: 18197 additions & 18225 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
@@ -427,7 +427,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
427427
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
428428
</ol>
429429
<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>
430-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-17</div> </div></div><!-- contents -->
430+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-18</div> </div></div><!-- contents -->
431431
</div><!-- PageDoc -->
432432
</div><!-- doc-content -->
433433
<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
@@ -1462,7 +1462,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14621462
</table>
14631463
<hr />
14641464
<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>
1465-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-17</div> </div></div><!-- contents -->
1465+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-18</div> </div></div><!-- contents -->
14661466
</div><!-- PageDoc -->
14671467
</div><!-- doc-content -->
14681468
<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-07-17</div> </div></div><!-- contents -->
1002+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-18</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 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md313"></a>
630630
<h3 class="doxsection"><a class="anchor" id="autotoc_md314"></a>
631631
Liutex visualization at transitional state</h3>
632632
<p><img src="result-3D_turb_mixing-example.png" alt="" height="400" class="inline"/></p>
633-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-17</div> </div></div><!-- contents -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-18</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
@@ -1715,7 +1715,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md447"></a>
17151715
<div class="line"> </div>
17161716
<div class="line"># Filter by type</div>
17171717
<div class="line">./mfc.sh params -t real weno</div>
1718-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-17</div> </div></div><!-- contents -->
1718+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-18</div> </div></div><!-- contents -->
17191719
</div><!-- PageDoc -->
17201720
</div><!-- doc-content -->
17211721
<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
@@ -674,7 +674,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md501"></a>
674674
<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>
675675
<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>
676676
</ul>
677-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-17</div> </div></div><!-- contents -->
677+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-18</div> </div></div><!-- contents -->
678678
</div><!-- PageDoc -->
679679
</div><!-- doc-content -->
680680
<div id="page-nav" class="page-nav-panel">

index.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@
5959
// Shock-droplet
6060
{ name: "Shedding water droplet", image: "res/simulations/a.png", computer: "Summit", computerUrl: "https://www.olcf.ornl.gov/summit/", accelerators: "960 V100s", walltime: "4h", source: "https://www.youtube.com/watch?v=Gjj-qZkXcrg" },
6161
{ name: "1K resolved particles", image: "res/simulations/x.jpg", computer: "Phoenix", computerUrl: "https://www.pace.gatech.edu/", accelerators: "4 A100s", walltime: "~1.5h", source: "https://www.youtube.com/watch?v=ufisHG0KkOU" },
62+
// Reacting flows & combustion
63+
{ name: "Cellular detonation", image: "res/simulations/det.jpg", computer: "Phoenix", computerUrl: "https://www.pace.gatech.edu/", accelerators: "1 A100", walltime: "~4h", source: "https://www.youtube.com/watch?v=V8Nis9jQqtc" },
64+
{ name: "Detonation collision", image: "res/simulations/coll.jpg", computer: "Phoenix", computerUrl: "https://www.pace.gatech.edu/", accelerators: "1 A100", walltime: "~1h", source: "https://www.youtube.com/watch?v=QBXBJsT4ZPc" },
65+
{ name: "Thermodiffusive cellular flame", image: "res/simulations/flame.jpg", computer: "Phoenix", computerUrl: "https://www.pace.gatech.edu/", accelerators: "1 A100", walltime: "~3h", source: "https://www.youtube.com/watch?v=mdtP5A7gQvY" },
66+
{ name: "Reactive shock-bubble roll-up", image: "res/simulations/rollup.jpg", computer: "Phoenix", computerUrl: "https://www.pace.gatech.edu/", accelerators: "1 A100", walltime: "~1h", source: "https://www.youtube.com/watch?v=J9RVKaTcxUY" },
67+
{ name: "Numerical soot foil", image: "res/simulations/sootfoil.jpg", computer: "Phoenix", computerUrl: "https://www.pace.gatech.edu/", accelerators: "1 A100", walltime: "~4h", source: "https://www.youtube.com/watch?v=jphIIsfGHQk" },
6268
// Biomedical & acoustics
6369
{ name: "Burstwave lithotripsy", image: "res/simulations/k.png", computer: "Delta", computerUrl: "https://www.ncsa.illinois.edu/research/project-highlights/delta/", accelerators: "128 A100s", walltime: "30m", source: "https://www.youtube.com/watch?v=XWsUTaJXGF8" },
6470
{ name: "Cavitation fragments kidney stone", image: "res/simulations/d.png", computer: "Summit", computerUrl: "https://www.olcf.ornl.gov/summit/", accelerators: "576 V100s", walltime: "30m", source: "https://doi.org/10.48550/arXiv.2305.09163" },

post_process/m__boundary__common_8fpp_8f90_source.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1666,9 +1666,9 @@
16661666
<div class="line"><a id="l01505" name="l01505"></a><span class="lineno"> 1505</span> <span class="keyword">end subroutine </span><a class="code hl_function" href="namespacem__boundary__common.html#a3ff6536d3b88213b0e72542f1b8ff7a4">s_populate_beta_bc_direction</a></div>
16671667
<div class="line"><a id="l01506" name="l01506"></a><span class="lineno"> 1506</span> </div>
16681668
<div class="line"><a id="l01507" name="l01507"></a><span class="lineno"> 1507</span><span class="keyword">end module </span><a class="code hl_namespace" href="namespacem__boundary__common.html">m_boundary_common</a></div>
1669-
<div class="ttc" id="am__phase__change_8fpp_8f90_html_ab59687ec5969af6d5b7b9ba5cf2835aa"><div class="ttname"><a href="m__phase__change_8fpp_8f90.html#ab59687ec5969af6d5b7b9ba5cf2835aa">k</a></div><div class="ttdeci">integer, intent(in) k</div><div class="ttdef"><b>Definition</b> <a href="m__phase__change_8fpp_8f90_source.html#l01078">m_phase_change.fpp.f90:1078</a></div></div>
1670-
<div class="ttc" id="am__phase__change_8fpp_8f90_html_ace2eaec12668a4d4eedb46c8c99c94f2"><div class="ttname"><a href="m__phase__change_8fpp_8f90.html#ace2eaec12668a4d4eedb46c8c99c94f2">j</a></div><div class="ttdeci">integer, intent(in) j</div><div class="ttdef"><b>Definition</b> <a href="m__phase__change_8fpp_8f90_source.html#l01078">m_phase_change.fpp.f90:1078</a></div></div>
1671-
<div class="ttc" id="am__phase__change_8fpp_8f90_html_ae9acc6b70aad4473254a118fe7e38e72"><div class="ttname"><a href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a></div><div class="ttdeci">integer, intent(in) l</div><div class="ttdef"><b>Definition</b> <a href="m__phase__change_8fpp_8f90_source.html#l01078">m_phase_change.fpp.f90:1078</a></div></div>
1669+
<div class="ttc" id="am__phase__change_8fpp_8f90_html_ab59687ec5969af6d5b7b9ba5cf2835aa"><div class="ttname"><a href="m__phase__change_8fpp_8f90.html#ab59687ec5969af6d5b7b9ba5cf2835aa">k</a></div><div class="ttdeci">integer, intent(in) k</div><div class="ttdef"><b>Definition</b> <a href="m__phase__change_8fpp_8f90_source.html#l01082">m_phase_change.fpp.f90:1082</a></div></div>
1670+
<div class="ttc" id="am__phase__change_8fpp_8f90_html_ace2eaec12668a4d4eedb46c8c99c94f2"><div class="ttname"><a href="m__phase__change_8fpp_8f90.html#ace2eaec12668a4d4eedb46c8c99c94f2">j</a></div><div class="ttdeci">integer, intent(in) j</div><div class="ttdef"><b>Definition</b> <a href="m__phase__change_8fpp_8f90_source.html#l01082">m_phase_change.fpp.f90:1082</a></div></div>
1671+
<div class="ttc" id="am__phase__change_8fpp_8f90_html_ae9acc6b70aad4473254a118fe7e38e72"><div class="ttname"><a href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a></div><div class="ttdeci">integer, intent(in) l</div><div class="ttdef"><b>Definition</b> <a href="m__phase__change_8fpp_8f90_source.html#l01082">m_phase_change.fpp.f90:1082</a></div></div>
16721672
<div class="ttc" id="anamespacem__boundary__common_html"><div class="ttname"><a href="namespacem__boundary__common.html">m_boundary_common</a></div><div class="ttdoc">Noncharacteristic and processor boundary condition application for ghost cells and buffer regions.</div><div class="ttdef"><b>Definition</b> <a href="#l00334">m_boundary_common.fpp.f90:334</a></div></div>
16731673
<div class="ttc" id="anamespacem__boundary__common_html_a352fa827d9dbbfb0be060dedcce86792"><div class="ttname"><a href="namespacem__boundary__common.html#a352fa827d9dbbfb0be060dedcce86792">m_boundary_common::s_populate_bc_direction</a></div><div class="ttdeci">impure subroutine s_populate_bc_direction(bc_dir, bc_loc, bc_bounds, bc_type_edge, q_prim_vf, pb_in, mv_in, q_t_sf)</div><div class="ttdoc">Populate the variable buffers along one direction and location, via MPI exchange for processor bounda...</div><div class="ttdef"><b>Definition</b> <a href="#l00738">m_boundary_common.fpp.f90:739</a></div></div>
16741674
<div class="ttc" id="anamespacem__boundary__common_html_a3ae990b28166105211eb26fe8360880c"><div class="ttname"><a href="namespacem__boundary__common.html#a3ae990b28166105211eb26fe8360880c">m_boundary_common::s_populate_capillary_bc_direction</a></div><div class="ttdeci">impure subroutine s_populate_capillary_bc_direction(bc_dir, bc_loc, bc_bounds, bc_type_edge, c_divs)</div><div class="ttdoc">Populate ghost cell buffers for one capillary BC direction and location, via MPI exchange for process...</div><div class="ttdef"><b>Definition</b> <a href="#l00865">m_boundary_common.fpp.f90:866</a></div></div>

post_process/m__data__input_8f90_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -762,7 +762,7 @@
762762
<div class="ttc" id="anamespacem__mpi__common_html_a1073fc1fcb6f3b9394606d5c9285e9f0"><div class="ttname"><a href="namespacem__mpi__common.html#a1073fc1fcb6f3b9394606d5c9285e9f0">m_mpi_common::s_mpi_barrier</a></div><div class="ttdeci">impure subroutine s_mpi_barrier</div><div class="ttdoc">Halts all processes until all have reached barrier.</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__common_8fpp_8f90_source.html#l00973">m_mpi_common.fpp.f90:974</a></div></div>
763763
<div class="ttc" id="anamespacem__mpi__common_html_a2e27b3212956af624c8da826f0c2c529"><div class="ttname"><a href="namespacem__mpi__common.html#a2e27b3212956af624c8da826f0c2c529">m_mpi_common::s_initialize_mpi_data</a></div><div class="ttdeci">impure subroutine s_initialize_mpi_data(q_cons_vf, ib_markers, beta)</div><div class="ttdoc">Set up MPI I/O data views and variable pointers for parallel file output.</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__common_8fpp_8f90_source.html#l00561">m_mpi_common.fpp.f90:562</a></div></div>
764764
<div class="ttc" id="anamespacem__mpi__common_html_a564644bad898d940dc6caea3297bb424"><div class="ttname"><a href="namespacem__mpi__common.html#a564644bad898d940dc6caea3297bb424">m_mpi_common::s_initialize_mpi_data_ds</a></div><div class="ttdeci">subroutine s_initialize_mpi_data_ds(q_cons_vf)</div><div class="ttdoc">Set up MPI I/O data views for downsampled (coarsened) parallel file output.</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__common_8fpp_8f90_source.html#l00642">m_mpi_common.fpp.f90:643</a></div></div>
765-
<div class="ttc" id="anamespacem__mpi__common_html_a60205c097faf19c0240af2eb40b28fee"><div class="ttname"><a href="namespacem__mpi__common.html#a60205c097faf19c0240af2eb40b28fee">m_mpi_common::s_apply_grid_from_global_dim</a></div><div class="ttdeci">subroutine s_apply_grid_from_global_dim(x_cb_glb, m_dim_glb, m_dim, sidx, bc_beg, bc_end, cb_lo, cb_hi, cw_lo, cw_hi, x_cb_loc, x_cc_loc, dx_loc)</div><div class="ttdoc">Populate the local cell-boundary, cell-center, and cell-width arrays in one direction directly from t...</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__common_8fpp_8f90_source.html#l03473">m_mpi_common.fpp.f90:3475</a></div></div>
765+
<div class="ttc" id="anamespacem__mpi__common_html_a60205c097faf19c0240af2eb40b28fee"><div class="ttname"><a href="namespacem__mpi__common.html#a60205c097faf19c0240af2eb40b28fee">m_mpi_common::s_apply_grid_from_global_dim</a></div><div class="ttdeci">subroutine s_apply_grid_from_global_dim(x_cb_glb, m_dim_glb, m_dim, sidx, bc_beg, bc_end, cb_lo, cb_hi, cw_lo, cw_hi, x_cb_loc, x_cc_loc, dx_loc)</div><div class="ttdoc">Populate the local cell-boundary, cell-center, and cell-width arrays in one direction directly from t...</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__common_8fpp_8f90_source.html#l03480">m_mpi_common.fpp.f90:3482</a></div></div>
766766
<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 gather and scatter operations for distributing post-process grid and flow-variable data.</div><div class="ttdef"><b>Definition</b> <a href="m__mpi__proxy_8fpp_8f90_source.html#l00007">m_mpi_proxy.fpp.f90:7</a></div></div>
767767
<div class="ttc" id="astructm__derived__types_1_1integer__field_html"><div class="ttname"><a href="structm__derived__types_1_1integer__field.html">m_derived_types::integer_field</a></div><div class="ttdoc">Derived type annexing an integer scalar field (SF).</div><div class="ttdef"><b>Definition</b> <a href="m__derived__types_8fpp_8f90_source.html#l00347">m_derived_types.fpp.f90:347</a></div></div>
768768
<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>

0 commit comments

Comments
 (0)