Box< DIM > Class Template Reference

#include <BoxCollection.hpp>

Collaboration diagram for Box< DIM >:

[legend]

List of all members.

Public Member Functions
	Box (c_vector< double, 2 *DIM > &rMinAndMaxValues)
c_vector< double, 2 *DIM > &	rGetMinAndMaxValues ()
void	AddNode (Node< DIM > *pNode)
void	RemoveNode (Node< DIM > *pNode)
void	AddElement (Element< DIM, DIM > *pElement)
std::set< Node< DIM > * > &	rGetNodesContained ()
std::set< Element< DIM, DIM > * > &	rGetElementsContained ()
Private Attributes
c_vector< double, 2 *DIM >	mMinAndMaxValues
std::set< Node< DIM > * >	mNodesContained
std::set< Element< DIM, DIM > * >	mElementsContained

---

Detailed Description

template<unsigned DIM>
class Box< DIM >

A small class for a nD 'box' defined by its min/max x/y/z values which can contains a list of nodes and elements located in that box

Definition at line 40 of file BoxCollection.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

Box< DIM >::Box

(

c_vector< double, 2 *DIM > &

rMinAndMaxValues

)

[inline]

Constructor just takes in the extremal values of the box.

Parameters:

rMinAndMaxValues

the extremal values. Of the from (for 2D, etc): xmin, xmax, ymin, ymax

Definition at line 37 of file BoxCollection.cpp.

References Box< DIM >::mMinAndMaxValues.

---

Member Function Documentation

template<unsigned DIM>

void Box< DIM >::AddElement

(

Element< DIM, DIM > *

pElement

)

[inline]

An element to this box.

Parameters:

pElement

address of the element to be added

Definition at line 67 of file BoxCollection.cpp.

References Box< DIM >::mElementsContained.

template<unsigned DIM>

void Box< DIM >::AddNode

(

Node< DIM > *

pNode

)

[inline]

Add a node to this box.

Parameters:

pNode

address of the node to be added

Definition at line 49 of file BoxCollection.cpp.

References Box< DIM >::mNodesContained.

template<unsigned DIM>

void Box< DIM >::RemoveNode

(

Node< DIM > *

pNode

)

[inline]

Remove a node from this box.

Parameters:

pNode

address of the node to be removed

Definition at line 55 of file BoxCollection.cpp.

References Box< DIM >::mNodesContained.

template<unsigned DIM>

std::set< Element< DIM, DIM > * > & Box< DIM >::rGetElementsContained

(

)

[inline]

Get all the elements in this box.

Definition at line 73 of file BoxCollection.cpp.

References Box< DIM >::mElementsContained.

template<unsigned DIM>

c_vector< double, 2 *DIM > & Box< DIM >::rGetMinAndMaxValues

(

)

[inline]

Get the coordinates of the box, in the form (for 2D) (xmin, xmax, ymin, ymax) (etc).

Definition at line 43 of file BoxCollection.cpp.

References Box< DIM >::mMinAndMaxValues.

template<unsigned DIM>

std::set< Node< DIM > * > & Box< DIM >::rGetNodesContained

(

)

[inline]

Get all the nodes in this box.

Definition at line 61 of file BoxCollection.cpp.

References Box< DIM >::mNodesContained.

---

Member Data Documentation

template<unsigned DIM>

std::set< Element<DIM,DIM>* > Box< DIM >::mElementsContained [private]

Elements contained in this box.

Definition at line 50 of file BoxCollection.hpp.

Referenced by Box< DIM >::AddElement(), and Box< DIM >::rGetElementsContained().

template<unsigned DIM>

c_vector<double, 2*DIM> Box< DIM >::mMinAndMaxValues [private]

Coordinates of the box, in the form (for 2D) (xmin, xmax, ymin, ymax) (etc).

Definition at line 44 of file BoxCollection.hpp.

Referenced by Box< DIM >::Box(), and Box< DIM >::rGetMinAndMaxValues().

template<unsigned DIM>

std::set< Node<DIM>* > Box< DIM >::mNodesContained [private]

Nodes contained in this box.

Definition at line 47 of file BoxCollection.hpp.

Referenced by Box< DIM >::AddNode(), Box< DIM >::RemoveNode(), and Box< DIM >::rGetNodesContained().

---

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

• mesh/src/utilities/BoxCollection.hpp
• mesh/src/utilities/BoxCollection.cpp