Skip to content

Commit aa03f72

Browse files
author
MFC Action
committed
Docs @ 6c87019
1 parent f713596 commit aa03f72

102 files changed

Lines changed: 2765 additions & 2765 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-08-30</div> </div></div><!-- contents -->
432+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-31</div> </div></div><!-- contents -->
433433
</div><!-- PageDoc -->
434434
</div><!-- doc-content -->
435435
<div id="page-nav" class="page-nav-panel">

‎documentation/case.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -817,7 +817,7 @@ <h4 class="doxsection"><a class="anchor" id="autotoc_md26"></a>
817817
<li><span class="tt">dt</span> specifies the constant time step size used in the simulation. The value of <span class="tt">dt</span> needs to be sufficiently small to satisfy the Courant-Friedrichs-Lewy (CFL) condition.</li>
818818
<li><span class="tt">t_step_start</span> and <span class="tt">t_step_stop</span> define the time steps at which the simulation starts and ends.</li>
819819
</ul>
820-
<p><span class="tt">t_step_save</span> is the time step interval for data output during simulation. To newly start the simulation, set <span class="tt">t_step_start = 0</span>. To restart the simulation from $k$-th time step, set <span class="tt">t_step_start = k</span>; see <a class="el" href="running.html" title="Running">Restarting Cases</a>.</p>
820+
<p><span class="tt">t_step_save</span> is the time step interval for data output during simulation. To newly start the simulation, set <span class="tt">t_step_start = 0</span>. To restart the simulation from $k$-th time step, set <span class="tt">t_step_start = k</span>; see <a class="el" href="running.html" title="Running">Restarting Cases</a>. When <span class="tt">t_step_start &gt; 0</span>, <span class="tt">./mfc.sh run</span> skips <span class="tt">pre_process</span> by default, since it would otherwise overwrite the restart data being resumed from. Pass <span class="tt">-t pre_process</span> explicitly (as in the restart workflow) if regenerating it is intended.</p>
821821
<h5 class="doxsection"><a class="anchor" id="autotoc_md27"></a>
822822
Adaptive Time-Stepping</h5>
823823
<ul>

‎documentation/case_constraints.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1500,7 +1500,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
15001500
</table>
15011501
<hr />
15021502
<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>
1503-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-30</div> </div></div><!-- contents -->
1503+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-31</div> </div></div><!-- contents -->
15041504
</div><!-- PageDoc -->
15051505
</div><!-- doc-content -->
15061506
<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-08-30</div> </div></div><!-- contents -->
994+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-31</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
<ul>
631631
<li>Papanastasiou, T. C. (1987). Flows of materials with yield. <em>J. Rheol.</em> 31, 385.</li>
632632
</ul>
633-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-30</div> </div></div><!-- contents -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-31</div> </div></div><!-- contents -->
634634
</div><!-- PageDoc -->
635635
</div><!-- doc-content -->
636636
<div id="page-nav" class="page-nav-panel">

