Chaste Release::3.1
Public Member Functions | Private Attributes
Box< DIM > Class Template Reference

#include <BoxCollection.hpp>

Collaboration diagram for Box< DIM >:

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 48 of file BoxCollection.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:
rMinAndMaxValuesthe extremal values. Of the from (for 2D, etc): xmin, xmax, ymin, ymax

Definition at line 44 of file BoxCollection.cpp.

Member Function Documentation

template<unsigned DIM>
void Box< DIM >::AddElement ( Element< DIM, DIM > *  pElement)

An element to this box.

Parameters:
pElementaddress of the element to be added

Definition at line 74 of file BoxCollection.cpp.

template<unsigned DIM>
void Box< DIM >::AddNode ( Node< DIM > *  pNode)

Add a node to this box.

Parameters:
pNodeaddress of the node to be added

Definition at line 56 of file BoxCollection.cpp.

template<unsigned DIM>
void Box< DIM >::RemoveNode ( Node< DIM > *  pNode)

Remove a node from this box.

Parameters:
pNodeaddress of the node to be removed

Definition at line 62 of file BoxCollection.cpp.

template<unsigned DIM>
std::set< Element< DIM, DIM > * > & Box< DIM >::rGetElementsContained ( )

Get all the elements in this box.

Definition at line 80 of file BoxCollection.cpp.

template<unsigned DIM>
c_vector< double, 2 *DIM > & Box< DIM >::rGetMinAndMaxValues ( )

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

Definition at line 50 of file BoxCollection.cpp.

template<unsigned DIM>
std::set< Node< DIM > * > & Box< DIM >::rGetNodesContained ( )

Get all the nodes in this box.

Definition at line 68 of file BoxCollection.cpp.

Member Data Documentation

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

Elements contained in this box.

Definition at line 59 of file BoxCollection.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 53 of file BoxCollection.hpp.

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

Nodes contained in this box.

Definition at line 56 of file BoxCollection.hpp.

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