#include <AbstractCellPopulation.hpp>

Inheritance diagram for AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >:

Collaboration diagram for AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >:

Classes
class	Iterator

Public Member Functions
	AbstractCellPopulation (AbstractMesh< ELEMENT_DIM, SPACE_DIM > &rMesh, std::vector< CellPtr > &rCells, const std::vector< unsigned > locationIndices=std::vector< unsigned >())

virtual	~AbstractCellPopulation ()

void	InitialiseCells ()

void	SetDataOnAllCells (const std::string &rDataName, double dataValue)

AbstractMesh< ELEMENT_DIM, SPACE_DIM > &	rGetMesh ()

virtual TetrahedralMesh< ELEMENT_DIM, SPACE_DIM > *	GetTetrahedralMeshForPdeModifier ()=0

virtual bool	IsPdeNodeAssociatedWithNonApoptoticCell (unsigned pdeNodeIndex)

virtual double	GetCellDataItemAtPdeNode (unsigned pdeNodeIndex, std::string &rVariableName, bool dirichletBoundaryConditionApplies=false, double dirichletBoundaryValue=0.0)=0

std::list< CellPtr > &	rGetCells ()

virtual unsigned	GetNumNodes ()=0

virtual c_vector< double, SPACE_DIM >	GetLocationOfCellCentre (CellPtr pCell)=0

virtual Node< SPACE_DIM > *	GetNode (unsigned index)=0

virtual void	SetNode (unsigned nodeIndex, ChastePoint< SPACE_DIM > &rNewLocation)=0

virtual bool	IsCellAssociatedWithADeletedLocation (CellPtr pCell)=0

virtual void	WriteDataToVisualizerSetupFile (out_stream &pVizSetupFile)

virtual CellPtr	AddCell (CellPtr pNewCell, CellPtr pParentCell=CellPtr())=0

virtual double	GetDefaultTimeStep ()=0

virtual unsigned	RemoveDeadCells ()=0

virtual void	Update (bool hasHadBirthsOrDeaths=true)=0

std::vector< unsigned >	GetCellMutationStateCount ()

std::vector< unsigned >	GetCellProliferativeTypeCount ()

std::vector< unsigned >	GetCellCyclePhaseCount ()

unsigned	GetNumRealCells ()

unsigned	GetNumAllCells ()

void	SetCellAncestorsToLocationIndices ()

std::set< unsigned >	GetCellAncestors ()

virtual CellPtr	GetCellUsingLocationIndex (unsigned index)

std::set< CellPtr >	GetCellsUsingLocationIndex (unsigned index)

virtual bool	IsCellAttachedToLocationIndex (unsigned index)

void	SetCellUsingLocationIndex (unsigned index, CellPtr pCell)

virtual void	AddCellUsingLocationIndex (unsigned index, CellPtr pCell)

virtual void	RemoveCellUsingLocationIndex (unsigned index, CellPtr pCell)

void	MoveCellInLocationMap (CellPtr pCell, unsigned old_index, unsigned new_index)

unsigned	GetLocationIndexUsingCell (CellPtr pCell)

boost::shared_ptr< CellPropertyRegistry >	GetCellPropertyRegistry ()

void	SetDefaultCellMutationStateAndProliferativeTypeOrdering ()

virtual double	GetWidth (const unsigned &rDimension)=0

virtual double	GetVolumeOfCell (CellPtr pCell)=0

virtual std::set< unsigned >	GetNeighbouringNodeIndices (unsigned index)=0

virtual std::set< unsigned >	GetNeighbouringLocationIndices (CellPtr pCell)=0

virtual std::set< std::pair< unsigned, unsigned > >	GetNeighbouringEdgeIndices (CellPtr pCell, unsigned pEdgeIndex)

c_vector< double, SPACE_DIM >	GetCentroidOfCellPopulation ()

virtual void	UpdateCellProcessLocation ()

virtual void	OpenWritersFiles (OutputFileHandler &rOutputFileHandler)

virtual void	CloseWritersFiles ()

virtual void	WriteResultsToFiles (const std::string &rDirectory)

virtual void	AcceptPopulationWriter (boost::shared_ptr< AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM > > pPopulationWriter)=0

virtual void	AcceptPopulationCountWriter (boost::shared_ptr< AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM > > pPopulationCountWriter)=0

virtual void	AcceptPopulationEventWriter (boost::shared_ptr< AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM > > pPopulationEventWriter)=0

virtual void	AcceptCellWriter (boost::shared_ptr< AbstractCellWriter< ELEMENT_DIM, SPACE_DIM > > pCellWriter, CellPtr pCell)=0

std::vector< std::string >	GetDivisionsInformation ()

void	AddDivisionInformation (std::string divisionInformation)

void	ClearDivisionsInformation ()

std::vector< std::string >	GetRemovalsInformation ()

void	AddRemovalInformation (std::string removalInformation)

void	ClearRemovalsInformation ()

void	GenerateRemovalInformation (CellPtr pCell, std::string killerInfo)

void	KillCell (CellPtr pCell, std::string killerInfo)

void	StartApoptosisOnCell (CellPtr pCell, std::string killerInfo)

void	OutputCellPopulationInfo (out_stream &rParamsFile)

virtual void	OutputCellPopulationParameters (out_stream &rParamsFile)=0

virtual void	SimulationSetupHook (AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM > *pSimulation)

bool	GetOutputResultsForChasteVisualizer ()

template<template< unsigned, unsigned > class T>
void	AddPopulationWriter ()

template<template< unsigned, unsigned > class T>
void	AddCellWriter ()

template<template< unsigned, unsigned > class T>
void	AddCellPopulationCountWriter ()

template<template< unsigned, unsigned > class T>
void	AddCellPopulationEventWriter ()

void	AddPopulationWriter (boost::shared_ptr< AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM > > pPopulationWriter)

void	AddCellWriter (boost::shared_ptr< AbstractCellWriter< ELEMENT_DIM, SPACE_DIM > > pCellWriter)

void	AddCellPopulationCountWriter (boost::shared_ptr< AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM > > pCellPopulationCountWriter)

void	AddCellPopulationEventWriter (boost::shared_ptr< AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM > > pCellPopulationEventWriter)

template<template< unsigned, unsigned > class T>
bool	HasWriter () const

void	SetOutputResultsForChasteVisualizer (bool outputResultsForChasteVisualizer)

c_vector< double, SPACE_DIM >	GetSizeOfCellPopulation ()

virtual bool	IsRoomToDivide (CellPtr pCell)

std::pair< unsigned, unsigned >	CreateOrderedPair (unsigned index1, unsigned index2)

Iterator	Begin ()

Iterator	End ()

Public Member Functions inherited from Identifiable
virtual	~Identifiable ()

std::string	GetIdentifier () const

Protected Member Functions
virtual void	Validate ()=0

virtual void	WriteVtkResultsToFile (const std::string &rDirectory)=0

	AbstractCellPopulation (AbstractMesh< ELEMENT_DIM, SPACE_DIM > &rMesh)

virtual void	AcceptCellWritersAcrossPopulation ()

