Skip to content

Commit a178198

Browse files
author
MFC Action
committed
Docs @ 603ce01
1 parent 6c1ca50 commit a178198

98 files changed

Lines changed: 12554 additions & 13303 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-29</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-30</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: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -862,8 +862,8 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
862862
<li>down sample requires m divisible by 3</li>
863863
</ul>
864864
<p><b>Valid values</b> (errors):</p><ul>
865+
<li>m must be at least param_name - 1 (= order - 1)</li>
865866
<li>m must be positive</li>
866-
<li>m must be at least igr_order - 1 (= igr_order - 1)</li>
867867
</ul>
868868
<p></p>
869869
</details>
@@ -925,7 +925,6 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
925925
</ul>
926926
<p><b>Valid values</b> (errors):</p><ul>
927927
<li>muscl_order must be 1 or 2</li>
928-
<li>m must be at least muscl_order - 1 (= muscl_order - 1)</li>
929928
</ul>
930929
<p></p>
931930
</details>
@@ -947,7 +946,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
947946
</ul>
948947
<p><b>Valid values</b> (errors):</p><ul>
949948
<li>n must be non-negative</li>
950-
<li>n must be at least igr_order - 1 (= igr_order - 1)</li>
949+
<li>n must be positive (2D or 3D) for cylindrical coordinates</li>
951950
</ul>
952951
<p></p>
953952
</details>
@@ -1147,7 +1146,6 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
11471146
</ul>
11481147
<p><b>Valid values</b> (errors):</p><ul>
11491148
<li>recon_type must be 1 (WENO) or 2 (MUSCL)</li>
1150-
<li>recon_type must be 1 (WENO) or 2 (MUSCL)</li>
11511149
</ul>
11521150
<p></p>
11531151
</details>
@@ -1437,7 +1435,6 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
14371435
</ul>
14381436
<p><b>Valid values</b> (errors):</p><ul>
14391437
<li>weno_order must be 1, 3, 5, or 7</li>
1440-
<li>m must be at least weno_order - 1 (= weno_order - 1)</li>
14411438
</ul>
14421439
<p></p>
14431440
</details>
@@ -1456,7 +1453,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14561453
</table>
14571454
<hr />
14581455
<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-29</div> </div></div><!-- contents -->
1456+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-30</div> </div></div><!-- contents -->
14601457
</div><!-- PageDoc -->
14611458
</div><!-- doc-content -->
14621459
<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-29</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-30</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_md275"></a>
388388
<h3 class="doxsection"><a class="anchor" id="autotoc_md276"></a>
389389
Result</h3>
390390
<p><img src="result-1D_titarevtorro-example.png" alt="" heiht="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-29</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-30</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: 181 additions & 195 deletions
Large diffs are not rendered by default.

