Chaste  Build::
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
AbstractMigrationRule< DIM > Class Template Reference

#include <AbstractMigrationRule.hpp>

+ Inheritance diagram for AbstractMigrationRule< DIM >:
+ Collaboration diagram for AbstractMigrationRule< DIM >:

Public Member Functions

 AbstractMigrationRule ()
 
virtual ~AbstractMigrationRule ()
 
virtual std::vector< DimensionalChastePoint< DIM > > GetDirections (const std::vector< boost::shared_ptr< VesselNode< DIM > > > &rNodes)
 
virtual std::vector< int > GetIndices (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< AbstractMigrationRule< DIM > > Create ()
 

Protected Attributes

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
 

Detailed Description

template<unsigned DIM>
class AbstractMigrationRule< DIM >

Abstract class for implementing a vessel tip cell migration rule. On and off-lattice specializations are implemented in subclasses.

Definition at line 54 of file AbstractMigrationRule.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>
AbstractMigrationRule< DIM >::AbstractMigrationRule ( )

Constructor.

Definition at line 39 of file AbstractMigrationRule.cpp.

template<unsigned DIM>
AbstractMigrationRule< DIM >::~AbstractMigrationRule ( )
virtual

Destructor.

Definition at line 51 of file AbstractMigrationRule.cpp.

Member Function Documentation

template<unsigned DIM>
boost::shared_ptr< AbstractMigrationRule< DIM > > AbstractMigrationRule< DIM >::Create ( )
static

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

Returns
a shared pointer to the class instance

Definition at line 57 of file AbstractMigrationRule.cpp.

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

Get the sprout directions

Parameters
rNodescandidate sprout nodes
Returns
the sprout directions

Reimplemented in OffLatticeMigrationRule< DIM >.

Definition at line 64 of file AbstractMigrationRule.cpp.

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

Get the sprout indices

Parameters
rNodescandidate sprout nodes
Returns
the sprout indices

Reimplemented in Owen2011MigrationRule< DIM >, CellPopulationMigrationRule< DIM >, and LatticeBasedMigrationRule< DIM >.

Definition at line 70 of file AbstractMigrationRule.cpp.

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

Set the bounding domain

Parameters
pPartthe bounding domain

Definition at line 76 of file AbstractMigrationRule.cpp.

References AbstractMigrationRule< DIM >::mpBoundingDomain.

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

Set the cell population

Parameters
pCellPopulationthe cell population

Definition at line 106 of file AbstractMigrationRule.cpp.

References AbstractMigrationRule< DIM >::mpCellPopulation.

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

Set the DiscreteContinuum solver containing the stimulus field

Parameters
pSolverthe DiscreteContinuum solver containing the stimulus field

Definition at line 94 of file AbstractMigrationRule.cpp.

References AbstractMigrationRule< DIM >::mpSolver.

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

Set the lattice/grid for the vessel network

Parameters
pGridthe grid for the vessel network

Definition at line 88 of file AbstractMigrationRule.cpp.

References AbstractMigrationRule< DIM >::mpGrid.

template<unsigned DIM>
void AbstractMigrationRule< DIM >::SetIsSprouting ( bool  isSprouting = true)

Set whether this is a sprouting event

Parameters
isSproutingis this a sprouting event

Definition at line 82 of file AbstractMigrationRule.cpp.

References AbstractMigrationRule< DIM >::mIsSprouting.

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

Set the vessel network

Parameters
pNetworkthe vessel network

Definition at line 100 of file AbstractMigrationRule.cpp.

References AbstractMigrationRule< DIM >::mpVesselNetwork.

Member Data Documentation

template<unsigned DIM>
bool AbstractMigrationRule< DIM >::mIsSprouting
protected

Distinguish between sprouting and migrating events

Definition at line 72 of file AbstractMigrationRule.hpp.

Referenced by OffLatticeMigrationRule< DIM >::GetDirections(), and AbstractMigrationRule< DIM >::SetIsSprouting().

template<unsigned DIM>
boost::shared_ptr<Part<DIM> > AbstractMigrationRule< DIM >::mpBoundingDomain
protected

The bounding domain, optional

Definition at line 87 of file AbstractMigrationRule.hpp.

Referenced by OffLatticeMigrationRule< DIM >::GetDirections(), OffLatticeMigrationRule< DIM >::GetDirectionsForSprouts(), and AbstractMigrationRule< DIM >::SetBoundingDomain().

template<unsigned DIM>
boost::shared_ptr<AbstractCellPopulation<DIM> > AbstractMigrationRule< DIM >::mpCellPopulation
protected

The cell population, only used in certain child classes

Definition at line 77 of file AbstractMigrationRule.hpp.

Referenced by CellPopulationMigrationRule< DIM >::GetIndices(), and AbstractMigrationRule< DIM >::SetCellPopulation().

template<unsigned DIM>
boost::shared_ptr<RegularGrid<DIM> > AbstractMigrationRule< DIM >::mpGrid
protected

A regular grid, used in some lattice based simulations

Definition at line 82 of file AbstractMigrationRule.hpp.

Referenced by LatticeBasedMigrationRule< DIM >::GetIndices(), CellPopulationMigrationRule< DIM >::GetIndices(), Owen2011MigrationRule< DIM >::GetIndices(), LatticeBasedMigrationRule< DIM >::GetNeighbourMovementProbabilities(), CellPopulationMigrationRule< DIM >::GetNeighbourMovementProbabilities(), Owen2011MigrationRule< DIM >::GetNeighbourMovementProbabilities(), and AbstractMigrationRule< DIM >::SetGrid().

template<unsigned DIM>
boost::shared_ptr<AbstractDiscreteContinuumSolver<DIM> > AbstractMigrationRule< DIM >::mpSolver
protected

A DiscreteContinuum solver containing a solution field of interest

Definition at line 62 of file AbstractMigrationRule.hpp.

Referenced by OffLatticeMigrationRule< DIM >::GetDirections(), OffLatticeMigrationRule< DIM >::GetDirectionsForSprouts(), Owen2011MigrationRule< DIM >::GetIndices(), and AbstractMigrationRule< DIM >::SetDiscreteContinuumSolver().

template<unsigned DIM>
boost::shared_ptr<VesselNetwork<DIM> > AbstractMigrationRule< DIM >::mpVesselNetwork
protected

The vessel network

Definition at line 67 of file AbstractMigrationRule.hpp.

Referenced by OffLatticeMigrationRule< DIM >::GetDirections(), LatticeBasedMigrationRule< DIM >::GetIndices(), CellPopulationMigrationRule< DIM >::GetIndices(), and AbstractMigrationRule< DIM >::SetNetwork().

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