AbstractCellPopulationBoundaryCondition< DIM > Class Template Reference

#include <AbstractCellPopulationBoundaryCondition.hpp>

Inherited by CryptSimulationBoundaryCondition< DIM >, PlaneBoundaryCondition< DIM >, and SphereGeometryBoundaryCondition< DIM >.

Collaboration diagram for AbstractCellPopulationBoundaryCondition< DIM >:

[legend]

List of all members.

Public Member Functions
	AbstractCellPopulationBoundaryCondition (AbstractCellPopulation< DIM > *pCellPopulation)
virtual	~AbstractCellPopulationBoundaryCondition ()
virtual void	ImposeBoundaryCondition (const std::vector< c_vector< double, DIM > > &rOldLocations)=0
virtual bool	VerifyBoundaryCondition ()=0
const AbstractCellPopulation < DIM > *	GetCellPopulation () const
void	OutputCellPopulationBoundaryConditionInfo (out_stream &rParamsFile)
virtual void	OutputCellPopulationBoundaryConditionParameters (out_stream &rParamsFile)=0
Protected Attributes
AbstractCellPopulation< 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 DIM>
class AbstractCellPopulationBoundaryCondition< DIM >

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

Definition at line 42 of file AbstractCellPopulationBoundaryCondition.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

AbstractCellPopulationBoundaryCondition< DIM >::AbstractCellPopulationBoundaryCondition ( AbstractCellPopulation< DIM > * pCellPopulation ) [inline]

Constructor.

Parameters:

pCellPopulation

pointer to the cell population.

Definition at line 32 of file AbstractCellPopulationBoundaryCondition.cpp.

template<unsigned DIM>

AbstractCellPopulationBoundaryCondition< DIM >::~AbstractCellPopulationBoundaryCondition ( ) [inline, virtual]

Destructor.

Definition at line 38 of file AbstractCellPopulationBoundaryCondition.cpp.

Member Function Documentation

template<unsigned DIM>

const AbstractCellPopulation< DIM > * AbstractCellPopulationBoundaryCondition< DIM >::GetCellPopulation ( ) const [inline]

Get a pointer to the cell population.

Returns:: A const pointer to the mpCellPopulation

Definition at line 43 of file AbstractCellPopulationBoundaryCondition.cpp.

References AbstractCellPopulationBoundaryCondition< DIM >::mpCellPopulation.

template<unsigned DIM>

virtual void AbstractCellPopulationBoundaryCondition< DIM >::ImposeBoundaryCondition ( const std::vector< c_vector< double, 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

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

template<unsigned DIM>

void AbstractCellPopulationBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionInfo ( out_stream & rParamsFile ) [inline]

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 49 of file AbstractCellPopulationBoundaryCondition.cpp.

References Identifiable::GetIdentifier(), and AbstractCellPopulationBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters().

template<unsigned DIM>

void AbstractCellPopulationBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters ( out_stream & rParamsFile ) [inline, 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 59 of file AbstractCellPopulationBoundaryCondition.cpp.

Referenced by AbstractCellPopulationBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionInfo().

template<unsigned DIM>

template<class Archive >

void AbstractCellPopulationBoundaryCondition< 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 56 of file AbstractCellPopulationBoundaryCondition.hpp.

template<unsigned DIM>

virtual bool AbstractCellPopulationBoundaryCondition< 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.