AbstractChasteRegion< SPACE_DIM > Class Template Reference

#include <AbstractChasteRegion.hpp>

Inherited by ChasteCuboid< SPACE_DIM >, and ChasteNodesList< SPACE_DIM >.

List of all members.

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 42 of file AbstractChasteRegion.hpp.

---

Constructor & Destructor Documentation

template<unsigned SPACE_DIM>

AbstractChasteRegion< SPACE_DIM >::AbstractChasteRegion

(

)

[inline]

Constructor

Definition at line 43 of file AbstractChasteRegion.hpp.

References AbstractChasteRegion< SPACE_DIM >::DoesContain(), and AbstractChasteRegion< SPACE_DIM >::~AbstractChasteRegion().

template<unsigned SPACE_DIM>

virtual AbstractChasteRegion< SPACE_DIM >::~AbstractChasteRegion

(

)

[inline, virtual]

Virtual functions, so virtual destructor.

Definition at line 49 of file AbstractChasteRegion.hpp.

Referenced by AbstractChasteRegion< SPACE_DIM >::AbstractChasteRegion().

---

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 >, and ChasteNodesList< SPACE_DIM >.

Referenced by AbstractChasteRegion< SPACE_DIM >::AbstractChasteRegion().

---

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

• /tmp/release_2.0/mesh/src/common/AbstractChasteRegion.hpp