Chaste  Release::2017.1
ChasteCuboid< SPACE_DIM > Class Template Reference

#include <ChasteCuboid.hpp>

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

Public Member Functions

 ChasteCuboid (ChastePoint< SPACE_DIM > &rLowerPoint, ChastePoint< SPACE_DIM > &rUpperPoint)
 
bool DoesContain (const ChastePoint< SPACE_DIM > &rPointToCheck) const
 
const ChastePoint< SPACE_DIM > & rGetUpperCorner () const
 
const ChastePoint< SPACE_DIM > & rGetLowerCorner () const
 
double GetWidth (unsigned rDimension) const
 
unsigned GetLongestAxis () 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 > mLowerCorner
 
ChastePoint< SPACE_DIM > mUpperCorner
 

Friends

class boost::serialization::access
 

Detailed Description

template<unsigned SPACE_DIM>
class ChasteCuboid< SPACE_DIM >

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

Definition at line 51 of file ChasteCuboid.hpp.

Constructor & Destructor Documentation

template<unsigned SPACE_DIM>
ChasteCuboid< SPACE_DIM >::ChasteCuboid ( ChastePoint< SPACE_DIM > &  rLowerPoint,
ChastePoint< SPACE_DIM > &  rUpperPoint 
)

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

Parameters
rLowerPointLower vertex of the cuboid.
rUpperPointUpper vertex of the cuboid.

Definition at line 40 of file ChasteCuboid.cpp.

References EXCEPTION, ChasteCuboid< SPACE_DIM >::mLowerCorner, and ChasteCuboid< SPACE_DIM >::mUpperCorner.

Member Function Documentation

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

Implements AbstractChasteRegion< SPACE_DIM >.

Definition at line 54 of file ChasteCuboid.cpp.

References ChasteCuboid< SPACE_DIM >::mLowerCorner, and ChasteCuboid< SPACE_DIM >::mUpperCorner.

template<unsigned SPACE_DIM>
unsigned ChasteCuboid< SPACE_DIM >::GetLongestAxis ( ) const
Returns
the longest axis of the cuboid (<SPACE_DIM). In the case where there's a tie, then any of the longest axes are returned.

Definition at line 87 of file ChasteCuboid.cpp.

References EXPORT_TEMPLATE_CLASS_SAME_DIMS, ChasteCuboid< SPACE_DIM >::mLowerCorner, and ChasteCuboid< SPACE_DIM >::mUpperCorner.

template<unsigned SPACE_DIM>
double ChasteCuboid< SPACE_DIM >::GetWidth ( unsigned  rDimension) const
Parameters
rDimensiondimension
Returns
the width in a particular dimension

Definition at line 80 of file ChasteCuboid.cpp.

References ChasteCuboid< SPACE_DIM >::mLowerCorner, and ChasteCuboid< SPACE_DIM >::mUpperCorner.

Referenced by FineCoarseMeshPair< DIM >::SetUpBoxes().

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

Archive the member variables.

Parameters
archive
version

Definition at line 62 of file ChasteCuboid.hpp.

Friends And Related Function Documentation

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

Needed for serialization.

Definition at line 54 of file ChasteCuboid.hpp.

Member Data Documentation

template<unsigned SPACE_DIM>
ChastePoint<SPACE_DIM> ChasteCuboid< SPACE_DIM >::mLowerCorner
private
template<unsigned SPACE_DIM>
ChastePoint<SPACE_DIM> ChasteCuboid< SPACE_DIM >::mUpperCorner
private

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