Skip to content

Commit e7adf0a

Browse files
author
MFC Action
committed
Docs @ 906eba6
1 parent b9a0ea6 commit e7adf0a

17 files changed

Lines changed: 2493 additions & 2459 deletions

documentation/architecture.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
427427
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
428428
</ol>
429429
<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>
430-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-22</div> </div></div><!-- contents -->
430+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-23</div> </div></div><!-- contents -->
431431
</div><!-- PageDoc -->
432432
</div><!-- doc-content -->
433433
<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
@@ -1461,7 +1461,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14611461
</table>
14621462
<hr />
14631463
<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>
1464-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-22</div> </div></div><!-- contents -->
1464+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-23</div> </div></div><!-- contents -->
14651465
</div><!-- PageDoc -->
14661466
</div><!-- doc-content -->
14671467
<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
@@ -999,7 +999,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
999999
<h3 class="doxsection"><a class="anchor" id="autotoc_md82"></a>
10001000
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
10011001
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
1002-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-22</div> </div></div><!-- contents -->
1002+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-23</div> </div></div><!-- contents -->
10031003
</div><!-- PageDoc -->
10041004
</div><!-- doc-content -->
10051005
<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_md313"></a>
630630
<p><img src="result-2D_shockdroplet-example.png" alt="" height="400" class="inline"/></p>
631631
<p>This example case contains an automated convergence test using a 1D, two-component advection case. The case can be run by executing the bash script <span class="tt">./submitJobs.sh</span> in a terminal after enabling execution permissions with <span class="tt">chmod +x ./submitJobs.sh</span> and setting the <span class="tt">ROOT_DIR</span> and <span class="tt">MFC_DIR</span> variables. By default the script runs the case for 6 different grid resolutions with 1st, 3rd, and 5th, order spatial reconstructions. These settings can be modified by editing the variables at the top of the script. You can also run different model equations by setting the <span class="tt">ME</span> variable and different Riemann solvers by setting the <span class="tt">RS</span> variable.</p>
632632
<p>Once the simulations have been run, you can generate convergence plots with matplotlib by running <span class="tt">python3 plot.py</span> in a terminal. This will generate plots of the L1, L2, and Linf error norms and save the results to <span class="tt">errors.csv</span>.</p>
633-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-22</div> </div></div><!-- contents -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-23</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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1605,7 +1605,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md434"></a>
16051605
<div class="line"> </div>
16061606
<div class="line"># Filter by type</div>
16071607
<div class="line">./mfc.sh params -t real weno</div>
1608-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-22</div> </div></div><!-- contents -->
1608+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-23</div> </div></div><!-- contents -->
16091609
</div><!-- PageDoc -->
16101610
</div><!-- doc-content -->
16111611
<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
@@ -656,7 +656,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md485"></a>
656656
<li>FFT WRT incompatible with cylindrical coordinates</li>
657657
<li>FFT WRT requires global dimensions divisible by 2</li>
658658
</ul>
659-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-22</div> </div></div><!-- contents -->
659+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-23</div> </div></div><!-- contents -->
660660
</div><!-- PageDoc -->
661661
</div><!-- doc-content -->
662662
<div id="page-nav" class="page-nav-panel">

post_process/m__mpi__common_8fpp_8f90_source.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -954,13 +954,13 @@
954954
<div class="foldopen" id="foldopen00797" data-start="" data-end="">
955955
<div class="line"><a id="l00797" name="l00797"></a><span class="lineno"><a class="line" href="namespacem__mpi__common.html#a750c773a9421c7837f197be9bdc4fb73"> 797</a></span> <span class="keywordtype">impure</span> <span class="keyword">subroutine </span><a class="code hl_function" href="namespacem__mpi__common.html#a750c773a9421c7837f197be9bdc4fb73">s_mpi_allreduce_integer_sum</a>(var_loc, var_glb)</div>
956956
<div class="line"><a id="l00798" name="l00798"></a><span class="lineno"> 798</span> </div>
957-
<div class="line"><a id="l00799" name="l00799"></a><span class="lineno"> 799</span> <span class="keywordtype">integer</span>, <span class="keywordtype">intent(in)</span> :: var_loc</div>
958-
<div class="line"><a id="l00800" name="l00800"></a><span class="lineno"> 800</span> <span class="keywordtype">integer</span>, <span class="keywordtype">intent(out)</span> :: var_glb</div>
957+
<div class="line"><a id="l00799" name="l00799"></a><span class="lineno"> 799</span> <span class="keywordtype">integer(kind=8)</span>, <span class="keywordtype">intent(in)</span> :: var_loc</div>
958+
<div class="line"><a id="l00800" name="l00800"></a><span class="lineno"> 800</span> <span class="keywordtype">integer(kind=8)</span>, <span class="keywordtype">intent(out)</span> :: var_glb</div>
959959
<div class="line"><a id="l00801" name="l00801"></a><span class="lineno"> 801</span> </div>
960960
<div class="line"><a id="l00802" name="l00802"></a><span class="lineno"> 802</span><span class="preprocessor">#ifdef MFC_MPI</span></div>
961961
<div class="line"><a id="l00803" name="l00803"></a><span class="lineno"> 803</span><span class="preprocessor"></span> <span class="keywordtype">integer</span> :: ierr<span class="comment"> !&lt; Generic flag used to identify and report MPI errors</span></div>
962962
<div class="line"><a id="l00804" name="l00804"></a><span class="lineno"> 804</span> </div>
963-
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno"> 805</span> <span class="keyword">call </span>mpi_allreduce(var_loc, var_glb, 1, mpi_integer, mpi_sum, mpi_comm_world, ierr)</div>
963+
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno"> 805</span> <span class="keyword">call </span>mpi_allreduce(var_loc, var_glb, 1, mpi_integer8, mpi_sum, mpi_comm_world, ierr)</div>
964964
<div class="line"><a id="l00806" name="l00806"></a><span class="lineno"> 806</span><span class="preprocessor">#else</span></div>
965965
<div class="line"><a id="l00807" name="l00807"></a><span class="lineno"> 807</span><span class="preprocessor"></span> var_glb = var_loc</div>
966966
<div class="line"><a id="l00808" name="l00808"></a><span class="lineno"> 808</span><span class="preprocessor">#endif</span></div>

