IBTK::PartitioningBoxes Class Reference

Class PartitioningBoxes stores a set of bounding boxes and can check if a point is in the set of partitioning boxes or not in a more optimized way than just looping over a std::vector<PartitioningBox>. More...

#include </home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/PartitioningBox.h>

Public Member Functions
	PartitioningBoxes ()=default
template<typename ForwardIterator >
	PartitioningBoxes (const ForwardIterator begin, const ForwardIterator end)
	Constructor. Creates an object from a sequence of partitioning boxes.
	PartitioningBoxes (const SAMRAI::hier::PatchHierarchy< NDIM > &hierarchy)
const Point &	bottom () const
const Point &	top () const
bool	contains (const Point &point) const
const PartitioningBox *	begin () const
	Return a pointer to the first partitioning box.
const PartitioningBox *	end () const

Protected Attributes
PartitioningBox	d_bounding_partitioning_box
	The partitioning box that bounds all other partitioning boxes.
std::vector< PartitioningBox >	d_boxes
	The set of bounding boxes.

Detailed Description

Class PartitioningBoxes stores a set of bounding boxes and can check if a point is in the set of partitioning boxes or not in a more optimized way than just looping over a std::vector<PartitioningBox>.

It is possible for the set of bounding boxes to be empty: in that case the bounds are [oo, oo) in each dimension.

Constructor & Destructor Documentation

PartitioningBoxes() [1/2]

IBTK::PartitioningBoxes::PartitioningBoxes ( )

default

Default constructor: an empty collection of partitioning boxes with bounds at oo.

PartitioningBoxes() [2/2]

IBTK::PartitioningBoxes::PartitioningBoxes

(

const SAMRAI::hier::PatchHierarchy< NDIM > &

hierarchy

)

Constructor. Uses the finest level boxes on the provided PatchHierarchy to create a set of bounding boxes.

Member Function Documentation

bottom()

const Point & IBTK::PartitioningBoxes::bottom ( ) const

inline

Get the bottom left corner of the partitioning box bounding all other partitioning boxes.

contains()

bool IBTK::PartitioningBoxes::contains ( const Point &  point ) const

inline

Return true if the point is inside the set of boxes and false otherwise.

end()

const PartitioningBox * IBTK::PartitioningBoxes::end ( ) const

inline

Return a pointer to one past the end of the end of the partitioning box array.

top()

const Point & IBTK::PartitioningBoxes::top ( ) const

inline

Get the top right corner of the partitioning box bounding all other partitioning boxes. Note that this point is not in the collection of boxes.

---

The documentation for this class was generated from the following files:

• /home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/PartitioningBox.h
• /home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/private/PartitioningBox-inl.h
• /home/runner/work/IBAMR/IBAMR/ibtk/src/utilities/PartitioningBox.cpp