You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Document stored parameter conventions and common material values
Add documentation for non-bubble users explaining that fluid_pp%gamma,
pi_inf, and Re use transformed stored forms (1/(γ-1), γπ∞/(γ-1), 1/μ).
Includes a common materials reference table and worked examples.
Also fixes misleading EOS section that implied raw γ/π∞ are input directly.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/documentation/equations.md
+53-1Lines changed: 53 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,58 @@ The main flow solver (Navier-Stokes equations, Riemann solvers, viscous stress,
37
37
38
38
This means that for simulations **without** sub-grid bubble models, the user can work in any consistent unit system without additional effort.
39
39
40
+
### Stored Parameter Conventions
41
+
42
+
Several EOS and transport parameters use **transformed stored forms** that differ from the standard physical values. This is the most common source of input errors:
These transformations arise because MFC internally solves the energy equation using the transformed variables \f$\Gamma\f$ and \f$\Pi_\infty\f$ (see Section 3.1), and the viscous stress is computed by dividing by `Re` rather than multiplying by \f$\mu\f$.
52
+
53
+
**Common mistake:** setting `fluid_pp(1)%gamma = 1.4` for air. The correct value is `1.0 / (1.4 - 1.0) = 2.5`. Setting `gamma = 1.4` corresponds to a physical \f$\gamma \approx 1.71\f$, which is not a standard gas.
54
+
55
+
### Common Material Values
56
+
57
+
Pre-computed stored-form values for common fluids (SI units):
For viscous cases, provide the **reciprocal** of the dynamic viscosity:
82
+
83
+
```python
84
+
mu =1.002e-3# water viscosity [Pa·s]
85
+
"fluid_pp(1)%Re(1)": 1.0/ mu, # ≈ 998
86
+
```
87
+
88
+
### Unit Consistency
89
+
90
+
The solver does not check or convert units. All inputs must use the **same consistent unit system** (e.g., all SI or all CGS). Mixing units — for example, pressures in atmospheres with densities in kg/m³ — will produce silently incorrect results.
91
+
40
92
### Non-Dimensional Bubble Dynamics
41
93
42
94
The sub-grid bubble models (`bubbles_euler = .true.` or `bubbles_lagrange = .true.`) solve the bubble wall dynamics in **non-dimensional form**. The bubble wall pressure equation as implemented is:
@@ -281,7 +333,7 @@ The pressure is recovered from the total energy as:
Input parameters per fluid: `gamma` (\f$\Gamma_k = 1/(\gamma_k - 1)\f$), `pi_inf` (\f$\Pi_{\infty,k} = \gamma_k\,\pi_{\infty,k}/(\gamma_k - 1)\f$), `cv` (\f$c_{v,k}\f$), `qv` (\f$q_{v,k}\f$), `qvp` (\f$q'_{v,k}\f$). Note that `gamma` and `pi_inf` are stored in transformed form, not as the raw physical values (see Section 1b).
285
337
286
338
### 3.2 Ideal Gas EOS (Chemistry, `chemistry = .true.`)
0 commit comments