Struct Orientation 

pub struct Orientation { /* private fields */ }

A wafer cut and the beam angles. See the module docs for the conventions.

Implementations

impl Orientation

pub fn new( lattice: &Lattice, normal_hkl: [i32; 3], reference_uvw: [i32; 3], tilt_rad: f64, twist_rad: f64, wafer_rotation_rad: f64, ) -> Result<Self, CrystalError>

Orientation of a wafer of lattice cut on (hkl) (inward normal) with in-plane reference direction [uvw], and a beam at tilt_rad (in [0, π/2)), twist_rad and wafer_rotation_rad (finite).

pub fn new_miller_bravais( lattice: &Lattice, normal_hkil: [i32; 4], reference_uvtw: [i32; 4], tilt_rad: f64, twist_rad: f64, wafer_rotation_rad: f64, ) -> Result<Self, CrystalError>

As Self::new for a hexagonal lattice, with the surface plane (hkil) and the reference direction [uvtw] in four-index (Miller-Bravais) notation. They are converted to three-index form by super::lattice::plane_from_hkil and super::lattice::direction_from_uvtw (convention in the super::lattice module docs), and those are what Self::normal_hkl and Self::reference_uvw return. The zone law in three-index form is equivalent to h u + k v + i t + l w = 0.

Errors

CrystalError::NotHexagonal for a cubic lattice, CrystalError::InvalidMillerBravais for indices that break their constraint, and the errors of Self::new.

pub fn normal_hkl(&self) -> [i32; 3]

Miller indices of the surface plane (inward normal).

pub fn reference_uvw(&self) -> [i32; 3]

Indices of the in-plane reference direction.

pub fn tilt_rad(&self) -> f64

Tilt, radians.

pub fn twist_rad(&self) -> f64

Twist, radians.

pub fn wafer_rotation_rad(&self) -> f64

Wafer rotation, radians.

pub fn crystal_to_lab(&self) -> Mat3

Crystal-to-lab rotation M = R_x(ω) B.

pub fn lab_to_crystal(&self) -> Mat3

Lab-to-crystal rotation, the transpose of Self::crystal_to_lab.

pub fn to_crystal(&self, v_lab: [f64; 3]) -> [f64; 3]

Rotate a lab-frame vector into the crystal frame.

pub fn to_lab(&self, v_crystal: [f64; 3]) -> [f64; 3]

Rotate a crystal-frame vector into the lab frame.

pub fn beam_lab(&self) -> [f64; 3]

Unit beam direction in the lab frame, lab_direction of the tilt and twist.

pub fn beam_crystal(&self) -> [f64; 3]

Unit beam direction in the crystal frame.

Trait Implementations

impl Clone for Orientation

fn clone(&self) -> Orientation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Orientation

impl Debug for Orientation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Orientation

fn eq(&self, other: &Orientation) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Orientation