Protected Attributes
std::map< unsigned, std::set< CellPtr > >	mLocationCellMap

std::map< Cell *, unsigned >	mCellLocationMap

AbstractMesh< ELEMENT_DIM, SPACE_DIM > &	mrMesh

std::list< CellPtr >	mCells

c_vector< double, SPACE_DIM >	mCentroid

out_stream	mpVtkMetaFile

boost::shared_ptr< CellPropertyRegistry >	mpCellPropertyRegistry

bool	mOutputResultsForChasteVisualizer

std::vector< boost::shared_ptr< AbstractCellWriter< ELEMENT_DIM, SPACE_DIM > > >	mCellWriters

std::vector< boost::shared_ptr< AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM > > >	mCellPopulationWriters

std::vector< boost::shared_ptr< AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM > > >	mCellPopulationCountWriters

std::vector< boost::shared_ptr< AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM > > >	mCellPopulationEventWriters

std::vector< std::string >	mDivisionsInformation

std::vector< std::string >	mRemovalsInformation

Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)

void	OpenRoundRobinWritersFilesForAppend (OutputFileHandler &rOutputFileHandler)

void	CloseRoundRobinWritersFiles ()

Friends
class	boost::serialization::access

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >

An abstract facade class encapsulating a cell population.

Contains a group of cells and associated methods.

Template Parameters

ELEMENT_DIM	Dimension of the elements.
SPACE_DIM	Dimension of the space. If not specified, it defaults to ELEMENT_DIM.

Definition at line 82 of file AbstractCellPopulation.hpp.

Constructor & Destructor Documentation

◆ AbstractCellPopulation() [1/2]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AbstractCellPopulation ( AbstractMesh< ELEMENT_DIM, SPACE_DIM > & rMesh )

protected

Constructor that just takes in a mesh.

Parameters

rMesh the mesh for the population.

Definition at line 110 of file AbstractCellPopulation.cpp.

◆ AbstractCellPopulation() [2/2]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AbstractCellPopulation	(	AbstractMesh< ELEMENT_DIM, SPACE_DIM > &	rMesh,
		std::vector< CellPtr > &	rCells,
		const std::vector< unsigned >	locationIndices = `std::vector<unsigned>()`
	)

AbstractCellPopulation Constructor.

Note: Warning: the passed-in vector of cells will be emptied, even if the constructor throws an exception!

Parameters

rMesh	a reference to the mesh underlying the cell population
rCells	a vector of cells. Copies of the cells will be stored in the cell population, and the passed-in vector cleared.
locationIndices	an optional vector of location indices that correspond to real cells

