Skip to content

Commit 38e6d48

Browse files
author
MFC Action
committed
Docs @ 35b2134
1 parent 2e9107f commit 38e6d48

File tree

139 files changed

+9887
-11354
lines changed

Some content is hidden

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

139 files changed

+9887
-11354
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-27</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-28</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: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1032,6 +1032,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
10321032
</ul>
10331033
<p><b>Incompatibilities</b> (errors):</p><ul>
10341034
<li>6-equation model (model_eqns = 3) does not support cylindrical coordinates (cyl_coord = T and p != 0)</li>
1035+
<li>Fully 3D cylindrical geometry (cyl_coord = T, p &gt; 0) is not supported in single precision (&ndash;single)</li>
10351036
</ul>
10361037
<p><b>Valid values</b> (errors):</p><ul>
10371038
<li>p must be non-negative</li>
@@ -1065,6 +1066,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
10651066
<li>Choices: <span class="tt">1</span> = single, <span class="tt">2</span> = double</li>
10661067
</ul>
10671068
<p><b>Requirements</b> (errors):</p><ul>
1069+
<li>precision = 2 (double output) requires MFC built without &ndash;single</li>
10681070
<li>output_partial_domain requires precision = 2</li>
10691071
</ul>
10701072
<p><b>Valid values</b> (errors):</p><ul>
@@ -1421,7 +1423,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14211423
</table>
14221424
<hr />
14231425
<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-27</div> </div></div><!-- contents -->
1426+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-28</div> </div></div><!-- contents -->
14251427
</div><!-- PageDoc -->
14261428
</div><!-- doc-content -->
14271429
<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-27</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-28</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 (Density)</h3>
390390
<p><img src="final-2D_forward_facing_step-example.png" alt="" class="inline"/></p>
391-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-27</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-28</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: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1159,7 +1159,7 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
11591159
<tr class="markdownTableRowEven">
11601160
<td class="markdownTableBodyNone"><span class="tt">cont_damage_s</span> </td><td class="markdownTableBodyNone">Real </td><td class="markdownTableBodyNone">Continuum damage shape parameter </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">cont_damage_s</span> must be specified for <span class="tt">cont_damage</span> </td></tr>
11611161
<tr class="markdownTableRowOdd">
1162-
<td class="markdownTableBodyNone"><span class="tt">cyl_coord</span> </td><td class="markdownTableBodyNone">Logical (T/F) </td><td class="markdownTableBodyNone">Enable cylindrical coordinates (2D: axisymmetric, 3D: cylindrical) </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">6-equation model (<span class="tt">model_eqns</span> = 3) does not support cylindrical coordinates (<span class="tt">cyl_coord</span> = T and p != 0); <span class="tt">bc_key</span> must not be -14 (BC_AXIS) for non-cylindrical coordinates; p must be odd for cylindrical coordinates </td></tr>
1162+
<td class="markdownTableBodyNone"><span class="tt">cyl_coord</span> </td><td class="markdownTableBodyNone">Logical (T/F) </td><td class="markdownTableBodyNone">Enable cylindrical coordinates (2D: axisymmetric, 3D: cylindrical) </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">6-equation model (<span class="tt">model_eqns</span> = 3) does not support cylindrical coordinates (<span class="tt">cyl_coord</span> = T and p != 0); <span class="tt">bc_key</span> must not be -14 (BC_AXIS) for non-cylindrical coordinates; Fully 3D cylindrical geometry (<span class="tt">cyl_coord</span> = T, p &gt; 0) is not supported in single <span class="tt">precision</span> (&ndash;single) </td></tr>
11631163
<tr class="markdownTableRowEven">
11641164
<td class="markdownTableBodyNone"><span class="tt">dist_type</span> </td><td class="markdownTableBodyNone">Integer </td><td class="markdownTableBodyNone">Distribution type for polydisperse bubbles </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">dist_type</span> must be set if using QBMM; <span class="tt">rhoRV</span> cannot be used with <span class="tt">dist_type</span> != 1 </td></tr>
11651165
<tr class="markdownTableRowOdd">
@@ -1361,7 +1361,7 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
13611361
<tr class="markdownTableRowOdd">
13621362
<td class="markdownTableBodyNone"><span class="tt">palpha_eps</span> </td><td class="markdownTableBodyNone">Real </td><td class="markdownTableBodyNone">Volume fraction epsilon for pressure relaxation </td><td class="markdownTableBodyNone">\(\varepsilon_\alpha\) </td><td class="markdownTableBodyNone"><span class="tt">palpha_eps</span> must be positive; <span class="tt">palpha_eps</span> must be less than 1 </td></tr>
13631363
<tr class="markdownTableRowEven">
1364-
<td class="markdownTableBodyNone"><span class="tt">parallel_io</span> </td><td class="markdownTableBodyNone">Logical (T/F) </td><td class="markdownTableBodyNone">Enable parallel I/O </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">down sample requires <span class="tt">parallel_io</span> = T </td></tr>
1364+
<td class="markdownTableBodyNone"><span class="tt">parallel_io</span> </td><td class="markdownTableBodyNone">Logical (T/F) </td><td class="markdownTableBodyNone">Enable parallel I/O </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">down sample requires <span class="tt">parallel_io</span> = T; <span class="tt">parallel_io</span> = T requires MFC built with &ndash;mpi </td></tr>
13651365
<tr class="markdownTableRowOdd">
13661366
<td class="markdownTableBodyNone"><span class="tt">perturb_flow</span> </td><td class="markdownTableBodyNone">Logical (T/F) </td><td class="markdownTableBodyNone">Enable flow perturbation </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">perturb_flow_fluid</span> and <span class="tt">perturb_flow_mag</span> must be set with <span class="tt">perturb_flow</span> = T; <span class="tt">perturb_flow_fluid</span> and <span class="tt">perturb_flow_mag</span> must not be set with <span class="tt">perturb_flow</span> = F </td></tr>
13671367
<tr class="markdownTableRowEven">
@@ -1387,7 +1387,7 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
13871387
<tr class="markdownTableRowEven">
13881388
<td class="markdownTableBodyNone"><span class="tt">pre_stress</span> </td><td class="markdownTableBodyNone">Logical (T/F) </td><td class="markdownTableBodyNone">Enable pre-stress initialization </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">pre_stress</span> requires <span class="tt">hyperelasticity</span> to be enabled </td></tr>
13891389
<tr class="markdownTableRowOdd">
1390-
<td class="markdownTableBodyNone"><span class="tt">precision</span> </td><td class="markdownTableBodyNone">Integer </td><td class="markdownTableBodyNone">Output precision </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">1=single, 2=double; <span class="tt">precision</span> must be 1 or 2 </td></tr>
1390+
<td class="markdownTableBodyNone"><span class="tt">precision</span> </td><td class="markdownTableBodyNone">Integer </td><td class="markdownTableBodyNone">Output precision </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">1=single, 2=double; <span class="tt">precision</span> = 2 (double output) requires MFC built without &ndash;single; <span class="tt">precision</span> must be 1 or 2 </td></tr>
13911391
<tr class="markdownTableRowEven">
13921392
<td class="markdownTableBodyNone"><span class="tt">pref</span> </td><td class="markdownTableBodyNone">Real </td><td class="markdownTableBodyNone">Reference pressure </td><td class="markdownTableBodyNone">\(p_\text{ref}\) </td><td class="markdownTableBodyNone"><span class="tt">pref</span> must be set if using <span class="tt">bubbles_euler</span> with <span class="tt">model_eqns</span> = 4; <span class="tt">pref</span> (reference pressure) must be positive </td></tr>
13931393
<tr class="markdownTableRowOdd">
@@ -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-27</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-28</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-27</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-28</div> </div></div><!-- contents -->
627627
</div><!-- PageDoc -->
628628
</div><!-- doc-content -->
629629
<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
@@ -163,7 +163,6 @@
163163
<a href="namespacem__checker.html"/>
164164
<a href="namespacem__checker.html#a214e05cb46bc7c3e0dbe55fdc433c072"/>
165165
<a href="namespacem__checker.html#a584c7102ac72172ee7ed4c46993f7808"/>
166-
<a href="namespacem__checker.html#aabc567e8c7924a4bfcd77e73eb125c0d"/>
167166
<a href="namespacem__checker__common.html"/>
168167
<a href="namespacem__checker__common.html#a37b5025d5e6ffafc4cb5f417387c21b8"/>
169168
<a href="namespacem__checker__common.html#a96fa54018d14ac0ea114fd0805dedd97"/>

