Chaste  Release::3.4
SphereGeometryBoundaryCondition< DIM > Class Template Reference

#include <SphereGeometryBoundaryCondition.hpp>

+ Inheritance diagram for SphereGeometryBoundaryCondition< 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)
 
- Public Member Functions inherited from AbstractCellPopulationBoundaryCondition< DIM >
 AbstractCellPopulationBoundaryCondition (AbstractCellPopulation< ELEMENT_DIM, ELEMENT_DIM > *pCellPopulation)
 
virtual ~AbstractCellPopulationBoundaryCondition ()
 
virtual void ImposeBoundaryCondition (const std::map< Node< ELEMENT_DIM > *, c_vector< double, ELEMENT_DIM > > &rOldLocations)=0
 
const AbstractCellPopulation
< ELEMENT_DIM, ELEMENT_DIM > * 
GetCellPopulation () const
 
void OutputCellPopulationBoundaryConditionInfo (out_stream &rParamsFile)
 
- Public Member Functions inherited from Identifiable
virtual ~Identifiable ()
 
std::string GetIdentifier () const
 

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
 

Additional Inherited Members

- Protected Attributes inherited from AbstractCellPopulationBoundaryCondition< DIM >
AbstractCellPopulation
< ELEMENT_DIM, ELEMENT_DIM > * 
mpCellPopulation
 

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 
)

Constructor.

Parameters
pCellPopulationpointer to the cell population
centrethe centre of the sphere
radiusthe radius of the sphere
distancethe 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
Returns
mRadiusOfSphere.

Definition at line 69 of file SphereGeometryBoundaryCondition.cpp.

template<unsigned DIM>
void SphereGeometryBoundaryCondition< DIM >::ImposeBoundaryCondition ( const std::map< Node< DIM > *, c_vector< double, DIM > > &  rOldLocations)

Overridden ImposeBoundaryCondition() method.

Apply the cell population boundary conditions.

Parameters
rOldLocationsthe node locations before any boundary conditions are applied

Definition at line 75 of file SphereGeometryBoundaryCondition.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Begin(), and Node< SPACE_DIM >::rGetModifiableLocation().

template<unsigned DIM>
void SphereGeometryBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters ( out_stream &  rParamsFile)
virtual

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

Parameters
rParamsFilethe file stream to which the parameters are output

Implements AbstractCellPopulationBoundaryCondition< DIM >.

Definition at line 128 of file SphereGeometryBoundaryCondition.cpp.

References AbstractCellPopulationBoundaryCondition< ELEMENT_DIM, SPACE_DIM >::OutputCellPopulationBoundaryConditionParameters().

template<unsigned DIM>
const c_vector< double, DIM > & SphereGeometryBoundaryCondition< DIM >::rGetCentreOfSphere ( ) const
Returns
mCentreOfSphere.

Definition at line 63 of file SphereGeometryBoundaryCondition.cpp.

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

Serialize the object.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 74 of file SphereGeometryBoundaryCondition.hpp.

References SphereGeometryBoundaryCondition< DIM >::mMaximumDistance.

template<unsigned DIM>
bool SphereGeometryBoundaryCondition< DIM >::VerifyBoundaryCondition ( )
virtual

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

Returns
whether the boundary conditions are satisfied.

Implements AbstractCellPopulationBoundaryCondition< DIM >.

Definition at line 103 of file SphereGeometryBoundaryCondition.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Begin().

Friends And Related Function Documentation

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

Needed for serialization.

Definition at line 66 of file SphereGeometryBoundaryCondition.hpp.

Member Data Documentation

template<unsigned DIM>
c_vector<double, DIM> SphereGeometryBoundaryCondition< DIM >::mCentreOfSphere
private

The centre of the sphere.

Definition at line 57 of file SphereGeometryBoundaryCondition.hpp.

template<unsigned DIM>
double SphereGeometryBoundaryCondition< DIM >::mMaximumDistance
private

The maximum distance from the surface of the sphere that cells may be.

Definition at line 63 of file SphereGeometryBoundaryCondition.hpp.

Referenced by SphereGeometryBoundaryCondition< DIM >::serialize(), and SphereGeometryBoundaryCondition< DIM >::SphereGeometryBoundaryCondition().

template<unsigned DIM>
double SphereGeometryBoundaryCondition< DIM >::mRadiusOfSphere
private

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