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

//! Reference Frame orthogonal to the beam

extern crate nalgebra;
extern crate rayon;
extern crate specs;
use nalgebra::Vector3;
use specs::Component;
use specs::VecStorage;

/// A component that stores the orthonormal basis vectors of a reference frame orthogonal to the beam.
#[derive(Clone, Copy)]
pub struct Frame {
    pub x_vector: Vector3<f64>,
    pub y_vector: Vector3<f64>,
}
impl Component for Frame {
    type Storage = VecStorage<Self>;
}

impl Frame {
    pub fn from_direction(beam_direction: Vector3<f64>, x_vector: Vector3<f64>) -> Self {
        let scalar_product: f64 = Vector3::dot(&beam_direction, &x_vector);
        if scalar_product != 0.0 {
            panic!("You entered non-orthogonal vectors!");
        }
        if beam_direction.norm() * x_vector.norm() == 0.0 {
            panic!("At least one of the entered vectors is zero!");
        }
        let orth_vector: Vector3<f64> = Vector3::cross(&beam_direction, &x_vector).normalize();
        let x_vector = x_vector.normalize();
        Frame {
            x_vector,
            y_vector: orth_vector,
        }
    }
}