CryptSimulationBoundaryCondition< DIM > Class Template Reference

#include <CryptSimulationBoundaryCondition.hpp>

Inherits AbstractCellPopulationBoundaryCondition< DIM >.

Collaboration diagram for CryptSimulationBoundaryCondition< DIM >:

Public Member Functions
	CryptSimulationBoundaryCondition (AbstractCellPopulation< DIM > *pCellPopulation)
void	ImposeBoundaryCondition (const std::vector< c_vector< double, DIM > > &rOldLocations)
bool	VerifyBoundaryCondition ()
void	SetUseJiggledBottomCells (bool useJiggledBottomCells)
bool	GetUseJiggledBottomCells ()
void	OutputCellPopulationBoundaryConditionParameters (out_stream &rParamsFile)
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
bool	mUseJiggledBottomCells
Friends
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class CryptSimulationBoundaryCondition< DIM >

A boundary condition class for use with CryptSimulation2d, which pins stem cells in the absence of a Wnt stimulus, and optionally prevents cells moving below the y=0 boundary via random jiggling.

Definition at line 44 of file CryptSimulationBoundaryCondition.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

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

Constructor.

Parameters:

pCellPopulation

pointer to the cell population

Definition at line 35 of file CryptSimulationBoundaryCondition.cpp.

Member Function Documentation

template<unsigned DIM>

bool CryptSimulationBoundaryCondition< DIM >::GetUseJiggledBottomCells ( ) [inline]

Get method for mUseJiggledBottomCells.

Definition at line 186 of file CryptSimulationBoundaryCondition.cpp.

References CryptSimulationBoundaryCondition< DIM >::mUseJiggledBottomCells.

template<unsigned DIM>

void CryptSimulationBoundaryCondition< DIM >::ImposeBoundaryCondition ( const std::vector< c_vector< double, DIM > > & rOldLocations ) [inline, virtual]

Overridden ImposeBoundaryCondition() method.

Apply the cell population boundary conditions.

Parameters:

rOldLocations

the node locations before any boundary conditions are applied

Implements AbstractCellPopulationBoundaryCondition< DIM >.

Definition at line 42 of file CryptSimulationBoundaryCondition.cpp.

References RandomNumberGenerator::Instance(), AbstractCellPopulationBoundaryCondition< DIM >::mpCellPopulation, CryptSimulationBoundaryCondition< DIM >::mUseJiggledBottomCells, RandomNumberGenerator::ranf(), Node< SPACE_DIM >::rGetLocation(), and Node< SPACE_DIM >::rGetModifiableLocation().

template<unsigned DIM>

void CryptSimulationBoundaryCondition< 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

Todo:: Can we abstract these XML out methods and do automatic indentation?

Implements AbstractCellPopulationBoundaryCondition< DIM >.

Definition at line 192 of file CryptSimulationBoundaryCondition.cpp.

References CryptSimulationBoundaryCondition< DIM >::mUseJiggledBottomCells.

template<unsigned DIM>

template<class Archive >

void CryptSimulationBoundaryCondition< 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 from AbstractCellPopulationBoundaryCondition< DIM >.

Definition at line 63 of file CryptSimulationBoundaryCondition.hpp.

References CryptSimulationBoundaryCondition< DIM >::mUseJiggledBottomCells.

template<unsigned DIM>

void CryptSimulationBoundaryCondition< DIM >::SetUseJiggledBottomCells ( bool useJiggledBottomCells ) [inline]

Set method for mUseJiggledBottomCells

Parameters:

useJiggledBottomCells

whether to jiggle the cells on the bottom surface

Definition at line 180 of file CryptSimulationBoundaryCondition.cpp.

References CryptSimulationBoundaryCondition< DIM >::mUseJiggledBottomCells.

template<unsigned DIM>

bool CryptSimulationBoundaryCondition< 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.