Struct HypercuboidCheckerboard 

pub struct HypercuboidCheckerboard<const N: usize> { /* private fields */ }

2^N color checkerboard with axis-aligned hypercuboidal cells.

A HypercuboidCheckerboard is comprised of n x m x … axis aligned spaces. Each space has the same shape, but each axis might have a different edge length. Each axis may be periodic or not.

Along the non-periodic axes, the checkerboard overhangs the boundary so that the entire domain is always covered (for any origin shift up to 1 cell length). Along periodic axes, the checkerboard has exactly the same width as the domain. HypercuboidCheckerboard wraps points “outside” the checkerboard into the correct periodic space.

Obviously, HypercuboidCheckerboard is a suitable checkerboard for Hypercuboid boundary geometries. It can also be a good choice for other boundaries. For example: cylindrical boundaries (periodic in one direction) and closed boundaries of any shape. There may be many overhanging spaces (some completely outside the boundary) in these cases. However, the checkerboard is still valid and rayon’s dynamic load balancing scheme should be able to handle the empty cells efficiently.

Implementations

impl<const N: usize> HypercuboidCheckerboard<N>

pub fn new<R: Rng + ?Sized>( rng: &mut R, interaction_range: PositiveReal, edge_lengths: [PositiveReal; N], periodic: [bool; N], ) -> Self

Construct a new HypercuboidCheckerboard.

Set interaction_range to the largest distance between any two interacting bodies. new will construct a checkerboard that covers the range [-edge_lengths[i]/2.0, edge_lengths[i]/2.0) (respecting periodic[i]) for each dimension i.

pub fn update<R: Rng + ?Sized>( &mut self, rng: &mut R, interaction_range: PositiveReal, edge_lengths: [PositiveReal; N], periodic: [bool; N], )

Update an existing checkerboard.

update performs the same steps as new, but modifies self in place. Prefer update when possible, as it can reuse the space index partitioning when the shape doesn’t change.

Trait Implementations

impl<const N: usize> Checkerboard<Cartesian<N>> for HypercuboidCheckerboard<N>

fn point_to_space_index(&self, point: &Cartesian<N>) -> Option<usize>

Determine the space index of a given point.

fn space_indices_by_color(&self) -> &[Vec<usize>]

The indices of all spaces, grouped by color.

fn num_spaces(&self) -> usize

The total number of spaces in the checkerboard.

impl<const N: usize> Clone for HypercuboidCheckerboard<N>

fn clone(&self) -> HypercuboidCheckerboard<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for HypercuboidCheckerboard<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for HypercuboidCheckerboard<N>

fn default() -> Self

Construct a default HypercuboidCheckerboard.

The default is a 2x2x… non-periodic checkerboard with 1.0 x 1.0 x … spaces.

impl<'de, const N: usize> Deserialize<'de> for HypercuboidCheckerboard<N>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize> PartialEq for HypercuboidCheckerboard<N>

fn eq(&self, other: &HypercuboidCheckerboard<N>) -> 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<const N: usize> Serialize for HypercuboidCheckerboard<N>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize> StructuralPartialEq for HypercuboidCheckerboard<N>