post_process/m__checker_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:a214e05cb46bc7c3e0dbe55fdc433c072" id="r_a214e05cb46bc7c3e0dbe55fdc433c072"><td class="memItemLeft">impure subroutine, public&#160;</td><td class="memItemRight"><a class="el" href="namespacem__checker.html#a214e05cb46bc7c3e0dbe55fdc433c072">m_checker::s_check_inputs</a></td></tr>
174174
<tr class="memdesc:a214e05cb46bc7c3e0dbe55fdc433c072"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks compatibility of parameters in the input file. Used by the post_process stage. <br /></td></tr>
175-
<tr class="memitem:aabc567e8c7924a4bfcd77e73eb125c0d" id="r_aabc567e8c7924a4bfcd77e73eb125c0d"><td class="memItemLeft">impure subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__checker.html#aabc567e8c7924a4bfcd77e73eb125c0d">m_checker::s_check_inputs_output_format</a></td></tr>
176-
<tr class="memdesc:aabc567e8c7924a4bfcd77e73eb125c0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks constraints on output format parameters. <br /></td></tr>
177175
<tr class="memitem:a584c7102ac72172ee7ed4c46993f7808" id="r_a584c7102ac72172ee7ed4c46993f7808"><td class="memItemLeft">impure subroutine, public&#160;</td><td class="memItemRight"><a class="el" href="namespacem__checker.html#a584c7102ac72172ee7ed4c46993f7808">m_checker::s_check_inputs_fft</a></td></tr>
178176
<tr class="memdesc:a584c7102ac72172ee7ed4c46993f7808"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks constraints on fft_wrt. <br /></td></tr>
179177
</table>
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
var m__checker_8fpp_8f90 =
22
[
33
[ "m_checker::s_check_inputs", "namespacem__checker.html#a214e05cb46bc7c3e0dbe55fdc433c072", null ],
4-
[ "m_checker::s_check_inputs_fft", "namespacem__checker.html#a584c7102ac72172ee7ed4c46993f7808", null ],
5-
[ "m_checker::s_check_inputs_output_format", "namespacem__checker.html#aabc567e8c7924a4bfcd77e73eb125c0d", null ]
4+
[ "m_checker::s_check_inputs_fft", "namespacem__checker.html#a584c7102ac72172ee7ed4c46993f7808", null ]
65
];

0 commit comments

Comments
 (0)