aeon-tk 0.3.3

Toolkit for running finite difference simulations with adaptive mesh refinement
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

//! High-level solvers and integrators for common numerical problems.

mod hyper;
mod intergrate;

use std::convert::Infallible;

pub use hyper::{HyperRelaxError, HyperRelaxSolver};
pub use intergrate::{Integrator, Method};

use crate::{image::ImageRef, mesh::Mesh};

/// Trait for implementing solver callbacks (most often used to output visualization data).
pub trait SolverCallback<const N: usize> {
    type Error;

    /// Called once for every iteration in a iterative solver.
    fn callback(
        &mut self,
        _mesh: &Mesh<N>,
        _input: ImageRef,
        _output: ImageRef,
        _iteration: usize,
    ) -> Result<(), Self::Error> {
        Ok(())
    }
}

impl<const N: usize> SolverCallback<N> for () {
    type Error = Infallible;
}

impl<const N: usize, F: Fn(&Mesh<N>, ImageRef, ImageRef, usize)> SolverCallback<N> for F {
    type Error = Infallible;
    fn callback(
        &mut self,
        mesh: &Mesh<N>,
        input: ImageRef,
        output: ImageRef,
        iteration: usize,
    ) -> Result<(), Infallible> {
        self(mesh, input, output, iteration);
        Ok(())
    }
}