Skip to content

Commit 80f9af6

Browse files
author
MFC Action
committed
Docs @ 8c2bec8
1 parent 30b37a4 commit 80f9af6

110 files changed

Lines changed: 7311 additions & 6783 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
@@ -433,7 +433,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
433433
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
434434
</ol>
435435
<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>
436-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-27</div> </div></div><!-- contents -->
436+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-28</div> </div></div><!-- contents -->
437437
</div><!-- PageDoc -->
438438
</div><!-- doc-content -->
439439
<div id="page-nav" class="page-nav-panel">

‎documentation/case.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -531,8 +531,8 @@ <h4 class="doxsection"><a class="anchor" id="autotoc_md24"></a>
531531
<li><span class="tt">radius</span> is the radius to be used for circular patches.</li>
532532
<li><span class="tt">c</span>, <span class="tt">t</span>, <span class="tt">p</span>, and <span class="tt">m</span> specify the parameters for a NACA airfoil (set on the referenced <span class="tt">ib_airfoil</span> entry). <span class="tt">m</span> is the maximum camber, <span class="tt">p</span> is the location of maximum camber, <span class="tt">c</span> is the chord length, and <span class="tt">t</span> is the thickness. Additional details on this specification can be found in <a href="https://en.wikipedia.org/wiki/NACA_airfoil">NACA airfoil</a>.</li>
533533
<li><span class="tt">slip</span> applies a slip boundary to the surface of the patch if true and a no-slip boundary condition to the surface if false.</li>
534-
<li><span class="tt">thermal_bc</span> selects the thermal immersed-boundary condition. A value of 0 applies a zero-normal-gradient temperature condition, 1 prescribes the wall temperature using <span class="tt">Twall</span>, and 2 solves the reacting-surface energy balance for the surface temperature. The <span class="tt">thermal_bc = 2</span> option requires <span class="tt">surface_reaction = 1</span>. A non-zero <span class="tt">thermal_bc</span> requires <span class="tt">chemistry = T</span> and cannot be combined with <span class="tt">inj_species &gt; 0</span>, since the thermal condition is applied by the chemistry ghost-state reconstruction, which an injecting surface bypasses.</li>
535-
<li><span class="tt">Twall</span> specifies the prescribed surface temperature when <span class="tt">thermal_bc = 1</span> and must be positive in that case.</li>
534+
<li><span class="tt">thermal_bc</span> selects the thermal immersed-boundary condition. A value of 0 applies a zero-normal-gradient temperature condition, 1 prescribes the wall temperature using <span class="tt">Twall</span>, and 2 solves the reacting-surface energy balance for the surface temperature. The <span class="tt">thermal_bc = 2</span> option requires <span class="tt">surface_reaction = 1</span>. A non-zero <span class="tt">thermal_bc</span> cannot be combined with <span class="tt">inj_species &gt; 0</span>, since an injecting surface bypasses the ghost-state reconstruction. Without chemistry, <span class="tt">thermal_bc = 1</span> needs <span class="tt">fluid_pp(1)%k_therm &gt; 0</span> and <span class="tt">num_fluids = 1</span>.</li>
535+
<li><span class="tt">Twall</span> specifies the prescribed surface temperature when <span class="tt">thermal_bc = 1</span> and must be positive in that case. With chemistry it must also be within <span class="tt">T_surface_min</span> = 200 K and <span class="tt">T_surface_max</span> = 5000 K (<span class="tt">m_constants.fpp</span>), the range of the NASA polynomial fits.</li>
536536
<li><span class="tt">surface_reaction</span> enables heterogeneous surface chemistry when set to 1. Surface reactions require <span class="tt">chemistry = T</span> and cannot be combined with <span class="tt">inj_species &gt; 0</span>.</li>
537537
<li>For STL/OBJ geometry (geometry 5 or 12), set <span class="tt">model_id</span> to index into the <span class="tt">stl_models</span> array and specify <span class="tt">model_filepath</span>, <span class="tt">model_scale</span>, <span class="tt">model_translate</span>, and <span class="tt">model_threshold</span> on that entry.</li>
538538
<li><span class="tt">moving_ibm</span> sets the method by which movement will be applied to the immersed boundary. Using 0 will result in no movement. Using 1 will result 1-way coupling where the boundary moves at a constant rate and applied forces to the fluid based upon its own motion. In 1-way coupling, the fluid does not apply forces back onto the IB. Using 2 will result in 2-way coupling, where the boundary pushes on the fluid and the fluid pushes back on the boundary via pressure and viscous forces. If external forces are applied, the boundary will also experience those forces.</li>
@@ -1871,7 +1871,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md41"></a>
18711871
<td class="markdownTableBodyNone">hypoelastic variables </td><td class="markdownTableBodyNone">N/A </td></tr>
18721872
</table>
18731873
<p>The above variables correspond to optional physics.</p>
1874-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-10</div> </div></div><!-- contents -->
1874+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-27</div> </div></div><!-- contents -->
18751875
</div><!-- PageDoc -->
18761876
</div><!-- doc-content -->
18771877
<div id="page-nav" class="page-nav-panel">

