atomecs 0.7.1

An data-oriented simulation package for cold atom experiments.
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
62
63
64
65
66
67
68
69
70
71
72

//! Handles indexes for laser beams.
//!

use specs::prelude::*;

/// An index that uniquely identifies a laser entity.
/// The index value corresponds to the position of each laser in per-atom sampler arrays.
///
/// Default `LaserIndex`s are created with `initiated: false`.
/// Once the index is set, initiated is set to true.
/// This is used to detect if all lasers in the simulation are correctly indexed, in case new lasers are added.
#[derive(Clone, Copy, Default)]
pub struct LaserIndex {
    pub index: usize,
    pub initiated: bool,
}
impl Component for LaserIndex {
    type Storage = HashMapStorage<Self>;
}
/// Assigns unique indices to laser entities.
pub struct IndexLasersSystem;
impl<'a> System<'a> for IndexLasersSystem {
    type SystemData = WriteStorage<'a, LaserIndex>;

    fn run(&mut self, mut indices: Self::SystemData) {
        let mut iter = 0;
        let mut need_to_assign_indices = false;
        for index in (&indices).join() {
            if !index.initiated {
                need_to_assign_indices = true;
            }
        }
        if need_to_assign_indices {
            for mut index in (&mut indices).join() {
                index.index = iter;
                index.initiated = true;
                iter += 1;
            }
        }
    }
}

#[cfg(test)]
pub mod tests {

    use super::*;

    #[test]
    fn test_index_lasers() {
        let mut test_world = World::new();
        test_world.register::<LaserIndex>();

        let test_entity_1 = test_world
            .create_entity()
            .with(LaserIndex::default())
            .build();
        let test_entity_2 = test_world
            .create_entity()
            .with(LaserIndex::default())
            .build();

        let mut system = IndexLasersSystem;
        system.run_now(&test_world);
        test_world.maintain();

        let storage = test_world.read_storage::<LaserIndex>();
        let index_1 = storage.get(test_entity_1).expect("entity not found");
        let index_2 = storage.get(test_entity_2).expect("entity not found");

        assert_ne!(index_1.index, index_2.index);
    }
}