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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 OUTRAM PARK contributors

/// Errors produced by the mesh layer (mesh construction and validation).
#[derive(Debug, Clone, PartialEq)]
pub enum MeshError {
    /// An array field in the mesh has the wrong length.
    ///
    /// For example, `owner` must have length `n_faces`; `neighbour` must have
    /// length `n_internal_faces`; `cell_volumes` must have length `n_cells`.
    ArrayLengthMismatch {
        /// Name of the offending array (e.g. `"owner"`, `"cell_volumes"`).
        array: &'static str,
        expected: usize,
        got: usize,
    },

    /// A boundary patch does not start immediately after the previous one,
    /// leaving a gap or overlap in face coverage.
    PatchStartMismatch {
        /// Name of the offending patch.
        name: String,
        expected: usize,
        got: usize,
    },

    /// The sum of all patch sizes does not equal the number of boundary faces.
    PatchCoverageMismatch {
        /// Total face count covered by all patches.
        covered: usize,
        /// Total face count in the mesh.
        n_faces: usize,
    },

    /// `number_of_cells` was zero or negative when building a 1-D mesh.
    NonPositiveCellCount { got: i64 },

    /// A [`PatchKind::Cyclic`](crate::mesh::PatchKind::Cyclic) patch pair is
    /// inconsistent — e.g. the partner index is out of range, the partner does
    /// not name this patch back, or the two halves have different face counts.
    CyclicPairMismatch {
        /// Name of the offending cyclic patch.
        name: String,
        /// Why the pair is invalid.
        reason: &'static str,
    },

    /// A [`PatchKind::CyclicAmi`](crate::mesh::PatchKind::CyclicAmi)
    /// (non-conformal periodic) coupling is inconsistent — e.g. a target/source
    /// cell or face index is out of range, or a target face has no overlapping
    /// source faces.
    AmiCouplingInvalid {
        /// Global face index of the offending AMI target face.
        target_face: usize,
        /// Why the coupling is invalid.
        reason: &'static str,
    },
}

impl std::fmt::Display for MeshError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            MeshError::ArrayLengthMismatch {
                array,
                expected,
                got,
            } => write!(
                f,
                "mesh array '{array}': expected length {expected}, got {got}"
            ),
            MeshError::PatchStartMismatch {
                name,
                expected,
                got,
            } => write!(
                f,
                "patch '{name}': expected to start at face {expected}, starts at {got}"
            ),
            MeshError::PatchCoverageMismatch { covered, n_faces } => write!(
                f,
                "boundary patches cover {covered} faces but n_faces = {n_faces}"
            ),
            MeshError::NonPositiveCellCount { got } => {
                write!(f, "number_of_cells must be ≥ 1, got {got}")
            }
            MeshError::CyclicPairMismatch { name, reason } => {
                write!(f, "cyclic patch '{name}': {reason}")
            }
            MeshError::AmiCouplingInvalid {
                target_face,
                reason,
            } => {
                write!(f, "AMI coupling at target face {target_face}: {reason}")
            }
        }
    }
}

impl std::error::Error for MeshError {}