CellsGenerator< CELL_CYCLE_MODEL, DIM > Class Template Reference

#include <CellsGenerator.hpp>

Inheritance diagram for CellsGenerator< CELL_CYCLE_MODEL, DIM >:

Inheritance graph
[legend]

List of all members.

Public Member Functions

void GenerateBasic (std::vector< CellPtr > &rCells, unsigned numCells, const std::vector< unsigned > locationIndices=std::vector< unsigned >(), CellProliferativeType cellProliferativeType=STEM)
void GenerateBasicRandom (std::vector< CellPtr > &rCells, unsigned numCells, CellProliferativeType cellProliferativeType=STEM)
void GenerateGivenLocationIndices (std::vector< CellPtr > &rCells, const std::vector< unsigned > locationIndices)


Detailed Description

template<class CELL_CYCLE_MODEL, unsigned DIM>
class CellsGenerator< CELL_CYCLE_MODEL, DIM >

A helper class for generating a vector of cells for a given mesh.

It is templated over types of cell-cycle model and spatial dimension.

Definition at line 44 of file CellsGenerator.hpp.


Member Function Documentation

template<class CELL_CYCLE_MODEL, unsigned DIM>
void CellsGenerator< CELL_CYCLE_MODEL, DIM >::GenerateBasic ( std::vector< CellPtr > &  rCells,
unsigned  numCells,
const std::vector< unsigned >  locationIndices = std::vector<unsigned>(),
CellProliferativeType  cellProliferativeType = STEM 
) [inline]

Fills a vector of cells with a specified cell-cycle model, to match a given number of cells. Gives them birth times of 0 for node 0, -1 for node 1, -2 for node 2 etc...

Parameters:
rCells An empty vector of cells to fill up.
numCells The number of cells to generate.
locationIndices is used when a birth-time hint is needed for individual cell. Defaults to an empty vector -- otherwise must be of length numCells
cellProliferativeType the cell proliferative type to give each cell (defaults to STEM)

Definition at line 88 of file CellsGenerator.hpp.

References CellPropertyRegistry::Clear(), EXCEPTION, and CellPropertyRegistry::Instance().

template<class CELL_CYCLE_MODEL, unsigned DIM>
void CellsGenerator< CELL_CYCLE_MODEL, DIM >::GenerateBasicRandom ( std::vector< CellPtr > &  rCells,
unsigned  numCells,
CellProliferativeType  cellProliferativeType = STEM 
) [inline]

Fills a vector of cells with a specified cell-cycle model, to match a given number of cells. Gives cells a random birth time drawn uniformly from 0 to the AverageStemCellCycleTime.

Parameters:
rCells An empty vector of cells to fill up.
numCells The number of cells to generate.
cellProliferativeType the cell proliferative type to give each cell (defaults to STEM)

Definition at line 131 of file CellsGenerator.hpp.

References CellPropertyRegistry::Clear(), RandomNumberGenerator::Instance(), CellPropertyRegistry::Instance(), and RandomNumberGenerator::ranf().

template<class CELL_CYCLE_MODEL, unsigned DIM>
void CellsGenerator< CELL_CYCLE_MODEL, DIM >::GenerateGivenLocationIndices ( std::vector< CellPtr > &  rCells,
const std::vector< unsigned >  locationIndices 
) [inline]

Fills a vector of cells with birth times to match a given vector of location indices.

Parameters:
rCells An empty vector of cells to fill up.
locationIndices The indices of the cell population to assign real cells to.

Definition at line 162 of file CellsGenerator.hpp.

References CellPropertyRegistry::Clear(), and CellPropertyRegistry::Instance().


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

Generated on Mon Apr 18 11:36:42 2011 for Chaste by  doxygen 1.5.5