#include <AbstractCellPopulationBoundaryCondition.hpp>

Inheritance diagram for AbstractCellPopulationBoundaryCondition< ELEMENT_DIM, SPACE_DIM >:

Collaboration diagram for AbstractCellPopulationBoundaryCondition< ELEMENT_DIM, SPACE_DIM >:

Public Member Functions
	AbstractCellPopulationBoundaryCondition (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)
virtual	~AbstractCellPopulationBoundaryCondition ()
virtual void	ImposeBoundaryCondition (const std::vector< c_vector< double, SPACE_DIM > > &rOldLocations)=0
virtual bool	VerifyBoundaryCondition ()=0
const AbstractCellPopulation < ELEMENT_DIM, SPACE_DIM > *	GetCellPopulation () const
void	OutputCellPopulationBoundaryConditionInfo (out_stream &rParamsFile)
virtual void	OutputCellPopulationBoundaryConditionParameters (out_stream &rParamsFile)=0
Protected Attributes
AbstractCellPopulation < ELEMENT_DIM, SPACE_DIM > *	mpCellPopulation
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Friends
class	TestCellPopulationBoundaryConditions
class	boost::serialization::access

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
class AbstractCellPopulationBoundaryCondition< ELEMENT_DIM, SPACE_DIM >

An abstract cell population boundary condition class, for use in cell-based simulations.

Definition at line 49 of file AbstractCellPopulationBoundaryCondition.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractCellPopulationBoundaryCondition< ELEMENT_DIM, SPACE_DIM >::AbstractCellPopulationBoundaryCondition ( AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > * pCellPopulation )

Constructor.

Parameters:

pCellPopulation pointer to the cell population.

Definition at line 39 of file AbstractCellPopulationBoundaryCondition.cpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractCellPopulationBoundaryCondition< ELEMENT_DIM, SPACE_DIM >::~AbstractCellPopulationBoundaryCondition ( ) [virtual]

Destructor.

Definition at line 45 of file AbstractCellPopulationBoundaryCondition.cpp.

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

const AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > * AbstractCellPopulationBoundaryCondition< ELEMENT_DIM, SPACE_DIM >::GetCellPopulation ( ) const

Get a pointer to the cell population.

Returns:: A const pointer to the mpCellPopulation

Definition at line 50 of file AbstractCellPopulationBoundaryCondition.cpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

virtual void AbstractCellPopulationBoundaryCondition< ELEMENT_DIM, SPACE_DIM >::ImposeBoundaryCondition ( const std::vector< c_vector< double, SPACE_DIM > > & rOldLocations ) [pure virtual]

Impose the boundary condition on each node.

As this method is pure virtual, it must be overridden in subclasses.

Parameters:

rOldLocations the node locations before any boundary conditions are applied

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulationBoundaryCondition< ELEMENT_DIM, SPACE_DIM >::OutputCellPopulationBoundaryConditionInfo ( out_stream & rParamsFile )

Output cell population boundary condition used in the simulation to file and then call OutputCellPopulationBoundaryConditionParameters() to output all relevant parameters.

Parameters:

rParamsFile the file stream to which the parameters are output

Definition at line 56 of file AbstractCellPopulationBoundaryCondition.cpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulationBoundaryCondition< ELEMENT_DIM, SPACE_DIM >::OutputCellPopulationBoundaryConditionParameters ( out_stream & rParamsFile ) [pure virtual]

Output cell population boundary condition parameters to file.

As this method is pure virtual, it must be overridden in subclasses.

Parameters:

rParamsFile the file stream to which the parameters are output

Implemented in PlaneBoundaryCondition< DIM >, SphereGeometryBoundaryCondition< DIM >, and CryptSimulationBoundaryCondition< DIM >.

Definition at line 66 of file AbstractCellPopulationBoundaryCondition.cpp.

Referenced by CryptSimulationBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters(), SphereGeometryBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters(), and PlaneBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

template<class Archive >

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

Serialize the object and its member variables.

Parameters:

archive	the archive
version	the current version of this class

Reimplemented in PlaneBoundaryCondition< DIM >, SphereGeometryBoundaryCondition< DIM >, and CryptSimulationBoundaryCondition< DIM >.

Definition at line 63 of file AbstractCellPopulationBoundaryCondition.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

virtual bool AbstractCellPopulationBoundaryCondition< ELEMENT_DIM, SPACE_DIM >::VerifyBoundaryCondition ( ) [pure virtual]

Pure method which should verify the boundary condition has been applied. This is called after ImposeBoundaryCondition() to ensure the condition is still satisfied.

As this method is pure virtual, it must be overridden in subclasses.