Struct vegas_lattice::Site

pub struct Site { /* private fields */ }

Represetns a site in a lattice.

The kind field is the type of the site, for example Fe for iron or Cu for copper. The position field is a tuple of the x, y, and z coordinates of the site within the lattice.

Exalples

Here is an example of how to create a site and access its fields:

use vegas_lattice::Site;

let site = Site::new("Fe");

assert_eq!(site.kind(), "Fe");
assert_eq!(site.position(), (0.0, 0.0, 0.0));

Implementations

impl Site

pub fn new(kind: &str) -> Self

Create a new site with a given kind located at the origin

pub fn position(&self) -> (f64, f64, f64)

Return the position of the site

pub fn kind(&self) -> String

Return the kind of the site

pub fn move_along(self, axis: Axis, distance: f64) -> Self

Move the site along a given axis by a given distance

pub fn with_kind(self, kind: String) -> Self

Changes the kind of the site

pub fn with_position(self, position: (f64, f64, f64)) -> Self

Changes the position of the site

pub fn with_tags(self, tags: Vec<&str>) -> Self

Adds tags to the site

Trait Implementations

impl Clone for Site

fn clone(&self) -> Site

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Site

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Site

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for Site

type Err = Error

The associated error which can be returned from parsing.

fn from_str(source: &str) -> Result<Site, Self::Err>

Parses a string s to return a value of this type.

impl Serialize for Site

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Tagged for Site

fn tags(&self) -> Option<&Vec<String>>

Returns the tags of the object

fn has_tag(&self, tag: String) -> bool

Returns true if the object has the given tag