Skip to content

Commit 07f892a

Browse files
author
MFC Action
committed
Docs @ 47b56e8
1 parent a178198 commit 07f892a

8 files changed

Lines changed: 58 additions & 60 deletions

documentation/architecture.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
405405
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
406406
</ol>
407407
<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>
408-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-30</div> </div></div><!-- contents -->
408+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-31</div> </div></div><!-- contents -->
409409
</div><!-- PageDoc -->
410410
</div><!-- doc-content -->
411411
<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
@@ -1453,7 +1453,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14531453
</table>
14541454
<hr />
14551455
<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>
1456-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-30</div> </div></div><!-- contents -->
1456+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-31</div> </div></div><!-- contents -->
14571457
</div><!-- PageDoc -->
14581458
</div><!-- doc-content -->
14591459
<div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -408,11 +408,15 @@ <h3 class="doxsection"><a class="anchor" id="test"></a>
408408
<tr class="markdownTableRowOdd">
409409
<td class="markdownTableBodyNone"><span class="tt">--shard</span> </td><td class="markdownTableBodyNone">Run only a subset of tests (e.g., '1/2' for first half, '2/2' for second half). </td><td class="markdownTableBodyNone">- </td></tr>
410410
<tr class="markdownTableRowEven">
411-
<td class="markdownTableBodyNone"><span class="tt">--build-coverage-cache</span> </td><td class="markdownTableBodyNone">Run all tests with gcov instrumentation to build the file-level coverage cache. Pass &ndash;gcov to enable coverage instrumentation in the internal build step. </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
411+
<td class="markdownTableBodyNone"><span class="tt">--build-coverage-map</span> </td><td class="markdownTableBodyNone">Build the gcov coverage map (requires a prior &ndash;gcov build). Master-side only. </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
412412
<tr class="markdownTableRowOdd">
413-
<td class="markdownTableBodyNone"><span class="tt">--only-changes</span> </td><td class="markdownTableBodyNone">Only run tests whose covered files overlap with files changed since branching from master (uses file-level gcov coverage cache). </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
413+
<td class="markdownTableBodyNone"><span class="tt">--only-changes</span> </td><td class="markdownTableBodyNone">Select only tests whose covered files overlap changed files (shadow mode unless &ndash;select-enforce). </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
414414
<tr class="markdownTableRowEven">
415-
<td class="markdownTableBodyNone"><span class="tt">--changes-branch</span> </td><td class="markdownTableBodyNone">Branch to compare against for &ndash;only-changes (default: master). </td><td class="markdownTableBodyNone"><span class="tt">master</span> </td></tr>
415+
<td class="markdownTableBodyNone"><span class="tt">--select-enforce</span> </td><td class="markdownTableBodyNone">With &ndash;only-changes, actually skip unselected tests (otherwise shadow: print selection, run all). </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
416+
<tr class="markdownTableRowOdd">
417+
<td class="markdownTableBodyNone"><span class="tt">--changed-files</span> </td><td class="markdownTableBodyNone">Changed-file list (newline-, space-, or comma-separated; from CI paths-filter). Overrides git detection. </td><td class="markdownTableBodyNone">- </td></tr>
418+
<tr class="markdownTableRowEven">
419+
<td class="markdownTableBodyNone"><span class="tt">--changes-branch</span> </td><td class="markdownTableBodyNone">Branch to diff against for &ndash;only-changes. </td><td class="markdownTableBodyNone"><span class="tt">master</span> </td></tr>
416420
<tr class="markdownTableRowOdd">
417421
<td class="markdownTableBodyNone"><span class="tt">--generate</span> </td><td class="markdownTableBodyNone">(Test Generation) Generate golden files. </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
418422
<tr class="markdownTableRowEven">
@@ -440,12 +444,6 @@ <h3 class="doxsection"><a class="anchor" id="test"></a>
440444
<div class="line"> </div>
441445
<div class="line"># Regenerate golden files</div>
442446
<div class="line">./mfc.sh test --generate</div>
443-
<div class="line"> </div>
444-
<div class="line"># Run tests affected by changed files</div>
445-
<div class="line">./mfc.sh test --only-changes -j 4</div>
446-
<div class="line"> </div>
447-
<div class="line"># One-time: build file-coverage cache</div>
448-
<div class="line">./mfc.sh build --gcov -j 8 &amp;&amp; ./mfc.sh test --build-coverage-cache</div>
449447
</div><!-- fragment --><hr />
450448
<h3 class="doxsection"><a class="anchor" id="clean"></a>
451449
clean</h3>
@@ -996,7 +994,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
996994
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
997995
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
998996
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
999-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-30</div> </div></div><!-- contents -->
997+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-31</div> </div></div><!-- contents -->
1000998
</div><!-- PageDoc -->
1001999
</div><!-- doc-content -->
10021000
<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 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md275"></a>
388388
<h3 class="doxsection"><a class="anchor" id="autotoc_md276"></a>
389389
Result</h3>
390390
<p><img src="result-1D_titarevtorro-example.png" alt="" heiht="400" class="inline"/></p>
391-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-30</div> </div></div><!-- contents -->
391+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-31</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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1563,7 +1563,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md393"></a>
15631563
<div class="line"> </div>
15641564
<div class="line"># Filter by type</div>
15651565
<div class="line">./mfc.sh params -t real weno</div>
1566-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-30</div> </div></div><!-- contents -->
1566+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-31</div> </div></div><!-- contents -->
15671567
</div><!-- PageDoc -->
15681568
</div><!-- doc-content -->
15691569
<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
@@ -627,7 +627,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md443"></a>
627627
<li>FFT WRT incompatible with cylindrical coordinates</li>
628628
<li>FFT WRT requires global dimensions divisible by 2</li>
629629
</ul>
630-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-30</div> </div></div><!-- contents -->
630+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-31</div> </div></div><!-- contents -->
631631
</div><!-- PageDoc -->
632632
</div><!-- doc-content -->
633633
<div id="page-nav" class="page-nav-panel">

