ChasteCuboid Class Reference

#include <ChasteCuboid.hpp>

Collaboration diagram for ChasteCuboid:

[legend]

List of all members.

Public Member Functions
	ChasteCuboid (ChastePoint< 3 > &rPointA, ChastePoint< 3 > &rPointB)
bool	DoesContain (const ChastePoint< 3U > &rPointToCheck)
bool	DoesContain (const ChastePoint< 2U > &rPointToCheck)
bool	DoesContain (const ChastePoint< 1U > &rPointToCheck)
Private Attributes
ChastePoint< 3 >	mrPointA
ChastePoint< 3 >	mrPointB

---

Detailed Description

This class defines a 3D cuboid and provides a method to check if a given point is contained in the volume.

Definition at line 39 of file ChasteCuboid.hpp.

---

Constructor & Destructor Documentation

ChasteCuboid::ChasteCuboid	(	ChastePoint< 3 > &	rPointA,
		ChastePoint< 3 > &	rPointB
	)

The cuboid is defined by any of its two space-diagonal opposite corners.

Parameters:

	rPointA	Any vertex of the cuboid.
	rPointB	The space-diagonal opposite corner of pointA.

Definition at line 32 of file ChasteCuboid.cpp.

References mrPointA, and mrPointB.

---

Member Function Documentation

bool ChasteCuboid::DoesContain

(

const ChastePoint< 3U > &

rPointToCheck

)

Todo:

: use a templated definition of the method below

Checks if a given 3D point is contained in the cuboid.

Parameters:

rPointToCheck

Point to be checked to be contained in the cuboid.

Definition at line 43 of file ChasteCuboid.cpp.

References mrPointA, and mrPointB.

bool ChasteCuboid::DoesContain

(

const ChastePoint< 2U > &

rPointToCheck

)

Checks if a given 2D point is contained in the cuboid.

Parameters:

rPointToCheck

Point to be checked to be contained in the cuboid.

Definition at line 58 of file ChasteCuboid.cpp.

References mrPointA, and mrPointB.

bool ChasteCuboid::DoesContain

(

const ChastePoint< 1U > &

rPointToCheck

)

Checks if a given 1D point is contained in the cuboid.

Parameters:

rPointToCheck

Point to be checked to be contained in the cuboid.

Definition at line 74 of file ChasteCuboid.cpp.

References mrPointA, and mrPointB.

---

Member Data Documentation

ChastePoint<3> ChasteCuboid::mrPointA [private]

A vertex of the cuboid.

Definition at line 44 of file ChasteCuboid.hpp.

Referenced by ChasteCuboid(), and DoesContain().

ChastePoint<3> ChasteCuboid::mrPointB [private]

The space-diagonal opposite corner of mrPointA.

Definition at line 47 of file ChasteCuboid.hpp.

Referenced by ChasteCuboid(), and DoesContain().

---

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

• /tmp/release_1.1/mesh/src/common/ChasteCuboid.hpp
• /tmp/release_1.1/mesh/src/common/ChasteCuboid.cpp