Skip to content

Commit b5158d8

Browse files
author
MFC Action
committed
Docs @ d963465
1 parent 580115d commit b5158d8

451 files changed

Lines changed: 79587 additions & 61280 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: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -259,10 +259,12 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md6"></a>
259259
<tr class="markdownTableRowOdd">
260260
<td class="markdownTableBodyNone"><span class="tt">m_riemann_solver_hllc</span> </td><td class="markdownTableBodyNone">HLLC Riemann solver with contact restoration, Toro et al </td></tr>
261261
<tr class="markdownTableRowEven">
262-
<td class="markdownTableBodyNone"><span class="tt">m_muscl</span> </td><td class="markdownTableBodyNone">MUSCL reconstruction with interface sharpening for contact-preserving advection </td></tr>
262+
<td class="markdownTableBodyNone"><span class="tt">m_riemann_solver_hypo_hlld</span> </td><td class="markdownTableBodyNone">Dual-pass HLLD approximate Riemann solver for hypoelastic flows, with non-conservative interface-velocity coupling </td></tr>
263263
<tr class="markdownTableRowOdd">
264-
<td class="markdownTableBodyNone"><span class="tt">m_variables_conversion</span> </td><td class="markdownTableBodyNone">Conservative-to-primitive variable conversion, mixture property evaluation, and pressure computation </td></tr>
264+
<td class="markdownTableBodyNone"><span class="tt">m_muscl</span> </td><td class="markdownTableBodyNone">MUSCL reconstruction with interface sharpening for contact-preserving advection </td></tr>
265265
<tr class="markdownTableRowEven">
266+
<td class="markdownTableBodyNone"><span class="tt">m_variables_conversion</span> </td><td class="markdownTableBodyNone">Conservative-to-primitive variable conversion, mixture property evaluation, and pressure computation </td></tr>
267+
<tr class="markdownTableRowOdd">
266268
<td class="markdownTableBodyNone"><span class="tt">m_thinc</span> </td><td class="markdownTableBodyNone">THINC and MTHINC interface compression for volume fraction sharpening </td></tr>
267269
</table>
268270
<h2 class="doxsection"><a class="anchor" id="autotoc_md7"></a>
@@ -427,7 +429,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
427429
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
428430
</ol>
429431
<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-08-11</div> </div></div><!-- contents -->
432+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-12</div> </div></div><!-- contents -->
431433
</div><!-- PageDoc -->
432434
</div><!-- doc-content -->
433435
<div id="page-nav" class="page-nav-panel">

‎documentation/case.html‎

Lines changed: 43 additions & 23 deletions
Large diffs are not rendered by default.

‎documentation/case_constraints.html‎