post_process/m__global__parameters_8fpp_8f90_source.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -509,20 +509,20 @@
509509
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno"> 371</span><span class="preprocessor"></span><span class="preprocessor"># 222 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
510510
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno"> 372</span><span class="preprocessor"></span> </div>
511511
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno"> 373</span><span class="preprocessor"># 224 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
512-
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno"> 374</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_in = .false.</div>
513-
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno"> 375</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_out = .false.</div>
514-
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno"> 376</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_in = dflt_real</div>
515-
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno"> 377</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_out = dflt_real</div>
512+
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno"> 374</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_in = .false.</div>
513+
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno"> 375</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_out = .false.</div>
514+
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno"> 376</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_in = dflt_real</div>
515+
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno"> 377</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_out = dflt_real</div>
516516
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno"> 378</span><span class="preprocessor"># 224 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
517-
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno"> 379</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_in = .false.</div>
518-
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno"> 380</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_out = .false.</div>
519-
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno"> 381</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_in = dflt_real</div>
520-
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno"> 382</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_out = dflt_real</div>
517+
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno"> 379</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_in = .false.</div>
518+
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno"> 380</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_out = .false.</div>
519+
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno"> 381</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_in = dflt_real</div>
520+
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno"> 382</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_out = dflt_real</div>
521521
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno"> 383</span><span class="preprocessor"># 224 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
522-
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno"> 384</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_in = .false.</div>
523-
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno"> 385</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_out = .false.</div>
524-
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno"> 386</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_in = dflt_real</div>
525-
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno"> 387</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_out = dflt_real</div>
522+
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno"> 384</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_in = .false.</div>
523+
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno"> 385</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_out = .false.</div>
524+
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno"> 386</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_in = dflt_real</div>
525+
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno"> 387</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_out = dflt_real</div>
526526
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno"> 388</span><span class="preprocessor"># 229 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
527527
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno"> 389</span><span class="preprocessor"></span> </div>
528528
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno"> 390</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a8617063e88a25d9bc5d8aec3189e0862">chem_params</a>%gamma_method = 1</div>

0 commit comments

Comments
 (0)