Definition at line 68 of file AbstractCellPopulation.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::ClearDivisionsInformation(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::ClearRemovalsInformation(), EXCEPTION, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellLocationMap, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCells, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mLocationCellMap, and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mpCellPropertyRegistry.

◆ ~AbstractCellPopulation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::~AbstractCellPopulation ( )

virtual

Base class with virtual methods needs a virtual destructor.

Definition at line 116 of file AbstractCellPopulation.cpp.

Member Function Documentation

◆ AcceptCellWriter()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AcceptCellWriter	(	boost::shared_ptr< AbstractCellWriter< ELEMENT_DIM, SPACE_DIM > >	pCellWriter,
		CellPtr	pCell
	)

pure virtual

Accept a cell writer so it can write data from this object to file.

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

Parameters

pCellWriter	the population writer.
pCell	the cell whose data are being written.

Implemented in MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, and MeshBasedCellPopulation< DIM >.

◆ AcceptCellWritersAcrossPopulation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AcceptCellWritersAcrossPopulation ( )

protectedvirtual

Call AcceptCellWriter across the whole population.

By default the implementation here iterates over the cell population, but this is overridden in some classes that need to go over nodes.

Reimplemented in AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, AbstractCentreBasedCellPopulation< DIM >, MeshBasedCellPopulationWithGhostNodes< DIM >, and NodeBasedCellPopulationWithParticles< DIM >.

Definition at line 715 of file AbstractCellPopulation.cpp.

◆ AcceptPopulationCountWriter()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AcceptPopulationCountWriter ( boost::shared_ptr< AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM > > pPopulationCountWriter )

pure virtual

Accept a cell population count writer so it can write data from this object to file.

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

Parameters

pPopulationCountWriter the population count writer.

Implemented in MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, and MeshBasedCellPopulation< DIM >.

◆ AcceptPopulationEventWriter()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AcceptPopulationEventWriter ( boost::shared_ptr< AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM > > pPopulationEventWriter )

pure virtual

Accept a cell population event writer so it can write data from this object to file.

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

Parameters

pPopulationEventWriter the population event writer.

Implemented in MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, and MeshBasedCellPopulation< DIM >.

◆ AcceptPopulationWriter()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AcceptPopulationWriter ( boost::shared_ptr< AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM > > pPopulationWriter )

pure virtual

Accept a cell population writer so it can write data from this object to file.

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

Parameters

pPopulationWriter the population writer.

Implemented in MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, and MeshBasedCellPopulation< DIM >.

◆ AddCell()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual CellPtr AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCell	(	CellPtr	pNewCell,
		CellPtr	pParentCell = `CellPtr()`
	)

pure virtual

Add a new cell to the cell population.

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

Parameters

pNewCell	the cell to add
pParentCell	pointer to a parent cell (if required)

Returns: address of cell as it appears in the cell list (internal of this method uses a copy constructor along the way).

◆ AddCellPopulationCountWriter() [1/2]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

template<template< unsigned, unsigned > class T>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCellPopulationCountWriter ( )

inline

Add a cell population count writer based on its type. Template parameters are inferred from the population. The implementation of this function must be available in the header file.

Definition at line 821 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellPopulationCountWriters.

◆ AddCellPopulationCountWriter() [2/2]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCellPopulationCountWriter ( boost::shared_ptr< AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM > > pCellPopulationCountWriter )

inline

Add a cell population count writer through an input argument. This alternative to the templated AddCellPopulationCountWriter() method allows the user to, for example, add a writer with a non-default value for its member mFileName.

Parameters

pCellPopulationCountWriter shared pointer to a cell population count writer

Definition at line 871 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellPopulationCountWriters.

◆ AddCellPopulationEventWriter() [1/2]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

template<template< unsigned, unsigned > class T>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCellPopulationEventWriter ( )

inline

Add a cell population event writer based on its type. Template parameters are inferred from the population. The implementation of this function must be available in the header file.

Definition at line 832 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellPopulationEventWriters.

◆ AddCellPopulationEventWriter() [2/2]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCellPopulationEventWriter ( boost::shared_ptr< AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM > > pCellPopulationEventWriter )

inline

Add a cell population count writer through an input argument. This alternative to the templated AddCellPopulationEventWriter() method allows the user to, for example, add a writer with a non-default value for its member mFileName.

Parameters

pCellPopulationEventWriter shared pointer to a cell population event writer

Definition at line 884 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellPopulationEventWriters.

◆ AddCellUsingLocationIndex()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCellUsingLocationIndex	(	unsigned	index,
		CellPtr	pCell
	)

virtual

Adds a cell to a given location index.

Parameters

index	the location index
pCell	the cell.

Reimplemented in CaBasedCellPopulation< DIM >.

Definition at line 381 of file AbstractCellPopulation.cpp.

Referenced by AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::AbstractCentreBasedCellPopulation(), AbstractOnLatticeCellPopulation< DIM >::AbstractOnLatticeCellPopulation(), ImmersedBoundaryCellPopulation< DIM >::ImmersedBoundaryCellPopulation(), VertexBasedCellPopulation< DIM >::VertexBasedCellPopulation(), and CaBasedCellPopulation< DIM >::AddCellUsingLocationIndex().

◆ AddCellWriter() [1/2]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

template<template< unsigned, unsigned > class T>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCellWriter ( )

inline

Add a cell writer based on its type. Template parameters are inferred from the population. The implementation of this function must be available in the header file.

Definition at line 810 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellWriters.

◆ AddCellWriter() [2/2]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCellWriter ( boost::shared_ptr< AbstractCellWriter< ELEMENT_DIM, SPACE_DIM > > pCellWriter )

inline

Add a cell writer through an input argument. This alternative to the templated AddCellWriter() method allows the user to, for example, add a writer with a non-default value for its member mFileName.

Parameters

pCellWriter shared pointer to a cell writer

Definition at line 858 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellWriters.

◆ AddDivisionInformation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddDivisionInformation ( std::string divisionInformation )

Add information for a division event.

Division Time, Location of Parent Cell (x,y,z), Age on Division, Parent Cell ID, New Cell ID.

Parameters

divisionInformation division information string

Definition at line 831 of file AbstractCellPopulation.cpp.

◆ AddPopulationWriter() [1/2]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

template<template< unsigned, unsigned > class T>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddPopulationWriter ( )

inline

Add a cell population writer based on its type. Template parameters are inferred from the population. The implementation of this function must be available in the header file.

Definition at line 799 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellPopulationWriters.

◆ AddPopulationWriter() [2/2]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddPopulationWriter ( boost::shared_ptr< AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM > > pPopulationWriter )

inline

Add a cell population writer through an input argument. This alternative to the templated AddPopulationWriter() method allows the user to, for example, add a writer with a non-default value for its member mFileName.

Parameters

pPopulationWriter shared pointer to a cell population writer

Definition at line 845 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellPopulationWriters.

◆ AddRemovalInformation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddRemovalInformation ( std::string removalInformation )

Add information for a division event.

Parameters

removalInformation removal information string

Definition at line 849 of file AbstractCellPopulation.cpp.

◆ Begin()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Begin ( )

Returns: iterator pointing to the first cell in the cell population

Definition at line 1119 of file AbstractCellPopulation.hpp.

Referenced by CryptProjectionForce::AddForceContribution(), BuskeCompressionForce< DIM >::AddForceContribution(), ChemotacticForce< DIM >::AddForceContribution(), FarhadifarForce< DIM >::AddForceContribution(), NagaiHondaForce< DIM >::AddForceContribution(), RadialSloughingCellKiller::CheckAndLabelCellsForApoptosisOrDeath(), EllipticBoxDomainPdeModifier< DIM >::ConstructBoundaryConditionsContainer(), CryptProjectionStatistics::GetCryptSection(), CryptStatistics::GetCryptSection(), AbstractBoxDomainPdeModifier< DIM >::InitialiseCellPdeElementMap(), AbstractCryptStatistics::LabelAllCellsAsHealthy(), AbstractCryptStatistics::LabelSPhaseCells(), CellwiseDataGradient< DIM >::SetupGradients(), ParabolicBoxDomainPdeModifier< DIM >::SetupInitialSolutionVector(), AbstractBoxDomainPdeModifier< DIM >::UpdateCellData(), AbstractGrowingDomainPdeModifier< DIM >::UpdateCellData(), DeltaNotchEdgeInteriorTrackingModifier< DIM >::UpdateCellData(), DeltaNotchEdgeTrackingModifier< DIM >::UpdateCellData(), DeltaNotchTrackingModifier< DIM >::UpdateCellData(), DivisionBiasTrackingModifier< DIM >::UpdateCellData(), VolumeTrackingModifier< DIM >::UpdateCellData(), AbstractBoxDomainPdeModifier< DIM >::UpdateCellPdeElementMap(), CryptProjectionForce::UpdateNode3dLocationMap(), HeterotypicBoundaryLengthWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), CellPopulationAdjacencyMatrixWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), HeterotypicBoundaryLengthWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), HeterotypicBoundaryLengthWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), HeterotypicBoundaryLengthWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), HeterotypicBoundaryLengthWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), CellPopulationAdjacencyMatrixWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation(), and RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ ClearDivisionsInformation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::ClearDivisionsInformation ( )

Clear the stored division information ready for the next output step.

Definition at line 837 of file AbstractCellPopulation.cpp.

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AbstractCellPopulation(), CellDivisionLocationsWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), and CellDivisionLocationsWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ ClearRemovalsInformation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::ClearRemovalsInformation ( )

Clear the stored removal information ready for the next output step.

Definition at line 855 of file AbstractCellPopulation.cpp.

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AbstractCellPopulation(), CellRemovalLocationsWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), and CellRemovalLocationsWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ CloseRoundRobinWritersFiles()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::CloseRoundRobinWritersFiles ( )

private

Close all files in mCellPopulationWriters and mCellWriters.

Files in mCellPopulationCountWriters are NOT closed in this call since they are not written in a round-robin fashion

Definition at line 481 of file AbstractCellPopulation.cpp.

References AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::CloseFile().

◆ CloseWritersFiles()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::CloseWritersFiles ( )

virtual

Close output files associated with any writers in the members mCellPopulationCountWriters, mCellPopulationWriters and mCellWriters.

The method also closes the .pvd output file if VTK is available.

Definition at line 497 of file AbstractCellPopulation.cpp.

◆ CreateOrderedPair()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::pair< unsigned, unsigned > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::CreateOrderedPair	(	unsigned	index1,
		unsigned	index2
	)

Returns: a pair of indices ordered by node index. Used by the rest length routines.

Parameters

index1	a node index
index2	a node index

Definition at line 936 of file AbstractCellPopulation.cpp.

