#include <deal.II/base/bounding_box.h>

Detailed Description

template<typename Number>
class BoundingBox< 0, Number >

Specialization of BoundingBox for spacedim 0. This class exists to enable dimension-independent programming but unconditionally throws an exception in its constructor.

Definition at line 399 of file bounding_box.h.

Inheritance diagram for BoundingBox< 0, Number >:

[legend]

Public Member Functions
	BoundingBox ()
	BoundingBox (const std::pair< Point< 0, Number >, Point< 0, Number > > &)
template<class Container>
	BoundingBox (const Container &)
BoundingBox< spacedim, Number > &	operator= (const BoundingBox< spacedim, Number > &t)=default
std::pair< Point< spacedim, Number >, Point< spacedim, Number > > &	get_boundary_points ()
bool	operator== (const BoundingBox< spacedim, Number > &box) const
bool	operator!= (const BoundingBox< spacedim, Number > &box) const
bool	has_overlap_with (const BoundingBox< spacedim, Number > &other_bbox, const double tolerance=std::numeric_limits< Number >::epsilon()) const
NeighborType	get_neighbor_type (const BoundingBox< spacedim, Number > &other_bbox, const double tolerance=std::numeric_limits< Number >::epsilon()) const
void	merge_with (const BoundingBox< spacedim, Number > &other_bbox)
bool	point_inside (const Point< spacedim, Number > &p, const double tolerance=std::numeric_limits< Number >::epsilon()) const
void	extend (const Number amount)
BoundingBox< spacedim, Number >	create_extended (const Number amount) const
BoundingBox< spacedim, Number >	create_extended_relative (const Number relative_amount) const
double	volume () const
Point< spacedim, Number >	center () const
Number	side_length (const unsigned int direction) const
Number	lower_bound (const unsigned int direction) const
Number	upper_bound (const unsigned int direction) const
BoundingBox< 1, Number >	bounds (const unsigned int direction) const
Point< spacedim, Number >	vertex (const unsigned int index) const
BoundingBox< spacedim, Number >	child (const unsigned int index) const
BoundingBox< spacedim - 1, Number >	cross_section (const unsigned int direction) const
Point< spacedim, Number >	real_to_unit (const Point< spacedim, Number > &point) const
Point< spacedim, Number >	unit_to_real (const Point< spacedim, Number > &point) const
Number	signed_distance (const Point< spacedim, Number > &point, const unsigned int direction) const
void	serialize (Archive &ar, const unsigned int version)

Static Public Attributes
static constexpr unsigned int	dimension

Private Attributes
std::pair< Point< spacedim, Number >, Point< spacedim, Number > >	boundary_points

Related Symbols
(Note that these are not member symbols.)
BoundingBox< dim, Number >	create_unit_bounding_box ()
int	coordinate_to_one_dim_higher (const int locked_coordinate, const int coordinate_in_dim)

Constructor & Destructor Documentation

◆ BoundingBox() [1/3]

template<typename Number>

BoundingBox< 0, Number >::BoundingBox ( )

Default constructor. Throws an exception.

◆ BoundingBox() [2/3]

template<typename Number>

BoundingBox< 0, Number >::BoundingBox ( const std::pair< Point< 0, Number >, Point< 0, Number > > & )

Equivalent two-point constructor. Throws an exception.

◆ BoundingBox() [3/3]

template<typename Number>

template<class Container>

BoundingBox< 0, Number >::BoundingBox ( const Container & )

Equivalent container constructor. Throws an exception.

Member Function Documentation

◆ operator=()

BoundingBox< spacedim, Number > & BoundingBox< spacedim, Number >::operator= ( const BoundingBox< spacedim, Number > & t )

default

Standard copy assignment operator.

◆ get_boundary_points()

std::pair< Point< spacedim, Number >, Point< spacedim, Number > > & BoundingBox< spacedim, Number >::get_boundary_points ( )

Return a reference to the boundary_points

◆ operator==()

bool BoundingBox< spacedim, Number >::operator== ( const BoundingBox< spacedim, Number > & box ) const

Test for equality.

◆ operator!=()

bool BoundingBox< spacedim, Number >::operator!= ( const BoundingBox< spacedim, Number > & box ) const

Test for inequality.

◆ has_overlap_with()

bool BoundingBox< spacedim, Number >::has_overlap_with	(	const BoundingBox< spacedim, Number > &	other_bbox,
		const double	tolerance = std::numeric_limits<Number>::epsilon() ) const

