Skip to content

Commit ac7b457

Browse files
author
MFC Action
committed
Docs @ 3dc5b2f
1 parent 52bc979 commit ac7b457

209 files changed

Lines changed: 188268 additions & 179721 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-07</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-08</div> </div></div><!-- contents -->
437437
</div><!-- PageDoc -->
438438
</div><!-- doc-content -->
439439
<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
@@ -1616,7 +1616,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
16161616
</table>
16171617
<hr />
16181618
<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>
1619-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-07</div> </div></div><!-- contents -->
1619+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-08</div> </div></div><!-- contents -->
16201620
</div><!-- PageDoc -->
16211621
</div><!-- doc-content -->
16221622
<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-07</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-08</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-07</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-08</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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1860,7 +1860,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md490"></a>
18601860
<div class="line"> </div>
18611861
<div class="line"># Filter by type</div>
18621862
<div class="line">./mfc.sh params -t real weno</div>
1863-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-07</div> </div></div><!-- contents -->
1863+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-08</div> </div></div><!-- contents -->
18641864
</div><!-- PageDoc -->
18651865
</div><!-- doc-content -->
18661866
<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-07</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-08</div> </div></div><!-- contents -->
823823
</div><!-- PageDoc -->
824824
</div><!-- doc-content -->
825825
<div id="page-nav" class="page-nav-panel">

‎post_process/m__boundary__common_8fpp_8f90_source.html‎

Lines changed: 1179 additions & 1153 deletions
Large diffs are not rendered by default.

‎post_process/m__boundary__io_8fpp_8f90_source.html‎

Lines changed: 237 additions & 230 deletions
Large diffs are not rendered by default.

‎post_process/m__boundary__primitives_8fpp_8f90_source.html‎

Lines changed: 2107 additions & 2085 deletions
Large diffs are not rendered by default.

