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 | DoesContain (const ChastePoint< SPACE_DIM > &rPointToCheck) const |
Private Attributes | |
| std::vector< Node< SPACE_DIM > * > | mListOfNodes |
Detailed Description
template<unsigned SPACE_DIM>
class ChasteNodesList< SPACE_DIM >
This class defines a 3D cuboid and provides a method to check
Definition at line 43 of file ChasteNodesList.hpp.
Constructor & Destructor Documentation
template<unsigned SPACE_DIM>
| ChasteNodesList< SPACE_DIM >::ChasteNodesList | ( | const std::vector< Node< SPACE_DIM > * > | rNodesList | ) | [inline] |
Constructor
- Parameters:
-
rNodesList a standard vector of (pointer to) nodes
Definition at line 57 of file ChasteNodesList.hpp.
Member Function Documentation
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 69 of file ChasteNodesList.hpp.
References ChasteNodesList< SPACE_DIM >::mListOfNodes.
Member Data Documentation
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 48 of file ChasteNodesList.hpp.
Referenced by ChasteNodesList< SPACE_DIM >::DoesContain().
The documentation for this class was generated from the following file:
- mesh/src/utilities/ChasteNodesList.hpp
