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

//! Different implementations for created atom species.

use specs::prelude::*;

/// Allows atoms to be modified after they are created.
pub trait AtomCreationModifier {
    /// Modifies the created atom
    fn mutate(updater: &LazyUpdate, new_atom: Entity);
}
pub trait AtomCreator : AtomCreationModifier + Copy + Send + Sync + Default {}
impl<T> AtomCreator for T where T : AtomCreationModifier + Copy + Send + Sync + Default {}

pub trait Species : AtomCreator {}
impl<T> Species for T where T : AtomCreator {}

/// Generates a species struct that can be used in an atom source.
/// 
/// # Arguments:
/// * `species_name`: name of the generated struct.
/// * `transition`: laser cooling transition to use.
/// * `mass`: mass of this species in atomic mass units.
#[macro_export]
macro_rules! species {
    // This macro takes an argument of designator `ident` and
    // creates a function named `$func_name`.
    // The `ident` designator is used for variable/function names.
    ($species_name:ident, $transition: ident, $mass: literal) => {
        /// A species that can be used in an atom source.
        #[derive(Copy, Clone, Default)]
        pub struct $species_name;
        impl $crate::atom_sources::species::AtomCreationModifier for $species_name {
            fn mutate(updater: &specs::LazyUpdate, new_atom: specs::Entity) {
                updater.insert(new_atom, $transition::default());
            }
        }
    };
}