Chaste Release::3.1
VolumeTrackedOffLatticeSimulation< DIM > Class Template Reference

#include <VolumeTrackedOffLatticeSimulation.hpp>

Inheritance diagram for VolumeTrackedOffLatticeSimulation< DIM >:
Collaboration diagram for VolumeTrackedOffLatticeSimulation< DIM >:

List of all members.

Public Member Functions

 VolumeTrackedOffLatticeSimulation (AbstractCellPopulation< DIM > &rCellPopulation, bool deleteCellPopulationInDestructor=false, bool initialiseCells=true)
 ~VolumeTrackedOffLatticeSimulation ()

Private Member Functions

template<class Archive >
void serialize (Archive &archive, const unsigned int version)
void SetupSolve ()
void UpdateAtEndOfTimeStep ()
void UpdateCellData ()

Friends

class boost::serialization::access

Detailed Description

template<unsigned DIM>
class VolumeTrackedOffLatticeSimulation< DIM >

Subclass of OffLatticeSimulation in which the volume of the cells is used in a CellData structure for contact inhibition below a threshold volume.

Definition at line 49 of file VolumeTrackedOffLatticeSimulation.hpp.


Constructor & Destructor Documentation

template<unsigned DIM>
VolumeTrackedOffLatticeSimulation< DIM >::VolumeTrackedOffLatticeSimulation ( AbstractCellPopulation< DIM > &  rCellPopulation,
bool  deleteCellPopulationInDestructor = false,
bool  initialiseCells = true 
)

Default constructor.

Parameters:
rCellPopulationA cell population facade class (contains a mesh and cells)
deleteCellPopulationInDestructorWhether to delete the cell population on destruction to free up memory (defaults to false)
initialiseCellswhether to initialise cells (defaults to true, set to false when loading from an archive)

Definition at line 40 of file VolumeTrackedOffLatticeSimulation.cpp.

Destructor.

Definition at line 48 of file VolumeTrackedOffLatticeSimulation.cpp.


Member Function Documentation

template<unsigned DIM>
template<class Archive >
void VolumeTrackedOffLatticeSimulation< DIM >::serialize ( Archive &  archive,
const unsigned int  version 
) [inline, private]

Archive the object and its member variables.

Parameters:
archivethe archive
versionthe current version of this class

Reimplemented from OffLatticeSimulation< DIM >.

Definition at line 62 of file VolumeTrackedOffLatticeSimulation.hpp.

template<unsigned DIM>
void VolumeTrackedOffLatticeSimulation< DIM >::SetupSolve ( ) [private, virtual]

Overridden SetupSolve() method. Calls UpdateCellData().

Reimplemented from OffLatticeSimulation< DIM >.

Definition at line 53 of file VolumeTrackedOffLatticeSimulation.cpp.

template<unsigned DIM>
void VolumeTrackedOffLatticeSimulation< DIM >::UpdateAtEndOfTimeStep ( ) [private, virtual]
template<unsigned DIM>
void VolumeTrackedOffLatticeSimulation< DIM >::UpdateCellData ( ) [private]

Compute the volume of each cell in the population and store these in the CellData.

This hack is needed because in the case of a MeshBasedCellPopulation in which multiple cell divisions have occurred over one time step, the Voronoi tessellation (while existing) is out-of-date. Thus, if we did not regenerate the Voronoi tessellation here, an assertion may trip as we try to access a Voronoi element whose index exceeds the number of elements in the out-of-date tessellation.

Todo:
work out how to properly fix this (#1986)

Definition at line 69 of file VolumeTrackedOffLatticeSimulation.cpp.

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


Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from OffLatticeSimulation< DIM >.

Definition at line 54 of file VolumeTrackedOffLatticeSimulation.hpp.


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