Referenced by MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::CalculateRestLengths(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetRestLength(), and MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SetRestLength().

◆ End()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::End ( )

Returns: iterator pointing to one past the last cell in the cell population

Definition at line 1125 of file AbstractCellPopulation.hpp.

Referenced by CryptProjectionForce::AddForceContribution(), BuskeCompressionForce< DIM >::AddForceContribution(), ChemotacticForce< DIM >::AddForceContribution(), RadialSloughingCellKiller::CheckAndLabelCellsForApoptosisOrDeath(), EllipticBoxDomainPdeModifier< DIM >::ConstructBoundaryConditionsContainer(), CryptProjectionStatistics::GetCryptSection(), CryptStatistics::GetCryptSection(), AbstractBoxDomainPdeModifier< DIM >::InitialiseCellPdeElementMap(), AbstractCryptStatistics::LabelAllCellsAsHealthy(), AbstractCryptStatistics::LabelSPhaseCells(), CellwiseDataGradient< DIM >::SetupGradients(), ParabolicBoxDomainPdeModifier< DIM >::SetupInitialSolutionVector(), AbstractBoxDomainPdeModifier< DIM >::UpdateCellData(), AbstractGrowingDomainPdeModifier< DIM >::UpdateCellData(), DeltaNotchEdgeInteriorTrackingModifier< DIM >::UpdateCellData(), DeltaNotchEdgeTrackingModifier< DIM >::UpdateCellData(), DeltaNotchTrackingModifier< DIM >::UpdateCellData(), DivisionBiasTrackingModifier< DIM >::UpdateCellData(), VolumeTrackingModifier< DIM >::UpdateCellData(), AbstractBoxDomainPdeModifier< DIM >::UpdateCellPdeElementMap(), CryptProjectionForce::UpdateNode3dLocationMap(), HeterotypicBoundaryLengthWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), CellPopulationAdjacencyMatrixWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), HeterotypicBoundaryLengthWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), HeterotypicBoundaryLengthWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), HeterotypicBoundaryLengthWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), HeterotypicBoundaryLengthWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), CellPopulationAdjacencyMatrixWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation(), and RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ GenerateRemovalInformation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GenerateRemovalInformation	(	CellPtr	pCell,
		std::string	killerInfo
	)

Helper method to store information about the removal in mRemovalInformation

Parameters

pCell	the cell
killerInfo	additional information the killer wants output i.e. the type of killer.

Definition at line 861 of file AbstractCellPopulation.cpp.

References SimulationTime::GetTime(), and SimulationTime::Instance().

◆ GetCellAncestors()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::set< unsigned > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellAncestors ( )

Loops over cells and makes a list of the ancestors that are part of the cell population.

Returns: remaining_ancestors The size of this set tells you how many clonal populations remain.

Definition at line 185 of file AbstractCellPopulation.cpp.

◆ GetCellCyclePhaseCount()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::vector< unsigned > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellCyclePhaseCount ( )

Find out how many cells in each cell cycle phase there are.

Returns: The number of cells of each phase (evaluated at each visualizer output) [0] = G_ZERO_PHASE [1] = G_ONE_PHASE [2] = S_PHASE [3] = G_TWO_PHASE [4] = M_PHASE

Definition at line 265 of file AbstractCellPopulation.cpp.

Referenced by CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), and CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ GetCellDataItemAtPdeNode()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual double AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellDataItemAtPdeNode	(	unsigned	pdeNodeIndex,
		std::string &	rVariableName,
		bool	dirichletBoundaryConditionApplies = `false`,
		double	dirichletBoundaryValue = `0.0`
	)

pure virtual

Parameters

pdeNodeIndex	index of a node in a tetrahedral mesh for use with a PDE modifier
rVariableName	the name of the cell data item to get
dirichletBoundaryConditionApplies	where a Dirichlet boundary condition is used (optional; defaults to false)
dirichletBoundaryValue	the value of the Dirichlet boundary condition, if used (optional; defaults to 0.0)

Returns: the value of a CellData item (interpolated if necessary) at a node, specified by its index in a tetrahedral mesh for use with a PDE modifier. This method can be called by PDE modifier classes.

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

Implemented in AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, AbstractCentreBasedCellPopulation< DIM >, CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, PottsBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

Referenced by ParabolicGrowingDomainPdeModifier< DIM >::UpdateSolutionVector().

◆ GetCellMutationStateCount()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::vector< unsigned > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellMutationStateCount ( )

Find out how many cells of each mutation state there are

Returns: The number of cells of each mutation state (evaluated at each visualizer output), with default ordering [0] = healthy count [1] = APC one hit [2] = APC two hit [3] = beta catenin one hit

Definition at line 196 of file AbstractCellPopulation.cpp.

Referenced by CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), and CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ GetCellProliferativeTypeCount()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::vector< unsigned > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellProliferativeTypeCount ( )

Find out how many cells of each type there are.

Returns: The number of cells of each type (evaluated at each visualizer output), with default ordering [0] = STEM [1] = TRANSIT [2] = DIFFERENTIATED [3] = DEFAULT

Definition at line 230 of file AbstractCellPopulation.cpp.

Referenced by CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), and CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ GetCellPropertyRegistry()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

boost::shared_ptr< CellPropertyRegistry > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellPropertyRegistry ( )

Returns: registry of cell properties used in this cell population.

Definition at line 423 of file AbstractCellPopulation.cpp.

Referenced by AbstractCryptStatistics::LabelAllCellsAsHealthy(), AbstractCryptStatistics::LabelSPhaseCells(), and CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::WriteHeader().

◆ GetCellsUsingLocationIndex()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::set< CellPtr > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellsUsingLocationIndex ( unsigned index )

Get the set of cells corresponding to a given location index.

Note that the set may be empty.

Parameters

index the location index

Returns: the set of cells.

Definition at line 345 of file AbstractCellPopulation.cpp.

◆ GetCellUsingLocationIndex()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

CellPtr AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellUsingLocationIndex ( unsigned index )

virtual

Get the cell corresponding to a given location index.

This method assumes that there is at most one cell attached to a location index and an assertion fails if not.

Todo:: should be an exception?

Parameters

index the location index

Returns: the cell.

Reimplemented in NodeBasedCellPopulation< DIM >.

Definition at line 324 of file AbstractCellPopulation.cpp.

References EXCEPTION.

◆ GetCentroidOfCellPopulation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

c_vector< double, SPACE_DIM > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCentroidOfCellPopulation ( )

Returns: the centroid of the cell population.

Definition at line 461 of file AbstractCellPopulation.cpp.

Referenced by DivisionBiasTrackingModifier< DIM >::UpdateCellData(), RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), and RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ GetDefaultTimeStep()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual double AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetDefaultTimeStep ( )

pure virtual

Returns: a default value for the time step to use when simulating the cell population.

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

Note that the time step can be reset by calling SetDt() on the simulation object used to simulate the cell population.

Implemented in AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, AbstractCentreBasedCellPopulation< DIM >, AbstractOnLatticeCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

Referenced by AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM >::AbstractCellBasedSimulation().

◆ GetDivisionsInformation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::vector< std::string > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetDivisionsInformation ( )

Return details of all divisions since the last sampling time step.

Returns: mDivisionsInformation

Definition at line 826 of file AbstractCellPopulation.cpp.

Referenced by CellDivisionLocationsWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), and CellDivisionLocationsWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ GetLocationIndexUsingCell()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

unsigned AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationIndexUsingCell ( CellPtr pCell )

Get the location index corresponding to a given cell.

Assumes there is one location index for each cell and an assertion fails if not.

Parameters

pCell the cell

Returns: the location index.

Definition at line 414 of file AbstractCellPopulation.cpp.

◆ GetLocationOfCellCentre()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual c_vector< double, SPACE_DIM > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationOfCellCentre ( CellPtr pCell )

