Struct Closed 

pub struct Closed<T>(pub T);

Restrict points to the inside of a shape.

Closed is a newtype that wraps a shape. It prevents bodies and sites from existing outside the shape. Bodies and sites are never wrapped, and there are no ghost sites.

Tuple Fields

0: T

Trait Implementations

impl<B, X> AppendMicrostate<B, OrientedPoint<Cartesian<2>, Angle>, X, Closed<Hypercuboid<2>>> for HoomdGsdFile

fn append_microstate( &mut self, microstate: &Microstate<B, OrientedPoint<Cartesian<2>, Angle>, X, Closed<Hypercuboid<2>>>, ) -> Result<Frame<'_>, AppendError>

Append the contents of the microstate as a frame in a GSD file.

impl<B, X> AppendMicrostate<B, OrientedPoint<Cartesian<3>, Versor>, X, Closed<Hypercuboid<3>>> for HoomdGsdFile

fn append_microstate( &mut self, microstate: &Microstate<B, OrientedPoint<Cartesian<3>, Versor>, X, Closed<Hypercuboid<3>>>, ) -> Result<Frame<'_>, AppendError>

Append the contents of the microstate as a frame in a GSD file.

impl<B, X> AppendMicrostate<B, Point<Cartesian<2>>, X, Closed<Hypercuboid<2>>> for HoomdGsdFile

fn append_microstate( &mut self, microstate: &Microstate<B, Point<Cartesian<2>>, X, Closed<Hypercuboid<2>>>, ) -> Result<Frame<'_>, AppendError>

Append the contents of the microstate as a frame in a GSD file.

impl<B, X> AppendMicrostate<B, Point<Cartesian<3>>, X, Closed<Hypercuboid<3>>> for HoomdGsdFile

fn append_microstate( &mut self, microstate: &Microstate<B, Point<Cartesian<3>>, X, Closed<Hypercuboid<3>>>, ) -> Result<Frame<'_>, AppendError>

Append the contents of the microstate as a frame in a GSD file.

impl<T: Clone> Clone for Closed<T>

fn clone(&self) -> Closed<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Closed<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Closed<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, P> Distribution<P> for Closed<T>

where T: Distribution<P>,

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> P

Generate points uniformly distributed in the wrapped shape.

Example

use hoomd_geometry::{IsPointInside, shape::Sphere};
use hoomd_microstate::boundary::Closed;
use rand::{SeedableRng, distr::Distribution, rngs::StdRng};

let sphere = Closed(Sphere {
    radius: 5.0.try_into()?,
});
let mut rng = StdRng::seed_from_u64(1);

let point = sphere.sample(&mut rng);
assert!(sphere.0.is_point_inside(&point));

fn sample_iter<R>(self, rng: R) -> Iter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> Map<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Map sampled values to type S

impl<S, T> GenerateGhosts<S> for Closed<T>

where S: Default,

fn maximum_interaction_range(&self) -> f64

The largest interaction distance between sites.

fn generate_ghosts(&self, _site_properties: &S) -> ArrayVec<S, MAX_GHOSTS>

Place periodic images of sites within the interaction range.

impl<P, T> MapPoint<P> for Closed<T>

where T: MapPoint<P>,

fn map_point(&self, point: P, other: &Self) -> Result<P, Error>

Map a point in the wrapped shape to another.

Errors

hoomd_geometry::Error::PointOutsideShape when point is outside self.shape().

Example

use hoomd_geometry::{MapPoint, shape::Rectangle};
use hoomd_microstate::boundary::Closed;
use hoomd_vector::Cartesian;

let closed_a = Closed(Rectangle::with_equal_edges(10.0.try_into()?));
let closed_b = Closed(Rectangle::with_equal_edges(20.0.try_into()?));

let mapped_point =
    closed_a.map_point(Cartesian::from([-1.0, 1.0]), &closed_b);

assert_eq!(mapped_point, Ok(Cartesian::from([-2.0, 2.0])));
assert_eq!(
    closed_a.map_point(Cartesian::from([-100.0, 1.0]), &closed_b),
    Err(hoomd_geometry::Error::PointOutsideShape)
);

impl<T: PartialEq> PartialEq for Closed<T>

fn eq(&self, other: &Closed<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Scale for Closed<T>

where T: Scale,

fn scale_length(&self, v: PositiveReal) -> Self

Scale the wrapped shape.

Example

use hoomd_geometry::{Scale, shape::Sphere};
use hoomd_microstate::boundary::Closed;

let sphere = Closed(Sphere {
    radius: 5.0.try_into()?,
});

let scaled_sphere = sphere.scale_length(0.5.try_into()?);

assert_eq!(scaled_sphere.0.radius.get(), 2.5);

fn scale_volume(&self, v: PositiveReal) -> Self

Scale the wrapped shape.

Example

use hoomd_geometry::{Scale, shape::Rectangle};
use hoomd_microstate::boundary::Closed;

let closed = Closed(Rectangle::with_equal_edges(10.0.try_into()?));

let scaled_closed = closed.scale_volume(4.0.try_into()?);

assert_eq!(scaled_closed.0.edge_lengths[0].get(), 20.0);

impl<T> Serialize for Closed<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Volume for Closed<T>

where T: Volume,

fn volume(&self) -> f64

Volume of the wrapped shape.

Examples

use hoomd_geometry::{Volume, shape::Rectangle};
use hoomd_microstate::boundary::Closed;

let closed = Closed(Rectangle::with_equal_edges(10.0.try_into()?));

let volume = closed.volume();

assert_eq!(volume, 100.0);

impl<BS, T, P> Wrap<BS> for Closed<T>

where BS: Position<Position = P>, T: IsPointInside<P>,

fn wrap(&self, properties: BS) -> Result<BS, Error>

Transform body/point properties into the boundary.

impl<T> StructuralPartialEq for Closed<T>