Skip to main content

PyMdSimulation

Struct PyMdSimulation 

Source
pub struct PyMdSimulation { /* private fields */ }
Expand description

Molecular Dynamics simulation (NVE/NVT) with periodic boundary conditions.

Uses a velocity-Verlet integrator and a truncated-shifted Lennard-Jones pair potential. Supports an optional velocity-rescaling thermostat.

Implementations§

Source§

impl PyMdSimulation

Source

pub fn new(config: PyMdConfig) -> Self

Create a new empty MD simulation from the given configuration.

Source

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

Add an atom at position with the given type index.

Returns the index of the newly added atom.

Source

pub fn set_velocity(&mut self, i: usize, vel: [f64; 3])

Set the velocity of atom i. No-op if i is out of bounds.

Source

pub fn position(&self, i: usize) -> Option<[f64; 3]>

Get the position of atom i, or None if out of bounds.

Source

pub fn velocity(&self, i: usize) -> Option<[f64; 3]>

Get the velocity of atom i, or None if out of bounds.

Source

pub fn atom_count(&self) -> usize

Number of atoms in the simulation.

Source

pub fn time(&self) -> f64

Accumulated simulation time.

Source

pub fn step_count(&self) -> u64

Number of completed steps.

Source

pub fn set_thermostat(&mut self, active: bool)

Enable or disable the velocity-rescaling thermostat.

Source

pub fn thermostat_active(&self) -> bool

Whether the thermostat is active.

Source

pub fn set_target_temperature(&mut self, t: f64)

Set the target temperature for the thermostat.

Source

pub fn potential_energy(&self) -> f64

Total potential energy from the last step.

Source

pub fn kinetic_energy(&self) -> f64

Total kinetic energy summed over all atoms.

Source

pub fn total_energy(&self) -> f64

Total energy (kinetic + potential).

Source

pub fn temperature(&self) -> f64

Instantaneous temperature from equipartition: T = 2KE / (3N*k_B).

In reduced units k_B = 1, so T = 2KE / (3N).

Source

pub fn step(&mut self, dt: f64)

Advance the simulation by dt using velocity Verlet integration.

Steps:

  1. Half-kick velocities: v += 0.5 * f/m * dt
  2. Update positions: x += v * dt (with PBC wrap)
  3. Recompute forces from LJ pair potential
  4. Half-kick velocities again
  5. Optionally rescale velocities to match target temperature
Source

pub fn run(&mut self, dt: f64, steps: u64)

Advance the simulation by dt for steps steps.

Source

pub fn all_positions(&self) -> Vec<f64>

Return all atom positions as a flat Vecf64of[x,y,z]` triples.

Source

pub fn all_velocities(&self) -> Vec<f64>

Return all atom velocities as a flat Vec<f64> of [vx,vy,vz] triples.

Trait Implementations§

Source§

impl Clone for PyMdSimulation

Source§

fn clone(&self) -> PyMdSimulation

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 PyMdSimulation

Source§

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

Formats the value using the given formatter. 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.