Docs @ 9d866bd

Author: MFC Action

documentation/architecture.html

@@ -407,7 +407,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-06-02</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-03</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/case.html

@@ -881,7 +881,7 @@ <h3 class="doxsection"><a class="anchor" id="sec-formatted-output"></a>
 <li><span class="tt">file_per_process</span> deactivates shared file MPI-IO and activates file per process MPI-IO. The default behavior is to use a shared file. File per process is useful when running on &gt;10K ranks. If <span class="tt">file_per_process</span> is true, then pre_process, simulation, and post_process must be run with the same number of ranks.</li>
 <li><span class="tt">cons_vars_wrt</span> and <span class="tt">prim_vars_wrt</span> activate the output of conservative and primitive state variables into the database.</li>
 <li><span class="tt">[variable's name]_wrt</span> activates the output of each specified variable into the database.</li>
-<li><span class="tt">schlieren_alpha(i)</span> specifies the intensity of the numerical Schlieren of $i$-th component.</li>
+<li><span class="tt">schlieren_alpha(i)</span> specifies the intensity of the numerical Schlieren of $i$-th component. It must be specified for every fluid when <span class="tt">schlieren_wrt</span> is enabled.</li>
 <li><span class="tt">fd_order</span> specifies the order of the finite difference scheme used to compute the vorticity from the velocity field and the numerical schlieren from the density field using an integer of 1, 2, and 4. <span class="tt">fd_order = 1</span>, <span class="tt">2</span>, and <span class="tt">4</span> correspond to the first, second, and fourth-order finite difference schemes.</li>
 <li><span class="tt">probe_wrt</span> activates the output of state variables at coordinates specified by <span class="tt">probe(i)%[x;y,z]</span>.</li>
 <li><span class="tt">ib_state_wrt</span> is used to trigger post-processing of the IB state to be written out as a point mesh in the SILO files. When no IBs are moving, it also triggers force and torque calculation so that those values may be written to the output state files.</li>

documentation/case_constraints.html

@@ -1203,6 +1203,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
 <p><b>Requirements</b> (errors):</p><ul>
 <li>schlieren_wrt requires n &gt; 0 (at least 2D)</li>
 <li>fd_order must be set for schlieren_wrt</li>
+<li>schlieren_alpha(i) must be set for every fluid when schlieren_wrt is enabled (unless model_eqns == 1)</li>
 </ul>
 <p><b>Incompatibilities</b> (errors):</p><ul>
 <li>output_partial_domain is incompatible with certain output flags</li>
@@ -1462,7 +1463,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-06-02</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-03</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

@@ -994,7 +994,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md81"></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-06-02</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-03</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/examples.html

@@ -388,7 +388,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md275"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md276"></a>
 Result</h3>
 <p><img src="result-1D_titarevtorro-example.png" alt="" heiht="400" class="inline"/></p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-02</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-03</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/parameters.html

@@ -1508,7 +1508,7 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><span class="tt">run_time_info</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Output run-time information  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">Post-processing output flag  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">schlieren_wrt</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Write schlieren images  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">schlieren_wrt</span> requires n &gt; 0 (at least 2D); <span class="tt">fd_order</span> must be set for <span class="tt">schlieren_wrt</span>; <span class="tt">schlieren_alpha</span>(i) should be set only with <span class="tt">schlieren_wrt</span> enabled  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">schlieren_wrt</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Write schlieren images  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">schlieren_wrt</span> requires n &gt; 0 (at least 2D); <span class="tt">fd_order</span> must be set for <span class="tt">schlieren_wrt</span>; <span class="tt">schlieren_alpha</span>(i) must be set for every fluid when <span class="tt">schlieren_wrt</span> is enabled (unless <span class="tt">model_eqns</span> == 1)  </td></tr>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><span class="tt">sigR</span>  </td><td class="markdownTableBodyNone">Real  </td><td class="markdownTableBodyNone">Bubble radius standard deviation  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"></td></tr>
 <tr class="markdownTableRowOdd">
@@ -1601,7 +1601,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md394"></a>
 <div class="line"> </div>
 <div class="line"># Filter by type</div>
 <div class="line">./mfc.sh params -t real weno</div>
-</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-02</div> </div></div><!-- contents -->
+</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-03</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/physics_constraints.html

@@ -627,7 +627,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md444"></a>
 <li>FFT WRT incompatible with cylindrical coordinates</li>
 <li>FFT WRT requires global dimensions divisible by 2</li>
 </ul>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-02</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-03</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">