beam_calc 0.1.1

A simple crate that calculates the stress on a beam.
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

//! # beam_calc
//! 
//! `beam_calc` is a simple crate that calculates the stress on a beam. The purpose of this crate
//! is to practice publishing on crates.io, so it's neither optimized nor tested.


/// Calculates the stress on a beam using the following expression:
/// 
/// Create a new Beam object that contains the maximum bending moment, 
/// the length of the beam from the point of reference, and the moment of inertia of 
/// the beam with respect to its cross section.
/// 
/// # Examples
/// ```
/// use beam_calc::Beam;
/// 
/// let beam_1 = Beam::new(12.0, 3.12, 44.3);
/// let stress = beam_1.stress_calc();
/// 
/// assert_eq!(0.8451467, stress);
/// ```
/// 

    #[derive(Debug)]
    pub struct Beam {
        pub bending_moment: f32,
        pub length: f32,
        pub moment_of_inertia: f32,
    }

    impl Beam {
        pub fn new(bending_moment: f32, length: f32, moment_of_inertia: f32) -> Beam {
            Beam {
                bending_moment,
                length,
                moment_of_inertia
            }
        }

        pub fn stress_calc(&self) -> f32 {
            (self.bending_moment*self.length)/(self.moment_of_inertia)
        }
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn good_output() {
        let beam_1 = Beam::new(11.0, 2.0, 44.0);
        assert_eq!(beam_1.stress_calc(), 0.5)
    }

    #[test]
    fn bad_output() {
        let beam_1 = Beam::new(11.0, 2.0, 44.0);
        assert_ne!(beam_1.stress_calc(), 2.0)
    }
}