Skip to content

Commit 1e3ff81

Browse files
author
MFC Action
committed
Docs @ 814f7a5
1 parent 7ab34f7 commit 1e3ff81

1,210 files changed

Lines changed: 161128 additions & 135232 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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md10"></a>
383383
<tr class="markdownTableRowEven">
384384
<td class="markdownTableBodyNone"><span class="tt">m_checker_common</span> </td><td class="markdownTableBodyNone">Shared input validation checks for grid dimensions and AMD GPU compiler limits </td></tr>
385385
<tr class="markdownTableRowOdd">
386-
<td class="markdownTableBodyNone"><span class="tt">m_sim_helpers</span> </td><td class="markdownTableBodyNone">Simulation helper routines for enthalpy computation, CFL calculation, and stability checks </td></tr>
386+
<td class="markdownTableBodyNone"><span class="tt">m_sim_helpers</span> </td><td class="markdownTableBodyNone">Simulation helper routines for cell state, CFL calculation, and stability checks </td></tr>
387387
<tr class="markdownTableRowEven">
388388
<td class="markdownTableBodyNone"><span class="tt">m_derived_variables</span> </td><td class="markdownTableBodyNone">Derives diagnostic flow quantities (vorticity, speed of sound, numerical Schlieren, etc.) from conservative and primitive variables </td></tr>
389389
<tr class="markdownTableRowOdd">
@@ -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-09-02</div> </div></div><!-- contents -->
432+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-03</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: 96 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -784,6 +784,96 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
784784
</details>
785785
<details >
786786
<summary >
787+
<b>fluid_pp(1)eos</b> (<span class="tt">fluid_pp(1)eos</span>)</summary>
788+
<p></p>
789+
<p><b>Schema constraints:</b></p><ul>
790+
<li>Choices: <span class="tt">1</span> = stiffened-gas, <span class="tt">2</span> = ideal-gas</li>
791+
</ul>
792+
<p></p>
793+
</details>
794+
<details >
795+
<summary >
796+
<b>fluid_pp(10)eos</b> (<span class="tt">fluid_pp(10)eos</span>)</summary>
797+
<p></p>
798+
<p><b>Schema constraints:</b></p><ul>
799+
<li>Choices: <span class="tt">1</span> = stiffened-gas, <span class="tt">2</span> = ideal-gas</li>
800+
</ul>
801+
<p></p>
802+
</details>
803+
<details >
804+
<summary >
805+
<b>fluid_pp(2)eos</b> (<span class="tt">fluid_pp(2)eos</span>)</summary>
806+
<p></p>
807+
<p><b>Schema constraints:</b></p><ul>
808+
<li>Choices: <span class="tt">1</span> = stiffened-gas, <span class="tt">2</span> = ideal-gas</li>
809+
</ul>
810+
<p></p>
811+
</details>
812+
<details >
813+
<summary >
814+
<b>fluid_pp(3)eos</b> (<span class="tt">fluid_pp(3)eos</span>)</summary>
815+
<p></p>
816+
<p><b>Schema constraints:</b></p><ul>
817+
<li>Choices: <span class="tt">1</span> = stiffened-gas, <span class="tt">2</span> = ideal-gas</li>
818+
</ul>
819+
<p></p>
820+
</details>
821+
<details >
822+
<summary >
823+
<b>fluid_pp(4)eos</b> (<span class="tt">fluid_pp(4)eos</span>)</summary>
824+
<p></p>
825+
<p><b>Schema constraints:</b></p><ul>
826+
<li>Choices: <span class="tt">1</span> = stiffened-gas, <span class="tt">2</span> = ideal-gas</li>
827+
</ul>
828+
<p></p>
829+
</details>
830+
<details >
831+
<summary >
832+
<b>fluid_pp(5)eos</b> (<span class="tt">fluid_pp(5)eos</span>)</summary>
833+
<p></p>
834+
<p><b>Schema constraints:</b></p><ul>
835+
<li>Choices: <span class="tt">1</span> = stiffened-gas, <span class="tt">2</span> = ideal-gas</li>
836+
</ul>
837+
<p></p>
838+
</details>
839+
<details >
840+
<summary >
841+
<b>fluid_pp(6)eos</b> (<span class="tt">fluid_pp(6)eos</span>)</summary>
842+
<p></p>
843+
<p><b>Schema constraints:</b></p><ul>
844+
<li>Choices: <span class="tt">1</span> = stiffened-gas, <span class="tt">2</span> = ideal-gas</li>
845+
</ul>
846+
<p></p>
847+
</details>
848+
<details >
849+
<summary >
850+
<b>fluid_pp(7)eos</b> (<span class="tt">fluid_pp(7)eos</span>)</summary>
851+
<p></p>
852+
<p><b>Schema constraints:</b></p><ul>
853+
<li>Choices: <span class="tt">1</span> = stiffened-gas, <span class="tt">2</span> = ideal-gas</li>
854+
</ul>
855+
<p></p>
856+
</details>
857+
<details >
858+
<summary >
859+
<b>fluid_pp(8)eos</b> (<span class="tt">fluid_pp(8)eos</span>)</summary>
860+
<p></p>
861+
<p><b>Schema constraints:</b></p><ul>
862+
<li>Choices: <span class="tt">1</span> = stiffened-gas, <span class="tt">2</span> = ideal-gas</li>
863+
</ul>
864+
<p></p>
865+
</details>
866+
<details >
867+
<summary >
868+
<b>fluid_pp(9)eos</b> (<span class="tt">fluid_pp(9)eos</span>)</summary>
869+
<p></p>
870+
<p><b>Schema constraints:</b></p><ul>
871+
<li>Choices: <span class="tt">1</span> = stiffened-gas, <span class="tt">2</span> = ideal-gas</li>
872+
</ul>
873+
<p></p>
874+
</details>
875+
<details >
876+
<summary >
787877
<b>format</b> (<span class="tt">format</span>)</summary>
788878
<p></p>
789879
<p><b>Schema constraints:</b></p><ul>
@@ -1006,10 +1096,11 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
10061096
<p><b>Incompatibilities</b> (errors):</p><ul>
10071097
<li>num_fluids is not supported for model_eqns = 1</li>
10081098
<li>num_fluids = 1 does not support mpp_lim</li>
1099+
<li>igr does not support fluid_pp(i)qv (heat of formation); it is discarded</li>
10091100
</ul>
10101101
<p><b>Valid values</b> (errors):</p><ul>
10111102
<li>num_fluids must be positive</li>
1012-
<li>perturb_flow_fluid must be between 0 and num_fluids</li>
1103+
<li>The Ensemble-Averaged Bubble Model is derived for a single carrier liquid; num_fluids must be &lt;= 2</li>
10131104
</ul>
10141105
<p></p>
10151106
</details>
@@ -1494,13 +1585,15 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14941585
<tr class="markdownTableRowOdd">
14951586
<td class="markdownTableBodyNone"><b>Alpha-Rho Consistency</b> </td><td class="markdownTableBodyNone">pre_process </td><td class="markdownTableBodyNone">patch_icpp(i): alpha(j) = 0 but alpha_rho(j) = alpha_rho (density in absent phase); patch_icpp(i): alpha(j) = alpha but alpha_rho(j) = 0 (present phase has zero density) </td></tr>
14961587
<tr class="markdownTableRowEven">
1497-
<td class="markdownTableBodyNone"><b>EOS Parameter Sanity</b> </td><td class="markdownTableBodyNone">common, post_process, pre_process, simulation </td><td class="markdownTableBodyNone">fluid_pp(i)gamma = gamma implies physical gamma = physical_gamma (unusually high). MFC uses the transformed parameter Gamma = 1/(gamma-1); fluid_pp(i)gamma = gamma implies physical gamma = physical_gamma (very close to 1). Did you enter the physical gamma instead of 1/(gamma-1)? </td></tr>
1588+
<td class="markdownTableBodyNone"><b>Bubbles Euler</b> </td><td class="markdownTableBodyNone">common, post_process, pre_process, simulation </td><td class="markdownTableBodyNone">patch_icpp(i)alpha(void_idx) = alpha is not a dilute void fraction; the Ensemble-Averaged Bubble Model is an O(alpha) expansion and is not recommended above DILUTE_VOID_FRACTION_MAX </td></tr>
14981589
<tr class="markdownTableRowOdd">
1590+
<td class="markdownTableBodyNone"><b>EOS Parameter Sanity</b> </td><td class="markdownTableBodyNone">common, post_process, pre_process, simulation </td><td class="markdownTableBodyNone">fluid_pp(i)gamma = gamma implies physical gamma = physical_gamma (unusually high). MFC uses the transformed parameter Gamma = 1/(gamma-1); fluid_pp(i)gamma = gamma implies physical gamma = physical_gamma (very close to 1). Did you enter the physical gamma instead of 1/(gamma-1)? </td></tr>
1591+
<tr class="markdownTableRowEven">
14991592
<td class="markdownTableBodyNone"><b>Volume Fraction Sum</b> </td><td class="markdownTableBodyNone">pre_process </td><td class="markdownTableBodyNone">patch_icpp(i): volume fractions sum to alpha_sum, expected 1.0 </td></tr>
15001593
</table>
15011594
<hr />
15021595
<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>
1503-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-02</div> </div></div><!-- contents -->
1596+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-03</div> </div></div><!-- contents -->
15041597
</div><!-- PageDoc -->
15051598
</div><!-- doc-content -->
15061599
<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
@@ -991,7 +991,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
991991
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
992992
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
993993
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
994-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-02</div> </div></div><!-- contents -->
994+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-03</div> </div></div><!-- contents -->
995995
</div><!-- PageDoc -->
996996
</div><!-- doc-content -->
997997
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)