IBTK::PartitioningBox Class Reference

Class PartitioningBox implements an NDIM-dimensional bounding box defined by two points. Unlike a standard bounding box, a PartitioningBox is an NDIM-dimensional tensor product of half-open intervals: i.e., it is a half-open box. This property allows one to partition a domain into a set of boxes. More...

#include <ibtk/PartitioningBox.h>

Public Member Functions
	PartitioningBox ()
	Default Constructor: an 'empty' partitioning box. More...
	PartitioningBox (const Point &bottom_point, const Point &top_point)
	Constructor. More...
	PartitioningBox (const SAMRAI::geom::CartesianPatchGeometry< NDIM > &patch)
	Constructor, starting from a SAMRAI data type. More...
const Point &	bottom () const
	Get the bottom left corner of the box. More...
const Point &	top () const
bool	contains (const Point &point) const
	Return true if the point is inside the box and false otherwise. More...
double	volume () const
	Return the volume of the box. If the box is empty then this is zero. More...

Protected Attributes
std::pair< Point, Point >	d_bounding_points
	bottom left and top right corners of the bounding box. More...

Detailed Description

It is possible for a partitioning box to be 'empty': in that case the bounds are [oo, oo) in each dimension.

Constructor & Destructor Documentation

PartitioningBox() [1/3]

IBTK::PartitioningBox::PartitioningBox

(

)

PartitioningBox() [2/3]

IBTK::PartitioningBox::PartitioningBox	(	const Point &	bottom_point,
		const Point &	top_point
	)

PartitioningBox() [3/3]

IBTK::PartitioningBox::PartitioningBox

(

const SAMRAI::geom::CartesianPatchGeometry< NDIM > &

patch

)

Member Function Documentation

bottom()

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

inline

top()

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

inline

Get the top right corner of the box. Note that this point is not in the box.

contains()

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

inline

volume()

double IBTK::PartitioningBox::volume

(

)

const

Member Data Documentation

d_bounding_points

std::pair<Point, Point> IBTK::PartitioningBox::d_bounding_points

protected

---

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

• ibtk/include/ibtk/PartitioningBox.h
• ibtk/include/ibtk/private/PartitioningBox-inl.h