Struct PhysicalBox

pub struct PhysicalBox { /* private fields */ }

A bounding box describes geometry in which an Octree lives.

Implementations

impl PhysicalBox

pub fn new(coords: [f64; 6]) -> Self

Create a new bounding box.

The coordinates are given by [xmin, ymin, zmin, xmax, ymax, zmax].

pub fn from_points(points: &[Point]) -> PhysicalBox

Give a slice of points. Compute an associated bounding box.

The created bounding box is slightly bigger than the actual point set. This is to make sure that no point lies exactly on the boundary of the box.

Examples found in repository

examples/mpi_global_bounding_box.rs (line 37)

pub fn main() {
    // Initialise MPI
    let universe = mpi::initialize().unwrap();

    // Get the world communicator
    let comm = universe.world();

    // Initialise a seeded Rng.
    let mut rng = ChaCha8Rng::seed_from_u64(2);

    // Create `npoints` per rank.
    let npoints = 10;

    // Generate random points.

    let points = generate_random_points(npoints, &mut rng, &comm);

    // Compute the distributed bounding box.

    let bounding_box = compute_global_bounding_box(&points, &comm);

    // Copy all points to root and compare local bounding box there.

    if let Some(points_root) = gather_to_root(&points, &comm) {
        // Compute the bounding box on root.

        let expected = PhysicalBox::from_points(&points_root);
        assert_eq!(expected.coordinates(), bounding_box.coordinates());
    }
}

pub fn coordinates(&self) -> [f64; 6]

Return coordinates

Examples found in repository

examples/mpi_global_bounding_box.rs (line 38)

pub fn main() {
    // Initialise MPI
    let universe = mpi::initialize().unwrap();

    // Get the world communicator
    let comm = universe.world();

    // Initialise a seeded Rng.
    let mut rng = ChaCha8Rng::seed_from_u64(2);

    // Create `npoints` per rank.
    let npoints = 10;

    // Generate random points.

    let points = generate_random_points(npoints, &mut rng, &comm);

    // Compute the distributed bounding box.

    let bounding_box = compute_global_bounding_box(&points, &comm);

    // Copy all points to root and compare local bounding box there.

    if let Some(points_root) = gather_to_root(&points, &comm) {
        // Compute the bounding box on root.

        let expected = PhysicalBox::from_points(&points_root);
        assert_eq!(expected.coordinates(), bounding_box.coordinates());
    }
}

pub fn reference_to_physical(&self, point: [f64; 3]) -> [f64; 3]

Map a point from the reference box [0, 1]^3 to the bounding box.

pub fn physical_to_reference(&self, point: [f64; 3]) -> [f64; 3]

Map a point from the physical domain to the reference box.

pub fn corners(&self) -> [[f64; 3]; 8]

Return an ordered list of corners of the box.

The ordering of the corners on the unit cube is [0, 0, 0] [1, 0, 0] [1, 1, 0] [0, 1, 0] [0, 0, 1] [1, 0, 1] [1, 1, 1] [0, 1, 1]

Trait Implementations

impl Display for PhysicalBox

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

Formats the value using the given formatter.