Skip to content

Commit d0a77f6

Browse files
author
MFC Action
committed
Docs @ d91e6ac
1 parent 6519f3a commit d0a77f6

11 files changed

+1047
-1035
lines changed

documentation/architecture.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
401401
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
402402
</ol>
403403
<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>
404-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-17</div> </div></div><!-- contents -->
404+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-18</div> </div></div><!-- contents -->
405405
</div><!-- PageDoc -->
406406
</div><!-- doc-content -->
407407
<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
@@ -1428,7 +1428,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14281428
</table>
14291429
<hr />
14301430
<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>
1431-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-17</div> </div></div><!-- contents -->
1431+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-18</div> </div></div><!-- contents -->
14321432
</div><!-- PageDoc -->
14331433
</div><!-- doc-content -->
14341434
<div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -390,16 +390,22 @@ <h3 class="doxsection"><a class="anchor" id="test"></a>
390390
<tr class="markdownTableRowOdd">
391391
<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>
392392
<tr class="markdownTableRowEven">
393-
<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>
393+
<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>
394394
<tr class="markdownTableRowOdd">
395-
<td class="markdownTableBodyNone"><span class="tt">--add-new-variables</span> </td><td class="markdownTableBodyNone">(Test Generation) If new variables are found in D/ when running tests, add them to the golden files. </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
395+
<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>
396396
<tr class="markdownTableRowEven">
397-
<td class="markdownTableBodyNone"><span class="tt">--remove-old-tests</span> </td><td class="markdownTableBodyNone">(Test Generation) Delete test directories that are no longer needed. </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
397+
<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>
398398
<tr class="markdownTableRowOdd">
399-
<td class="markdownTableBodyNone"><span class="tt">--mpi</span>, <span class="tt">--no-mpi</span> </td><td class="markdownTableBodyNone">Enable/disable MPI </td><td class="markdownTableBodyNone"><span class="tt">true</span> </td></tr>
399+
<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>
400400
<tr class="markdownTableRowEven">
401-
<td class="markdownTableBodyNone"><span class="tt">--gpu [acc/mp]</span>, <span class="tt">--no-gpu</span> </td><td class="markdownTableBodyNone">Enable GPU (OpenACC/OpenMP) </td><td class="markdownTableBodyNone"><span class="tt">no</span> </td></tr>
401+
<td class="markdownTableBodyNone"><span class="tt">--add-new-variables</span> </td><td class="markdownTableBodyNone">(Test Generation) If new variables are found in D/ when running tests, add them to the golden files. </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
402402
<tr class="markdownTableRowOdd">
403+
<td class="markdownTableBodyNone"><span class="tt">--remove-old-tests</span> </td><td class="markdownTableBodyNone">(Test Generation) Delete test directories that are no longer needed. </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
404+
<tr class="markdownTableRowEven">
405+
<td class="markdownTableBodyNone"><span class="tt">--mpi</span>, <span class="tt">--no-mpi</span> </td><td class="markdownTableBodyNone">Enable/disable MPI </td><td class="markdownTableBodyNone"><span class="tt">true</span> </td></tr>
406+
<tr class="markdownTableRowOdd">
407+
<td class="markdownTableBodyNone"><span class="tt">--gpu [acc/mp]</span>, <span class="tt">--no-gpu</span> </td><td class="markdownTableBodyNone">Enable GPU (OpenACC/OpenMP) </td><td class="markdownTableBodyNone"><span class="tt">no</span> </td></tr>
408+
<tr class="markdownTableRowEven">
403409
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
404410
</table>
405411
<p><b>Examples:</b></p>
@@ -414,6 +420,12 @@ <h3 class="doxsection"><a class="anchor" id="test"></a>
414420
<div class="line"> </div>
415421
<div class="line"># Regenerate golden files</div>
416422
<div class="line">./mfc.sh test --generate</div>
423+
<div class="line"> </div>
424+
<div class="line"># Run tests affected by changed files</div>
425+
<div class="line">./mfc.sh test --only-changes -j 4</div>
426+
<div class="line"> </div>
427+
<div class="line"># One-time: build file-coverage cache</div>
428+
<div class="line">./mfc.sh build --gcov -j 8 &amp;&amp; ./mfc.sh test --build-coverage-cache</div>
417429
</div><!-- fragment --><hr />
418430
<h3 class="doxsection"><a class="anchor" id="clean"></a>
419431
clean</h3>
@@ -952,7 +964,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md78"></a>
952964
<h3 class="doxsection"><a class="anchor" id="autotoc_md79"></a>
953965
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
954966
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
955-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-17</div> </div></div><!-- contents -->
967+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-18</div> </div></div><!-- contents -->
956968
</div><!-- PageDoc -->
957969
</div><!-- doc-content -->
958970
<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 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md273"></a>
388388
<h3 class="doxsection"><a class="anchor" id="autotoc_md274"></a>
389389
Final Condition (Density)</h3>
390390
<p><img src="final-2D_forward_facing_step-example.png" alt="" class="inline"/></p>
391-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-17</div> </div></div><!-- contents -->
391+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-18</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
@@ -1568,7 +1568,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md393"></a>
15681568
<div class="line"> </div>
15691569
<div class="line"># Filter by type</div>
15701570
<div class="line">./mfc.sh params -t real weno</div>
1571-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-17</div> </div></div><!-- contents -->
1571+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-18</div> </div></div><!-- contents -->
15721572
</div><!-- PageDoc -->
15731573
</div><!-- doc-content -->
15741574
<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
@@ -624,7 +624,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md443"></a>
624624
<li>FFT WRT incompatible with cylindrical coordinates</li>
625625
<li>FFT WRT requires global dimensions divisible by 2</li>
626626
</ul>
627-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-17</div> </div></div><!-- contents -->
627+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-18</div> </div></div><!-- contents -->
628628
</div><!-- PageDoc -->
629629
</div><!-- doc-content -->
630630
<div id="page-nav" class="page-nav-panel">

