outram-foam-basic-lib 0.1.6

OpenFOAM primitive functions translated to Rust -- an independent OUTRAM PARK fork, not the official OpenFOAM software
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 OUTRAM PARK contributors
// Derived from OpenFOAM (www.openfoam.com)
// Copyright (C) 2004-2023 OpenFOAM Foundation
// Copyright (C) 2016-2023 OpenCFD Ltd.
//
// This file is part of OUTRAM PARK.
//
// OUTRAM PARK is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the
// Free Software Foundation, either version 3 of the License, or (at your
// option) any later version.
//
// OUTRAM PARK is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with OUTRAM PARK.  If not, see <https://www.gnu.org/licenses/>.

use crate::fields::vol_field::VolScalarField;
use crate::mesh::fv_mesh::FvMesh;
use std::sync::Arc;

/// Field-level fluid thermodynamic model.
///
/// Mirrors the `Foam::fluidThermo` / `Foam::psiThermo` / `Foam::rhoThermo`
/// abstract interface from `src/thermophysicalModels/basic/`.
///
/// Owns the primary thermodynamic fields (`p`, `T`, `he`, `rho`, `psi`) and
/// provides `correct()` to recompute derived quantities after `he` or `p`
/// have been updated by the solver.
///
/// Computed transport fields (`mu`, `kappa`, `alpha_h`) are returned by value
/// rather than stored, to keep the struct lean and avoid stale-field bugs.
pub trait FluidThermo {
    /// The finite-volume mesh these thermodynamic fields are defined on.
    fn mesh(&self) -> &Arc<FvMesh>;

    /// Pressure field `[Pa]`.
    fn p(&self) -> &VolScalarField;
    /// Mutable pressure field `[Pa]` — for the pressure equation to update in place.
    fn p_mut(&mut self) -> &mut VolScalarField;

    /// Temperature field `[K]`.
    fn t(&self) -> &VolScalarField;

    /// Density field `[kg/m³]`.
    fn rho(&self) -> &VolScalarField;

    /// Energy field — sensible enthalpy `hs` `[J/kg]` by default.
    fn he(&self) -> &VolScalarField;
    /// Mutable energy field `he` `[J/kg]` — for the energy equation to update in place.
    fn he_mut(&mut self) -> &mut VolScalarField;

    /// Compressibility field ψ = ∂ρ/∂p|_T `[s²/m²]`.
    fn psi(&self) -> &VolScalarField;

    /// Dynamic viscosity field μ `[Pa·s]` — computed on demand.
    fn mu(&self) -> VolScalarField;

    /// Thermal conductivity field κ `[W/(m·K)]` — computed on demand.
    fn kappa(&self) -> VolScalarField;

    /// Thermal diffusivity αh = κ/Cp `[kg/(m·s)]` — computed on demand.
    fn alpha_h(&self) -> VolScalarField;

    /// Recompute `T`, `ρ`, and `ψ` from `he` + `p`.
    ///
    /// Call this after the energy equation has updated `he` and after `p` has
    /// been corrected.  The Newton iteration `t_from_hs` is applied cell-by-cell.
    fn correct(&mut self);

    /// Clamp density after the pressure equation:
    /// `ρ ← clamp(ρ + δρ, ρ_min, ρ_max)`.
    ///
    /// Corresponds to `thermo.correctRho(psi*p − ψ₀·p₀, rhoMin, rhoMax)` in
    /// OpenFOAM's rhoPimpleFoam.
    fn correct_rho(&mut self, delta_rho: &VolScalarField, rho_min: f64, rho_max: f64);
}