Skip to main content

SimpleDcdWriter

Struct SimpleDcdWriter 

Source
pub struct SimpleDcdWriter {
    pub header: DcdHeader,
    pub frames: Vec<DcdFrame>,
}
Expand description

In-memory DCD writer.

Fields§

§header: DcdHeader

File header.

§frames: Vec<DcdFrame>

Accumulated frames.

Implementations§

Source§

impl SimpleDcdWriter

Source

pub fn new(n_atoms: u32, timestep: f32) -> Self

Create a new writer. n_atoms is fixed for the entire trajectory.

Source

pub fn with_title(n_atoms: u32, timestep: f32, title: &str) -> Self

Create a writer with a custom title.

Source

pub fn add_frame(&mut self, positions: &[[f32; 3]])

Append a frame from interleaved [x, y, z] positions.

Source

pub fn add_frame_xyz(&mut self, x: Vec<f32>, y: Vec<f32>, z: Vec<f32>)

Append a frame from separate x, y, z arrays.

Source

pub fn frame_count(&self) -> usize

Number of frames.

Source

pub fn to_bytes(&self) -> Vec<u8>

Serialise to a simplified DCD byte stream.

Each Fortran record is wrapped with a 4-byte integer giving the byte length of the payload (written before and after the block).

Layout:

HEADER BLOCK:
  [4] block_len
  [4] "CORD" signature
  [4] n_frames  (u32 LE)
  [4] n_atoms   (u32 LE)
  [4] timestep  (f32 LE)
  [80] title (padded with spaces)
  [4] block_len  (repeated)

per frame:
  X block: [4] len_x | x[0..n] as f32 LE | [4] len_x
  Y block: [4] len_y | y[0..n] as f32 LE | [4] len_y
  Z block: [4] len_z | z[0..n] as f32 LE | [4] len_z

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> 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, 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.