noether-guard 0.1.0

Physics linter — verify conservation laws in simulations using Noether's theorem
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

use std::fmt;

/// Errors produced by noether-guard.
#[derive(Debug, Clone)]
pub enum Error {
    /// No conservation laws registered.
    NoLaws,
    /// Value count mismatch on tick.
    ValueCountMismatch { expected: usize, got: usize },
    /// Invalid tolerance (must be >= 0).
    InvalidTolerance(f64),
    /// Invalid time step (must be >= 0).
    InvalidTime(f64),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::NoLaws => write!(f, "no conservation laws registered"),
            Self::ValueCountMismatch { expected, got } => {
                write!(f, "expected {expected} values, got {got}")
            }
            Self::InvalidTolerance(v) => write!(f, "invalid tolerance: {v}"),
            Self::InvalidTime(v) => write!(f, "invalid time: {v}"),
        }
    }
}

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

pub type Result<T> = std::result::Result<T, Error>;