post_process/namespacem__mpi__common.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -386,12 +386,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#a750c773a9421c7837f197be9
386386
<tr>
387387
<td class="memname">impure subroutine m_mpi_common::s_mpi_allreduce_integer_sum </td>
388388
<td>(</td>
389-
<td class="paramtype">integer, intent(in)</td> <td class="paramname"><span class="paramname"><em>var_loc</em></span>, </td>
389+
<td class="paramtype">integer(kind=8), intent(in)</td> <td class="paramname"><span class="paramname"><em>var_loc</em></span>, </td>
390390
</tr>
391391
<tr>
392392
<td class="paramkey"></td>
393393
<td></td>
394-
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>var_glb</em></span>&#160;)</td>
394+
<td class="paramtype">integer(kind=8), intent(out)</td> <td class="paramname"><span class="paramname"><em>var_glb</em></span>&#160;)</td>
395395
</tr>
396396
</table>
397397
</div><div class="memdoc">

pre_process/m__mpi__common_8fpp_8f90_source.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -954,13 +954,13 @@
954954
<div class="foldopen" id="foldopen00797" data-start="" data-end="">
955955
<div class="line"><a id="l00797" name="l00797"></a><span class="lineno"><a class="line" href="namespacem__mpi__common.html#a750c773a9421c7837f197be9bdc4fb73"> 797</a></span> <span class="keywordtype">impure</span> <span class="keyword">subroutine </span><a class="code hl_function" href="namespacem__mpi__common.html#a750c773a9421c7837f197be9bdc4fb73">s_mpi_allreduce_integer_sum</a>(var_loc, var_glb)</div>
956956
<div class="line"><a id="l00798" name="l00798"></a><span class="lineno"> 798</span> </div>
957-
<div class="line"><a id="l00799" name="l00799"></a><span class="lineno"> 799</span> <span class="keywordtype">integer</span>, <span class="keywordtype">intent(in)</span> :: var_loc</div>
958-
<div class="line"><a id="l00800" name="l00800"></a><span class="lineno"> 800</span> <span class="keywordtype">integer</span>, <span class="keywordtype">intent(out)</span> :: var_glb</div>
957+
<div class="line"><a id="l00799" name="l00799"></a><span class="lineno"> 799</span> <span class="keywordtype">integer(kind=8)</span>, <span class="keywordtype">intent(in)</span> :: var_loc</div>
958+
<div class="line"><a id="l00800" name="l00800"></a><span class="lineno"> 800</span> <span class="keywordtype">integer(kind=8)</span>, <span class="keywordtype">intent(out)</span> :: var_glb</div>
959959
<div class="line"><a id="l00801" name="l00801"></a><span class="lineno"> 801</span> </div>
960960
<div class="line"><a id="l00802" name="l00802"></a><span class="lineno"> 802</span><span class="preprocessor">#ifdef MFC_MPI</span></div>
961961
<div class="line"><a id="l00803" name="l00803"></a><span class="lineno"> 803</span><span class="preprocessor"></span> <span class="keywordtype">integer</span> :: ierr<span class="comment"> !&lt; Generic flag used to identify and report MPI errors</span></div>
962962
<div class="line"><a id="l00804" name="l00804"></a><span class="lineno"> 804</span> </div>
963-
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno"> 805</span> <span class="keyword">call </span>mpi_allreduce(var_loc, var_glb, 1, mpi_integer, mpi_sum, mpi_comm_world, ierr)</div>
963+
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno"> 805</span> <span class="keyword">call </span>mpi_allreduce(var_loc, var_glb, 1, mpi_integer8, mpi_sum, mpi_comm_world, ierr)</div>
964964
<div class="line"><a id="l00806" name="l00806"></a><span class="lineno"> 806</span><span class="preprocessor">#else</span></div>
965965
<div class="line"><a id="l00807" name="l00807"></a><span class="lineno"> 807</span><span class="preprocessor"></span> var_glb = var_loc</div>
966966
<div class="line"><a id="l00808" name="l00808"></a><span class="lineno"> 808</span><span class="preprocessor">#endif</span></div>

pre_process/namespacem__mpi__common.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -391,12 +391,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#a750c773a9421c7837f197be9
391391
<tr>
392392
<td class="memname">impure subroutine m_mpi_common::s_mpi_allreduce_integer_sum </td>
393393
<td>(</td>
394-
<td class="paramtype">integer, intent(in)</td> <td class="paramname"><span class="paramname"><em>var_loc</em></span>, </td>
394+
<td class="paramtype">integer(kind=8), intent(in)</td> <td class="paramname"><span class="paramname"><em>var_loc</em></span>, </td>
395395
</tr>
396396
<tr>
397397
<td class="paramkey"></td>
398398
<td></td>
399-
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>var_glb</em></span>&#160;)</td>
399+
<td class="paramtype">integer(kind=8), intent(out)</td> <td class="paramname"><span class="paramname"><em>var_glb</em></span>&#160;)</td>
400400
</tr>
401401
</table>
402402
</div><div class="memdoc">

0 commit comments

Comments
 (0)