‎documentation/gpuParallelization.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md352"></a>
234234
<tr class="markdownTableRowOdd">
235235
<td class="markdownTableBodyNone"><span class="tt">create</span> </td><td class="markdownTableBodyNone">string list </td><td class="markdownTableBodyNone">None </td><td class="markdownTableBodyNone">Allocates data on GPU on entrance and then deallocates on exit </td></tr>
236236
<tr class="markdownTableRowEven">
237-
<td class="markdownTableBodyNone"><span class="tt">no_create</span> </td><td class="markdownTableBodyNone">string list </td><td class="markdownTableBodyNone">None </td><td class="markdownTableBodyNone">Use data in CPU memory unless data is already in GPU memory </td></tr>
237+
<td class="markdownTableBodyNone"><span class="tt">no_create</span> </td><td class="markdownTableBodyNone">string list </td><td class="markdownTableBodyNone">None </td><td class="markdownTableBodyNone">Use data in CPU memory unless data is already in GPU memory (OpenACC only) </td></tr>
238238
<tr class="markdownTableRowOdd">
239239
<td class="markdownTableBodyNone"><span class="tt">present</span> </td><td class="markdownTableBodyNone">string list </td><td class="markdownTableBodyNone">None </td><td class="markdownTableBodyNone">Data that must be present in GPU memory. Increment counter on entrance, decrement on exit </td></tr>
240240
<tr class="markdownTableRowEven">
@@ -362,7 +362,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md352"></a>
362362
<tr class="markdownTableRowOdd">
363363
<td class="markdownTableBodyNone"><span class="tt">create</span> </td><td class="markdownTableBodyNone">string list </td><td class="markdownTableBodyNone">None </td><td class="markdownTableBodyNone">Allocates data on GPU on entrance and then deallocates on exit </td></tr>
364364
<tr class="markdownTableRowEven">
365-
<td class="markdownTableBodyNone"><span class="tt">no_create</span> </td><td class="markdownTableBodyNone">string list </td><td class="markdownTableBodyNone">None </td><td class="markdownTableBodyNone">Use data in CPU memory unless data is already in GPU memory </td></tr>
365+
<td class="markdownTableBodyNone"><span class="tt">no_create</span> </td><td class="markdownTableBodyNone">string list </td><td class="markdownTableBodyNone">None </td><td class="markdownTableBodyNone">Use data in CPU memory unless data is already in GPU memory (OpenACC only) </td></tr>
366366
<tr class="markdownTableRowOdd">
367367
<td class="markdownTableBodyNone"><span class="tt">present</span> </td><td class="markdownTableBodyNone">string list </td><td class="markdownTableBodyNone">None </td><td class="markdownTableBodyNone">Data that must be present in GPU memory. Increment counter on entrance, decrement on exit </td></tr>
368368
<tr class="markdownTableRowEven">
@@ -429,7 +429,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md354"></a>
429429
<tr class="markdownTableRowEven">
430430
<td class="markdownTableBodyNone"><span class="tt">create</span> </td><td class="markdownTableBodyNone">string list </td><td class="markdownTableBodyNone">None </td><td class="markdownTableBodyNone">Allocates data on GPU on entrance and then deallocates on exit </td></tr>
431431
<tr class="markdownTableRowOdd">
432-
<td class="markdownTableBodyNone"><span class="tt">no_create</span> </td><td class="markdownTableBodyNone">string list </td><td class="markdownTableBodyNone">None </td><td class="markdownTableBodyNone">Use data in CPU memory unless data is already in GPU memory </td></tr>
432+
<td class="markdownTableBodyNone"><span class="tt">no_create</span> </td><td class="markdownTableBodyNone">string list </td><td class="markdownTableBodyNone">None </td><td class="markdownTableBodyNone">Use data in CPU memory unless data is already in GPU memory (OpenACC only) </td></tr>
433433
<tr class="markdownTableRowEven">
434434
<td class="markdownTableBodyNone"><span class="tt">present</span> </td><td class="markdownTableBodyNone">string list </td><td class="markdownTableBodyNone">None </td><td class="markdownTableBodyNone">Data that must be present in GPU memory. Increment counter on entrance, decrement on exit </td></tr>
435435
<tr class="markdownTableRowOdd">

‎documentation/parameters.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1758,7 +1758,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md448"></a>
17581758
<div class="line"> </div>
17591759
<div class="line"># Filter by type</div>
17601760
<div class="line">./mfc.sh params -t real weno</div>
1761-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-30</div> </div></div><!-- contents -->
1761+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-31</div> </div></div><!-- contents -->
17621762
</div><!-- PageDoc -->
17631763
</div><!-- doc-content -->
17641764
<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
@@ -740,7 +740,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md507"></a>
740740
<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>
741741
<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>
742742
</ul>
743-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-30</div> </div></div><!-- contents -->
743+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-31</div> </div></div><!-- contents -->
744744
</div><!-- PageDoc -->
745745
</div><!-- doc-content -->
746746
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)