Check if the current object and other_bbox are neighbors, i.e. if the boxes have dimension spacedim, check if their intersection is non empty.

Definition at line 213 of file bounding_box.cc.

◆ get_neighbor_type()

NeighborType BoundingBox< spacedim, Number >::get_neighbor_type	(	const BoundingBox< spacedim, Number > &	other_bbox,
		const double	tolerance = std::numeric_limits<Number>::epsilon() ) const

Check which NeighborType other_bbox is to the current object.

Definition at line 221 of file bounding_box.cc.

◆ merge_with()

void BoundingBox< spacedim, Number >::merge_with ( const BoundingBox< spacedim, Number > & other_bbox )

Enlarge the current object so that it contains other_bbox . If the current object already contains other_bbox then it is not changed by this function.

Definition at line 231 of file bounding_box.cc.

◆ point_inside()

bool BoundingBox< spacedim, Number >::point_inside	(	const Point< spacedim, Number > &	p,
		const double	tolerance = std::numeric_limits<Number>::epsilon() ) const

Return true if the point is inside the Bounding Box, false otherwise. The parameter tolerance is a factor by which the bounding box is enlarged relative to the dimensions of the bounding box in order to determine in a numerically robust way whether the point is inside.

Definition at line 240 of file bounding_box.cc.

◆ extend()

void BoundingBox< spacedim, Number >::extend ( const Number amount )

Increase (or decrease) the size of the bounding box by the given amount. After calling this method, the lower left corner of the bounding box will have each coordinate decreased by amount, and the upper right corner of the bounding box will have each coordinate increased by amount.

If you call this method with a negative number, and one of the axes of the original bounding box is smaller than amount/2, the method will trigger an assertion.

◆ create_extended()

BoundingBox< spacedim, Number > BoundingBox< spacedim, Number >::create_extended ( const Number amount ) const

The same as above with the difference that a new BoundingBox instance is created without changing the current object.

◆ create_extended_relative()

BoundingBox< spacedim, Number > BoundingBox< spacedim, Number >::create_extended_relative ( const Number relative_amount ) const

Increase (or decrease) each side of the bounding box by the given relative_amount.

After calling this method, the lower left corner of the bounding box will have each coordinate decreased by relative_amount * side_length(direction), and the upper right corner of the bounding box will have each coordinate increased by relative_amount * side_length(direction).

If you call this method with a negative number, and one of the axes of the original bounding box is smaller than relative_amount * side_length(direction) / 2, the method will trigger an assertion.

◆ volume()

double BoundingBox< spacedim, Number >::volume ( ) const

Compute the volume (i.e. the dim-dimensional measure) of the BoundingBox.

Definition at line 284 of file bounding_box.cc.

◆ center()

Point< spacedim, Number > BoundingBox< spacedim, Number >::center ( ) const

Returns the point in the center of the box.

Definition at line 290 of file bounding_box.cc.

◆ side_length()

Number BoundingBox< spacedim, Number >::side_length ( const unsigned int direction ) const

Returns the side length of the box in direction.

Definition at line 296 of file bounding_box.cc.

◆ lower_bound()

Number BoundingBox< spacedim, Number >::lower_bound ( const unsigned int direction ) const

Return the lower bound of the box in direction.

Definition at line 302 of file bounding_box.cc.

◆ upper_bound()

Number BoundingBox< spacedim, Number >::upper_bound ( const unsigned int direction ) const

Return the upper bound of the box in direction.

Definition at line 308 of file bounding_box.cc.

◆ bounds()

BoundingBox< 1, Number > BoundingBox< spacedim, Number >::bounds ( const unsigned int direction ) const

Return the bounds of the box in direction, as a one-dimensional box.

Definition at line 314 of file bounding_box.cc.

◆ vertex()

Point< spacedim, Number > BoundingBox< spacedim, Number >::vertex ( const unsigned int index ) const

Returns the indexth vertex of the box. Vertex is meant in the same way as for a cell, so that index \(\in [0, 2^{\text{dim}} - 1]\).

Definition at line 321 of file bounding_box.cc.

◆ child()

BoundingBox< spacedim, Number > BoundingBox< spacedim, Number >::child ( const unsigned int index ) const

Returns the indexth child of the box. Child is meant in the same way as for a cell.

Definition at line 328 of file bounding_box.cc.

◆ cross_section()

BoundingBox< spacedim - 1, Number > BoundingBox< spacedim, Number >::cross_section ( const unsigned int direction ) const

Returns the cross section of the box orthogonal to direction. This is a box in one dimension lower.