‎post_process/m__checker_8fpp_8f90_source.html‎

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -521,28 +521,32 @@
521521
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno"> 381</span><span class="preprocessor"></span> <span class="keyword">call </span>s_prohibit_abort(.and.<span class="stringliteral">&quot;fft_wrt MOD(n_glb+1,n+1) /= 0&quot;</span>, <span class="stringliteral">&quot;FFT WRT requires n_glb to be divisible by num_procs_y&quot;</span>)</div>
522522
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno"> 382</span><span class="preprocessor"># 31 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
523523
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno"> 383</span><span class="preprocessor"></span><span class="keywordflow"> end if</span></div>
524-
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno"> 384</span> <span class="keywordflow">if</span> (fft_wrt .and. mod(<a class="code hl_variable" href="namespacem__global__parameters.html#a1072f221ca8e41b0ea3240b33374cc1e">p_glb</a>+1,p+1) /= 0) <span class="keywordflow">then</span></div>
525-
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno"> 385</span><span class="preprocessor"># 32 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
526-
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno"> 386</span><span class="preprocessor"></span> <span class="keyword">call </span>s_prohibit_abort(.and.<span class="stringliteral">&quot;fft_wrt MOD(p_glb+1,p+1) /= 0&quot;</span>, <span class="stringliteral">&quot;FFT WRT requires p_glb to be divisible by num_procs_z&quot;</span>)</div>
527-
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno"> 387</span><span class="preprocessor"># 32 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
528-
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno"> 388</span><span class="preprocessor"></span><span class="keywordflow"> end if</span></div>
529-
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno"> 389</span> num_procs_y = (<a class="code hl_variable" href="namespacem__global__parameters.html#adab11dab474410541d4c37725bea01e1">n_glb</a> + 1)/(n + 1)</div>
530-
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno"> 390</span> num_procs_z = (<a class="code hl_variable" href="namespacem__global__parameters.html#a1072f221ca8e41b0ea3240b33374cc1e">p_glb</a> + 1)/(p + 1)</div>
531-
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno"> 391</span> <span class="keywordflow">if</span> (fft_wrt .and. mod(<a class="code hl_variable" href="namespacem__global__parameters.html#ad4e160df8d0de7ea1801a1ca29f8e9b0">m_glb</a>+1,num_procs_y) /= 0) <span class="keywordflow">then</span></div>
532-
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno"> 392</span><span class="preprocessor"># 35 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
533-
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno"> 393</span><span class="preprocessor"></span> <span class="keyword">call </span>s_prohibit_abort(.and.<span class="stringliteral">&quot;fft_wrt MOD(m_glb+1,num_procs_y) /= 0&quot;</span>, <span class="stringliteral">&quot;FFT WRT requires m_glb to be divisible by num_procs_y&quot;</span>)</div>
524+
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno"> 384</span><span class="preprocessor"># 32 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
525+
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno"> 385</span><span class="preprocessor"></span> <span class="keywordflow">if</span> (fft_wrt .and. mod(<a class="code hl_variable" href="namespacem__global__parameters.html#a1072f221ca8e41b0ea3240b33374cc1e">p_glb</a>+1,p+1) /= 0) <span class="keywordflow">then</span></div>
526+
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno"> 386</span><span class="preprocessor"># 32 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
527+
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno"> 387</span><span class="preprocessor"></span> <span class="keyword">call </span>s_prohibit_abort(.and.<span class="stringliteral">&quot;fft_wrt MOD(p_glb+1,p+1) /= 0&quot;</span>, <span class="stringliteral">&quot;FFT WRT requires p_glb to be divisible by num_procs_z&quot;</span>)</div>
528+
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno"> 388</span><span class="preprocessor"># 32 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
529+
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno"> 389</span><span class="preprocessor"></span><span class="keywordflow"> end if</span></div>
530+
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno"> 390</span><span class="preprocessor"># 33 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
531+
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno"> 391</span><span class="preprocessor"></span> num_procs_y = (<a class="code hl_variable" href="namespacem__global__parameters.html#adab11dab474410541d4c37725bea01e1">n_glb</a> + 1)/(n + 1)</div>
532+
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno"> 392</span> num_procs_z = (<a class="code hl_variable" href="namespacem__global__parameters.html#a1072f221ca8e41b0ea3240b33374cc1e">p_glb</a> + 1)/(p + 1)</div>
533+
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno"> 393</span> <span class="keywordflow">if</span> (fft_wrt .and. mod(<a class="code hl_variable" href="namespacem__global__parameters.html#ad4e160df8d0de7ea1801a1ca29f8e9b0">m_glb</a>+1,num_procs_y) /= 0) <span class="keywordflow">then</span></div>
534534
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno"> 394</span><span class="preprocessor"># 35 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
535-
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno"> 395</span><span class="preprocessor"></span><span class="keywordflow"> end if</span></div>
536-
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno"> 396</span> <span class="keywordflow">if</span> (fft_wrt .and. mod(<a class="code hl_variable" href="namespacem__global__parameters.html#adab11dab474410541d4c37725bea01e1">n_glb</a>+1,num_procs_z) /= 0) <span class="keywordflow">then</span></div>
537-
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno"> 397</span><span class="preprocessor"># 36 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
538-
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno"> 398</span><span class="preprocessor"></span> <span class="keyword">call </span>s_prohibit_abort(.and.<span class="stringliteral">&quot;fft_wrt MOD(n_glb+1,num_procs_z) /= 0&quot;</span>, <span class="stringliteral">&quot;FFT WRT requires n_glb to be divisible by num_procs_z&quot;</span>)</div>
539-
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno"> 399</span><span class="preprocessor"># 36 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
540-
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno"> 400</span><span class="preprocessor"></span><span class="keywordflow"> end if</span></div>
541-
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno"> 401</span> </div>
535+
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno"> 395</span><span class="preprocessor"></span> <span class="keyword">call </span>s_prohibit_abort(.and.<span class="stringliteral">&quot;fft_wrt MOD(m_glb+1,num_procs_y) /= 0&quot;</span>, <span class="stringliteral">&quot;FFT WRT requires m_glb to be divisible by num_procs_y&quot;</span>)</div>
536+
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno"> 396</span><span class="preprocessor"># 35 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
537+
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno"> 397</span><span class="preprocessor"></span><span class="keywordflow"> end if</span></div>
538+
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno"> 398</span><span class="preprocessor"># 36 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
539+
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno"> 399</span><span class="preprocessor"></span> <span class="keywordflow">if</span> (fft_wrt .and. mod(<a class="code hl_variable" href="namespacem__global__parameters.html#adab11dab474410541d4c37725bea01e1">n_glb</a>+1,num_procs_z) /= 0) <span class="keywordflow">then</span></div>
540+
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno"> 400</span><span class="preprocessor"># 36 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
541+
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno"> 401</span><span class="preprocessor"></span> <span class="keyword">call </span>s_prohibit_abort(.and.<span class="stringliteral">&quot;fft_wrt MOD(n_glb+1,num_procs_z) /= 0&quot;</span>, <span class="stringliteral">&quot;FFT WRT requires n_glb to be divisible by num_procs_z&quot;</span>)</div>
542+
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno"> 402</span><span class="preprocessor"># 36 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
543+
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno"> 403</span><span class="preprocessor"></span><span class="keywordflow"> end if</span></div>
544+
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno"> 404</span><span class="preprocessor"># 37 &quot;/home/runner/work/MFC/MFC/src/post_process/m_checker.fpp&quot;</span></div>
545+
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno"> 405</span><span class="preprocessor"></span> </div>
542546
</div>
543-
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno"> 402</span> <span class="keyword">end subroutine </span><a class="code hl_function" href="namespacem__checker.html#a584c7102ac72172ee7ed4c46993f7808">s_check_inputs_fft</a></div>
544-
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno"> 403</span> </div>
545-
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno"> 404</span><span class="keyword">end module </span><a class="code hl_namespace" href="namespacem__checker.html">m_checker</a></div>
547+
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno"> 406</span> <span class="keyword">end subroutine </span><a class="code hl_function" href="namespacem__checker.html#a584c7102ac72172ee7ed4c46993f7808">s_check_inputs_fft</a></div>
548+
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno"> 407</span> </div>
549+
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno"> 408</span><span class="keyword">end module </span><a class="code hl_namespace" href="namespacem__checker.html">m_checker</a></div>
546550
<div class="ttc" id="anamespacem__checker_html"><div class="ttname"><a href="namespacem__checker.html">m_checker</a></div><div class="ttdoc">Validates post-process input parameters and output format consistency.</div><div class="ttdef"><b>Definition</b> <a href="#l00356">m_checker.fpp.f90:356</a></div></div>
547551
<div class="ttc" id="anamespacem__checker_html_a214e05cb46bc7c3e0dbe55fdc433c072"><div class="ttname"><a href="namespacem__checker.html#a214e05cb46bc7c3e0dbe55fdc433c072">m_checker::s_check_inputs</a></div><div class="ttdeci">impure subroutine, public s_check_inputs</div><div class="ttdoc">Checks compatibility of parameters in the input file. Used by the post_process stage.</div><div class="ttdef"><b>Definition</b> <a href="#l00370">m_checker.fpp.f90:371</a></div></div>
548552
<div class="ttc" id="anamespacem__checker_html_a584c7102ac72172ee7ed4c46993f7808"><div class="ttname"><a href="namespacem__checker.html#a584c7102ac72172ee7ed4c46993f7808">m_checker::s_check_inputs_fft</a></div><div class="ttdeci">impure subroutine, public s_check_inputs_fft</div><div class="ttdoc">Checks constraints on fft_wrt.</div><div class="ttdef"><b>Definition</b> <a href="#l00375">m_checker.fpp.f90:376</a></div></div>

0 commit comments

Comments
 (0)