Docs @ 187292a

Author: MFC Action

documentation/architecture.html

@@ -427,7 +427,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
 <li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
 </ol>
 <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>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-21</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-22</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/case.html

@@ -391,6 +391,8 @@ <h4 class="doxsection"><a class="anchor" id="autotoc_md20"></a>
 <li><span class="tt">case(170)</span>: Load 1D profile from data files</li>
 <li><span class="tt">case(270)</span>: Extrude 1D data to 2D domain</li>
 <li><span class="tt">case(370)</span>: Extrude 2D data to 3D domain</li>
+<li><span class="tt">case(273)</span>: Extrude 1D data to 2D domain, with the mom%beg data column carrying the extruded-axis (mom%end) velocity profile instead of its own (zeroed) component. Used by <span class="tt">examples/2D_reacting_mixing_layer</span> to give a temporally-evolving mixing layer a nonzero streamwise velocity profile along the extruded axis, which <span class="tt">case(270)</span> cannot represent since it always zeros that component.</li>
+<li><span class="tt">case(274)</span>: Load a full 2D <span class="tt">(x, y)</span> field with no extrusion &ndash; one data file per variable, <span class="tt">(m_glb+1)*(n_glb+1)</span> lines each in x-major order, covering all primitive variables directly (unlike <span class="tt">case(270)</span>/<span class="tt">case(273)</span>, no component is zeroed or repurposed). Used by <span class="tt">examples/2D_spatial_reacting_mixing_layer</span> for a spatially-evolving mixing layer, where the cross-stream profile must vary with the streamwise coordinate too (via the <span class="tt">bf_spatial_support</span> body force) so no single extrusion axis applies. The file's line count, origin, and (uniform) cell spacing must match the run grid; a mismatched file is rejected with a fatal error, so regenerate the IC whenever the grid changes.</li>
 </ul>
 <p>Setup: Only requires specifying <span class="tt">files_dir</span> and filename pattern via <span class="tt">file_extension</span>. The files are located, for example, at <span class="tt">examples/1D_flamelet/IC</span>, and their format is <span class="tt">prim.XX.YY.file_extension.dat</span>. Implementation: All variables and file handling are managed in the <span class="tt">case.py</span> file of the simulation. Usage: Ideal for initializing simulations from lower-dimensional solutions, enabling users to add perturbations or modifications to the base extruded fields for flow instability studies.</p>
 <p>The following parameters support hardcoded initial conditions that read interface data from files:</p>
@@ -1283,19 +1285,22 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md30"></a>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyRight"><span class="tt">bf_x[y,z]</span>  </td><td class="markdownTableBodyCenter">Logical  </td><td class="markdownTableBodyLeft">Enable body forces in the x[y,z] direction  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight"><span class="tt">k_x[y,y]</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Magnitude of oscillating acceleration  </td></tr>
+<td class="markdownTableBodyRight"><span class="tt">k_x[y,z]</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Magnitude of oscillating acceleration  </td></tr>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyRight"><span class="tt">w_x[y,z]</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Frequency of oscillating acceleration  </td></tr>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyRight"><span class="tt">p_x[y,z]</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Phase shift of oscillating acceleration  </td></tr>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyRight"><span class="tt">g_x[y,z]</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Magnitude of background acceleration  </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyRight"><span class="tt">bf_spatial_support</span>  </td><td class="markdownTableBodyCenter">Logical  </td><td class="markdownTableBodyLeft">Enable spatially supported body force (Wei &amp; Freund, JFM 2005)  </td></tr>
 </table>
 <p><span class="tt">k_x[y,z]</span>, <span class="tt">w_x[y,z]</span>, <span class="tt">p_x[y,z]</span>, and <span class="tt">g_x[y,z]</span> define an oscillating acceleration in the <span class="tt">x[y,z]</span> direction with the form</p>
 <p class="formulaDsp">
 \[ a_{x[y,z]} = g_{x[y,z]} + k_{x[y,z]}\sin\left(w_{x[y,z]}t + p_{x[y,z]}\right). \]
 </p>
 <p>By convention, positive accelerations in the <span class="tt">x[y,z]</span> direction are in the positive <span class="tt">x[y,z]</span> direction.</p>
