#include <Owen2011MigrationRule.hpp>

Inheritance diagram for Owen2011MigrationRule< DIM >:

Collaboration diagram for Owen2011MigrationRule< DIM >:

Public Member Functions
	Owen2011MigrationRule ()

virtual	~Owen2011MigrationRule ()

std::vector< int >	GetIndices (const std::vector< boost::shared_ptr< VesselNode< DIM > > > &rNodes)

void	SetCellChemotacticParameter (units::quantity< unit::diffusivity_per_concentration > cellChemotacticParameter)

void	SetCellMotilityParameter (units::quantity< unit::diffusivity > cellMotility)

Public Member Functions inherited from LatticeBasedMigrationRule< DIM >
	LatticeBasedMigrationRule ()

virtual	~LatticeBasedMigrationRule ()

void	SetMovementProbability (double movementProbability)

Public Member Functions inherited from AbstractMigrationRule< DIM >
	AbstractMigrationRule ()

virtual	~AbstractMigrationRule ()

virtual std::vector< DimensionalChastePoint< DIM > >	GetDirections (const std::vector< boost::shared_ptr< VesselNode< DIM > > > &rNodes)

void	SetIsSprouting (bool isSprouting=true)

void	SetDiscreteContinuumSolver (boost::shared_ptr< AbstractDiscreteContinuumSolver< DIM > > pSolver)

void	SetNetwork (boost::shared_ptr< VesselNetwork< DIM > > pNetwork)

void	SetBoundingDomain (boost::shared_ptr< Part< DIM > > pPart)

void	SetGrid (boost::shared_ptr< RegularGrid< DIM > > pGrid)

void	SetCellPopulation (boost::shared_ptr< AbstractCellPopulation< DIM > > pCellPopulation)

Static Public Member Functions
static boost::shared_ptr< Owen2011MigrationRule< DIM > >	Create ()

Static Public Member Functions inherited from LatticeBasedMigrationRule< DIM >
static boost::shared_ptr< LatticeBasedMigrationRule< DIM > >	Create ()

Static Public Member Functions inherited from AbstractMigrationRule< DIM >
static boost::shared_ptr< AbstractMigrationRule< DIM > >	Create ()

Protected Attributes
units::quantity< unit::diffusivity >	mCellMotility

units::quantity< unit::diffusivity_per_concentration >	mCellChemotacticParameter

std::vector< units::quantity< unit::concentration > >	mVegfField

Protected Attributes inherited from LatticeBasedMigrationRule< DIM >
double	mMovementProbability

Protected Attributes inherited from AbstractMigrationRule< DIM >
boost::shared_ptr< AbstractDiscreteContinuumSolver< DIM > >	mpSolver

boost::shared_ptr< VesselNetwork< DIM > >	mpVesselNetwork

bool	mIsSprouting

boost::shared_ptr< AbstractCellPopulation< DIM > >	mpCellPopulation

boost::shared_ptr< RegularGrid< DIM > >	mpGrid

boost::shared_ptr< Part< DIM > >	mpBoundingDomain

Private Member Functions
std::vector< double >	GetNeighbourMovementProbabilities (boost::shared_ptr< VesselNode< DIM > > pNode, std::vector< unsigned > neighbourIndices, unsigned gridIndex)

Additional Inherited Members
Protected Member Functions inherited from LatticeBasedMigrationRule< DIM >
virtual int	GetNeighbourMovementIndex (std::vector< double > movementProbabilities, std::vector< unsigned > neighbourIndices)

Detailed Description

template<unsigned DIM>
class Owen2011MigrationRule< DIM >

A concrete migration rule for lattice based simulations based on a model described in Owen et al. 2011. Default parameter values are taken from that study.

Definition at line 53 of file Owen2011MigrationRule.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

Owen2011MigrationRule< DIM >::Owen2011MigrationRule ( )

Constructor.

Definition at line 45 of file Owen2011MigrationRule.cpp.

template<unsigned DIM>

Owen2011MigrationRule< DIM >::~Owen2011MigrationRule ( )

virtual

Destructor.

Definition at line 62 of file Owen2011MigrationRule.cpp.

Member Function Documentation

template<unsigned DIM>

boost::shared_ptr< Owen2011MigrationRule< DIM > > Owen2011MigrationRule< DIM >::Create ( )

static

Construct a new instance of the class and return a shared pointer to it.

Returns: a pointer to a new instance of the class

