Skip to main content

PyMdBinding

Struct PyMdBinding 

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

PyO3-style binding handle for an MD simulation.

Wraps PyMdSimulation and exposes flat-array query helpers that mirror the #[pymethods] surface that would be used with the real PyO3 macro expansion. All methods take and return primitive Rust types so that future #[pyfunction] / #[pymethods] annotations require no changes.

Implementations§

Source§

impl PyMdBinding

Source

pub fn new_default() -> Self

Create a new MD binding with the default (argon-reduced) configuration.

Source

pub fn new(config: PyMdConfig) -> Self

Create from explicit configuration.

Source

pub fn add_atom( &mut self, x: f64, y: f64, z: f64, vx: f64, vy: f64, vz: f64, atom_type: u32, ) -> usize

Add an atom at [x, y, z] with optional velocity [vx, vy, vz].

Returns the index of the newly added atom.

Source

pub fn atom_count(&self) -> usize

Return the number of atoms.

Source

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

Advance the simulation by dt (reduced units or SI, consistent with config).

Source

pub fn run_steps(&mut self, n_steps: u32, dt: f64)

Advance the simulation by n_steps steps, each of size dt.

Source

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

Return positions as a flat [x0,y0,z0, x1,y1,z1, …] array.

Source

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

Return velocities as a flat array.

Source

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

Return [kinetic, potential, total] energy.

Source

pub fn get_temperature(&self) -> f64

Instantaneous temperature in reduced units (from equipartition theorem).

Source

pub fn elapsed_time(&self) -> f64

Total simulation time elapsed.

Source

pub fn step_count(&self) -> u64

Number of completed time steps.

Source

pub fn set_thermostat_enabled(&mut self, enabled: bool)

Enable or disable the velocity-rescaling thermostat at runtime.

Source

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

Set the target temperature (reduced units).

Trait Implementations§

Source§

impl Clone for PyMdBinding

Source§

fn clone(&self) -> PyMdBinding

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 PyMdBinding

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.