discreet-common 0.1.0

Code shared between the discreet and discreet-macros packages.
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

pub mod diff_eq;

pub use diff_eq::{Derivative, Variable};

/// A node in a 2-dimensional finite difference method. This corresponds to the term u[i+I, j+J].
pub struct Node2D<const I: usize, const J: usize> {
    /// The value of this node when evaluating the finite difference operator on the stencil
    value: f64,
}

/// A marker struct that indicates a Dirichlet boundary condition
pub struct Dirichlet;

/// A marker struct that indicates a Dirichlet boundary condition
pub struct Neumann;

/// A struct implementing this trait can be used as the stencil for a finite difference method. This
/// trait is not intended to be manually implemented but rather to be implemented through the `stencil`
/// macro.
pub trait FiniteDifferenceStencil2D {
    /// Constructs an instance of the stencil
    fn construct(grid: &[f64], x_nodes: usize, i: usize, j: usize) -> Self;

    /// Computes the value of the target of a filled in stencil.
    fn compute(&self) -> f64;
}