+<p>When <span class="tt">bf_spatial_support</span> is enabled, the body force is given a localized spatial envelope following Wei &amp; Freund (JFM, 2005), parameterized through the <span class="tt">spatial_bf</span> derived type with attributes <span class="tt">amp</span>, <span class="tt">x_centroid</span>, <span class="tt">y_centroid</span>, <span class="tt">conv_vel</span>, <span class="tt">sigma</span>, and per-mode arrays <span class="tt">freq(1:8)</span>, <span class="tt">phase(1:8)</span>. Unlike the domain-wide <span class="tt">k/w/p/g</span> forcing above, it seeds a downstream instability at a fixed streamwise location with a ladder of forcing frequencies. <span class="tt">x</span> is the streamwise direction by convention for this forcing: the <span class="tt">x</span> component advects with the mean flow via a <span class="tt">conv_vel*t</span> term, while the cross-stream (<span class="tt">y</span>) component does not. The source is constructed from a streamfunction, so it is divergence-free, and the corresponding <span class="tt">u*f</span> work term is added to the energy equation. This forcing is implemented for <b>2D cases only</b>; enabling it in 1D or 3D is rejected at startup.</p>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md31"></a>
 14. Magnetohydrodynamics (MHD)</h3>
 <table class="markdownTable">

documentation/case_constraints.html

@@ -1462,7 +1462,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
 </table>
 <hr  />
 <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>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-21</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-22</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

@@ -999,7 +999,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md82"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md83"></a>
 Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
 <p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-21</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-22</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/doxygen_crawl.html

@@ -416,12 +416,12 @@
 <a href="gpuParallelization.html#autotoc_md375"/>
 <a href="graph_legend.html"/>
 <a href="index.html"/>
-<a href="index.html#autotoc_md502"/>
-<a href="index.html#autotoc_md503"/>
 <a href="index.html#autotoc_md504"/>
 <a href="index.html#autotoc_md505"/>
 <a href="index.html#autotoc_md506"/>
 <a href="index.html#autotoc_md507"/>
+<a href="index.html#autotoc_md508"/>
+<a href="index.html#autotoc_md509"/>
 <a href="pages.html"/>
 <a href="papers.html"/>
 <a href="papers.html#autotoc_md376"/>
@@ -450,17 +450,18 @@
 <a href="parameters.html#autotoc_md409"/>
 <a href="parameters.html#autotoc_md411"/>
 <a href="parameters.html#autotoc_md413"/>
-<a href="parameters.html#autotoc_md418"/>
+<a href="parameters.html#autotoc_md415"/>
 <a href="parameters.html#autotoc_md420"/>
 <a href="parameters.html#autotoc_md422"/>
 <a href="parameters.html#autotoc_md424"/>
 <a href="parameters.html#autotoc_md426"/>
 <a href="parameters.html#autotoc_md428"/>
-<a href="parameters.html#autotoc_md432"/>
+<a href="parameters.html#autotoc_md430"/>
 <a href="parameters.html#autotoc_md434"/>
 <a href="parameters.html#autotoc_md436"/>
 <a href="parameters.html#autotoc_md438"/>
-<a href="parameters.html#autotoc_md447"/>
+<a href="parameters.html#autotoc_md440"/>
+<a href="parameters.html#autotoc_md449"/>
 <a href="parameters.html#bc_x"/>
 <a href="parameters.html#bc_y"/>
 <a href="parameters.html#bc_z"/>
@@ -483,6 +484,7 @@
 <a href="parameters.html#probe"/>
 <a href="parameters.html#schlieren_alpha"/>
 <a href="parameters.html#simplex_params"/>
+<a href="parameters.html#spatial_bf"/>
 <a href="parameters.html#stl_models"/>
 <a href="parameters.html#synth_L"/>
 <a href="parameters.html#synth_amp_shell"/>
@@ -497,125 +499,123 @@
 <a href="parameters.html#z_domain"/>
 <a href="parameters.html#z_output"/>
 <a href="physics_constraints.html"/>
-<a href="physics_constraints.html#autotoc_md448"/>
 <a href="physics_constraints.html#autotoc_md450"/>
-<a href="physics_constraints.html#autotoc_md451"/>
 <a href="physics_constraints.html#autotoc_md452"/>
 <a href="physics_constraints.html#autotoc_md453"/>
+<a href="physics_constraints.html#autotoc_md454"/>
 <a href="physics_constraints.html#autotoc_md455"/>
-<a href="physics_constraints.html#autotoc_md456"/>
 <a href="physics_constraints.html#autotoc_md457"/>
+<a href="physics_constraints.html#autotoc_md458"/>
 <a href="physics_constraints.html#autotoc_md459"/>
-<a href="physics_constraints.html#autotoc_md460"/>
 <a href="physics_constraints.html#autotoc_md461"/>
 <a href="physics_constraints.html#autotoc_md462"/>
+<a href="physics_constraints.html#autotoc_md463"/>
 <a href="physics_constraints.html#autotoc_md464"/>
