OpenPFC  0.1.4
Phase Field Crystal simulation framework
Loading...
Searching...
No Matches
box3d.hpp File Reference

3D integer bounding box for grid index space More...

#include <array>
#include <ostream>
#include <stdexcept>
Include dependency graph for box3d.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  pfc::Box3D
 Represents a 3D integer box in grid index space. More...
 

Detailed Description

3D integer bounding box for grid index space

Defines the Box3D class which represents a discrete 3D rectangular region in grid index space. This is used to describe local computational domains in parallel simulations.

Box3D operates purely in index space and is independent of physical coordinates, spacing, or origin. It is typically paired with World for coordinate transformations.

// Create a box from (0,0,0) to (63,63,63)
pfc::Box3D box({0, 0, 0}, {64, 64, 64});
auto size = box.size(); // Returns {64, 64, 64}
3D integer bounding box for grid index space
Represents a 3D integer box in grid index space.
Definition box3d.hpp:74
Int3 size() const noexcept
Returns the size (number of elements) in each dimension.
See also
core/world.hpp for physical coordinate mapping
core/decomposition.hpp for domain decomposition using Box3D
Author
OpenPFC Development Team
Date
2025