Trait grafen::system::Component
[−]
[src]
pub trait Component<'a> { fn box_size(&self) -> Coord; fn iter_atoms(&'a self) -> AtomIterItem<'a>; fn num_atoms(&self) -> u64; fn with_pbc(self) -> Self; }
Methods for yielding atoms and output information from constructed objects.
Required Methods
fn box_size(&self) -> Coord
Return the size of the object's bounding box seen from origo.
That is, for a component of size (1, 1, 1) with origin (1, 1, 1) this returns (2, 2, 2).
fn iter_atoms(&'a self) -> AtomIterItem<'a>
Return an Iterator
over all atoms in the object as CurrentAtom
objects.
fn num_atoms(&self) -> u64
Return the number of atoms in the object.
fn with_pbc(self) -> Self
Return the component with its coordinates adjusted to lie within its box.
Implementors
impl<'a> Component<'a> for ComponentEntry
impl<'a> Component<'a> for grafen::surface::Cylinder
impl<'a> Component<'a> for Sheet
impl<'a> Component<'a> for Cuboid
impl<'a> Component<'a> for grafen::volume::Cylinder