ChasteNodesList< SPACE_DIM > Class Template Reference
#include <ChasteNodesList.hpp>
Inherits AbstractChasteRegion< SPACE_DIM >.
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 54 of file ChasteNodesList.hpp.
Constructor & Destructor Documentation
| 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 39 of file ChasteNodesList.cpp.
| ChasteNodesList< SPACE_DIM >::~ChasteNodesList | ( | ) | [inline] |
Clean the memory used by the nodes in this node list
Definition at line 46 of file ChasteNodesList.cpp.
References ChasteNodesList< SPACE_DIM >::mListOfNodes, and ChasteNodesList< SPACE_DIM >::mOwnNodes.
Member Function Documentation
| bool ChasteNodesList< SPACE_DIM >::DoesContain | ( | const ChastePoint< SPACE_DIM > & | rPointToCheck | ) | const [inline, virtual] |
- Returns:
- true if a given point is contained in the node list.
- Parameters:
-
rPointToCheck Point to be checked whether it is a node in the list.
Implements AbstractChasteRegion< SPACE_DIM >.
Definition at line 58 of file ChasteNodesList.cpp.
References ChasteNodesList< SPACE_DIM >::mListOfNodes.
| unsigned ChasteNodesList< SPACE_DIM >::GetSize | ( | ) | const [inline] |
- Returns:
- the size of the nodes list
Definition at line 80 of file ChasteNodesList.cpp.
References ChasteNodesList< SPACE_DIM >::mListOfNodes.
| const std::vector< Node< SPACE_DIM > * > & ChasteNodesList< SPACE_DIM >::rGetNodesList | ( | ) | const [inline] |
- Returns:
- the list of nodes in this nodes list
Definition at line 74 of file ChasteNodesList.cpp.
References ChasteNodesList< SPACE_DIM >::mListOfNodes.
| 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 65 of file ChasteNodesList.hpp.
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from AbstractChasteRegion< SPACE_DIM >.
Definition at line 57 of file ChasteNodesList.hpp.
Member Data Documentation
std::vector< Node<SPACE_DIM>*> ChasteNodesList< SPACE_DIM >::mListOfNodes [private] |
A vector to store the list of nodes
Definition at line 73 of file ChasteNodesList.hpp.
Referenced by ChasteNodesList< SPACE_DIM >::DoesContain(), ChasteNodesList< SPACE_DIM >::GetSize(), ChasteNodesList< SPACE_DIM >::rGetNodesList(), and ChasteNodesList< SPACE_DIM >::~ChasteNodesList().
bool ChasteNodesList< SPACE_DIM >::mOwnNodes [private] |
Whether we own the Node objects and should free the memory on destruction
Definition at line 76 of file ChasteNodesList.hpp.
Referenced by ChasteNodesList< SPACE_DIM >::~ChasteNodesList().
The documentation for this class was generated from the following files:
- mesh/src/utilities/ChasteNodesList.hpp
- mesh/src/utilities/ChasteNodesList.cpp
