Skip to main content

RectangularGeometry

Struct RectangularGeometry 

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

A rectangular lattice with explicit row-major site order and boundaries.

Implementations§

Source§

impl RectangularGeometry

Source

pub fn new( lx: usize, ly: usize, boundary_x: Boundary, boundary_y: Boundary, ) -> Result<RectangularGeometry, GeometryError>

Construct an orthogonal rectangular geometry.

Source

pub fn with_kind( lx: usize, ly: usize, boundary_x: Boundary, boundary_y: Boundary, kind: LatticeKind, ) -> Result<RectangularGeometry, GeometryError>

Construct a rectangular coordinate grid with an explicit embedding.

Source

pub const fn site_count(&self) -> SiteCount

Number of sites.

Source

pub const fn lx(&self) -> usize

Return the horizontal extent.

Source

pub const fn ly(&self) -> usize

Return the vertical extent.

Source

pub const fn boundary_x(&self) -> Boundary

Return the horizontal boundary condition.

Source

pub const fn boundary_y(&self) -> Boundary

Return the vertical boundary condition.

Source

pub const fn kind(&self) -> LatticeKind

Return the selected embedding.

Source

pub fn site_id(&self, x: usize, y: usize) -> Result<SiteId, GeometryError>

Map row-major (x, y) coordinates to a site identifier.

Source

pub fn coordinate(&self, site: SiteId) -> Result<Coordinate, GeometryError>

Map a canonical site identifier to its row-major coordinate.

Source

pub fn minimum_image_displacement( &self, a: SiteId, b: SiteId, ) -> Result<Coordinate, GeometryError>

Return the canonical minimum-image Cartesian displacement r_b - r_a.

Source

pub fn pairs_at_squared_distance( &self, target_squared: f64, tolerance: ShellTolerance, ) -> Result<Vec<Bond>, GeometryError>

Return unordered pairs whose minimum-image squared distance lies in a shell.

Source

pub fn bonds( &self, multiplicity: BondMultiplicity, ) -> Result<Vec<Bond>, GeometryError>

Generate canonical bonds under the requested multiplicity policy.

Trait Implementations§

Source§

impl Clone for RectangularGeometry

Source§

fn clone(&self) -> RectangularGeometry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RectangularGeometry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for RectangularGeometry

Source§

fn eq(&self, other: &RectangularGeometry) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RectangularGeometry

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V