Box< DIM > Class Template Reference

#include <Box.hpp>

Collaboration diagram for Box< DIM >:

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	ClearNodes ()
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 50 of file Box.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

Box< DIM >::Box

(

c_vector< double, 2 *DIM > &

rMinAndMaxValues

)

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 43 of file Box.cpp.

Member Function Documentation

template<unsigned DIM>

void Box< DIM >::AddElement

(

Element< DIM, DIM > *

pElement

)

An element to this box.

Parameters

pElement

address of the element to be added

Definition at line 79 of file Box.cpp.

template<unsigned DIM>

void Box< DIM >::AddNode

(

Node< DIM > *

pNode

)

Add a node to this box.

Parameters

pNode

address of the node to be added

Definition at line 55 of file Box.cpp.

template<unsigned DIM>

void Box< DIM >::ClearNodes

(

)

Remove all nodes from the box.

Definition at line 67 of file Box.cpp.

template<unsigned DIM>

void Box< DIM >::RemoveNode

(

Node< DIM > *

pNode

)

Remove a node from this box.

Parameters

pNode

address of the node to be removed

Definition at line 61 of file Box.cpp.

template<unsigned DIM>

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

(

)

Returns

all the elements in this box.

Definition at line 85 of file Box.cpp.

template<unsigned DIM>

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

(

)

Returns

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

Definition at line 49 of file Box.cpp.

template<unsigned DIM>

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

(

)

Returns

all the nodes in this box.

Definition at line 73 of file Box.cpp.

Referenced by DistributedBoxCollection< DIM >::AddPairsFromBox().

Member Data Documentation

template<unsigned DIM>

std::set< Element<DIM,DIM>* > Box< DIM >::mElementsContained

private

Elements contained in this box.

Definition at line 61 of file Box.hpp.

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 55 of file Box.hpp.

template<unsigned DIM>

std::set< Node<DIM>* > Box< DIM >::mNodesContained

private

Nodes contained in this box.

Definition at line 58 of file Box.hpp.

---

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

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