pure virtual

Find where a given cell is in space.

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

Parameters

pCell the cell

Returns: the location of the cell

Implemented in AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, AbstractCentreBasedCellPopulation< DIM >, CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, PottsBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

◆ GetNeighbouringEdgeIndices()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::set< std::pair< unsigned, unsigned > > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNeighbouringEdgeIndices	(	CellPtr	pCell,
		unsigned	pEdgeIndex
	)

virtual

Gets the local edge index of the neighbouring element

Parameters

pCell	Cell pointer
pEdgeIndex	Local edge index

Returns: pair of element location and local edge index

Reimplemented in VertexBasedCellPopulation< DIM >.

Definition at line 454 of file AbstractCellPopulation.cpp.

Referenced by DeltaNotchEdgeInteriorTrackingModifier< DIM >::UpdateCellData(), and DeltaNotchEdgeTrackingModifier< DIM >::UpdateCellData().

◆ GetNeighbouringLocationIndices()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual std::set< unsigned > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNeighbouringLocationIndices ( CellPtr pCell )

pure virtual

Given a cell, returns the set of location indices corresponding to neighbouring cells.

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

Parameters

pCell a cell

Returns: the set of neighbouring location indices.

Implemented in AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, AbstractCentreBasedCellPopulation< DIM >, CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, MeshBasedCellPopulationWithGhostNodes< DIM >, PottsBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

Referenced by ImmersedBoundaryNeighbourNumberWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput(), DeltaNotchTrackingModifier< DIM >::UpdateCellData(), and CellPopulationAdjacencyMatrixWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ GetNeighbouringNodeIndices()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual std::set< unsigned > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNeighbouringNodeIndices ( unsigned index )

pure virtual

Given a node index, returns the set of neighbouring node indices.

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

Parameters

index the node index

Returns: the set of neighbouring node indices.

Implemented in AbstractOnLatticeCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, MeshBasedCellPopulation< DIM >, NodeBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

◆ GetNode()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual Node< SPACE_DIM > * AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNode ( unsigned index )

pure virtual

Get a pointer to the node with a given index.

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

Parameters

index global index of the specified node

Returns: a pointer to the node with a given index.

Implemented in CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, MeshBasedCellPopulation< DIM >, NodeBasedCellPopulation< DIM >, PottsBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

Referenced by CryptProjectionForce::AddForceContribution(), BuskeCompressionForce< DIM >::AddForceContribution(), ChemotacticForce< DIM >::AddForceContribution(), PopulationTestingForce< ELEMENT_DIM, SPACE_DIM >::AddForceContribution(), CryptProjectionForce::CalculateForceBetweenNodes(), BuskeAdhesiveForce< DIM >::CalculateForceBetweenNodes(), BuskeElasticForce< DIM >::CalculateForceBetweenNodes(), GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::CalculateForceBetweenNodes(), CellRadiusWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput(), CellAppliedForceWriter< ELEMENT_DIM, SPACE_DIM >::GetVectorCellDataForVtkOutput(), ExtrinsicPullModifier< DIM >::UpdateAtEndOfTimeStep(), and CellRadiusWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell().

◆ GetNumAllCells()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

unsigned AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNumAllCells ( )

This returns the number of cells that are present in the internal mCells vector. It also includes dead cells and cells that are associated with a deleted location in the mesh.

Returns: the number of real cells.

Definition at line 169 of file AbstractCellPopulation.cpp.

◆ GetNumNodes()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual unsigned AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNumNodes ( )

pure virtual

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

Returns: the number of nodes in the cell population.

Implemented in CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, MeshBasedCellPopulation< DIM >, NodeBasedCellPopulation< DIM >, PottsBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

Referenced by PopulationTestingForce< ELEMENT_DIM, SPACE_DIM >::AddForceContribution(), ExtrinsicPullModifier< DIM >::UpdateAtEndOfTimeStep(), and AbstractGrowingDomainPdeModifier< DIM >::UpdateCellData().

◆ GetNumRealCells()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

unsigned AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNumRealCells ( )

This counts the number of cells that the cell iterator covers. It does not include dead cells or cells that are associated with a deleted location in the mesh.

Returns: the number of real cells.

Definition at line 156 of file AbstractCellPopulation.cpp.

Referenced by CellPopulationAdjacencyMatrixWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), and CellPopulationAdjacencyMatrixWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ GetOutputResultsForChasteVisualizer()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

bool AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetOutputResultsForChasteVisualizer ( )

Returns: mOutputResultsForChasteVisualizer

Definition at line 814 of file AbstractCellPopulation.cpp.

◆ GetRemovalsInformation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::vector< std::string > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetRemovalsInformation ( )

Return details of all cell removals since the last sampling time step.

Returns: mRemovalsInformation

Definition at line 843 of file AbstractCellPopulation.cpp.

Referenced by CellRemovalLocationsWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), and CellRemovalLocationsWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ GetSizeOfCellPopulation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

c_vector< double, SPACE_DIM > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetSizeOfCellPopulation ( )

Returns: The width (maximum distance to centroid) of the cell population in each dimension

Definition at line 906 of file AbstractCellPopulation.cpp.

Referenced by NodeBasedCellPopulation< DIM >::GetSizeOfCellPopulation().

◆ GetTetrahedralMeshForPdeModifier()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual TetrahedralMesh< ELEMENT_DIM, SPACE_DIM > * AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetTetrahedralMeshForPdeModifier ( )

pure virtual

Returns: a shared to a tetrahedral mesh, for use with a PDE modifier. This method is called by AbstractGrowingDomainPdeModifier.

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

Implemented in CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, MeshBasedCellPopulation< DIM >, MeshBasedCellPopulationWithGhostNodes< DIM >, NodeBasedCellPopulation< DIM >, PottsBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

Referenced by AbstractGrowingDomainPdeModifier< DIM >::GenerateFeMesh().

◆ GetVolumeOfCell()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual double AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetVolumeOfCell ( CellPtr pCell )

pure virtual

Returns: the volume (or area in 2D, or length in 1D) of a given cell.

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

Parameters

pCell boost shared pointer to a cell

Implemented in CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, MeshBasedCellPopulation< DIM >, NodeBasedCellPopulation< DIM >, PottsBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

Referenced by CellVolumesWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput(), VolumeTrackingModifier< DIM >::UpdateCellData(), and CellVolumesWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell().

◆ GetWidth()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual double AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetWidth ( const unsigned & rDimension )

pure virtual

Calculate the 'width' of any dimension of the cell population.

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

Parameters

rDimension a dimension (0,1 or 2)

Returns: The maximum distance between any nodes in this dimension.

Implemented in CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, MeshBasedCellPopulation< DIM >, NodeBasedCellPopulation< DIM >, PottsBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

◆ HasWriter()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

template<template< unsigned, unsigned > class T>

bool AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::HasWriter ( ) const

inline

Get whether the population has a writer of the specified type.

Returns: whether the population has this writer

Definition at line 895 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellPopulationCountWriters, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellPopulationEventWriters, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellPopulationWriters, and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellWriters.

