Skip to content

Commit 509d9ff

Browse files
author
MFC Action
committed
Docs @ b44c811
1 parent b8a7e0a commit 509d9ff

109 files changed

Lines changed: 21505 additions & 20219 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
@@ -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-07</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-08</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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1593,7 +1593,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
15931593
</table>
15941594
<hr />
15951595
<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>
1596-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-07</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-08</div> </div></div><!-- contents -->
15971597
</div><!-- PageDoc -->
15981598
</div><!-- doc-content -->
15991599
<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-07</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-08</div> </div></div><!-- contents -->
995995
</div><!-- PageDoc -->
996996
</div><!-- doc-content -->
997997
<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
@@ -630,7 +630,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md311"></a>
630630
<h3 class="doxsection"><a class="anchor" id="autotoc_md312"></a>
631631
Result</h3>
632632
<p><img src="result-2D_shockdroplet-example.png" alt="" height="400" class="inline"/></p>
633-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-07</div> </div></div><!-- contents -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-08</div> </div></div><!-- contents -->
634634
</div><!-- PageDoc -->
635635
</div><!-- doc-content -->
636636
<div id="page-nav" class="page-nav-panel">

documentation/parameters.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@
165165
</blockquote>
166166
<h2 class="doxsection"><a class="anchor" id="autotoc_md379"></a>
167167
Overview</h2>
168-
<p>MFC supports <b>3,792</b> case parameters organized into families.</p>
168+
<p>MFC supports <b>3,793</b> case parameters organized into families.</p>
169169
<p><b>Quick search:</b> Use <span class="tt">./mfc.sh params &lt;query&gt;</span> to search parameters from the command line.</p>
170170
<h2 class="doxsection"><a class="anchor" id="autotoc_md380"></a>
171171
Parameter Families</h2>
@@ -227,7 +227,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md380"></a>
227227
<tr class="markdownTableRowOdd">
228228
<td class="markdownTableBodyNone"><a class="el" href="#chem_params" title="chem_params">chem_params</a> </td><td class="markdownTableBodyNone">7 </td><td class="markdownTableBodyNone">Chemistry model parameters </td></tr>
229229
<tr class="markdownTableRowEven">
230-
<td class="markdownTableBodyNone"><a class="el" href="#rburn" title="rburn">rburn</a> </td><td class="markdownTableBodyNone">5 </td><td class="markdownTableBodyNone"></td></tr>
230+
<td class="markdownTableBodyNone"><a class="el" href="#rburn" title="rburn">rburn</a> </td><td class="markdownTableBodyNone">6 </td><td class="markdownTableBodyNone"></td></tr>
231231
<tr class="markdownTableRowOdd">
232232
<td class="markdownTableBodyNone"><a class="el" href="#ib_airfoil" title="ib_airfoil">ib_airfoil</a> </td><td class="markdownTableBodyNone">4 </td><td class="markdownTableBodyNone"></td></tr>
233233
<tr class="markdownTableRowEven">
@@ -1125,7 +1125,7 @@ <h2 class="doxsection"><a class="anchor" id="chem_params"></a>
11251125
<hr />
11261126
<h2 class="doxsection"><a class="anchor" id="rburn"></a>
11271127
rburn</h2>
1128-
<p><b>5 parameters</b></p>
1128+
<p><b>6 parameters</b></p>
11291129
<table class="markdownTable">
11301130
<tr class="markdownTableHead">
11311131
<th class="markdownTableHeadNone">Parameter </th><th class="markdownTableHeadNone">Type </th><th class="markdownTableHeadNone">Description </th><th class="markdownTableHeadNone">Constraints </th></tr>
@@ -1138,6 +1138,8 @@ <h2 class="doxsection"><a class="anchor" id="rburn"></a>
11381138
<tr class="markdownTableRowEven">
11391139
<td class="markdownTableBodyNone"><span class="tt">rburn%pref</span> </td><td class="markdownTableBodyNone">Real </td><td class="markdownTableBodyNone">Reactive-burn reference pressure for the pressure drive [Pa] </td><td class="markdownTableBodyNone"><span class="tt">reactive_burn</span> requires <span class="tt">rburnpref</span> &gt; 0 (it normalizes the pressure drive and is used as a divisor) </td></tr>
11401140
<tr class="markdownTableRowOdd">
1141+
<td class="markdownTableBodyNone"><span class="tt">rburn%substeps</span> </td><td class="markdownTableBodyNone">Integer </td><td class="markdownTableBodyNone">Reactive-burn parameter: substeps </td><td class="markdownTableBodyNone"><span class="tt">reactive_burn</span> requires <span class="tt">rburnsubsteps</span> &gt;= 0 (operator-split sub-steps per time step; 0 adds the source to the flow RHS) </td></tr>
1142+
<tr class="markdownTableRowEven">
11411143
<td class="markdownTableBodyNone"><span class="tt">rburn%ta</span> </td><td class="markdownTableBodyNone">Real </td><td class="markdownTableBodyNone">Reactive-burn activation temperature [K] (0 = pure pressure-driven; &gt;0 adds a... </td><td class="markdownTableBodyNone"><span class="tt">reactive_burn</span> requires <span class="tt">rburnta</span> &gt;= 0 (activation temperature [K]; 0 disables the Arrhenius factor); <span class="tt">reactive_burn</span> with <span class="tt">rburnta</span> &gt; 0 requires <span class="tt">fluid_pp(1)cv</span> &gt; 0 (the reactant temperature needs a physical heat capacity; cv = 0 silently disables the Arrhenius factor) </td></tr>
11421144
</table>
11431145
<hr />
@@ -1760,7 +1762,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md449"></a>
17601762
<div class="line"> </div>
17611763
<div class="line"># Filter by type</div>
17621764
<div class="line">./mfc.sh params -t real weno</div>
1763-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-07</div> </div></div><!-- contents -->
1765+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-08</div> </div></div><!-- contents -->
17641766
</div><!-- PageDoc -->
17651767
</div><!-- doc-content -->
17661768
<div id="page-nav" class="page-nav-panel">

documentation/physics_constraints.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -746,6 +746,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md506"></a>
746746
<li><span class="tt">reactive_burn</span> requires <code class="f90l">rburn%</code><code class="f90r">pref</code> &gt; 0 (it normalizes the pressure drive and is used as a divisor)</li>
747747
<li><span class="tt">reactive_burn</span> requires <code class="f90l">rburn%</code><code class="f90r">n</code> &gt;= 0 (pressure-drive exponent)</li>
748748
<li><span class="tt">reactive_burn</span> requires <code class="f90l">rburn%</code><code class="f90r">ta</code> &gt;= 0 (activation temperature [K]; 0 disables the Arrhenius factor)</li>
749+
<li><span class="tt">reactive_burn</span> requires <code class="f90l">rburn%</code><code class="f90r">substeps</code> &gt;= 0 (operator-split sub-steps per time step; 0 adds the source to the flow RHS)</li>
749750
<li><span class="tt">reactive_burn</span> with <code class="f90l">rburn%</code><code class="f90r">ta</code> &gt; 0 requires <code class="f90l">fluid_pp(1)%</code><code class="f90r">cv</code> &gt; 0 (the reactant temperature needs a physical heat capacity; cv = 0 silently disables the Arrhenius factor)</li>
750751
</ul>
751752
<hr />
@@ -760,7 +761,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md509"></a>
760761
<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>
761762
<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>
762763
</ul>
763-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-07</div> </div></div><!-- contents -->
764+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-08</div> </div></div><!-- contents -->
764765
</div><!-- PageDoc -->
765766
</div><!-- doc-content -->
766767
<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
@@ -1313,6 +1313,7 @@
13131313
<a href="structm__derived__types_1_1reactive__burn__parameters.html"/>
13141314
<a href="structm__derived__types_1_1reactive__burn__parameters.html#a0a1ad0295f8c886b183d9b43ed08a034"/>
13151315
<a href="structm__derived__types_1_1reactive__burn__parameters.html#a54d0b7fb3439d5a1be2bcd964477ffd4"/>
1316+
<a href="structm__derived__types_1_1reactive__burn__parameters.html#a700b4e7b1fdd9ef38c3de058f6b74a63"/>
13161317
<a href="structm__derived__types_1_1reactive__burn__parameters.html#a797a8e2cddd5bf0f70db4193b8bdd156"/>
13171318
<a href="structm__derived__types_1_1reactive__burn__parameters.html#ac3f1b960070efad80a71f2ddc5ace71f"/>
13181319
<a href="structm__derived__types_1_1reactive__burn__parameters.html#ad249e63d845d2d58a2a94b623aa26818"/>

post_process/functions_s.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,7 @@ <h3 class="doxsection"><a id="index_s" name="index_s"></a>- s -</h3><ul>
183183
<li>step_y_centroid&#160;:&#160;<a class="el" href="structm__derived__types_1_1ib__patch__parameters.html#ad68984b963cc8f5831ee66da0403ea63">m_derived_types::ib_patch_parameters</a></li>
184184
<li>step_z_centroid&#160;:&#160;<a class="el" href="structm__derived__types_1_1ib__patch__parameters.html#a65fd8284fb98b908833e32ccfe18e6c1">m_derived_types::ib_patch_parameters</a></li>
185185
<li>stress&#160;:&#160;<a class="el" href="structm__derived__types_1_1eqn__idx__info.html#a34de6c19a6e9bc3b3b3a1053cb549751">m_derived_types::eqn_idx_info</a></li>
186+
<li>substeps&#160;:&#160;<a class="el" href="structm__derived__types_1_1reactive__burn__parameters.html#a700b4e7b1fdd9ef38c3de058f6b74a63">m_derived_types::reactive_burn_parameters</a></li>
186187
<li>support&#160;:&#160;<a class="el" href="structm__derived__types_1_1acoustic__parameters.html#a11971a4761b5fa3482a6c37d1efec4b5">m_derived_types::acoustic_parameters</a></li>
187188
</ul>
188189
</div><!-- contents -->

post_process/functions_vars_s.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,7 @@ <h3 class="doxsection"><a id="index_s" name="index_s"></a>- s -</h3><ul>
182182
<li>step_y_centroid&#160;:&#160;<a class="el" href="structm__derived__types_1_1ib__patch__parameters.html#ad68984b963cc8f5831ee66da0403ea63">m_derived_types::ib_patch_parameters</a></li>
183183
<li>step_z_centroid&#160;:&#160;<a class="el" href="structm__derived__types_1_1ib__patch__parameters.html#a65fd8284fb98b908833e32ccfe18e6c1">m_derived_types::ib_patch_parameters</a></li>
184184
<li>stress&#160;:&#160;<a class="el" href="structm__derived__types_1_1eqn__idx__info.html#a34de6c19a6e9bc3b3b3a1053cb549751">m_derived_types::eqn_idx_info</a></li>
185+
<li>substeps&#160;:&#160;<a class="el" href="structm__derived__types_1_1reactive__burn__parameters.html#a700b4e7b1fdd9ef38c3de058f6b74a63">m_derived_types::reactive_burn_parameters</a></li>
185186
<li>support&#160;:&#160;<a class="el" href="structm__derived__types_1_1acoustic__parameters.html#a11971a4761b5fa3482a6c37d1efec4b5">m_derived_types::acoustic_parameters</a></li>
186187
</ul>
187188
</div><!-- contents -->

0 commit comments

Comments
 (0)