russell_pde 2.5.0

Essential tools to solve partial differential equations; not a full-fledged PDE solver
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

/// Specifies the (boundary) side of a rectangle
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Side {
    Xmin = 0,
    Xmax = 1,
    Ymin = 2,
    Ymax = 3,
}

impl Side {
    /// Creates a `Side` from its index
    ///
    /// # Panics
    ///
    /// A panic occurs if the index is not in {0, 1, 2, 3}.
    pub fn from_index(index: usize) -> Self {
        match index {
            0 => Side::Xmin,
            1 => Side::Xmax,
            2 => Side::Ymin,
            3 => Side::Ymax,
            _ => panic!("Side::from_index(): invalid index {}", index),
        }
    }
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

#[cfg(test)]
mod tests {
    use super::Side;

    #[test]
    fn test_side_from_index() {
        assert_eq!(Side::from_index(0), Side::Xmin);
        assert_eq!(Side::from_index(1), Side::Xmax);
        assert_eq!(Side::from_index(2), Side::Ymin);
        assert_eq!(Side::from_index(3), Side::Ymax);
    }

    #[test]
    #[should_panic(expected = "Side::from_index(): invalid index 123")]
    fn test_side_from_index_error() {
        Side::from_index(123);
    }

    #[test]
    fn test_side_debug() {
        assert_eq!(format!("{:?}", Side::Xmin), "Xmin");
        assert_eq!(format!("{:?}", Side::Xmax), "Xmax");
        assert_eq!(format!("{:?}", Side::Ymin), "Ymin");
        assert_eq!(format!("{:?}", Side::Ymax), "Ymax");
    }

    #[test]
    fn test_side_clone_copy() {
        let side = Side::Xmin;
        let copy = side;
        assert_eq!(side, copy);
    }
}