Skip to main content

UnitCell

Struct UnitCell 

Source
pub struct UnitCell {
    pub lattice: [[f64; 3]; 3],
}
Expand description

A 3D periodic unit cell defined by lattice vectors.

Fields§

§lattice: [[f64; 3]; 3]

Lattice vectors as rows: [[ax,ay,az], [bx,by,bz], [cx,cy,cz]].

Implementations§

Source§

impl UnitCell

Source

pub fn new(lattice: [[f64; 3]; 3]) -> Self

Create a unit cell from three lattice vectors (row vectors).

Source

pub fn cubic(a: f64) -> Self

Create a cubic unit cell with edge length a.

Source

pub fn from_parameters(params: &CellParameters) -> Self

Create a cell from crystallographic parameters (a, b, c, α, β, γ in degrees).

Source

pub fn parameters(&self) -> CellParameters

Extract crystallographic parameters from lattice vectors.

Source

pub fn volume(&self) -> f64

Unit cell volume: |a · (b × c)|.

Source

pub fn frac_to_cart(&self, frac: [f64; 3]) -> [f64; 3]

Convert fractional coordinates to Cartesian (Å). r_cart = f0 * a + f1 * b + f2 * c

Source

pub fn cart_to_frac(&self, cart: [f64; 3]) -> [f64; 3]

Convert Cartesian coordinates (Å) to fractional. frac_to_cart computes: r = f[0]*a + f[1]*b + f[2]*c = M^T · f So: f = (M^T)^{-1} · r = (M^{-1})^T · r

Source

pub fn wrap_frac(frac: [f64; 3]) -> [f64; 3]

Wrap fractional coordinates into [0, 1) — periodic boundary conditions.

Source

pub fn wrap_cart(&self, cart: [f64; 3]) -> [f64; 3]

Wrap Cartesian coordinates into the unit cell.

Source

pub fn minimum_image_distance(&self, a: [f64; 3], b: [f64; 3]) -> f64

Minimum-image distance between two Cartesian points under PBC.

Source

pub fn supercell( &self, na: usize, nb: usize, nc: usize, ) -> (UnitCell, Vec<[f64; 3]>)

Build a supercell by replicating (na × nb × nc) times. Returns new lattice and list of fractional offsets for each image.

Trait Implementations§

Source§

impl Clone for UnitCell

Source§

fn clone(&self) -> UnitCell

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UnitCell

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for UnitCell

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for UnitCell

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,