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

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

//! Finite-volume mesh layer: topology and geometry.
//!
//! This module holds the flat, cache-friendly mesh representation the FV
//! operators run on. It contains:
//!
//! - [`FvMesh`](crate::mesh::fv_mesh::FvMesh) — the mesh itself (cells, faces, owner/neighbour connectivity,
//!   cell volumes `[m³]`, face-area vectors `[m²]`, and cell/face centres `[m]`),
//!   plus [`FvMeshBuilder`](crate::mesh::fv_mesh::FvMeshBuilder) to assemble one incrementally.
//! - [`BoundaryPatch`](crate::mesh::fv_mesh::BoundaryPatch) /
//!   [`PatchKind`](crate::mesh::fv_mesh::PatchKind) — boundary-patch descriptors.
//! - [`ami`](crate::mesh::ami) — arbitrary-mesh-interface (non-conformal periodic / `cyclicAMI`)
//!   face-overlap weighting and [`AmiCoupling`](crate::mesh::ami::AmiCoupling)
//!   representation.
//! - [`RegionInterface`](crate::mesh::region_interface::RegionInterface) — a face-to-face coupling map between two regions'
//!   patches (used by conjugate-heat-transfer solvers).
//! - [`MeshError`](crate::mesh::error::MeshError) — the errors raised during mesh construction and validation.
//!
//! It stores only the data required by the operators; the OpenFOAM
//! `polyMesh → primitiveMesh → lduMesh` inheritance chain is not reproduced.

pub mod ami;
pub mod error;
pub mod fv_mesh;
pub mod region_interface;

pub use ami::{AmiCoupling, AmiOverlap, AmiWeight};
pub use error::MeshError;
pub use fv_mesh::*;
pub use region_interface::RegionInterface;