-<a href="physics_constraints.html#autotoc_md465"/>
+<a href="physics_constraints.html#autotoc_md466"/>
 <a href="physics_constraints.html#autotoc_md467"/>
-<a href="physics_constraints.html#autotoc_md468"/>
+<a href="physics_constraints.html#autotoc_md469"/>
 <a href="physics_constraints.html#autotoc_md470"/>
-<a href="physics_constraints.html#autotoc_md471"/>
+<a href="physics_constraints.html#autotoc_md472"/>
 <a href="physics_constraints.html#autotoc_md473"/>
-<a href="physics_constraints.html#autotoc_md474"/>
 <a href="physics_constraints.html#autotoc_md475"/>
 <a href="physics_constraints.html#autotoc_md476"/>
+<a href="physics_constraints.html#autotoc_md477"/>
 <a href="physics_constraints.html#autotoc_md478"/>
-<a href="physics_constraints.html#autotoc_md479"/>
 <a href="physics_constraints.html#autotoc_md480"/>
 <a href="physics_constraints.html#autotoc_md481"/>
 <a href="physics_constraints.html#autotoc_md482"/>
 <a href="physics_constraints.html#autotoc_md483"/>
 <a href="physics_constraints.html#autotoc_md484"/>
 <a href="physics_constraints.html#autotoc_md485"/>
+<a href="physics_constraints.html#autotoc_md486"/>
 <a href="physics_constraints.html#autotoc_md487"/>
-<a href="physics_constraints.html#autotoc_md488"/>
 <a href="physics_constraints.html#autotoc_md489"/>
 <a href="physics_constraints.html#autotoc_md490"/>
 <a href="physics_constraints.html#autotoc_md491"/>
+<a href="physics_constraints.html#autotoc_md492"/>
 <a href="physics_constraints.html#autotoc_md493"/>
-<a href="physics_constraints.html#autotoc_md494"/>
+<a href="physics_constraints.html#autotoc_md495"/>
 <a href="physics_constraints.html#autotoc_md496"/>
-<a href="physics_constraints.html#autotoc_md497"/>
 <a href="physics_constraints.html#autotoc_md498"/>
+<a href="physics_constraints.html#autotoc_md499"/>
 <a href="physics_constraints.html#autotoc_md500"/>
-<a href="physics_constraints.html#autotoc_md501"/>
+<a href="physics_constraints.html#autotoc_md502"/>
+<a href="physics_constraints.html#autotoc_md503"/>
 <a href="running.html"/>
-<a href="running.html#autotoc_md508"/>
-<a href="running.html#autotoc_md509"/>
+<a href="running.html#autotoc_md510"/>
 <a href="running.html#autotoc_md511"/>
 <a href="running.html#autotoc_md513"/>
-<a href="running.html#autotoc_md514"/>
 <a href="running.html#autotoc_md515"/>
 <a href="running.html#autotoc_md516"/>
 <a href="running.html#autotoc_md517"/>
 <a href="running.html#autotoc_md518"/>
 <a href="running.html#autotoc_md519"/>
 <a href="running.html#autotoc_md520"/>
 <a href="running.html#autotoc_md521"/>
+<a href="running.html#autotoc_md522"/>
 <a href="running.html#autotoc_md523"/>
-<a href="running.html#autotoc_md524"/>
 <a href="running.html#autotoc_md525"/>
 <a href="running.html#autotoc_md526"/>
 <a href="running.html#autotoc_md527"/>
 <a href="running.html#autotoc_md528"/>
+<a href="running.html#autotoc_md529"/>
 <a href="running.html#autotoc_md530"/>
 <a href="running.html#autotoc_md532"/>
+<a href="running.html#autotoc_md534"/>
 <a href="testing.html"/>
-<a href="testing.html#autotoc_md533"/>
-<a href="testing.html#autotoc_md534"/>
 <a href="testing.html#autotoc_md535"/>
+<a href="testing.html#autotoc_md536"/>
+<a href="testing.html#autotoc_md537"/>
 <a href="troubleshooting.html"/>
-<a href="troubleshooting.html#autotoc_md536"/>
-<a href="troubleshooting.html#autotoc_md537"/>
 <a href="troubleshooting.html#autotoc_md538"/>
 <a href="troubleshooting.html#autotoc_md539"/>
 <a href="troubleshooting.html#autotoc_md540"/>
+<a href="troubleshooting.html#autotoc_md541"/>
 <a href="troubleshooting.html#autotoc_md542"/>
