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

// 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/>.

//! Explicit (`fvc`) finite-volume operators — each returns a **new field**
//! (a `VolField` / `SurfaceField`), never a matrix.
//!
//! Mirrors `Foam::fvc::` (`src/finiteVolume/finiteVolume/fvc/`). Contents:
//! Gauss gradient (`grad`, `grad_vec`), Gauss divergence (`div`, `div_flux`,
//! `div_vec`, `div_tensor`, `div_symm_tensor`), surface-normal gradient
//! the Gauss cell gradient (`grad`, `grad_vec`) and the mesh-independent
//! least-squares cell gradient (`grad_least_squares` — exact for a linear field
//! on a non-orthogonal mesh, where the Gauss gradient is not), the
//! surface-normal gradient
//! (`sn_grad`), linear face interpolation (`interpolate`) and flux assembly
//! (`flux`, `buoyancy_flux`), least-squares velocity reconstruction
//! (`reconstruct`), the Rhie–Chow time-derivative flux correction
//! (`ddt_corr`), MUSCL / TVD limited face reconstruction
//! (`reconstruct_pos_neg`, `Limiter`), and the EOS-free
//! Kurganov–Noelle–Petrova central-upwind face flux (`central_upwind`). Field values carry raw
//! `f64` / `Vector3` / `Tensor` element data (no `uom`), consistent with the
//! rest of the FV operator layer.

pub mod central_upwind;
mod ddt_corr;
mod div;
mod div_tensor;
mod flux;
mod grad;
mod grad_least_squares;
mod grad_vec;
mod interpolate;
mod muscl;
mod reconstruct;
mod sn_grad;

pub use ddt_corr::ddt_corr;
pub use div::{div, div_flux, div_vec};
pub use div_tensor::{div_symm_tensor, div_tensor};
pub use flux::{buoyancy_flux, flux};
pub use grad::grad;
pub use grad_least_squares::grad_least_squares;
pub use grad_vec::grad_vec;
pub use interpolate::interpolate;
pub use muscl::{reconstruct_pos_neg, Limiter};
pub use reconstruct::reconstruct;
pub use sn_grad::sn_grad;