‎documentation/case_constraints.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -747,18 +747,18 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
747747
<li>When enabled, requires: <span class="tt">cantera_file</span></li>
748748
</ul>
749749
<p><b>Requirements</b> (errors):</p><ul>
750-
<li>patch_ib(i)thermal_bc /= 0 requires chemistry = T</li>
751-
<li>patch_ib(i)surface_reaction = 1 requires chemistry = T</li>
752-
<li>chem_paramsdiffusion requires chemistry = T</li>
750+
<li>patch_ib(i)thermal_bc = thermal_bc requires chemistry = T</li>
751+
<li>patch_ib(i)thermal_bc = 1 requires chemistry = T or fluid_pp(1)k_therm &gt; 0</li>
752+
<li>patch_ib(i)thermal_bc = 1 without chemistry requires num_fluids = 1</li>
753753
</ul>
754754
<p><b>Incompatibilities</b> (errors):</p><ul>
755755
<li>HLLD hypoelasticity does not support chemistry</li>
756756
<li>riemann_hypo_ADC does not support bubbles, surface tension, chemistry, or continuum damage (the ADC HLL blend omits their flux components)</li>
757757
<li>heat conduction is not supported with chemistry: the reacting path already carries mixture-averaged conduction through chem_paramsdiffusion</li>
758758
</ul>
759759
<p><b>Valid values</b> (errors):</p><ul>
760+
<li>patch_ib(i)Twall must be positive when thermal_bc = 1</li>
760761
<li>chem_paramsreaction_substeps must be &gt;= 0 (0 = reaction source in the flow RHS; &gt; 0 = operator-split sub-stepping)</li>
761-
<li>chem_paramsreaction_substeps_max must be &gt;= reaction_substeps when adap_substeps = T</li>
762762
</ul>
763763
<p></p>
764764
</details>
@@ -1618,7 +1618,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
16181618
</table>
16191619
<hr />
16201620
<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>
1621-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-27</div> </div></div><!-- contents -->
1621+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-28</div> </div></div><!-- contents -->
16221622
</div><!-- PageDoc -->
16231623
</div><!-- doc-content -->
16241624
<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
@@ -993,7 +993,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
993993
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
994994
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
995995
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
996-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-27</div> </div></div><!-- contents -->
996+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-28</div> </div></div><!-- contents -->
997997
</div><!-- PageDoc -->
998998
</div><!-- doc-content -->
999999
<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
@@ -974,7 +974,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md350"></a>
974974
<h3 class="doxsection"><a class="anchor" id="autotoc_md351"></a>
975975
Density Norms</h3>
976976
<p><img src="density_norms-2D_isentropicvortex-example.png" alt="" height="400" class="inline"/></p>
977-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-27</div> </div></div><!-- contents -->
977+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-28</div> </div></div><!-- contents -->
978978
</div><!-- PageDoc -->
979979
</div><!-- doc-content -->
980980
<div id="page-nav" class="page-nav-panel">

