Skip to main content

AtomSet

Struct AtomSet 

Source
pub struct AtomSet {
    pub atom_types: Vec<AtomTypeDesc>,
    pub positions: Vec<[f64; 3]>,
    pub velocities: Vec<[f64; 3]>,
    pub forces: Vec<[f64; 3]>,
    pub type_indices: Vec<usize>,
    pub box_size: f64,
}
Expand description

A typed atom set that groups atoms by species.

Supports heterogeneous systems with multiple atom types, per-atom charges, and retrieval of all positions / velocities by type.

Fields§

§atom_types: Vec<AtomTypeDesc>

Registered atom type descriptors.

§positions: Vec<[f64; 3]>

Per-atom position [x, y, z].

§velocities: Vec<[f64; 3]>

Per-atom velocity [vx, vy, vz].

§forces: Vec<[f64; 3]>

Per-atom force (accumulated each step) [fx, fy, fz].

§type_indices: Vec<usize>

Per-atom type index (into atom_types).

§box_size: f64

Simulation box size (cubic).

Implementations§

Source§

impl AtomSet

Source

pub fn new(box_size: f64) -> Self

Create an empty AtomSet with the given box size.

Source

pub fn register_type(&mut self, desc: AtomTypeDesc) -> usize

Register an atom type and return its index.

Source

pub fn add_atom(&mut self, position: [f64; 3], type_idx: usize) -> usize

Add an atom at position with the given type index. Returns atom index.

Source

pub fn len(&self) -> usize

Number of atoms.

Source

pub fn is_empty(&self) -> bool

Whether the atom set is empty.

Source

pub fn mass(&self, i: usize) -> f64

Mass of atom i.

Source

pub fn charge(&self, i: usize) -> f64

Charge of atom i.

Source

pub fn positions_of_type(&self, type_idx: usize) -> Vec<[f64; 3]>

Return all positions of atoms with type index type_idx.

Source

pub fn net_charge(&self) -> f64

Net charge of the system (sum of all partial charges).

Source

pub fn kinetic_energy(&self) -> f64

Total kinetic energy.

Source

pub fn temperature(&self) -> f64

Temperature from equipartition (reduced units k_B = 1).

Trait Implementations§

Source§

impl Clone for AtomSet

Source§

fn clone(&self) -> AtomSet

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 AtomSet

Source§

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

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

impl<'de> Deserialize<'de> for AtomSet

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 AtomSet

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> 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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,