documentation/physics_constraints.html

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -477,9 +477,6 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md430"></a>
477477
<ul>
478478
<li><span class="tt">igr_pres_lim</span> requires <span class="tt">igr</span> to be enabled</li>
479479
<li><span class="tt">igr_order</span> must be 3 or 5</li>
480-
<li><span class="tt">m</span> must be at least <span class="tt">igr_order</span> - 1 (= <span class="tt">igr_order</span> - 1)</li>
481-
<li><span class="tt">n</span> must be at least <span class="tt">igr_order</span> - 1 (= <span class="tt">igr_order</span> - 1)</li>
482-
<li><span class="tt">p</span> must be at least <span class="tt">igr_order</span> - 1 (= <span class="tt">igr_order</span> - 1)</li>
483480
</ul>
484481
<hr />
485482
<h2 class="doxsection"><a class="anchor" id="autotoc_md432"></a>
@@ -492,26 +489,26 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md433"></a>
492489
<ul>
493490
<li><span class="tt">recon_type</span> = 1 (WENO) is not compatible with <span class="tt">muscl_order</span></li>
494491
<li><span class="tt">recon_type</span> = 1 (WENO) is not compatible with <span class="tt">muscl_lim</span></li>
495-
<li><span class="tt">recon_type</span> must be 1 (WENO) or 2 (MUSCL)</li>
496492
<li><span class="tt">weno_order</span> must be 1, 3, 5, or 7</li>
497-
<li><span class="tt">m</span> must be at least <span class="tt">weno_order</span> - 1 (= <span class="tt">weno_order</span> - 1)</li>
498-
<li>For 2D simulation, <span class="tt">n</span> must be at least <span class="tt">weno_order</span> - 1 (= <span class="tt">weno_order</span> - 1)</li>
499-
<li>For 3D simulation, <span class="tt">p</span> must be at least <span class="tt">weno_order</span> - 1 (= <span class="tt">weno_order</span> - 1)</li>
500493
</ul>
501494
<h3 class="doxsection"><a class="anchor" id="autotoc_md434"></a>
502495
MUSCL Reconstruction</h3>
503496
<p>muscl_order must be 1 or 2. Second order requires muscl_lim in {0,1,2,3,4,5}.</p>
504497
<p><b>Stage:</b> common, pre_process, simulation, post_process | <b>Severity:</b> error</p>
505498
<p><b>Enforced checks:</b></p>
506499
<ul>
507-
<li><span class="tt">recon_type</span> must be 1 (WENO) or 2 (MUSCL)</li>
508-
<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with param = T</li>
509-
<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with param</li>
500+
<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with <span class="tt">mapped_weno</span> = T</li>
501+
<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with wenoz = T</li>
502+
<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with teno = T</li>
503+
<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with <span class="tt">mp_weno</span> = T</li>
504+
<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with <span class="tt">weno_avg</span> = T</li>
505+
<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with <span class="tt">null_weights</span> = T</li>
506+
<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with <span class="tt">weno_Re_flux</span> = T</li>
507+
<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with <span class="tt">wenoz_q</span></li>
508+
<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with <span class="tt">teno_CT</span></li>
509+
<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with <span class="tt">weno_eps</span></li>
510510
<li><span class="tt">recon_type</span> = 2 (MUSCL) requires <span class="tt">weno_order</span> unset or 0, but got <span class="tt">weno_order</span></li>
511511
<li><span class="tt">muscl_order</span> must be 1 or 2</li>
512-
<li><span class="tt">m</span> must be at least <span class="tt">muscl_order</span> - 1 (= <span class="tt">muscl_order</span> - 1)</li>
513-
<li>For 2D simulation, <span class="tt">n</span> must be at least <span class="tt">muscl_order</span> - 1 (= <span class="tt">muscl_order</span> - 1)</li>
514-
<li>For 3D simulation, <span class="tt">p</span> must be at least <span class="tt">muscl_order</span> - 1 (= <span class="tt">muscl_order</span> - 1)</li>
515512
</ul>
516513
<h3 class="doxsection"><a class="anchor" id="autotoc_md435"></a>
517514
Time Stepping</h3>
@@ -630,7 +627,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md443"></a>
630627
<li>FFT WRT incompatible with cylindrical coordinates</li>
631628
<li>FFT WRT requires global dimensions divisible by 2</li>
632629
</ul>
633-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-29</div> </div></div><!-- contents -->
630+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-30</div> </div></div><!-- contents -->
634631
</div><!-- PageDoc -->
635632
</div><!-- doc-content -->
636633
<div id="page-nav" class="page-nav-panel">

