outram_foam_basic_lib/lib.rs
1// SPDX-License-Identifier: GPL-3.0-only
2// Copyright (C) 2026 OUTRAM PARK contributors
3// Derived from OpenFOAM (www.openfoam.com)
4// Copyright (C) 2004-2023 OpenFOAM Foundation
5// Copyright (C) 2016-2023 OpenCFD Ltd.
6//
7// This file is part of OUTRAM PARK.
8//
9// OUTRAM PARK is free software: you can redistribute it and/or modify it
10// under the terms of the GNU General Public License as published by the
11// Free Software Foundation, either version 3 of the License, or (at your
12// option) any later version.
13//
14// OUTRAM PARK is distributed in the hope that it will be useful, but
15// WITHOUT ANY WARRANTY; without even the implied warranty of
16// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17// General Public License for more details.
18//
19// You should have received a copy of the GNU General Public License along
20// with OUTRAM PARK. If not, see <https://www.gnu.org/licenses/>.
21
22//! **This is OUTRAM PARK's independent Rust translation of selected
23//! OpenFOAM® primitive/finite-volume algorithms — it is not the official
24//! OpenFOAM® software and is not affiliated with, endorsed by, or
25//! sanctioned by OpenCFD Ltd. or the ESI Group.** OpenFOAM® is a registered
26//! trademark of OpenCFD Limited. See `TRADEMARKS.md` (this crate's
27//! directory, mirrored from the workspace root) for the full attribution
28//! and non-affiliation notice.
29
30pub mod fields;
31pub mod fluid_thermo;
32pub mod fv_operators;
33pub mod interpolation;
34pub mod ldu_matrix;
35pub mod math;
36pub mod matrix;
37pub mod mesh;
38pub mod ode;
39pub mod polynomial;
40pub mod prelude;
41pub mod primitives;
42pub mod thermophysics;
43
44/// this part is extension in Rust
45/// Now under here, I want to expose the openfoam primitives to something
46/// that can be human readable
47///
48/// Also useful add-ons for the underlying libraries are put here,
49/// eg. generating one dimensional meshes for system code type simulations
50/// in TAMPINES
51pub mod interface;