AbstractChasteRegion< SPACE_DIM > Class Template Reference
#include <AbstractChasteRegion.hpp>
Inheritance diagram for AbstractChasteRegion< SPACE_DIM >:
Public Member Functions | |
| AbstractChasteRegion () | |
| virtual | ~AbstractChasteRegion () |
| virtual bool | DoesContain (const ChastePoint< SPACE_DIM > &rPointToCheck) const =0 |
Detailed Description
template<unsigned SPACE_DIM>
class AbstractChasteRegion< SPACE_DIM >
Abstract base class for Chaste regions.
Definition at line 41 of file AbstractChasteRegion.hpp.
Constructor & Destructor Documentation
template<unsigned SPACE_DIM>
| AbstractChasteRegion< SPACE_DIM >::AbstractChasteRegion | ( | ) | [inline] |
Constructor
Definition at line 49 of file AbstractChasteRegion.hpp.
template<unsigned SPACE_DIM>
| virtual AbstractChasteRegion< SPACE_DIM >::~AbstractChasteRegion | ( | ) | [inline, virtual] |
Virtual functions, so virtual destructor.
Definition at line 55 of file AbstractChasteRegion.hpp.
Member Function Documentation
template<unsigned SPACE_DIM>
| virtual bool AbstractChasteRegion< SPACE_DIM >::DoesContain | ( | const ChastePoint< SPACE_DIM > & | rPointToCheck | ) | const [pure virtual] |
Checks whether the Chaste point is contained in the region. implemented in the concrete classes
- Parameters:
-
rPointToCheck Point to be checked to be contained in the region
- Returns:
- true if the point is contained, false otherwise
Implemented in ChasteCuboid< SPACE_DIM >, ChasteEllipsoid< SPACE_DIM >, and ChasteNodesList< SPACE_DIM >.
The documentation for this class was generated from the following file:
- mesh/src/common/AbstractChasteRegion.hpp