-<a href="troubleshooting.html#autotoc_md543"/>
 <a href="troubleshooting.html#autotoc_md544"/>
 <a href="troubleshooting.html#autotoc_md545"/>
+<a href="troubleshooting.html#autotoc_md546"/>
 <a href="troubleshooting.html#autotoc_md547"/>
-<a href="troubleshooting.html#autotoc_md548"/>
 <a href="troubleshooting.html#autotoc_md549"/>
 <a href="troubleshooting.html#autotoc_md550"/>
 <a href="troubleshooting.html#autotoc_md551"/>
 <a href="troubleshooting.html#autotoc_md552"/>
+<a href="troubleshooting.html#autotoc_md553"/>
 <a href="troubleshooting.html#autotoc_md554"/>
-<a href="troubleshooting.html#autotoc_md555"/>
 <a href="troubleshooting.html#autotoc_md556"/>
 <a href="troubleshooting.html#autotoc_md557"/>
 <a href="troubleshooting.html#autotoc_md558"/>
+<a href="troubleshooting.html#autotoc_md559"/>
 <a href="troubleshooting.html#autotoc_md560"/>
-<a href="troubleshooting.html#autotoc_md561"/>
 <a href="troubleshooting.html#autotoc_md562"/>
 <a href="troubleshooting.html#autotoc_md563"/>
 <a href="troubleshooting.html#autotoc_md564"/>
 <a href="troubleshooting.html#autotoc_md565"/>
+<a href="troubleshooting.html#autotoc_md566"/>
 <a href="troubleshooting.html#autotoc_md567"/>
-<a href="troubleshooting.html#autotoc_md568"/>
 <a href="troubleshooting.html#autotoc_md569"/>
 <a href="troubleshooting.html#autotoc_md570"/>
+<a href="troubleshooting.html#autotoc_md571"/>
 <a href="troubleshooting.html#autotoc_md572"/>
-<a href="troubleshooting.html#autotoc_md573"/>
 <a href="troubleshooting.html#autotoc_md574"/>
 <a href="troubleshooting.html#autotoc_md575"/>
 <a href="troubleshooting.html#autotoc_md576"/>
 <a href="troubleshooting.html#autotoc_md577"/>
+<a href="troubleshooting.html#autotoc_md578"/>
 <a href="troubleshooting.html#autotoc_md579"/>
-<a href="troubleshooting.html#autotoc_md580"/>
 <a href="troubleshooting.html#autotoc_md581"/>
 <a href="troubleshooting.html#autotoc_md582"/>
 <a href="troubleshooting.html#autotoc_md583"/>
+<a href="troubleshooting.html#autotoc_md584"/>
 <a href="troubleshooting.html#autotoc_md585"/>
-<a href="troubleshooting.html#autotoc_md586"/>
 <a href="troubleshooting.html#autotoc_md587"/>
 <a href="troubleshooting.html#autotoc_md588"/>
 <a href="troubleshooting.html#autotoc_md589"/>
+<a href="troubleshooting.html#autotoc_md590"/>
 <a href="troubleshooting.html#autotoc_md591"/>
+<a href="troubleshooting.html#autotoc_md593"/>
 <a href="visualization.html"/>
-<a href="visualization.html#autotoc_md592"/>
 <a href="visualization.html#autotoc_md594"/>
-<a href="visualization.html#autotoc_md595"/>
 <a href="visualization.html#autotoc_md596"/>
 <a href="visualization.html#autotoc_md597"/>
 <a href="visualization.html#autotoc_md598"/>
@@ -627,13 +627,15 @@
 <a href="visualization.html#autotoc_md604"/>
 <a href="visualization.html#autotoc_md605"/>
 <a href="visualization.html#autotoc_md606"/>
+<a href="visualization.html#autotoc_md607"/>
 <a href="visualization.html#autotoc_md608"/>
-<a href="visualization.html#autotoc_md609"/>
 <a href="visualization.html#autotoc_md610"/>
 <a href="visualization.html#autotoc_md611"/>
 <a href="visualization.html#autotoc_md612"/>
 <a href="visualization.html#autotoc_md613"/>
 <a href="visualization.html#autotoc_md614"/>
 <a href="visualization.html#autotoc_md615"/>
+<a href="visualization.html#autotoc_md616"/>
+<a href="visualization.html#autotoc_md617"/>
 </body>
 </html>

documentation/examples.html

@@ -630,7 +630,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md313"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md314"></a>
 Liutex visualization at transitional state</h3>
 <p><img src="result-3D_turb_mixing-example.png" alt="" height="400" class="inline"/></p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-21</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-22</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">