Note: Calling this method in 1d will result in an exception since BoundingBox<0> is not implemented.

Definition at line 338 of file bounding_box.cc.

◆ real_to_unit()

Point< spacedim, Number > BoundingBox< spacedim, Number >::real_to_unit ( const Point< spacedim, Number > & point ) const

Apply the affine transformation that transforms this BoundingBox to a unit BoundingBox object.

If \(B\) is this bounding box, and \(\hat{B}\) is the unit bounding box, compute the affine mapping that satisfies \(G(B) = \hat{B}\) and apply it to point.

Definition at line 349 of file bounding_box.cc.

◆ unit_to_real()

Point< spacedim, Number > BoundingBox< spacedim, Number >::unit_to_real ( const Point< spacedim, Number > & point ) const

Apply the affine transformation that transforms the unit BoundingBox object to this object.

If \(B\) is this bounding box, and \(\hat{B}\) is the unit bounding box, compute the affine mapping that satisfies \(F(\hat{B}) = B\) and apply it to point.

Definition at line 360 of file bounding_box.cc.

◆ signed_distance()

Number BoundingBox< spacedim, Number >::signed_distance	(	const Point< spacedim, Number > &	point,
		const unsigned int	direction ) const

Returns the signed distance from a point orthogonal to the bounds of the box in direction. The signed distance is negative for points inside the interval described by the bounds of the rectangle in the respective direction, zero for points on the interval boundary and positive for points outside.

Definition at line 369 of file bounding_box.cc.

◆ serialize()

void BoundingBox< spacedim, Number >::serialize	(	Archive &	ar,
		const unsigned int	version )

Write or read the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

◆ create_unit_bounding_box()

BoundingBox< dim, Number > create_unit_bounding_box ( )

Returns the unit box \([0,1]^\text{dim}\).

Definition at line 427 of file bounding_box.cc.

◆ coordinate_to_one_dim_higher()

int coordinate_to_one_dim_higher	(	const int	locked_coordinate,
		const int	coordinate_in_dim )

This function defines a convention for how coordinates in dim dimensions should translate to the coordinates in dim + 1 dimensions, when one of the coordinates in dim + 1 dimensions is locked to a given value.

The convention is the following: Starting from the locked coordinate we store the lower dimensional coordinates consecutively and wrap around when going over the dimension. This relationship is, in 2d,

locked in 2D	1d coordinate	2d coordinate
x0	(a)	(x0, a)
x1	(a)	(a , x1)

and, in 3d,

locked in 3D	2d coordinates	3d coordinates
x0	(a, b)	(x0, a, b)
x1	(a, b)	( b, x1, a)
x2	(a, b)	( a, b, x2)

Given a locked coordinate, this function maps a coordinate index in dim dimension to a coordinate index in dim + 1 dimensions.

Parameters

locked_coordinate	should be in the range [0, dim+1).
coordinate_in_dim	should be in the range [0, dim).

Returns: A coordinate index in the range [0, dim+1)

Definition at line 466 of file bounding_box.h.

Member Data Documentation

◆ dimension

unsigned int BoundingBox< spacedim, Number >::dimension

staticconstexpr

Provide a way to get the dimension of an object without explicit knowledge of it's data type.

Definition at line 142 of file bounding_box.h.

◆ boundary_points

std::pair<Point<spacedim, Number>, Point<spacedim, Number> > BoundingBox< spacedim, Number >::boundary_points

private

Definition at line 390 of file bounding_box.h.

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

include/deal.II/base/bounding_box.h
source/base/bounding_box.cc

Detailed Description

Public Member Functions

Static Public Attributes

Private Attributes

Related Symbols

Constructor & Destructor Documentation

◆ BoundingBox() [1/3]

◆ BoundingBox() [2/3]

◆ BoundingBox() [3/3]

Member Function Documentation

◆ operator=()

◆ get_boundary_points()

◆ operator==()

◆ operator!=()

◆ has_overlap_with()

◆ get_neighbor_type()

◆ merge_with()

◆ point_inside()

◆ extend()

◆ create_extended()

◆ create_extended_relative()

◆ volume()

◆ center()

◆ side_length()

◆ lower_bound()

◆ upper_bound()

◆ bounds()

◆ vertex()

◆ child()

◆ cross_section()

◆ real_to_unit()

◆ unit_to_real()

◆ signed_distance()

◆ serialize()

Friends And Related Symbol Documentation

◆ create_unit_bounding_box()

◆ coordinate_to_one_dim_higher()

Member Data Documentation

◆ dimension

◆ boundary_points