Definition at line 55 of file Owen2011MigrationRule.cpp.

template<unsigned DIM>

std::vector< int > Owen2011MigrationRule< DIM >::GetIndices ( const std::vector< boost::shared_ptr< VesselNode< DIM > > > & rNodes )

virtual

Calculate the grid index that each migrating node will move into. Set to -1 if the node does not move.

Parameters

rNodes nodes to calculate indices

Returns: a vector of grid indices to move nodes into

Reimplemented from LatticeBasedMigrationRule< DIM >.

Definition at line 80 of file Owen2011MigrationRule.cpp.

References LatticeBasedMigrationRule< DIM >::GetIndices(), AbstractMigrationRule< DIM >::mpGrid, AbstractMigrationRule< DIM >::mpSolver, and Owen2011MigrationRule< DIM >::mVegfField.

template<unsigned DIM>

std::vector< double > Owen2011MigrationRule< DIM >::GetNeighbourMovementProbabilities	(	boost::shared_ptr< VesselNode< DIM > >	pNode,
		std::vector< unsigned >	neighbourIndices,
		unsigned	gridIndex
	)

privatevirtual

Get the probabilities for movement into each lattice point in the node's neighbourhood. This can be over-written for custom movement rules.

Parameters

pNode	the sprouting node
neighbourIndices	the grid indices of the neighbour nodes
gridIndex	the grid index

Returns: a vector of movement probabilities corresponding to each neighbour index

Reimplemented from LatticeBasedMigrationRule< DIM >.

Definition at line 94 of file Owen2011MigrationRule.cpp.

References BaseUnits::GetReferenceTimeScale(), BaseUnits::Instance(), Owen2011MigrationRule< DIM >::mCellChemotacticParameter, Owen2011MigrationRule< DIM >::mCellMotility, AbstractMigrationRule< DIM >::mpGrid, and Owen2011MigrationRule< DIM >::mVegfField.

template<unsigned DIM>

void Owen2011MigrationRule< DIM >::SetCellChemotacticParameter ( units::quantity< unit::diffusivity_per_concentration > cellChemotacticParameter )

Set the cell chemotactic parameter

Parameters

cellChemotacticParameter the cell chemotactic parameter

Definition at line 68 of file Owen2011MigrationRule.cpp.

References Owen2011MigrationRule< DIM >::mCellChemotacticParameter.

template<unsigned DIM>

void Owen2011MigrationRule< DIM >::SetCellMotilityParameter ( units::quantity< unit::diffusivity > cellMotility )

Set the cell motility parameter

Parameters

cellMotility the cell motility parameter

Definition at line 74 of file Owen2011MigrationRule.cpp.

References Owen2011MigrationRule< DIM >::mCellMotility.

Member Data Documentation

template<unsigned DIM>

units::quantity<unit::diffusivity_per_concentration> Owen2011MigrationRule< DIM >::mCellChemotacticParameter

protected

Cell chemotactic sensitivity

Definition at line 66 of file Owen2011MigrationRule.hpp.

Referenced by Owen2011MigrationRule< DIM >::GetNeighbourMovementProbabilities(), and Owen2011MigrationRule< DIM >::SetCellChemotacticParameter().

template<unsigned DIM>

units::quantity<unit::diffusivity> Owen2011MigrationRule< DIM >::mCellMotility

protected

Cell motility for random walks

Definition at line 61 of file Owen2011MigrationRule.hpp.

Referenced by Owen2011MigrationRule< DIM >::GetNeighbourMovementProbabilities(), and Owen2011MigrationRule< DIM >::SetCellMotilityParameter().

template<unsigned DIM>

std::vector<units::quantity<unit::concentration> > Owen2011MigrationRule< DIM >::mVegfField

protected

Vegf field sampled on the vessel lattice

Definition at line 71 of file Owen2011MigrationRule.hpp.

Referenced by Owen2011MigrationRule< DIM >::GetIndices(), and Owen2011MigrationRule< DIM >::GetNeighbourMovementProbabilities().

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

projects/MicrovesselChaste/src/simulation/angiogenesis/migration_rules/lattice/Owen2011MigrationRule.hpp
projects/MicrovesselChaste/src/simulation/angiogenesis/migration_rules/lattice/Owen2011MigrationRule.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

template<unsigned DIM> class Owen2011MigrationRule< DIM >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<unsigned DIM>
class Owen2011MigrationRule< DIM >