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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! Creation of atoms in a controlled manner and realease into the simulation

pub mod emit;
pub mod gaussian;
pub mod mass;
pub mod oven;
pub mod precalc;
pub mod surface;
pub mod species;

use specs::prelude::*;

use rand;
use rand::distributions::Distribution;
use rand::distributions::WeightedIndex;
use rand::Rng;
use std::marker::PhantomData;

use crate::simulation::Plugin;

use self::species::AtomCreator;

pub struct VelocityCap {
    /// The maximum speed of an atom emitted by an atom source. See [Velocity](struct.Velocity.html) for units.
    pub value: f64,
}

/// This plugin implements the creation of atoms of a given species from sources such as ovens or vacuum chambers.
/// 
/// See also [crate::atom_sources].
/// 
/// # Generic Arguments
/// 
/// * `T`: The atom species to create, which must implement the `AtomCreator` trait.
#[derive(Default)]
pub struct AtomSourcePlugin<T>(PhantomData<T>) where T : AtomCreator;
impl<T> Plugin for AtomSourcePlugin<T> where T : AtomCreator + 'static {
    fn build(&self, builder: &mut crate::simulation::SimulationBuilder) {
        add_systems_to_dispatch::<T>(&mut builder.dispatcher_builder, &[]);
        register_components::<T>(&mut builder.world);
    }
    fn deps(&self) -> Vec::<Box<dyn Plugin>> {
        Vec::new()
    }
}

/// Adds the systems required by `atom_sources` to the dispatcher.
///
/// #Arguments
///
/// `builder`: the dispatch builder to modify
///
/// `deps`: any dependencies that must be completed before the atom_sources systems run.
fn add_systems_to_dispatch<T>(
    builder: &mut DispatcherBuilder<'static, 'static>,
    deps: &[&str],
) where T : AtomCreator + 'static {
    builder.add(
        emit::EmitNumberPerFrameSystem,
        "emit_number_per_frame",
        deps,
    );
    builder.add(
        emit::EmitFixedRateSystem,
        "emit_fixed_rate",
        &["emit_number_per_frame"],
    );
    builder.add(
        precalc::PrecalculateForSpeciesSystem::<oven::Oven<T>> {
            marker: PhantomData,
        },
        "precalculated_oven",
        deps,
    );
    builder.add(
        precalc::PrecalculateForSpeciesSystem::<surface::SurfaceSource<T>> {
            marker: PhantomData,
        },
        "precalculated_surfaces",
        deps,
    );
    builder.add(
        gaussian::PrecalculateForGaussianSourceSystem::<T>::default(),
        "precalculate_gaussian",
        deps,
    );
    builder.add(
        oven::OvenCreateAtomsSystem::<T>::default(),
        "oven_create_atoms",
        &["emit_number_per_frame", "precalculated_oven"],
    );
    builder.add(
        surface::CreateAtomsOnSurfaceSystem::<T>::default(),
        "surface_create_atoms",
        &["emit_number_per_frame", "precalculated_surfaces"],
    );
    builder.add(
        gaussian::GaussianCreateAtomsSystem::<T>::default(),
        "gaussian_create_atoms",
        &["emit_number_per_frame", "precalculate_gaussian"],
    );
    builder.add(
        emit::EmitOnceSystem,
        "emit_once_system",
        &[
            "oven_create_atoms",
            "surface_create_atoms",
            "gaussian_create_atoms",
        ],
    );
}

/// Registers resources required by `atom_sources` to the ecs world.
fn register_components<T>(world: &mut World) where T : AtomCreator + 'static {
    world.register::<oven::Oven<T>>();
    world.register::<mass::MassDistribution>();
    world.register::<emit::EmitFixedRate>();
    world.register::<emit::EmitNumberPerFrame>();
    world.register::<emit::EmitOnce>();
    world.register::<emit::AtomNumberToEmit>();
    world.register::<surface::SurfaceSource<T>>();
    world.register::<gaussian::GaussianVelocityDistributionSource<T>>();
    world.register::<gaussian::GaussianVelocityDistributionSourceDefinition<T>>();
}

/// A simple probability distribution which uses weighted indices to retrieve values.
pub struct WeightedProbabilityDistribution {
    values: Vec<f64>,
    weighted_index: WeightedIndex<f64>,
}
impl WeightedProbabilityDistribution {
    pub fn new(values: Vec<f64>, weights: Vec<f64>) -> Self {
        WeightedProbabilityDistribution {
            values,
            weighted_index: WeightedIndex::new(&weights).unwrap(),
        }
    }
}
impl Distribution<f64> for WeightedProbabilityDistribution {
    fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64 {
        let index = self.weighted_index.sample(rng);
        self.values[index]
    }
}