Skip to content

Commit 01a99f3

Browse files
author
MFC Action
committed
Docs @ 751db87
1 parent acf7162 commit 01a99f3

1,658 files changed

Lines changed: 124844 additions & 112794 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: 33 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -249,10 +249,20 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md6"></a>
249249
<tr class="markdownTableRowEven">
250250
<td class="markdownTableBodyNone"><span class="tt">m_riemann_solvers</span> </td><td class="markdownTableBodyNone">Approximate and exact Riemann solvers (HLL, HLLC, HLLD, exact) for the multicomponent Navier&ndash;Stokes equations </td></tr>
251251
<tr class="markdownTableRowOdd">
252-
<td class="markdownTableBodyNone"><span class="tt">m_muscl</span> </td><td class="markdownTableBodyNone">MUSCL reconstruction with interface sharpening for contact-preserving advection </td></tr>
252+
<td class="markdownTableBodyNone"><span class="tt">m_riemann_state</span> </td><td class="markdownTableBodyNone">Shared Riemann-solver module state and the per-sweep setup, state-buffer population, viscous source flux, and finalization helpers </td></tr>
253253
<tr class="markdownTableRowEven">
254-
<td class="markdownTableBodyNone"><span class="tt">m_variables_conversion</span> </td><td class="markdownTableBodyNone">Conservative-to-primitive variable conversion, mixture property evaluation, and pressure computation </td></tr>
254+
<td class="markdownTableBodyNone"><span class="tt">m_riemann_solver_hlld</span> </td><td class="markdownTableBodyNone">HLLD approximate Riemann solver for MHD, Miyoshi &amp; Kusano JCP (2005) </td></tr>
255+
<tr class="markdownTableRowOdd">
256+
<td class="markdownTableBodyNone"><span class="tt">m_riemann_solver_hll</span> </td><td class="markdownTableBodyNone">HLL approximate Riemann solver, Harten et al </td></tr>
257+
<tr class="markdownTableRowEven">
258+
<td class="markdownTableBodyNone"><span class="tt">m_riemann_solver_lf</span> </td><td class="markdownTableBodyNone">Lax-Friedrichs (Rusanov) approximate Riemann solver </td></tr>
259+
<tr class="markdownTableRowOdd">
260+
<td class="markdownTableBodyNone"><span class="tt">m_riemann_solver_hllc</span> </td><td class="markdownTableBodyNone">HLLC Riemann solver with contact restoration, Toro et al </td></tr>
261+
<tr class="markdownTableRowEven">
262+
<td class="markdownTableBodyNone"><span class="tt">m_muscl</span> </td><td class="markdownTableBodyNone">MUSCL reconstruction with interface sharpening for contact-preserving advection </td></tr>
255263
<tr class="markdownTableRowOdd">
264+
<td class="markdownTableBodyNone"><span class="tt">m_variables_conversion</span> </td><td class="markdownTableBodyNone">Conservative-to-primitive variable conversion, mixture property evaluation, and pressure computation </td></tr>
265+
<tr class="markdownTableRowEven">
256266
<td class="markdownTableBodyNone"><span class="tt">m_thinc</span> </td><td class="markdownTableBodyNone">THINC and MTHINC interface compression for volume fraction sharpening </td></tr>
257267
</table>
258268
<h2 class="doxsection"><a class="anchor" id="autotoc_md7"></a>
@@ -305,6 +315,10 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md8"></a>
305315
<tr class="markdownTableRowOdd">
306316
<td class="markdownTableBodyNone"><span class="tt">m_boundary_common</span> </td><td class="markdownTableBodyNone">Noncharacteristic and processor boundary condition application for ghost cells and buffer regions </td></tr>
307317
<tr class="markdownTableRowEven">
318+
<td class="markdownTableBodyNone"><span class="tt">m_boundary_primitives</span> </td><td class="markdownTableBodyNone">Per-cell noncharacteristic boundary condition primitives applied in the ghost cells </td></tr>
319+
<tr class="markdownTableRowOdd">
320+
<td class="markdownTableBodyNone"><span class="tt">m_boundary_io</span> </td><td class="markdownTableBodyNone">Boundary condition restart I/O, capillary/IGR buffer population, and grid-variable buffers </td></tr>
321+
<tr class="markdownTableRowEven">
308322
<td class="markdownTableBodyNone"><span class="tt">m_ibm</span> </td><td class="markdownTableBodyNone">Ghost-node immersed boundary method: locates ghost/image points, computes interpolation coefficients, and corrects the flow state </td></tr>
309323
<tr class="markdownTableRowOdd">
310324
<td class="markdownTableBodyNone"><span class="tt">m_particle_cloud</span> </td><td class="markdownTableBodyNone">Generates particle beds by converting particle_cloud patch specifications into individual immersed boundary patches before domain reduction </td></tr>
@@ -339,34 +353,36 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md10"></a>
339353
<tr class="markdownTableRowEven">
340354
<td class="markdownTableBodyNone"><span class="tt">m_global_parameters</span> </td><td class="markdownTableBodyNone">Defines global parameters for the computational domain, simulation algorithm, and initial conditions </td></tr>
341355
<tr class="markdownTableRowOdd">
342-
<td class="markdownTableBodyNone"><span class="tt">m_mpi_common</span> </td><td class="markdownTableBodyNone">MPI communication layer: domain decomposition, halo exchange, reductions, and parallel I/O setup </td></tr>
356+
<td class="markdownTableBodyNone"><span class="tt">m_global_parameters_common</span> </td><td class="markdownTableBodyNone">Shared global parameters and equation-index setup for all three executables </td></tr>
343357
<tr class="markdownTableRowEven">
344-
<td class="markdownTableBodyNone"><span class="tt">m_mpi_proxy</span> </td><td class="markdownTableBodyNone">Broadcasts user inputs and decomposes the domain across MPI ranks for pre-processing </td></tr>
358+
<td class="markdownTableBodyNone"><span class="tt">m_mpi_common</span> </td><td class="markdownTableBodyNone">MPI communication layer: domain decomposition, halo exchange, reductions, and parallel I/O setup </td></tr>
345359
<tr class="markdownTableRowOdd">
346-
<td class="markdownTableBodyNone"><span class="tt">m_constants</span> </td><td class="markdownTableBodyNone">Compile-time constant parameters: default values, tolerances, and physical constants </td></tr>
360+
<td class="markdownTableBodyNone"><span class="tt">m_mpi_proxy</span> </td><td class="markdownTableBodyNone">Broadcasts user inputs and decomposes the domain across MPI ranks for pre-processing </td></tr>
347361
<tr class="markdownTableRowEven">
348-
<td class="markdownTableBodyNone"><span class="tt">m_precision_select</span> </td><td class="markdownTableBodyNone">Working-precision kind selection (half/single/double) and corresponding MPI datatype parameters </td></tr>
362+
<td class="markdownTableBodyNone"><span class="tt">m_constants</span> </td><td class="markdownTableBodyNone">Compile-time constant parameters: default values, tolerances, and physical constants </td></tr>
349363
<tr class="markdownTableRowOdd">
350-
<td class="markdownTableBodyNone"><span class="tt">m_helper</span> </td><td class="markdownTableBodyNone">Utility routines for bubble model setup, coordinate transforms, array sampling, and special functions </td></tr>
364+
<td class="markdownTableBodyNone"><span class="tt">m_precision_select</span> </td><td class="markdownTableBodyNone">Working-precision kind selection (half/single/double) and corresponding MPI datatype parameters </td></tr>
351365
<tr class="markdownTableRowEven">
352-
<td class="markdownTableBodyNone"><span class="tt">m_helper_basic</span> </td><td class="markdownTableBodyNone">Basic floating-point utilities: approximate equality, default detection, and coordinate bounds </td></tr>
366+
<td class="markdownTableBodyNone"><span class="tt">m_helper</span> </td><td class="markdownTableBodyNone">Utility routines for bubble model setup, coordinate transforms, array sampling, and special functions </td></tr>
353367
<tr class="markdownTableRowOdd">
354-
<td class="markdownTableBodyNone"><span class="tt">m_compile_specific</span> </td><td class="markdownTableBodyNone">Platform-specific file and directory operations: create, delete, inquire, getcwd, and basename </td></tr>
368+
<td class="markdownTableBodyNone"><span class="tt">m_helper_basic</span> </td><td class="markdownTableBodyNone">Basic floating-point utilities: approximate equality, default detection, and coordinate bounds </td></tr>
355369
<tr class="markdownTableRowEven">
356-
<td class="markdownTableBodyNone"><span class="tt">m_fftw</span> </td><td class="markdownTableBodyNone">Forward and inverse FFT wrappers (FFTW/cuFFT/hipFFT) for azimuthal Fourier filtering in cylindrical geometries </td></tr>
370+
<td class="markdownTableBodyNone"><span class="tt">m_compile_specific</span> </td><td class="markdownTableBodyNone">Platform-specific file and directory operations: create, delete, inquire, getcwd, and basename </td></tr>
357371
<tr class="markdownTableRowOdd">
358-
<td class="markdownTableBodyNone"><span class="tt">m_nvtx</span> </td><td class="markdownTableBodyNone">NVIDIA NVTX profiling API bindings for GPU performance instrumentation </td></tr>
372+
<td class="markdownTableBodyNone"><span class="tt">m_fftw</span> </td><td class="markdownTableBodyNone">Forward and inverse FFT wrappers (FFTW/cuFFT/hipFFT) for azimuthal Fourier filtering in cylindrical geometries </td></tr>
359373
<tr class="markdownTableRowEven">
360-
<td class="markdownTableBodyNone"><span class="tt">m_model</span> </td><td class="markdownTableBodyNone">Binary STL file reader and processor for immersed boundary geometry </td></tr>
374+
<td class="markdownTableBodyNone"><span class="tt">m_nvtx</span> </td><td class="markdownTableBodyNone">NVIDIA NVTX profiling API bindings for GPU performance instrumentation </td></tr>
361375
<tr class="markdownTableRowOdd">
362-
<td class="markdownTableBodyNone"><span class="tt">m_finite_differences</span> </td><td class="markdownTableBodyNone">Finite difference operators for computing divergence of velocity fields </td></tr>
376+
<td class="markdownTableBodyNone"><span class="tt">m_model</span> </td><td class="markdownTableBodyNone">Binary STL file reader and processor for immersed boundary geometry </td></tr>
363377
<tr class="markdownTableRowEven">
364-
<td class="markdownTableBodyNone"><span class="tt">m_checker</span> </td><td class="markdownTableBodyNone">Checks pre-process input file parameters for compatibility and correctness </td></tr>
378+
<td class="markdownTableBodyNone"><span class="tt">m_finite_differences</span> </td><td class="markdownTableBodyNone">Finite difference operators for computing divergence of velocity fields </td></tr>
365379
<tr class="markdownTableRowOdd">
366-
<td class="markdownTableBodyNone"><span class="tt">m_checker_common</span> </td><td class="markdownTableBodyNone">Shared input validation checks for grid dimensions and AMD GPU compiler limits </td></tr>
380+
<td class="markdownTableBodyNone"><span class="tt">m_checker</span> </td><td class="markdownTableBodyNone">Checks pre-process input file parameters for compatibility and correctness </td></tr>
367381
<tr class="markdownTableRowEven">
368-
<td class="markdownTableBodyNone"><span class="tt">m_sim_helpers</span> </td><td class="markdownTableBodyNone">Simulation helper routines for enthalpy computation, CFL calculation, and stability checks </td></tr>
382+
<td class="markdownTableBodyNone"><span class="tt">m_checker_common</span> </td><td class="markdownTableBodyNone">Shared input validation checks for grid dimensions and AMD GPU compiler limits </td></tr>
369383
<tr class="markdownTableRowOdd">
384+
<td class="markdownTableBodyNone"><span class="tt">m_sim_helpers</span> </td><td class="markdownTableBodyNone">Simulation helper routines for enthalpy computation, CFL calculation, and stability checks </td></tr>
385+
<tr class="markdownTableRowEven">
370386
<td class="markdownTableBodyNone"><span class="tt">m_derived_variables</span> </td><td class="markdownTableBodyNone">Derives diagnostic flow quantities (vorticity, speed of sound, numerical Schlieren, etc.) from conservative and primitive variables </td></tr>
371387
</table>
372388
<h2 class="doxsection"><a class="anchor" id="autotoc_md11"></a>
@@ -409,7 +425,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
409425
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
410426
</ol>
411427
<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>
412-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-12</div> </div></div><!-- contents -->
428+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-13</div> </div></div><!-- contents -->
413429
</div><!-- PageDoc -->
414430
</div><!-- doc-content -->
415431
<div id="page-nav" class="page-nav-panel">

‎documentation/case_constraints.html‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1153,9 +1153,6 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
11531153
<p><b>Dependencies:</b></p><ul>
11541154
<li>When = 2, recommends: <span class="tt">muscl_order</span>, <span class="tt">muscl_lim</span></li>
11551155
</ul>
1156-
<p><b>Valid values</b> (errors):</p><ul>
1157-
<li>recon_type must be 1 (WENO) or 2 (MUSCL)</li>
1158-
</ul>
11591156
<p></p>
11601157
</details>
11611158
<details >
@@ -1464,7 +1461,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14641461
</table>
14651462
<hr />
14661463
<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>
1467-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-12</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-13</div> </div></div><!-- contents -->
14681465
</div><!-- PageDoc -->
14691466
</div><!-- doc-content -->
14701467
<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_md80"></a>
999999
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></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-12</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-13</div> </div></div><!-- contents -->
10031003
</div><!-- PageDoc -->
10041004
</div><!-- doc-content -->
10051005
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)