Chaste Commit::1fd4e48e3990e67db148bc1bc4cf6991a0049d0c
Box< DIM > Class Template Reference

#include <Box.hpp>

+ Collaboration diagram for Box< DIM >:

Public Member Functions

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

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.

Member Function Documentation

◆ AddElement()

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

◆ AddNode()

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

◆ ClearNodes()

template<unsigned DIM>
void Box< DIM >::ClearNodes ( )

Remove all nodes from the box.

Definition at line 50 of file Box.cpp.

◆ RemoveNode()

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

◆ rGetElementsContained()

template<unsigned DIM>
std::set< Element< DIM, DIM > * > & Box< DIM >::rGetElementsContained ( )
Returns
all the elements in this box.
Todo:
#2308 there are no methods to remove or clear elements

Definition at line 70 of file Box.cpp.

◆ rGetNodesContained()

template<unsigned DIM>
std::set< Node< DIM > * > & Box< DIM >::rGetNodesContained ( )
Returns
all the nodes in this box.

Definition at line 56 of file Box.cpp.

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

Member Data Documentation

◆ mElementsContained

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

Elements contained in this box.

Definition at line 58 of file Box.hpp.

◆ mNodesContained

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

Nodes contained in this box.

Definition at line 55 of file Box.hpp.


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