◆ InitialiseCells()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::InitialiseCells ( )

Initialise each cell's cell-cycle model.

Definition at line 121 of file AbstractCellPopulation.cpp.

◆ IsCellAssociatedWithADeletedLocation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual bool AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::IsCellAssociatedWithADeletedLocation ( CellPtr pCell )

pure virtual

Helper method for establishing if a cell is real.

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

Parameters

pCell the cell

Returns: whether a given cell is associated with a deleted node (cell-centre models) or element (vertex models).

Implemented in AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, AbstractCentreBasedCellPopulation< DIM >, CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, PottsBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

◆ IsCellAttachedToLocationIndex()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

bool AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::IsCellAttachedToLocationIndex ( unsigned index )

virtual

Returns whether or not a cell is associated with a location index

Parameters

index the location index

Returns: whether there is a cell attached.

Definition at line 352 of file AbstractCellPopulation.cpp.

Referenced by HeterotypicBoundaryLengthWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), and CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit().

◆ IsPdeNodeAssociatedWithNonApoptoticCell()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

bool AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::IsPdeNodeAssociatedWithNonApoptoticCell ( unsigned pdeNodeIndex )

virtual

Parameters

pdeNodeIndex index of a node in a tetrahedral mesh for use with a PDE modifier

Returns: if a node, specified by its index in a tetrahedral mesh for use with a PDE modifier, is associated with a non-apoptotic cell. This method can be called by PDE classes.

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

Reimplemented in CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

Definition at line 955 of file AbstractCellPopulation.cpp.

◆ IsRoomToDivide()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

bool AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::IsRoomToDivide ( CellPtr pCell )

virtual

Returns: whether there is room into which a given cell may divide. Returns true by default, but may be overridden in subclasses.

Parameters

pCell pointer to a cell

Reimplemented in CaBasedCellPopulation< DIM >.

Definition at line 900 of file AbstractCellPopulation.cpp.

◆ KillCell()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::KillCell	(	CellPtr	pCell,
		std::string	killerInfo
	)

Helper method to mark a cell as killed and store information about the removal.

Parameters

pCell	the cell
killerInfo	additional information the killer wants output i.e. the type of killer.

Definition at line 880 of file AbstractCellPopulation.cpp.

Referenced by RadialSloughingCellKiller::CheckAndLabelCellsForApoptosisOrDeath().

◆ MoveCellInLocationMap()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::MoveCellInLocationMap	(	CellPtr	pCell,
		unsigned	old_index,
		unsigned	new_index
	)

Change the location index of a cell in mLocationCellMap and mCellLocationMap

Parameters

pCell	the cell to move
old_index	the old location index
new_index	the new location index

Definition at line 404 of file AbstractCellPopulation.cpp.

Referenced by CryptShovingCaBasedDivisionRule::CalculateDaughterNodeIndex(), and ShovingCaBasedDivisionRule< SPACE_DIM >::CalculateDaughterNodeIndex().

◆ OpenRoundRobinWritersFilesForAppend()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::OpenRoundRobinWritersFilesForAppend ( OutputFileHandler & rOutputFileHandler )

private

Open all files in mCellPopulationWriters and mCellWriters in append mode for writing.

Files in mCellPopulationCountWriters are NOT opened in this call since they are not written in a round-robin fashion.

Parameters

rOutputFileHandler handler for the directory in which to open this file.

Definition at line 581 of file AbstractCellPopulation.cpp.

References AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::OpenOutputFileForAppend().

◆ OpenWritersFiles()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::OpenWritersFiles ( OutputFileHandler & rOutputFileHandler )

virtual

Open output files (and, if required, write headers) for any writers in the members mCellPopulationCountWriters, mCellPopulationWriters and mCellWriters.

The method also writes the header for the .pvd output file if VTK is available.

Before doing this, the method also creates appropriate writer objects if mOutputResultsForChasteVisualizer is set to true.

This method is public because it is called by the simulation class at the start of the Solve() call.

Parameters

rOutputFileHandler handler for the directory in which to open this file.

Reimplemented in CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, MeshBasedCellPopulation< DIM >, MeshBasedCellPopulationWithGhostNodes< DIM >, PottsBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

Definition at line 519 of file AbstractCellPopulation.cpp.

Referenced by CaBasedCellPopulation< DIM >::OpenWritersFiles(), ImmersedBoundaryCellPopulation< DIM >::OpenWritersFiles(), PottsBasedCellPopulation< DIM >::OpenWritersFiles(), and VertexBasedCellPopulation< DIM >::OpenWritersFiles().

◆ OutputCellPopulationInfo()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::OutputCellPopulationInfo ( out_stream & rParamsFile )

Outputs CellPopulation used in the simulation to file and then calls OutputCellPopulationParameters to output all relevant parameters.

Parameters

rParamsFile the file stream to which the parameters are output

Loop over cells and generate a set of cell-cycle model classes that are present in the population.

