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 () const
Private Member Functions
template<class Archive>
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
ChastePoint< SPACE_DIM >	mCentre
ChastePoint< SPACE_DIM >	mRadii
Friends
class	boost::serialization::access

---

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 45 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 32 of file ChasteEllipsoid.cpp.

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

---

Member Function Documentation

template<unsigned SPACE_DIM>

template<class Archive>

void ChasteEllipsoid< SPACE_DIM >::serialize	(	Archive &	archive,
		const unsigned int	version
	)			[inline, private]

Archive the member variables.

Parameters:

	archive
	version

Reimplemented from AbstractChasteRegion< SPACE_DIM >.

Definition at line 56 of file ChasteEllipsoid.hpp.

template<unsigned SPACE_DIM>

bool ChasteEllipsoid< SPACE_DIM >::DoesContain

(

const ChastePoint< SPACE_DIM > &

rPointToCheck

)

const [virtual]

Checks if a given point is contained in the ellipsoid.

Parameters:

rPointToCheck

Point to be checked to be contained in the ellipsoid.

Implements AbstractChasteRegion< SPACE_DIM >.

template<unsigned SPACE_DIM>

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

(

)

const [inline]

Returns:

centre of the ellipsoid

Definition at line 114 of file ChasteEllipsoid.cpp.

template<unsigned SPACE_DIM>

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

(

)

const [inline]

Returns:

radii of the ellipsoid

Definition at line 120 of file ChasteEllipsoid.cpp.

---

Friends And Related Function Documentation

template<unsigned SPACE_DIM>

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractChasteRegion< SPACE_DIM >.

Definition at line 48 of file ChasteEllipsoid.hpp.

---

Member Data Documentation

template<unsigned SPACE_DIM>

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

Centre of the ellipsoid.

Definition at line 63 of file ChasteEllipsoid.hpp.

template<unsigned SPACE_DIM>

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

Radii of the ellipsoid.

Definition at line 66 of file ChasteEllipsoid.hpp.

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

---

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

• mesh/src/utilities/ChasteEllipsoid.hpp
• mesh/src/utilities/ChasteEllipsoid.cpp