post_process/doxygen_crawl.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -517,6 +517,7 @@
517517
<a href="namespacem__global__parameters.html#acaad071090079e05985a27f6e55d70a8"/>
518518
<a href="namespacem__global__parameters.html#acbb163a79ff0011a4327c3fb65a04c14"/>
519519
<a href="namespacem__global__parameters.html#acc9528b2fecd03ad3e257b912e5772b4"/>
520+
<a href="namespacem__global__parameters.html#acd7c27a92399b2ae79a4e2ae6d66fd8d"/>
520521
<a href="namespacem__global__parameters.html#acd86b6cea52b83b147f680d9d6da342c"/>
521522
<a href="namespacem__global__parameters.html#acdbe546c7ab8a757a82aee80295b9477"/>
522523
<a href="namespacem__global__parameters.html#ace0c8a67825d0dccd2e23b5d0f9985c0"/>
@@ -545,7 +546,6 @@
545546
<a href="namespacem__global__parameters.html#ae9a8bf3ee4dc2a8682b84abe1ec4b880"/>
546547
<a href="namespacem__global__parameters.html#aea6f7a78cfc15cfbc9ecf75de24adbce"/>
547548
<a href="namespacem__global__parameters.html#aeb332a499ed778d200d1caa2abe19782"/>
548-
<a href="namespacem__global__parameters.html#aeca6669400147d334a6b77025da6a7d9"/>
549549
<a href="namespacem__global__parameters.html#aee38c9d03e9195858a93ec611b605f33"/>
550550
<a href="namespacem__global__parameters.html#aeea4f114de783213aeaf3147d002e53a"/>
551551
<a href="namespacem__global__parameters.html#af0abe82216f3cae1170e7aae4304dae9"/>

post_process/m__boundary__common_8fpp_8f90_source.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4085,9 +4085,9 @@
40854085
<div class="ttc" id="anamespacem__delay__file__access_html"><div class="ttname"><a href="namespacem__delay__file__access.html">m_delay_file_access</a></div><div class="ttdoc">Rank-staggered file access delays to prevent I/O contention on parallel file systems.</div><div class="ttdef"><b>Definition</b> <a href="m__delay__file__access_8f90_source.html#l00006">m_delay_file_access.f90:6</a></div></div>
40864086
<div class="ttc" id="anamespacem__derived__types_html"><div class="ttname"><a href="namespacem__derived__types.html">m_derived_types</a></div><div class="ttdoc">Shared derived types for field data, patch geometry, bubble dynamics, and MPI I/O structures.</div><div class="ttdef"><b>Definition</b> <a href="m__derived__types_8fpp_8f90_source.html#l00317">m_derived_types.fpp.f90:317</a></div></div>
40874087
<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>
4088-
<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>
4089-
<div class="ttc" id="anamespacem__global__parameters_html_a496ef8774198893700cd0ecce1ef8611"><div class="ttname"><a href="namespacem__global__parameters.html#a496ef8774198893700cd0ecce1ef8611">m_global_parameters::bc_io</a></div><div class="ttdeci">logical bc_io</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00137">m_global_parameters.fpp.f90:137</a></div></div>
4090-
<div class="ttc" id="anamespacem__global__parameters_html_a4dac2e4ead915635e0c6c33af87be01b"><div class="ttname"><a href="namespacem__global__parameters.html#a4dac2e4ead915635e0c6c33af87be01b">m_global_parameters::sys_size</a></div><div class="ttdeci">integer sys_size</div><div class="ttdoc">Number of unknowns in the system of equations.</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00103">m_global_parameters.fpp.f90:103</a></div></div>
4088+
<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#l00204">m_global_parameters.fpp.f90:204</a></div></div>
4089+
<div class="ttc" id="anamespacem__global__parameters_html_a496ef8774198893700cd0ecce1ef8611"><div class="ttname"><a href="namespacem__global__parameters.html#a496ef8774198893700cd0ecce1ef8611">m_global_parameters::bc_io</a></div><div class="ttdeci">logical bc_io</div><div class="ttdef"><b>Definition</b> <a href="m__global__parameters_8fpp_8f90_source.html#l00219">m_global_parameters.fpp.f90:219</a></div></div>
4090+
<div class="ttc" id="anamespacem__global__parameters_html_a4dac2e4ead915635e0c6c33af87be01b"><div class="ttname"><a href="namespacem__global__parameters.html#a4dac2e4ead915635e0c6c33af87be01b">m_global_parameters::sys_size</a></div><div class="ttdeci">integer sys_size</div><div class="ttdoc">Number of unknowns in the system of equations.</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>
40914091
<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>
40924092
<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#l00331">m_derived_types.fpp.f90:331</a></div></div>
40934093
</div><!-- fragment --></div><!-- contents -->

0 commit comments

Comments
 (0)