Todo:: this currently ignores different parameter regimes (#1453)

Loop over cells and generate a set of SRN model classes that are present in the population.

Todo:: this currently ignores different parameter regimes (#1453)

Definition at line 731 of file AbstractCellPopulation.cpp.

◆ OutputCellPopulationParameters()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::OutputCellPopulationParameters ( out_stream & rParamsFile )

pure virtual

Outputs CellPopulation 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

Definition at line 803 of file AbstractCellPopulation.cpp.

Referenced by AbstractOffLatticeCellPopulation< ELEMENT_DIM, SPACE_DIM >::OutputCellPopulationParameters(), and AbstractOnLatticeCellPopulation< DIM >::OutputCellPopulationParameters().

◆ RemoveCellUsingLocationIndex()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::RemoveCellUsingLocationIndex	(	unsigned	index,
		CellPtr	pCell
	)

virtual

Removes a cell from a given location index.

Parameters

index	the location index
pCell	the cell.

Reimplemented in CaBasedCellPopulation< DIM >.

Definition at line 388 of file AbstractCellPopulation.cpp.

References EXCEPTION.

Referenced by CaBasedCellPopulation< DIM >::RemoveCellUsingLocationIndex().

◆ RemoveDeadCells()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual unsigned AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::RemoveDeadCells ( )

pure virtual

Remove all cells labelled as dead.

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

Returns: number of cells removed

Implemented in CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, MeshBasedCellPopulation< DIM >, NodeBasedCellPopulation< DIM >, PottsBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

◆ rGetCells()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::list< CellPtr > & AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetCells ( )

Returns: reference to mCells.

Definition at line 150 of file AbstractCellPopulation.cpp.

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::Iterator(), and AbstractTargetAreaModifier< DIM >::UpdateTargetAreas().

◆ rGetMesh()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractMesh< ELEMENT_DIM, SPACE_DIM > & AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetMesh ( )

Returns: reference to the mesh, mrMesh.

Definition at line 144 of file AbstractCellPopulation.cpp.

Referenced by DiffusionForce< DIM >::AddForceContribution(), GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::CalculateForceBetweenNodes(), ExtrinsicPullModifier< DIM >::UpdateAtEndOfTimeStep(), ImmersedBoundarySvgWriter< DIM >::UpdateAtEndOfTimeStep(), BoundaryNodeWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation(), and NodeLocationWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ serialize()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

template<class Archive >

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::serialize	(	Archive &	archive,
		const unsigned int	version
	)

inlineprivate

Serialize the object and its member variables.

Parameters

archive	the archive
version	the current version of this class

Definition at line 96 of file AbstractCellPopulation.hpp.

◆ SetCellAncestorsToLocationIndices()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::SetCellAncestorsToLocationIndices ( )

Sets the Ancestor index of all the cells at this time to be the same as their location index, can be used to trace clonal populations.

Definition at line 175 of file AbstractCellPopulation.cpp.

References MAKE_PTR_ARGS.

◆ SetCellUsingLocationIndex()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::SetCellUsingLocationIndex	(	unsigned	index,
		CellPtr	pCell
	)

Set the cell corresponding to a given location index.

Assumes there is one cell for each location index and replaces any existing cell attached to the location index. If you wish to attach an additional cell to a location index use AddCellUsingLocaitonIndex as SetCellUsingLocation Index will overwrite cells attached to this index.

Parameters

index	the location index
pCell	the cell.

Definition at line 367 of file AbstractCellPopulation.cpp.

◆ SetDataOnAllCells()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::SetDataOnAllCells	(	const std::string &	rDataName,
		double	dataValue
	)

Add an item of cell data to every cell in the population

Parameters

rDataName	is the name associated with the data
dataValue	is the value of the data, initially the same for each cell

Definition at line 133 of file AbstractCellPopulation.cpp.

◆ SetDefaultCellMutationStateAndProliferativeTypeOrdering()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::SetDefaultCellMutationStateAndProliferativeTypeOrdering ( )

Set a default ordering on cell mutation states and cell proliferative types, so that existing tests don't need to specify the old ordering explicitly.

Definition at line 429 of file AbstractCellPopulation.cpp.

Referenced by CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::WriteHeader().

◆ SetNode()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::SetNode	(	unsigned	nodeIndex,
		ChastePoint< SPACE_DIM > &	rNewLocation
	)

pure virtual

Move the node with a given index to a new point in space.

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

Parameters

nodeIndex	the index of the node to be moved
rNewLocation	the new target location of the node

Implemented in MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, MeshBasedCellPopulation< DIM >, AbstractOffLatticeCellPopulation< ELEMENT_DIM, SPACE_DIM >, AbstractOffLatticeCellPopulation< DIM >, and AbstractOffLatticeCellPopulation< ELEMENT_DIM, ELEMENT_DIM >.

◆ SetOutputResultsForChasteVisualizer()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::SetOutputResultsForChasteVisualizer ( bool outputResultsForChasteVisualizer )

Set mOutputResultsForChasteVisualizer.

Parameters

outputResultsForChasteVisualizer the new value of mOutputResultsForChasteVisualizer

Definition at line 820 of file AbstractCellPopulation.cpp.

◆ SimulationSetupHook()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::SimulationSetupHook ( AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM > * pSimulation )

virtual

Empty hook method to provide the ability to specify some additional property of a cell-based simulation object.

This method is called immediately prior to calling SetupSolve() within the Solve() method in AbstractCellBasedSimulation.

This method can be overridden, for example, to add a T2SwapCellKiller to the simulation object in the case of a VertexBasedCellPopulation. This functionality avoids the need for static or dynamic casts to specific cell population types within simulation methods.

Parameters

pSimulation pointer to a cell-based simulation object

Definition at line 809 of file AbstractCellPopulation.cpp.

◆ StartApoptosisOnCell()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::StartApoptosisOnCell	(	CellPtr	pCell,
		std::string	killerInfo
	)

Helper method to mark a cell as starting apoptosis and store information about the removal.

Parameters

pCell	the cell
killerInfo	additional information the killer wants output i.e. the type of killer.

Definition at line 890 of file AbstractCellPopulation.cpp.

◆ Update()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Update ( bool hasHadBirthsOrDeaths = true )

pure virtual

Remove the Nodes (for cell-centre) or VertexElements (for cell-vertex) which have been marked as deleted and update the correspondence with Cells.

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

Parameters

hasHadBirthsOrDeaths - a bool saying whether cell population has had Births Or Deaths

Implemented in CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, MeshBasedCellPopulation< DIM >, NodeBasedCellPopulation< DIM >, PottsBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

Referenced by DeltaNotchTrackingModifier< DIM >::UpdateCellData(), DivisionBiasTrackingModifier< DIM >::UpdateCellData(), VolumeTrackingModifier< DIM >::UpdateCellData(), and CellPopulationAdjacencyMatrixWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

◆ UpdateCellProcessLocation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::UpdateCellProcessLocation ( )

virtual

Update the ownership of cell in a parallel cell-based simulation.

Reimplemented in NodeBasedCellPopulation< DIM >.

Definition at line 476 of file AbstractCellPopulation.cpp.

◆ Validate()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Validate ( )

protectedpure virtual

Check consistency of our internal data structures.

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

Implemented in CaBasedCellPopulation< DIM >, ImmersedBoundaryCellPopulation< DIM >, MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, MeshBasedCellPopulation< DIM >, MeshBasedCellPopulationWithGhostNodes< DIM >, NodeBasedCellPopulation< DIM >, NodeBasedCellPopulationWithParticles< DIM >, PottsBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

◆ WriteDataToVisualizerSetupFile()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::WriteDataToVisualizerSetupFile ( out_stream & pVizSetupFile )

virtual

Write any data necessary to a visualization setup file. Used by AbstractCellBasedSimulation::WriteVisualizerSetupFile().

Parameters

pVizSetupFile a visualization setup file

Reimplemented in MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, MeshBasedCellPopulation< DIM >, and VertexBasedCellPopulation< DIM >.

Definition at line 362 of file AbstractCellPopulation.cpp.

◆ WriteResultsToFiles()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::WriteResultsToFiles ( const std::string & rDirectory )

virtual

Write results from the current cell population state to output files.

Parameters

rDirectory pathname of the output directory, relative to where Chaste output is stored

Reimplemented in MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >, MeshBasedCellPopulation< 1 >, MeshBasedCellPopulation< 2 >, MeshBasedCellPopulation< DIM >, and PottsBasedCellPopulation< DIM >.

Definition at line 596 of file AbstractCellPopulation.cpp.

References PetscTools::BeginRoundRobin().

Referenced by PottsBasedCellPopulation< DIM >::WriteResultsToFiles().

◆ WriteVtkResultsToFile()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::WriteVtkResultsToFile ( const std::string & rDirectory )

protectedpure virtual

Write the current results to mpVtkMetaFile.

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

Parameters

rDirectory pathname of the output directory, relative to where Chaste output is stored

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 87 of file AbstractCellPopulation.hpp.

Member Data Documentation

◆ mCellLocationMap

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::map<Cell*, unsigned> AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellLocationMap

protected

Map cells to location (node or VertexElement) indices.

Definition at line 133 of file AbstractCellPopulation.hpp.

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AbstractCellPopulation(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::serialize().

◆ mCellPopulationCountWriters

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::vector<boost::shared_ptr<AbstractCellPopulationCountWriter<ELEMENT_DIM, SPACE_DIM> > > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellPopulationCountWriters

protected

A list of cell population count writers.

Definition at line 160 of file AbstractCellPopulation.hpp.

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCellPopulationCountWriter(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCellPopulationCountWriter(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::HasWriter(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::serialize().

◆ mCellPopulationEventWriters

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::vector<boost::shared_ptr<AbstractCellPopulationEventWriter<ELEMENT_DIM, SPACE_DIM> > > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellPopulationEventWriters

protected

A list of cell population event writers.

Definition at line 163 of file AbstractCellPopulation.hpp.

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCellPopulationEventWriter(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCellPopulationEventWriter(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::HasWriter().

◆ mCellPopulationWriters

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::vector<boost::shared_ptr<AbstractCellPopulationWriter<ELEMENT_DIM, SPACE_DIM> > > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellPopulationWriters

protected

A list of cell population writers.

Definition at line 157 of file AbstractCellPopulation.hpp.

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddPopulationWriter(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddPopulationWriter(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::HasWriter(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::serialize().

◆ mCells

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::list<CellPtr> AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCells

protected

List of cells.

Definition at line 139 of file AbstractCellPopulation.hpp.

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AbstractCellPopulation(), AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::AbstractCentreBasedCellPopulation(), ImmersedBoundaryCellPopulation< DIM >::ImmersedBoundaryCellPopulation(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::MeshBasedCellPopulation(), VertexBasedCellPopulation< DIM >::VertexBasedCellPopulation(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::CheckCellPointers(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::serialize().

◆ mCellWriters

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::vector<boost::shared_ptr<AbstractCellWriter<ELEMENT_DIM, SPACE_DIM> > > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCellWriters

protected

A list of cell writers.

Definition at line 154 of file AbstractCellPopulation.hpp.

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCellWriter(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AddCellWriter(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::HasWriter(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::serialize().

◆ mCentroid

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

c_vector<double, SPACE_DIM> AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mCentroid

protected

Population centroid.

Definition at line 142 of file AbstractCellPopulation.hpp.

◆ mDivisionsInformation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::vector<std::string> AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mDivisionsInformation

protected

Details of cell divisions, to be used by CellDivisionLocationsWriter The locations are stored until they are cleared by ClearDivisionsInformation().

Definition at line 169 of file AbstractCellPopulation.hpp.

◆ mLocationCellMap

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::map<unsigned, std::set<CellPtr> > AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mLocationCellMap

protected

Map location (node or VertexElement) indices back to cells.

Definition at line 130 of file AbstractCellPopulation.hpp.

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AbstractCellPopulation(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::serialize().

◆ mOutputResultsForChasteVisualizer

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

bool AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mOutputResultsForChasteVisualizer

protected

Whether to write results to file for visualization using the Chaste java visualizer (defaults to true).

Definition at line 151 of file AbstractCellPopulation.hpp.

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::serialize().

◆ mpCellPropertyRegistry

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

boost::shared_ptr<CellPropertyRegistry> AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mpCellPropertyRegistry

protected

Cell property registry.

Definition at line 148 of file AbstractCellPopulation.hpp.

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::AbstractCellPopulation(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::serialize().

◆ mpVtkMetaFile

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

out_stream AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mpVtkMetaFile

protected

Meta results file for VTK.

Definition at line 145 of file AbstractCellPopulation.hpp.

◆ mRemovalsInformation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::vector<std::string> AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mRemovalsInformation

protected

Details of cell removals, to be used by CellRemovalLocationsWriter The locations are stored until they are cleared by ClearRemovalsInformation().

Definition at line 175 of file AbstractCellPopulation.hpp.

◆ mrMesh

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractMesh<ELEMENT_DIM, SPACE_DIM>& AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::mrMesh

protected

Reference to the mesh.

Definition at line 136 of file AbstractCellPopulation.hpp.

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

cell_based/src/population/AbstractCellPopulation.hpp
cell_based/src/population/AbstractCellPopulation.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ AbstractCellPopulation() [1/2]

◆ AbstractCellPopulation() [2/2]

◆ ~AbstractCellPopulation()

Member Function Documentation

◆ AcceptCellWriter()

◆ AcceptCellWritersAcrossPopulation()

◆ AcceptPopulationCountWriter()

◆ AcceptPopulationEventWriter()

◆ AcceptPopulationWriter()

◆ AddCell()

◆ AddCellPopulationCountWriter() [1/2]

◆ AddCellPopulationCountWriter() [2/2]

◆ AddCellPopulationEventWriter() [1/2]

◆ AddCellPopulationEventWriter() [2/2]

◆ AddCellUsingLocationIndex()

◆ AddCellWriter() [1/2]

◆ AddCellWriter() [2/2]

◆ AddDivisionInformation()

◆ AddPopulationWriter() [1/2]

◆ AddPopulationWriter() [2/2]

◆ AddRemovalInformation()

◆ Begin()

◆ ClearDivisionsInformation()

◆ ClearRemovalsInformation()

◆ CloseRoundRobinWritersFiles()

◆ CloseWritersFiles()

◆ CreateOrderedPair()

◆ End()

◆ GenerateRemovalInformation()

◆ GetCellAncestors()

◆ GetCellCyclePhaseCount()

◆ GetCellDataItemAtPdeNode()

◆ GetCellMutationStateCount()

◆ GetCellProliferativeTypeCount()

◆ GetCellPropertyRegistry()

◆ GetCellsUsingLocationIndex()

◆ GetCellUsingLocationIndex()

◆ GetCentroidOfCellPopulation()

◆ GetDefaultTimeStep()

◆ GetDivisionsInformation()

◆ GetLocationIndexUsingCell()

◆ GetLocationOfCellCentre()

◆ GetNeighbouringEdgeIndices()

◆ GetNeighbouringLocationIndices()

◆ GetNeighbouringNodeIndices()

◆ GetNode()

◆ GetNumAllCells()

◆ GetNumNodes()

◆ GetNumRealCells()

◆ GetOutputResultsForChasteVisualizer()

◆ GetRemovalsInformation()

◆ GetSizeOfCellPopulation()

◆ GetTetrahedralMeshForPdeModifier()

◆ GetVolumeOfCell()

◆ GetWidth()

◆ HasWriter()

◆ InitialiseCells()

◆ IsCellAssociatedWithADeletedLocation()

◆ IsCellAttachedToLocationIndex()

◆ IsPdeNodeAssociatedWithNonApoptoticCell()

◆ IsRoomToDivide()

◆ KillCell()

◆ MoveCellInLocationMap()

◆ OpenRoundRobinWritersFilesForAppend()

◆ OpenWritersFiles()

◆ OutputCellPopulationInfo()

◆ OutputCellPopulationParameters()

◆ RemoveCellUsingLocationIndex()

◆ RemoveDeadCells()

◆ rGetCells()

◆ rGetMesh()

◆ serialize()