simulation/m__global__parameters_8fpp_8f90.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -309,18 +309,18 @@
309309
<tr class="memitem:aabad0b5732baec4916c15bd01cb7f9b7" id="r_aabad0b5732baec4916c15bd01cb7f9b7"><td class="memItemLeft">logical&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#aabad0b5732baec4916c15bd01cb7f9b7">m_global_parameters::bf_y</a></td></tr>
310310
<tr class="memitem:a8f189b60d9f8aa4b5cfb8451d9bacd73" id="r_a8f189b60d9f8aa4b5cfb8451d9bacd73"><td class="memItemLeft">logical&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a8f189b60d9f8aa4b5cfb8451d9bacd73">m_global_parameters::bf_z</a></td></tr>
311311
<tr class="memdesc:a8f189b60d9f8aa4b5cfb8451d9bacd73"><td class="mdescLeft">&#160;</td><td class="mdescRight">body force toggle in three directions amplitude, frequency, and phase shift sinusoid in each direction <br /></td></tr>
312-
<tr class="memitem:a72371679cecccecfbc2b291dcd726228" id="r_a72371679cecccecfbc2b291dcd726228"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a72371679cecccecfbc2b291dcd726228">m_global_parameters::k_y</a></td></tr>
313-
<tr class="memitem:a82a4a61004712d4ded68b1018d796fae" id="r_a82a4a61004712d4ded68b1018d796fae"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a82a4a61004712d4ded68b1018d796fae">m_global_parameters::g_y</a></td></tr>
314-
<tr class="memitem:ac5836965fc47e3cda0ac04bd3f33e347" id="r_ac5836965fc47e3cda0ac04bd3f33e347"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#ac5836965fc47e3cda0ac04bd3f33e347">m_global_parameters::w_y</a></td></tr>
315-
<tr class="memitem:a86fb50483af0d51af7adb848daa8a4ae" id="r_a86fb50483af0d51af7adb848daa8a4ae"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a86fb50483af0d51af7adb848daa8a4ae">m_global_parameters::p_y</a></td></tr>
316-
<tr class="memitem:a1671373492ac31693c8698500f095ff4" id="r_a1671373492ac31693c8698500f095ff4"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1671373492ac31693c8698500f095ff4">m_global_parameters::k_x</a></td></tr>
317-
<tr class="memitem:a1b2b0f3b66e4aef04d872e7550735df5" id="r_a1b2b0f3b66e4aef04d872e7550735df5"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1b2b0f3b66e4aef04d872e7550735df5">m_global_parameters::g_x</a></td></tr>
318-
<tr class="memitem:a04316d272b181c3c8496d1b0ce088c64" id="r_a04316d272b181c3c8496d1b0ce088c64"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a04316d272b181c3c8496d1b0ce088c64">m_global_parameters::w_x</a></td></tr>
319-
<tr class="memitem:a1b662ab55a2226686cc9e8a9ab95ada3" id="r_a1b662ab55a2226686cc9e8a9ab95ada3"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1b662ab55a2226686cc9e8a9ab95ada3">m_global_parameters::p_x</a></td></tr>
320-
<tr class="memitem:a2b4bee61739d582d3f9d9538c6100c02" id="r_a2b4bee61739d582d3f9d9538c6100c02"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a2b4bee61739d582d3f9d9538c6100c02">m_global_parameters::k_z</a></td></tr>
321312
<tr class="memitem:a444ad421d11df63042d50c0ecae450c9" id="r_a444ad421d11df63042d50c0ecae450c9"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a444ad421d11df63042d50c0ecae450c9">m_global_parameters::g_z</a></td></tr>
322313
<tr class="memitem:aa11528d15dfa6e313e1298dee5ca42cd" id="r_aa11528d15dfa6e313e1298dee5ca42cd"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#aa11528d15dfa6e313e1298dee5ca42cd">m_global_parameters::w_z</a></td></tr>
314+
<tr class="memitem:a2b4bee61739d582d3f9d9538c6100c02" id="r_a2b4bee61739d582d3f9d9538c6100c02"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a2b4bee61739d582d3f9d9538c6100c02">m_global_parameters::k_z</a></td></tr>
323315
<tr class="memitem:a1f924d5ee4e2910cffe8e756a0c8657b" id="r_a1f924d5ee4e2910cffe8e756a0c8657b"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1f924d5ee4e2910cffe8e756a0c8657b">m_global_parameters::p_z</a></td></tr>
316+
<tr class="memitem:a1b2b0f3b66e4aef04d872e7550735df5" id="r_a1b2b0f3b66e4aef04d872e7550735df5"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1b2b0f3b66e4aef04d872e7550735df5">m_global_parameters::g_x</a></td></tr>
317+
<tr class="memitem:a04316d272b181c3c8496d1b0ce088c64" id="r_a04316d272b181c3c8496d1b0ce088c64"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a04316d272b181c3c8496d1b0ce088c64">m_global_parameters::w_x</a></td></tr>
318+
<tr class="memitem:a1671373492ac31693c8698500f095ff4" id="r_a1671373492ac31693c8698500f095ff4"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1671373492ac31693c8698500f095ff4">m_global_parameters::k_x</a></td></tr>
319+
<tr class="memitem:a1b662ab55a2226686cc9e8a9ab95ada3" id="r_a1b662ab55a2226686cc9e8a9ab95ada3"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1b662ab55a2226686cc9e8a9ab95ada3">m_global_parameters::p_x</a></td></tr>
320+
<tr class="memitem:a82a4a61004712d4ded68b1018d796fae" id="r_a82a4a61004712d4ded68b1018d796fae"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a82a4a61004712d4ded68b1018d796fae">m_global_parameters::g_y</a></td></tr>
321+
<tr class="memitem:ac5836965fc47e3cda0ac04bd3f33e347" id="r_ac5836965fc47e3cda0ac04bd3f33e347"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#ac5836965fc47e3cda0ac04bd3f33e347">m_global_parameters::w_y</a></td></tr>
322+
<tr class="memitem:a72371679cecccecfbc2b291dcd726228" id="r_a72371679cecccecfbc2b291dcd726228"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a72371679cecccecfbc2b291dcd726228">m_global_parameters::k_y</a></td></tr>
323+
<tr class="memitem:a86fb50483af0d51af7adb848daa8a4ae" id="r_a86fb50483af0d51af7adb848daa8a4ae"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a86fb50483af0d51af7adb848daa8a4ae">m_global_parameters::p_y</a></td></tr>
324324
<tr class="memitem:a4d953db2f36f05624766c42cc9851362" id="r_a4d953db2f36f05624766c42cc9851362"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>), dimension(3)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a4d953db2f36f05624766c42cc9851362">m_global_parameters::accel_bf</a></td></tr>
325325
<tr class="memitem:a5422a3820409740b5c3b0b2e88bdb2b0" id="r_a5422a3820409740b5c3b0b2e88bdb2b0"><td class="memItemLeft">integer&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a5422a3820409740b5c3b0b2e88bdb2b0">m_global_parameters::cpu_start</a></td></tr>
326326
<tr class="memitem:a8ed3dee47bbaa5de7ae564ca9d770404" id="r_a8ed3dee47bbaa5de7ae564ca9d770404"><td class="memItemLeft">integer&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a8ed3dee47bbaa5de7ae564ca9d770404">m_global_parameters::cpu_end</a></td></tr>

0 commit comments

Comments
 (0)