Skip to content

Commit f409050

Browse files
author
MFC Action
committed
Docs @ 7406f04
1 parent 7e3335f commit f409050

876 files changed

Lines changed: 128685 additions & 124982 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: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -263,32 +263,34 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md7"></a>
263263
<tr class="markdownTableRowOdd">
264264
<td class="markdownTableBodyNone"><span class="tt">m_viscous</span> </td><td class="markdownTableBodyNone">Computes viscous stress tensors and diffusive flux contributions for the Navier&ndash;Stokes equations </td></tr>
265265
<tr class="markdownTableRowEven">
266-
<td class="markdownTableBodyNone"><span class="tt">m_surface_tension</span> </td><td class="markdownTableBodyNone">Computes capillary source fluxes and color-function gradients for the diffuse-interface surface tension model </td></tr>
266+
<td class="markdownTableBodyNone"><span class="tt">m_hb_function</span> </td><td class="markdownTableBodyNone">Herschel-Bulkley non-Newtonian viscosity: formula, shear rate, and mixture inverse-Re </td></tr>
267267
<tr class="markdownTableRowOdd">
268-
<td class="markdownTableBodyNone"><span class="tt">m_bubbles</span> </td><td class="markdownTableBodyNone">Bubble-dynamics procedures for ensemble- and volume-averaged models </td></tr>
268+
<td class="markdownTableBodyNone"><span class="tt">m_surface_tension</span> </td><td class="markdownTableBodyNone">Computes capillary source fluxes and color-function gradients for the diffuse-interface surface tension model </td></tr>
269269
<tr class="markdownTableRowEven">
270-
<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EE</span> </td><td class="markdownTableBodyNone">Computes ensemble-averaged (Euler&ndash;Euler) bubble source terms for radius, velocity, pressure, and mass transfer </td></tr>
270+
<td class="markdownTableBodyNone"><span class="tt">m_bubbles</span> </td><td class="markdownTableBodyNone">Bubble-dynamics procedures for ensemble- and volume-averaged models </td></tr>
271271
<tr class="markdownTableRowOdd">
272-
<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EL</span> </td><td class="markdownTableBodyNone">Tracks Lagrangian bubbles and couples their dynamics to the Eulerian flow via volume averaging </td></tr>
272+
<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EE</span> </td><td class="markdownTableBodyNone">Computes ensemble-averaged (Euler&ndash;Euler) bubble source terms for radius, velocity, pressure, and mass transfer </td></tr>
273273
<tr class="markdownTableRowEven">
274-
<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EL_kernels</span> </td><td class="markdownTableBodyNone">Kernel functions (Gaussian, delta) that smear Lagrangian bubble effects onto the Eulerian grid </td></tr>
274+
<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EL</span> </td><td class="markdownTableBodyNone">Tracks Lagrangian bubbles and couples their dynamics to the Eulerian flow via volume averaging </td></tr>
275275
<tr class="markdownTableRowOdd">
276-
<td class="markdownTableBodyNone"><span class="tt">m_qbmm</span> </td><td class="markdownTableBodyNone">Quadrature-based moment methods (QBMM) for polydisperse bubble moment inversion and transport </td></tr>
276+
<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EL_kernels</span> </td><td class="markdownTableBodyNone">Kernel functions (Gaussian, delta) that smear Lagrangian bubble effects onto the Eulerian grid </td></tr>
277277
<tr class="markdownTableRowEven">
278-
<td class="markdownTableBodyNone"><span class="tt">m_hyperelastic</span> </td><td class="markdownTableBodyNone">Computes the left Cauchy&ndash;Green deformation tensor and hyperelastic stress source terms </td></tr>
278+
<td class="markdownTableBodyNone"><span class="tt">m_qbmm</span> </td><td class="markdownTableBodyNone">Quadrature-based moment methods (QBMM) for polydisperse bubble moment inversion and transport </td></tr>
279279
<tr class="markdownTableRowOdd">
280-
<td class="markdownTableBodyNone"><span class="tt">m_hypoelastic</span> </td><td class="markdownTableBodyNone">Computes hypoelastic stress-rate source terms and damage-state evolution </td></tr>
280+
<td class="markdownTableBodyNone"><span class="tt">m_hyperelastic</span> </td><td class="markdownTableBodyNone">Computes the left Cauchy&ndash;Green deformation tensor and hyperelastic stress source terms </td></tr>
281281
<tr class="markdownTableRowEven">
282-
<td class="markdownTableBodyNone"><span class="tt">m_phase_change</span> </td><td class="markdownTableBodyNone">Phase transition relaxation solvers for liquid-vapor flows with cavitation and boiling </td></tr>
282+
<td class="markdownTableBodyNone"><span class="tt">m_hypoelastic</span> </td><td class="markdownTableBodyNone">Computes hypoelastic stress-rate source terms and damage-state evolution </td></tr>
283283
<tr class="markdownTableRowOdd">
284-
<td class="markdownTableBodyNone"><span class="tt">m_chemistry</span> </td><td class="markdownTableBodyNone">Multi-species chemistry interface for thermodynamic properties, reaction rates, and transport coefficients </td></tr>
284+
<td class="markdownTableBodyNone"><span class="tt">m_phase_change</span> </td><td class="markdownTableBodyNone">Phase transition relaxation solvers for liquid-vapor flows with cavitation and boiling </td></tr>
285285
<tr class="markdownTableRowEven">
286-
<td class="markdownTableBodyNone"><span class="tt">m_acoustic_src</span> </td><td class="markdownTableBodyNone">One-way acoustic source injection, Maeda and Colonius JCP (2017) </td></tr>
286+
<td class="markdownTableBodyNone"><span class="tt">m_chemistry</span> </td><td class="markdownTableBodyNone">Multi-species chemistry interface for thermodynamic properties, reaction rates, and transport coefficients </td></tr>
287287
<tr class="markdownTableRowOdd">
288-
<td class="markdownTableBodyNone"><span class="tt">m_body_forces</span> </td><td class="markdownTableBodyNone">Computes gravitational and body force source terms for the momentum equations </td></tr>
288+
<td class="markdownTableBodyNone"><span class="tt">m_acoustic_src</span> </td><td class="markdownTableBodyNone">One-way acoustic source injection, Maeda and Colonius JCP (2017) </td></tr>
289289
<tr class="markdownTableRowEven">
290-
<td class="markdownTableBodyNone"><span class="tt">m_pressure_relaxation</span> </td><td class="markdownTableBodyNone">Pressure relaxation for the six-equation multi-component model via Newton&ndash;Raphson equilibration and volume-fraction correction </td></tr>
290+
<td class="markdownTableBodyNone"><span class="tt">m_body_forces</span> </td><td class="markdownTableBodyNone">Computes gravitational and body force source terms for the momentum equations </td></tr>
291291
<tr class="markdownTableRowOdd">
292+
<td class="markdownTableBodyNone"><span class="tt">m_pressure_relaxation</span> </td><td class="markdownTableBodyNone">Pressure relaxation for the six-equation multi-component model via Newton&ndash;Raphson equilibration and volume-fraction correction </td></tr>
293+
<tr class="markdownTableRowEven">
292294
<td class="markdownTableBodyNone"><span class="tt">m_collisions</span> </td><td class="markdownTableBodyNone">Ghost-node immersed boundary method: locates ghost/image points, computes interpolation coefficients, and corrects the flow state </td></tr>
293295
</table>
294296
<h2 class="doxsection"><a class="anchor" id="autotoc_md8"></a>
@@ -407,7 +409,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
407409
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
408410
</ol>
409411
<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>
410-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-10</div> </div></div><!-- contents -->
412+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-11</div> </div></div><!-- contents -->
411413
</div><!-- PageDoc -->
412414
</div><!-- doc-content -->
413415
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)