outram-foam-basic-lib 0.1.3

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

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

//! Iterative linear solvers for the sparse LDU systems `A·x = b`.
//!
//! Each solver takes an [`LduMatrix`](super::ldu_matrix::LduMatrix) and a
//! right-hand side and returns the solution together with the iteration count
//! and final normalised residual:
//!
//! - [`gauss_seidel`](crate::ldu_matrix::solvers::gauss_seidel()) — a robust smoother that also handles the asymmetric
//!   (convection-bearing) momentum matrix.
//! - [`conjugate_gradient`](crate::ldu_matrix::solvers::conjugate_gradient()) — DIC-preconditioned CG for symmetric SPD systems
//!   (the pressure Poisson equation).
//! - [`gamg`](crate::ldu_matrix::solvers::gamg()) — algebraic multigrid for the same symmetric SPD systems, with
//!   near mesh-independent convergence on fine grids.
//! - [`krylov_solve`](fn@crate::ldu_matrix::solvers::krylov_solve) — the adapter onto the **asymmetric** Krylov kernels in
//!   [`crate::krylov`] (BiCGStab / restarted GMRES with identity, Jacobi or
//!   ILU(0) preconditioning), for the convection-bearing matrices where PCG and
//!   GAMG do not apply and Gauss-Seidel is slow.
//!
//! Belongs here: the linear-solver kernels only. The matrix assembly and the
//! `FvMatrix`/`FvVectorMatrix` wrappers that call them live one level up.

pub mod conjugate_gradient;
pub mod gamg;
pub mod gauss_seidel;
pub mod krylov_solve;

pub use conjugate_gradient::conjugate_gradient;
pub use gamg::gamg;
pub use gauss_seidel::gauss_seidel;
pub use krylov_solve::{
    krylov_solve, krylov_solve_prepared, KrylovMethod, KrylovOptions, PreconditionerKind,
};