outram-foam-basic-lib 0.1.6

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

/// Errors produced by the specie-level thermophysics layer.
#[derive(Debug, Clone, PartialEq)]
pub enum ThermoError {
    /// Newton T-inversion exhausted all iterations without meeting the
    /// convergence tolerance (|ΔT/T| < 1e-6). Carries the last iterate.
    NonConvergent { max_iter: usize, last_t: f64 },
}

impl std::fmt::Display for ThermoError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            ThermoError::NonConvergent { max_iter, last_t } => write!(
                f,
                "Newton T-inversion did not converge after {max_iter} iterations \
                 (last T = {last_t:.2} K)"
            ),
        }
    }
}

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