Skip to content

Commit 84f9206

Browse files
author
MFC Action
committed
Docs @ b40c0bf
1 parent 3d60287 commit 84f9206

331 files changed

Lines changed: 45248 additions & 48712 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
@@ -405,7 +405,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
405405
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
406406
</ol>
407407
<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>
408-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-13</div> </div></div><!-- contents -->
408+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-14</div> </div></div><!-- contents -->
409409
</div><!-- PageDoc -->
410410
</div><!-- doc-content -->
411411
<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
@@ -1456,7 +1456,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14561456
</table>
14571457
<hr />
14581458
<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>
1459-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-13</div> </div></div><!-- contents -->
1459+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-14</div> </div></div><!-- contents -->
14601460
</div><!-- PageDoc -->
14611461
</div><!-- doc-content -->
14621462
<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
@@ -996,7 +996,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
996996
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
997997
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
998998
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
999-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-13</div> </div></div><!-- contents -->
999+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-14</div> </div></div><!-- contents -->
10001000
</div><!-- PageDoc -->
10011001
</div><!-- doc-content -->
10021002
<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 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md276"></a>
388388
Final Condition</h3>
389389
<p>This figure shows the isosurface with zero q-criterion.</p>
390390
<p><img src="result-3D_TaylorGreenVortex-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-05-13</div> </div></div><!-- contents -->
391+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-14</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
@@ -1577,7 +1577,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md393"></a>
15771577
<div class="line"> </div>
15781578
<div class="line"># Filter by type</div>
15791579
<div class="line">./mfc.sh params -t real weno</div>
1580-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-13</div> </div></div><!-- contents -->
1580+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-14</div> </div></div><!-- contents -->
15811581
</div><!-- PageDoc -->
15821582
</div><!-- doc-content -->
15831583
<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
@@ -630,7 +630,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md443"></a>
630630
<li>FFT WRT incompatible with cylindrical coordinates</li>
631631
<li>FFT WRT requires global dimensions divisible by 2</li>
632632
</ul>
633-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-13</div> </div></div><!-- contents -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-14</div> </div></div><!-- contents -->
634634
</div><!-- PageDoc -->
635635
</div><!-- doc-content -->
636636
<div id="page-nav" class="page-nav-panel">

post_process/doxygen_crawl.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,6 @@
398398
<a href="namespacem__global__parameters.html#a462197f1d200764c9a08659fb9c38b8f"/>
399399
<a href="namespacem__global__parameters.html#a46a3e8a6405a0008a7f34bcfc648b20f"/>
400400
<a href="namespacem__global__parameters.html#a46b16c80e0d218bcc685eac47ed8540c"/>
401-
<a href="namespacem__global__parameters.html#a473ba9ea57f14c04235537f2c6652163"/>
402401
<a href="namespacem__global__parameters.html#a47c47975a0cf5173d1113466a31e9e35"/>
403402
<a href="namespacem__global__parameters.html#a47f14158f79eaa37dabc2f8ed64faf59"/>
404403
<a href="namespacem__global__parameters.html#a480ab158b8c8cdb98778575649077d83"/>

post_process/m__checker__common_8fpp_8f90_source.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -542,14 +542,14 @@
542542
<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">Check that simulation parameters stay within AMD GPU compiler limits when case optimization is disabl...</div><div class="ttdef"><b>Definition</b> <a href="#l00372">m_checker_common.fpp.f90:373</a></div></div>
543543
<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">Verify that the total number of grid cells meets the minimum required by the number of dimensions and...</div><div class="ttdef"><b>Definition</b> <a href="#l00353">m_checker_common.fpp.f90:354</a></div></div>
544544
<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>
545-
<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#l00253">m_global_parameters.fpp.f90:253</a></div></div>
545+
<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#l00252">m_global_parameters.fpp.f90:252</a></div></div>
546546
<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#l00120">m_global_parameters.fpp.f90:120</a></div></div>
547547
<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#l00099">m_global_parameters.fpp.f90:99</a></div></div>
548-
<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#l00278">m_global_parameters.fpp.f90:278</a></div></div>
548+
<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#l00277">m_global_parameters.fpp.f90:277</a></div></div>
549549
<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#l00033">m_global_parameters.fpp.f90:33</a></div></div>
550550
<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#l00044">m_global_parameters.fpp.f90:44</a></div></div>
551551
<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#l00043">m_global_parameters.fpp.f90:43</a></div></div>
552-
<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#l00250">m_global_parameters.fpp.f90:250</a></div></div>
552+
<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#l00249">m_global_parameters.fpp.f90:249</a></div></div>
553553
<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#l00042">m_global_parameters.fpp.f90:42</a></div></div>
554554
<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="ttdoc">Total number of cells in global domain.</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00049">m_global_parameters.fpp.f90:49</a></div></div>
555555
<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#l00317">m_helper_basic.fpp.f90:317</a></div></div>