‎documentation/parameters.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1465,7 +1465,7 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
14651465
<tr class="markdownTableRowOdd">
14661466
<td class="markdownTableBodyNone"><span class="tt">chem_wrt_T</span> </td><td class="markdownTableBodyNone">Logical (T/F) </td><td class="markdownTableBodyNone">Write temperature field for chemistry </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">Chemistry output flag </td></tr>
14671467
<tr class="markdownTableRowEven">
1468-
<td class="markdownTableBodyNone"><span class="tt">chemistry</span> </td><td class="markdownTableBodyNone">Logical (T/F) </td><td class="markdownTableBodyNone">Enable chemical reactions </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">patch_ib(i)thermal_bc</span> /= 0 requires <span class="tt">chemistry</span> = T; <span class="tt">patch_ib(i)surface_reaction</span> = 1 requires <span class="tt">chemistry</span> = T; <span class="tt">chem_paramsadap_substeps</span> requires <span class="tt">reaction_substeps</span> &gt;= 1 (the operator-split floor) </td></tr>
1468+
<td class="markdownTableBodyNone"><span class="tt">chemistry</span> </td><td class="markdownTableBodyNone">Logical (T/F) </td><td class="markdownTableBodyNone">Enable chemical reactions </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">patch_ib(i)thermal_bc</span> = <span class="tt">thermal_bc</span> requires <span class="tt">chemistry</span> = T; <span class="tt">patch_ib(i)surface_reaction</span> = 1 requires <span class="tt">chemistry</span> = T; <span class="tt">chem_paramsadap_substeps</span> requires <span class="tt">reaction_substeps</span> &gt;= 1 (the operator-split floor) </td></tr>
14691469
<tr class="markdownTableRowOdd">
14701470
<td class="markdownTableBodyNone"><span class="tt">coefficient_of_restitution</span> </td><td class="markdownTableBodyNone">Real </td><td class="markdownTableBodyNone">Real number describing the elasticity of collisions from 0 (perfectly ineleas... </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">Immersed boundary parameter </td></tr>
14711471
<tr class="markdownTableRowEven">
@@ -1659,7 +1659,7 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
16591659
<tr class="markdownTableRowEven">
16601660
<td class="markdownTableBodyNone"><span class="tt">num_bc_patches</span> </td><td class="markdownTableBodyNone">Integer </td><td class="markdownTableBodyNone">Number of boundary condition patches </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">num_bc_patches</span> must be &lt;= <span class="tt">num_bc_patches_max</span> </td></tr>
16611661
<tr class="markdownTableRowOdd">
1662-
<td class="markdownTableBodyNone"><span class="tt">num_fluids</span> </td><td class="markdownTableBodyNone">Integer </td><td class="markdownTableBodyNone">Number of fluid components </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">Min: 1, Max: 10; <span class="tt">num_fluids</span> must be positive </td></tr>
1662+
<td class="markdownTableBodyNone"><span class="tt">num_fluids</span> </td><td class="markdownTableBodyNone">Integer </td><td class="markdownTableBodyNone">Number of fluid components </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">Min: 1, Max: 10; <span class="tt">patch_ib(i)thermal_bc</span> = 1 without <span class="tt">chemistry</span> requires <span class="tt">num_fluids</span> = 1; <span class="tt">num_fluids</span> must be positive </td></tr>
16631663
<tr class="markdownTableRowEven">
16641664
<td class="markdownTableBodyNone"><span class="tt">num_ibs</span> </td><td class="markdownTableBodyNone">Integer </td><td class="markdownTableBodyNone">Number of immersed boundary patches </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">Min: 0; <span class="tt">num_ibs</span> must be &gt;= 1 when <span class="tt">ib</span> is enabled (or specify at least one <span class="tt">particle_cloud</span> with <span class="tt">num_particles</span> &gt; 0); <span class="tt">num_ibs</span> must be &lt;= <span class="tt">num_ib_patches_max</span> (<span class="tt">num_ib_patches_max_namelist</span> in <span class="tt">m_constants</span>.fpp); <span class="tt">num_ibs</span> is set, but <span class="tt">ib</span> is not enabled </td></tr>
16651665
<tr class="markdownTableRowOdd">
@@ -1870,7 +1870,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md490"></a>
18701870
<div class="line"> </div>
18711871
<div class="line"># Filter by type</div>
18721872
<div class="line">./mfc.sh params -t real weno</div>
1873-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-27</div> </div></div><!-- contents -->
1873+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-28</div> </div></div><!-- contents -->
18741874
</div><!-- PageDoc -->
18751875
</div><!-- doc-content -->
18761876
<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
@@ -819,7 +819,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md553"></a>
819819
<li><code class="f90l">patch_icpp(i)%</code><code class="f90r">hcid</code>=hcid requires <span class="tt">files_dir</span> to be set</li>
820820
<li><code class="f90l">patch_icpp(i)%</code><code class="f90r">hcid</code>=hcid requires <span class="tt">file_extension</span> to be set</li>
821821
</ul>
822-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-27</div> </div></div><!-- contents -->
822+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-28</div> </div></div><!-- contents -->
823823
</div><!-- PageDoc -->
824824
</div><!-- doc-content -->
825825
<div id="page-nav" class="page-nav-panel">

‎post_process/doxygen_crawl.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -419,6 +419,7 @@
419419
<a href="namespacem__eos.html#a5ebc2d48e418d117cc50ca367b4dad9f"/>
420420
<a href="namespacem__eos.html#a5f54355da48a287243f68675f8ca5292"/>
421421
<a href="namespacem__eos.html#a62af0ed16a0014e1f2af776d7af4f9e8"/>
422+
<a href="namespacem__eos.html#a6b500f8e9ecd66d959832fa94d61b528"/>
422423
<a href="namespacem__eos.html#a714ea412afc117e067ea543f59e2d11a"/>
423424
<a href="namespacem__eos.html#a7ba17e1c8ce6dd3120ae00e70e7f348c"/>
424425
<a href="namespacem__eos.html#a7c36c117e7220f4da5732cc8b2379ef7"/>

0 commit comments

Comments
 (0)