SphereGeometryBoundaryCondition< DIM > Class Template Reference

#include <SphereGeometryBoundaryCondition.hpp>

Inherits AbstractCellPopulationBoundaryCondition< DIM >.

Collaboration diagram for SphereGeometryBoundaryCondition< DIM >:

Public Member Functions
	SphereGeometryBoundaryCondition (AbstractCellPopulation< DIM > *pCellPopulation, c_vector< double, DIM > centre, double radius, double distance=1e-5)
const c_vector< double, DIM > &	rGetCentreOfSphere () const
double	GetRadiusOfSphere () const
void	ImposeBoundaryCondition (const std::map< Node< DIM > *, c_vector< double, DIM > > &rOldLocations)
bool	VerifyBoundaryCondition ()
void	OutputCellPopulationBoundaryConditionParameters (out_stream &rParamsFile)
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
c_vector< double, DIM >	mCentreOfSphere
double	mRadiusOfSphere
double	mMaximumDistance
Friends
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class SphereGeometryBoundaryCondition< DIM >

A spherical cell population boundary condition class, which restricts nodes to lie on the surface of a sphere in the domain. Although the name of this class suggests it is specific to 3D, it is actually also implemented in 2D, for which it is really a circle geometry boundary condition.

Definition at line 52 of file SphereGeometryBoundaryCondition.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

SphereGeometryBoundaryCondition< DIM >::SphereGeometryBoundaryCondition	(	AbstractCellPopulation< DIM > *	pCellPopulation,
		c_vector< double, DIM >	centre,
		double	radius,
		double	distance = `1e-5`
	)			`[inline]`

Constructor.

Parameters:

	pCellPopulation	pointer to the cell population
	centre	the centre of the sphere
	radius	the radius of the sphere
	distance	the maximum distance from the surface of the sphere that cells may be (defaults to 1e-5)

Definition at line 40 of file SphereGeometryBoundaryCondition.cpp.

References EXCEPTION, SphereGeometryBoundaryCondition< DIM >::mMaximumDistance, AbstractCellPopulationBoundaryCondition< DIM >::mpCellPopulation, and SphereGeometryBoundaryCondition< DIM >::mRadiusOfSphere.

Member Function Documentation

template<unsigned DIM>

double SphereGeometryBoundaryCondition< DIM >::GetRadiusOfSphere ( ) const [inline]

Returns:: mRadiusOfSphere.

Definition at line 69 of file SphereGeometryBoundaryCondition.cpp.

References SphereGeometryBoundaryCondition< DIM >::mRadiusOfSphere.

template<unsigned DIM>

void SphereGeometryBoundaryCondition< DIM >::ImposeBoundaryCondition ( const std::map< Node< DIM > *, c_vector< double, DIM > > & rOldLocations ) [inline]

Overridden ImposeBoundaryCondition() method.

Apply the cell population boundary conditions.

Parameters:

rOldLocations

the node locations before any boundary conditions are applied

Definition at line 75 of file SphereGeometryBoundaryCondition.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Begin(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::End(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationIndexUsingCell(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationOfCellCentre(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNode(), SphereGeometryBoundaryCondition< DIM >::mCentreOfSphere, SphereGeometryBoundaryCondition< DIM >::mMaximumDistance, AbstractCellPopulationBoundaryCondition< DIM >::mpCellPopulation, SphereGeometryBoundaryCondition< DIM >::mRadiusOfSphere, and Node< SPACE_DIM >::rGetModifiableLocation().

template<unsigned DIM>

void SphereGeometryBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters ( out_stream & rParamsFile ) [inline, virtual]

Overridden OutputCellPopulationBoundaryConditionParameters() method. Output cell population boundary condition parameters to file.

Parameters:

rParamsFile

the file stream to which the parameters are output

Implements AbstractCellPopulationBoundaryCondition< DIM >.

Definition at line 128 of file SphereGeometryBoundaryCondition.cpp.

References SphereGeometryBoundaryCondition< DIM >::mCentreOfSphere, SphereGeometryBoundaryCondition< DIM >::mMaximumDistance, and SphereGeometryBoundaryCondition< DIM >::mRadiusOfSphere.

template<unsigned DIM>

const c_vector< double, DIM > & SphereGeometryBoundaryCondition< DIM >::rGetCentreOfSphere ( ) const [inline]

Returns:: mCentreOfSphere.

Definition at line 63 of file SphereGeometryBoundaryCondition.cpp.

References SphereGeometryBoundaryCondition< DIM >::mCentreOfSphere.

template<unsigned DIM>

template<class Archive >

void SphereGeometryBoundaryCondition< DIM >::serialize	(	Archive &	archive,
		const unsigned int	version
	)			`[inline, private]`

Serialize the object.

Parameters:

	archive	the archive
	version	the current version of this class

Reimplemented from AbstractCellPopulationBoundaryCondition< DIM >.

Definition at line 74 of file SphereGeometryBoundaryCondition.hpp.

References SphereGeometryBoundaryCondition< DIM >::mMaximumDistance.

template<unsigned DIM>

bool SphereGeometryBoundaryCondition< DIM >::VerifyBoundaryCondition ( ) [inline, virtual]

Overridden VerifyBoundaryCondition() method. Verify the boundary conditions have been applied. This is called after ImposeBoundaryCondition() to ensure the condition is still satisfied.