ChasteEllipsoid< SPACE_DIM > Class Template Reference

#include <ChasteEllipsoid.hpp>

Inheritance diagram for ChasteEllipsoid< SPACE_DIM >:

[legend]

Collaboration diagram for ChasteEllipsoid< SPACE_DIM >:

[legend]

List of all members.

Public Member Functions
	ChasteEllipsoid (ChastePoint< SPACE_DIM > &rCentre, ChastePoint< SPACE_DIM > &rRadii)
bool	DoesContain (const ChastePoint< SPACE_DIM > &rPointToCheck) const
const ChastePoint< SPACE_DIM > &	rGetCentre () const
const ChastePoint< SPACE_DIM > &	rGetRadii ()
Private Attributes
ChastePoint< SPACE_DIM >	mCentre
ChastePoint< SPACE_DIM >	mRadii

---

Detailed Description

template<unsigned SPACE_DIM>
class ChasteEllipsoid< SPACE_DIM >

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

Definition at line 43 of file ChasteEllipsoid.hpp.

---

Constructor & Destructor Documentation

template<unsigned SPACE_DIM>

ChasteEllipsoid< SPACE_DIM >::ChasteEllipsoid	(	ChastePoint< SPACE_DIM > &	rCentre,
		ChastePoint< SPACE_DIM > &	rRadii
	)			[inline]

The (axis aligned) ellipsoid is defined by its centre and its radii in the x, y and z directions.

Parameters:

	rCentre	Centre of the ellipsoid.
	rRadii	Radii of the ellipsoid.

Definition at line 61 of file ChasteEllipsoid.hpp.

References EXCEPTION, and ChasteEllipsoid< SPACE_DIM >::mRadii.

---

Member Function Documentation

template<unsigned SPACE_DIM>

bool ChasteEllipsoid< SPACE_DIM >::DoesContain

(

const ChastePoint< SPACE_DIM > &

rPointToCheck

)

const [inline, virtual]

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

Parameters:

rPointToCheck

Point to be checked to be contained in the ellipsoid.

Implements AbstractChasteRegion< SPACE_DIM >.

Definition at line 82 of file ChasteEllipsoid.hpp.

References ChasteEllipsoid< SPACE_DIM >::mCentre, and ChasteEllipsoid< SPACE_DIM >::mRadii.

template<unsigned SPACE_DIM>

const ChastePoint<SPACE_DIM>& ChasteEllipsoid< SPACE_DIM >::rGetCentre

(

)

const [inline]

Returns:

centre of the ellipsoid

Definition at line 119 of file ChasteEllipsoid.hpp.

References ChasteEllipsoid< SPACE_DIM >::mCentre.

template<unsigned SPACE_DIM>

const ChastePoint<SPACE_DIM>& ChasteEllipsoid< SPACE_DIM >::rGetRadii

(

)

[inline]

Returns:

radii of the ellipsoid

Definition at line 124 of file ChasteEllipsoid.hpp.

References ChasteEllipsoid< SPACE_DIM >::mRadii.

---

Member Data Documentation

template<unsigned SPACE_DIM>

ChastePoint<SPACE_DIM> ChasteEllipsoid< SPACE_DIM >::mCentre [private]

Centre of the ellipsoid.

Definition at line 48 of file ChasteEllipsoid.hpp.

Referenced by ChasteEllipsoid< SPACE_DIM >::DoesContain(), and ChasteEllipsoid< SPACE_DIM >::rGetCentre().

template<unsigned SPACE_DIM>

ChastePoint<SPACE_DIM> ChasteEllipsoid< SPACE_DIM >::mRadii [private]

Radii of the ellipsoid.

Definition at line 51 of file ChasteEllipsoid.hpp.

Referenced by ChasteEllipsoid< SPACE_DIM >::ChasteEllipsoid(), ChasteEllipsoid< SPACE_DIM >::DoesContain(), and ChasteEllipsoid< SPACE_DIM >::rGetRadii().

---

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

• mesh/src/utilities/ChasteEllipsoid.hpp