ChasteNodesList< SPACE_DIM > Class Template Reference

#include <ChasteNodesList.hpp>

Inheritance diagram for ChasteNodesList< SPACE_DIM >:

Inheritance graph
[legend]
Collaboration diagram for ChasteNodesList< SPACE_DIM >:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ChasteNodesList (const std::vector< Node< SPACE_DIM > * > rNodesList, bool ownNodes=false)
 ~ChasteNodesList ()
const std::vector< Node
< SPACE_DIM > * > & 
rGetNodesList () const
bool DoesContain (const ChastePoint< SPACE_DIM > &rPointToCheck) const
unsigned GetSize () const

Private Member Functions

template<class Archive>
void serialize (Archive &archive, const unsigned int version)

Private Attributes

std::vector< Node< SPACE_DIM > * > mListOfNodes
bool mOwnNodes

Friends

class boost::serialization::access


Detailed Description

template<unsigned SPACE_DIM>
class ChasteNodesList< SPACE_DIM >

This class defines a list of nodes and provides a method to check whether a point is contained in the list.

Definition at line 47 of file ChasteNodesList.hpp.


Constructor & Destructor Documentation

template<unsigned SPACE_DIM>
ChasteNodesList< SPACE_DIM >::ChasteNodesList ( const std::vector< Node< SPACE_DIM > * >  rNodesList,
bool  ownNodes = false 
) [inline]

Constructor

Parameters:
rNodesList a standard vector of (pointer to) nodes
ownNodes whether we own the Node objects and should free the memory on destruction

Definition at line 32 of file ChasteNodesList.cpp.

template<unsigned SPACE_DIM>
ChasteNodesList< SPACE_DIM >::~ChasteNodesList (  )  [inline]

Clean the memory used by the nodes in this node list

Definition at line 39 of file ChasteNodesList.cpp.

References ChasteNodesList< SPACE_DIM >::mListOfNodes, and ChasteNodesList< SPACE_DIM >::mOwnNodes.


Member Function Documentation

template<unsigned SPACE_DIM>
template<class Archive>
void ChasteNodesList< SPACE_DIM >::serialize ( Archive &  archive,
const unsigned int  version 
) [inline, private]

Archive the member variables.

Parameters:
archive 
version 

Reimplemented from AbstractChasteRegion< SPACE_DIM >.

Definition at line 58 of file ChasteNodesList.hpp.

template<unsigned SPACE_DIM>
const std::vector< Node< SPACE_DIM > * > & ChasteNodesList< SPACE_DIM >::rGetNodesList (  )  const [inline]

Returns:
the list of ndoes in this nodes list

Definition at line 67 of file ChasteNodesList.cpp.

References ChasteNodesList< SPACE_DIM >::mListOfNodes.

template<unsigned SPACE_DIM>
bool ChasteNodesList< SPACE_DIM >::DoesContain ( const ChastePoint< SPACE_DIM > &  rPointToCheck  )  const [inline, virtual]

Checks if a given point is contained in the ndoe list.

Parameters:
rPointToCheck Point to be checked whether it is a node in the list.

Implements AbstractChasteRegion< SPACE_DIM >.

Definition at line 51 of file ChasteNodesList.cpp.

References ChasteNodesList< SPACE_DIM >::mListOfNodes.

template<unsigned SPACE_DIM>
unsigned ChasteNodesList< SPACE_DIM >::GetSize (  )  const [inline]

Returns:
the size of the nodes list

Definition at line 73 of file ChasteNodesList.cpp.

References ChasteNodesList< SPACE_DIM >::mListOfNodes.


Friends And Related Function Documentation

template<unsigned SPACE_DIM>
friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractChasteRegion< SPACE_DIM >.

Definition at line 50 of file ChasteNodesList.hpp.


Member Data Documentation

template<unsigned SPACE_DIM>
std::vector< Node<SPACE_DIM>*> ChasteNodesList< SPACE_DIM >::mListOfNodes [private]

template<unsigned SPACE_DIM>
bool ChasteNodesList< SPACE_DIM >::mOwnNodes [private]

Whether we own the Node objects and should free the memory on destruction

Definition at line 69 of file ChasteNodesList.hpp.

Referenced by ChasteNodesList< SPACE_DIM >::~ChasteNodesList().


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

Generated on Mon Apr 18 11:36:43 2011 for Chaste by  doxygen 1.5.5