Chaste Commit::ca8ccdedf819b6e02855bc0e8e6f50bdecbc5208
ChasteNodesList< SPACE_DIM > Class Template Reference

#include <ChasteNodesList.hpp>

+ Inheritance diagram for ChasteNodesList< SPACE_DIM >:
+ Collaboration diagram for ChasteNodesList< 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
 
- Public Member Functions inherited from AbstractChasteRegion< SPACE_DIM >
 AbstractChasteRegion ()
 
virtual void Destroy ()
 
virtual ~AbstractChasteRegion ()
 

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()

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

Constructor

Parameters
rNodesLista standard vector of (pointer to) nodes
ownNodeswhether we own the Node objects and should free the memory on destruction

Definition at line 39 of file ChasteNodesList.cpp.

◆ ~ChasteNodesList()

template<unsigned SPACE_DIM>
ChasteNodesList< SPACE_DIM >::~ChasteNodesList ( )

Clean the memory used by the nodes in this node list

Definition at line 46 of file ChasteNodesList.cpp.

Member Function Documentation

◆ DoesContain()

template<unsigned SPACE_DIM>
bool ChasteNodesList< SPACE_DIM >::DoesContain ( const ChastePoint< SPACE_DIM > &  rPointToCheck) const
virtual
Returns
true if a given point is contained in the node list.
Parameters
rPointToCheckPoint to be checked whether it is a node in the list.

Implements AbstractChasteRegion< SPACE_DIM >.

Definition at line 58 of file ChasteNodesList.cpp.

◆ GetSize()

template<unsigned SPACE_DIM>
unsigned ChasteNodesList< SPACE_DIM >::GetSize ( ) const
Returns
the size of the nodes list

Definition at line 80 of file ChasteNodesList.cpp.

◆ rGetNodesList()

template<unsigned SPACE_DIM>
const std::vector< Node< SPACE_DIM > * > & ChasteNodesList< SPACE_DIM >::rGetNodesList ( ) const
Returns
the list of nodes in this nodes list

Definition at line 74 of file ChasteNodesList.cpp.

◆ serialize()

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

Archive the member variables.

Parameters
archive
version

Definition at line 65 of file ChasteNodesList.hpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

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

Needed for serialization.

Definition at line 57 of file ChasteNodesList.hpp.

Member Data Documentation

◆ mListOfNodes

template<unsigned SPACE_DIM>
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.

◆ mOwnNodes

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 76 of file ChasteNodesList.hpp.


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