Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
ChasteEllipsoid< SPACE_DIM > Class Template Reference

#include <ChasteEllipsoid.hpp>

+ Inheritance diagram for ChasteEllipsoid< SPACE_DIM >:
+ Collaboration diagram for ChasteEllipsoid< SPACE_DIM >:

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
 
- Public Member Functions inherited from AbstractChasteRegion< SPACE_DIM >
 AbstractChasteRegion ()
 
virtual void Destroy ()
 
virtual ~AbstractChasteRegion ()
 

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 52 of file ChasteEllipsoid.hpp.

Constructor & Destructor Documentation

◆ ChasteEllipsoid()

template<unsigned SPACE_DIM>
ChasteEllipsoid< SPACE_DIM >::ChasteEllipsoid ( ChastePoint< SPACE_DIM > &  rCentre,
ChastePoint< SPACE_DIM > &  rRadii 
)

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

Parameters
rCentreCentre of the ellipsoid.
rRadiiRadii of the ellipsoid.

Definition at line 40 of file ChasteEllipsoid.cpp.

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

Member Function Documentation

◆ DoesContain()

template<unsigned SPACE_DIM>
bool ChasteEllipsoid< SPACE_DIM >::DoesContain ( const ChastePoint< SPACE_DIM > &  rPointToCheck) const
virtual
Returns
true if a given point is contained in the ellipsoid.
Parameters
rPointToCheckPoint to be checked to be contained in the ellipsoid.

Implements AbstractChasteRegion< SPACE_DIM >.

◆ rGetCentre()

template<unsigned SPACE_DIM>
const ChastePoint< SPACE_DIM > & ChasteEllipsoid< SPACE_DIM >::rGetCentre ( ) const
Returns
centre of the ellipsoid

Get Doxygen to ignore, since it's confused by explicit instantiation of templated methods

Get Doxygen to ignore, since it's confused by explicit instantiation of templated methods

Get Doxygen to ignore, since it's confused by explicit instantiation of templated methods

Definition at line 125 of file ChasteEllipsoid.cpp.

◆ rGetRadii()

template<unsigned SPACE_DIM>
const ChastePoint< SPACE_DIM > & ChasteEllipsoid< SPACE_DIM >::rGetRadii ( ) const
Returns
radii of the ellipsoid

Definition at line 131 of file ChasteEllipsoid.cpp.

◆ serialize()

template<unsigned SPACE_DIM>
template<class Archive >
void ChasteEllipsoid< SPACE_DIM >::serialize ( Archive &  archive,
const unsigned int  version 
)
inlineprivate

Archive the member variables.

Parameters
archive
version

Definition at line 63 of file ChasteEllipsoid.hpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<unsigned SPACE_DIM>
friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 55 of file ChasteEllipsoid.hpp.

Member Data Documentation

◆ mCentre

template<unsigned SPACE_DIM>
ChastePoint<SPACE_DIM> ChasteEllipsoid< SPACE_DIM >::mCentre
private

Centre of the ellipsoid.

Definition at line 70 of file ChasteEllipsoid.hpp.

◆ mRadii

template<unsigned SPACE_DIM>
ChastePoint<SPACE_DIM> ChasteEllipsoid< SPACE_DIM >::mRadii
private

Radii of the ellipsoid.

Definition at line 73 of file ChasteEllipsoid.hpp.

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


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