Lines changed: 75 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -689,8 +689,9 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
689689
<li>adv_n requires bubbles_euler to be enabled</li>
690690
</ul>
691691
<p><b>Incompatibilities</b> (errors):</p><ul>
692+
<li>Hypoelasticity does not support Euler-Euler bubbles</li>
693+
<li>riemann_hypo_ADC does not support bubbles, surface tension, chemistry, or continuum damage (the ADC HLL blend omits their flux components)</li>
692694
<li>Activate only one of the bubble subgrid models (bubbles_euler or bubbles_lagrange)</li>
693-
<li>alt_soundspeed is not compatible with bubbles_euler</li>
694695
</ul>
695696
<p><b>Valid values</b> (errors):</p><ul>
696697
<li>patch_icpp(istr)r0 must be positive (got r0)</li>
@@ -750,6 +751,10 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
750751
<li>Isothermal Out (bc_xisothermal_out) requires both chemistry='T' and chem_paramsdiffusion='T' to calculate heat conduction.</li>
751752
<li>Isothermal In (bc_yisothermal_in) requires both chemistry='T' and chem_paramsdiffusion='T' to calculate heat conduction.</li>
752753
</ul>
754+
<p><b>Incompatibilities</b> (errors):</p><ul>
755+
<li>HLLD hypoelasticity does not support chemistry</li>
756+
<li>riemann_hypo_ADC does not support bubbles, surface tension, chemistry, or continuum damage (the ADC HLL blend omits their flux components)</li>
757+
</ul>
753758
<p></p>
754759
</details>
755760
<details >
@@ -790,6 +795,36 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
790795
</details>
791796
<details >
792797
<summary >
798+
<b>hll_u_interface</b> (<span class="tt">hll_u_interface</span>)</summary>
799+
<p></p>
800+
<p><b>Dependencies:</b></p><ul>
801+
<li>When enabled, requires <span class="tt">riemann_solver</span> = <span class="tt">1</span> (HLL)</li>
802+
</ul>
803+
<p><b>Requirements</b> (errors):</p><ul>
804+
<li>hll_u_interface requires HLL Riemann solver (riemann_solver = 1)</li>
805+
<li>surface_tension requires a shared interface-velocity representation (HLL Method 2 or HLLC)</li>
806+
</ul>
807+
<p><b>Incompatibilities</b> (errors):</p><ul>
808+
<li>HLL Method 2 does not support MHD (the MHD path zeroes the shared interface-velocity trace)</li>
809+
</ul>
810+
<p></p>
811+
</details>
812+
<details >
813+
<summary >
814+
<b>hypo_hll_interface_rhs</b> (<span class="tt">hypo_hll_interface_rhs</span>)</summary>
815+
<p></p>
816+
<p><b>Dependencies:</b></p><ul>
817+
<li>When enabled, requires: <span class="tt">hypoelasticity</span></li>
818+
<li>When enabled, requires <span class="tt">riemann_solver</span> = <span class="tt">1</span> (HLL)</li>
819+
</ul>
820+
<p><b>Requirements</b> (errors):</p><ul>
821+
<li>hypo_hll_interface_rhs requires hypoelasticity to be enabled</li>
822+
<li>hypo_hll_interface_rhs requires HLL Riemann solver (riemann_solver = 1)</li>
823+
</ul>
824+
<p></p>
825+
</details>
826+
<details >
827+
<summary >
793828
<b>Immersed Boundaries</b> (<span class="tt">ib</span>)</summary>
794829
<p></p>
795830
<p><b>Dependencies:</b></p><ul>
@@ -933,8 +968,8 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
933968
</ul>
934969
<p><b>Requirements</b> (errors):</p><ul>
935970
<li>int_comp = 2 (MTHINC) requires at least 2D (n &gt; 0)</li>
971+
<li>HLLD hypoelasticity requires at least 2D (n &gt; 0)</li>
936972
<li>Immersed Boundaries do not work in 1D (requires n &gt; 0)</li>
937-
<li>down sample requires n divisible by 3</li>
938973
</ul>
939974
<p><b>Incompatibilities</b> (errors):</p><ul>
940975
<li>Bx0 must not be set in 2D/3D MHD simulations</li>
@@ -1059,6 +1094,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
10591094
</ul>
10601095
<p><b>Incompatibilities</b> (errors):</p><ul>
10611096
<li>6-equation model (model_eqns = 3) does not support cylindrical coordinates (cyl_coord = T and p != 0)</li>
1097+
<li>3D cylindrical hypoelasticity is not supported</li>
10621098
<li>Fully 3D cylindrical geometry (cyl_coord = T, p &gt; 0) is not supported in single precision (&ndash;single)</li>
10631099
</ul>
10641100
<p><b>Valid values</b> (errors):</p><ul>
@@ -1159,18 +1195,40 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
11591195
</details>
11601196
<details >
11611197
<summary >
1198+
<b>riemann_hypo_ADC</b> (<span class="tt">riemann_hypo_ADC</span>)</summary>
1199+
<p></p>
1200+
<p><b>Dependencies:</b></p><ul>
1201+
<li>When enabled, requires: <span class="tt">hypoelasticity</span></li>
1202+
<li>When enabled, requires <span class="tt">riemann_solver</span> = <span class="tt">2</span> (HLLC) or <span class="tt">4</span> (HLLD)</li>
1203+
</ul>
1204+
<p><b>Requirements</b> (errors):</p><ul>
1205+
<li>riemann_hypo_ADC requires hypoelasticity to be enabled</li>
1206+
</ul>
1207+
<p><b>Incompatibilities</b> (errors):</p><ul>
1208+
<li>riemann_hypo_ADC does not support bubbles, surface tension, chemistry, or continuum damage (the ADC HLL blend omits their flux components)</li>
1209+
<li>riemann_hypo_ADC does not support low_Mach (the ADC HLL reference flux uses pre-correction velocities)</li>
1210+
</ul>
1211+
<p><b>Valid values</b> (errors):</p><ul>
1212+
<li>ADC_kappa must be positive</li>
1213+
</ul>
1214+
<p></p>
1215+
</details>
1216+
<details >
1217+
<summary >
11621218
<b>Riemann Solver</b> (<span class="tt">riemann_solver</span>)</summary>
11631219
<p></p>
11641220
<p><b>Schema constraints:</b></p><ul>
11651221
<li>Choices: <span class="tt">1</span> = HLL, <span class="tt">2</span> = HLLC, <span class="tt">4</span> = HLLD, <span class="tt">5</span> = Lax-Friedrichs</li>
11661222
</ul>
11671223
<p><b>Requirements</b> (errors):</p><ul>
1168-
<li>hypoelasticity requires HLL Riemann solver (riemann_solver = 1)</li>
1169-
<li>riemann_solver must be specified (1=HLL, 2=HLLC, 4=HLLD, 5=Lax-Friedrichs)</li>
1170-
<li>6-equation model (model_eqns = 3) requires riemann_solver = 2 (HLLC)</li>
1224+
<li>hypoelasticity requires HLL (1), HLLC (2), or HLLD (4) Riemann solver</li>
1225+
<li>hypo_hll_interface_rhs requires HLL Riemann solver (riemann_solver = 1)</li>
1226+
<li>HLLD hypoelasticity requires at least 2D (n &gt; 0)</li>
11711227
</ul>
11721228
<p><b>Incompatibilities</b> (errors):</p><ul>
1173-
<li>HLLD is not available for RMHD (relativity)</li>
1229+
<li>HLLD hypoelasticity does not support viscous effects (the dual-pass omits the viscous source term)</li>
1230+
<li>HLLD hypoelasticity does not support surface tension (the dual-pass omits the surface-tension source term)</li>
1231+
<li>HLLD hypoelasticity does not support continuum damage (the dual-pass does not damage-scale the shear modulus)</li>
11741232
</ul>
11751233
<p><b>Valid values</b> (errors):</p><ul>
11761234
<li>riemann_solver must be 1 (HLL), 2 (HLLC), 4 (HLLD), or 5 (Lax-Friedrichs)</li>
@@ -1282,6 +1340,10 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
12821340
<li>The surface tension model requires model_eqns = 2 or model_eqns = 3</li>
12831341
<li>The surface tension model requires num_fluids = 2</li>
12841342
</ul>
1343+
<p><b>Incompatibilities</b> (errors):</p><ul>
1344+
<li>HLLD hypoelasticity does not support surface tension (the dual-pass omits the surface-tension source term)</li>
1345+
<li>riemann_hypo_ADC does not support bubbles, surface tension, chemistry, or continuum damage (the ADC HLL blend omits their flux components)</li>
1346+
</ul>
12851347
<p><b>Valid values</b> (errors):</p><ul>
12861348
<li>sigma must be greater than or equal to zero</li>
12871349
</ul>
@@ -1377,6 +1439,9 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
13771439
<li>weno_Re_flux requires viscous to be enabled</li>
13781440
<li>fluid_pp(i)non_newtonian requires viscous = T</li>
13791441
</ul>
1442+
<p><b>Incompatibilities</b> (errors):</p><ul>
1443+
<li>HLLD hypoelasticity does not support viscous effects (the dual-pass omits the viscous source term)</li>
1444+
</ul>
13801445
<p></p>
13811446
</details>
13821447
<details >
@@ -1391,6 +1456,9 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
13911456
<li>6-equation model (model_eqns = 3) requires wave_speeds = 1</li>
13921457
<li>MHD requires wave_speeds = 1</li>
13931458
</ul>
1459+
<p><b>Incompatibilities</b> (errors):</p><ul>
1460+
<li>HLLD uses its own direct wave-speed estimates; wave_speeds = 2 is not supported</li>
1461+
</ul>
13941462
<p><b>Valid values</b> (errors):</p><ul>
13951463
<li>wave_speeds must be 1 or 2</li>
13961464
</ul>
@@ -1448,7 +1516,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14481516
</table>
14491517
<hr />
14501518
<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>
1451-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-11</div> </div></div><!-- contents -->
1519+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-12</div> </div></div><!-- contents -->
14521520
</div><!-- PageDoc -->
14531521
</div><!-- doc-content -->
14541522
<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-08-11</div> </div></div><!-- contents -->
1002+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-12</div> </div></div><!-- contents -->
10031003
</div><!-- PageDoc -->
10041004
</div><!-- doc-content -->
10051005
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)