post_process/m__chemistry_8fpp_8f90_source.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -757,7 +757,7 @@
757757
<div class="line"><a id="l00611" name="l00611"></a><span class="lineno"> 611</span><span class="preprocessor"># 194 &quot;/home/runner/work/MFC/MFC/src/common/m_chemistry.fpp&quot;</span></div>
758758
<div class="line"><a id="l00612" name="l00612"></a><span class="lineno"> 612</span><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
759759
<div class="line"><a id="l00613" name="l00613"></a><span class="lineno"> 613</span><span class="preprocessor"></span> </div>
760-
<div class="line"><a id="l00614" name="l00614"></a><span class="lineno"> 614</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="namespacem__global__parameters.html#a206f9fba2814a2fd594e9b884e183347">chemistry</a> .or. <a class="code hl_variable" href="namespacem__global__parameters.html#a473ba9ea57f14c04235537f2c6652163">dummy</a>) <span class="keywordflow">then</span></div>
760+
<div class="line"><a id="l00614" name="l00614"></a><span class="lineno"> 614</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="namespacem__global__parameters.html#a206f9fba2814a2fd594e9b884e183347">chemistry</a>) <span class="keywordflow">then</span></div>
761761
<div class="line"><a id="l00615" name="l00615"></a><span class="lineno"> 615</span> <span class="comment">! Set offsets based on direction using array indexing</span></div>
762762
<div class="line"><a id="l00616" name="l00616"></a><span class="lineno"> 616</span> offsets = 0</div>
763763
<div class="line"><a id="l00617" name="l00617"></a><span class="lineno"> 617</span> offsets(idir) = 1</div>
@@ -1155,9 +1155,8 @@
11551155
<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>
11561156
<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#l00120">m_global_parameters.fpp.f90:120</a></div></div>
11571157
<div class="ttc" id="anamespacem__global__parameters_html_a353ab56efc0b78fea27c11158c2cf536"><div class="ttname"><a href="namespacem__global__parameters.html#a353ab56efc0b78fea27c11158c2cf536">m_global_parameters::y_cc</a></div><div class="ttdeci">real(wp), dimension(:), allocatable y_cc</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00071">m_global_parameters.fpp.f90:71</a></div></div>
1158-
<div class="ttc" id="anamespacem__global__parameters_html_a473ba9ea57f14c04235537f2c6652163"><div class="ttname"><a href="namespacem__global__parameters.html#a473ba9ea57f14c04235537f2c6652163">m_global_parameters::dummy</a></div><div class="ttdeci">logical dummy</div><div class="ttdoc">AMDFlang workaround for case-optimization + GPU-kernel bug.</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00200">m_global_parameters.fpp.f90:200</a></div></div>
11591158
<div class="ttc" id="anamespacem__global__parameters_html_a7f28c6009b6b3031436d2f1ad6228555"><div class="ttname"><a href="namespacem__global__parameters.html#a7f28c6009b6b3031436d2f1ad6228555">m_global_parameters::x_cc</a></div><div class="ttdeci">real(wp), dimension(:), allocatable x_cc</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00071">m_global_parameters.fpp.f90:71</a></div></div>
1160-
<div class="ttc" id="anamespacem__global__parameters_html_a8617063e88a25d9bc5d8aec3189e0862"><div class="ttname"><a href="namespacem__global__parameters.html#a8617063e88a25d9bc5d8aec3189e0862">m_global_parameters::chem_params</a></div><div class="ttdeci">type(chemistry_parameters) chem_params</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00247">m_global_parameters.fpp.f90:247</a></div></div>
1159+
<div class="ttc" id="anamespacem__global__parameters_html_a8617063e88a25d9bc5d8aec3189e0862"><div class="ttname"><a href="namespacem__global__parameters.html#a8617063e88a25d9bc5d8aec3189e0862">m_global_parameters::chem_params</a></div><div class="ttdeci">type(chemistry_parameters) chem_params</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00246">m_global_parameters.fpp.f90:246</a></div></div>
11611160
<div class="ttc" id="anamespacem__global__parameters_html_a9efba3343251f7bc76bf9c7c6613b41e"><div class="ttname"><a href="namespacem__global__parameters.html#a9efba3343251f7bc76bf9c7c6613b41e">m_global_parameters::z_cc</a></div><div class="ttdeci">real(wp), dimension(:), allocatable z_cc</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00071">m_global_parameters.fpp.f90:71</a></div></div>
11621161
<div class="ttc" id="anamespacem__global__parameters_html_af450e59f07548be6596c3b9ecd707200"><div class="ttname"><a href="namespacem__global__parameters.html#af450e59f07548be6596c3b9ecd707200">m_global_parameters::eqn_idx</a></div><div class="ttdeci">type(eqn_idx_info) eqn_idx</div><div class="ttdoc">All conserved-variable equation index ranges and scalars.</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00126">m_global_parameters.fpp.f90:126</a></div></div>
11631162
</div><!-- fragment --></div><!-- contents -->

0 commit comments

Comments
 (0)