#include <AbstractSproutingRule.hpp>

Inheritance diagram for AbstractSproutingRule< DIM >:

Collaboration diagram for AbstractSproutingRule< DIM >:

Public Member Functions
	AbstractSproutingRule ()

virtual	~AbstractSproutingRule ()

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

void	SetVesselNetwork (boost::shared_ptr< VesselNetwork< DIM > > pVesselNetwork)

void	SetSproutingProbability (units::quantity< unit::rate > probability)

void	SetVesselEndCutoff (units::quantity< unit::length > cutoff)

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

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

Protected Attributes
boost::shared_ptr< AbstractDiscreteContinuumSolver< DIM > >	mpSolver

units::quantity< unit::rate >	mSproutingProbability

boost::shared_ptr< VesselNetwork< DIM > >	mpVesselNetwork

units::quantity< unit::length >	mVesselEndCutoff

Detailed Description

template<unsigned DIM>
class AbstractSproutingRule< DIM >

Abstract class for implementing sprouting rules in angiogenesis solver. Child classes implement GetSprouts() which returns a vector of potential sprouting nodes

Definition at line 53 of file AbstractSproutingRule.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

AbstractSproutingRule< DIM >::AbstractSproutingRule ( )

Constructor.

Definition at line 42 of file AbstractSproutingRule.cpp.

template<unsigned DIM>

AbstractSproutingRule< DIM >::~AbstractSproutingRule ( )

virtual

Destructor.

Definition at line 52 of file AbstractSproutingRule.cpp.

Member Function Documentation

template<unsigned DIM>

std::vector< boost::shared_ptr< VesselNode< DIM > > > AbstractSproutingRule< DIM >::GetSprouts ( const std::vector< boost::shared_ptr< VesselNode< DIM > > > & rNodes )

virtual

Return the nodes which may form sprouts

Parameters

rNodes nodes to check for sprouting

Returns: a vector of nodes which may sprout

Reimplemented in OffLatticeSproutingRule< DIM >, LatticeBasedSproutingRule< DIM >, and Owen2011SproutingRule< DIM >.

Definition at line 83 of file AbstractSproutingRule.cpp.

template<unsigned DIM>

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

Set the DiscreteContinuum solver containing the VEGF field

Parameters

pSolver the DiscreteContinuum solver containing the VEGF field

Definition at line 58 of file AbstractSproutingRule.cpp.

References AbstractSproutingRule< DIM >::mpSolver.

template<unsigned DIM>

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

virtual

Set a grid for the vessel network, implemented in some, but not all, child classes.

Parameters

pGrid the grid for the vessel network

Reimplemented in LatticeBasedSproutingRule< DIM >.

Definition at line 89 of file AbstractSproutingRule.cpp.

template<unsigned DIM>

void AbstractSproutingRule< DIM >::SetSproutingProbability ( units::quantity< unit::rate > probability )

Set the sprouting probability

Parameters

probability probability of sprouting per unit time

Definition at line 65 of file AbstractSproutingRule.cpp.

References AbstractSproutingRule< DIM >::mSproutingProbability.

template<unsigned DIM>

void AbstractSproutingRule< DIM >::SetVesselEndCutoff ( units::quantity< unit::length > cutoff )

Set the minimum distance to a vessel end at which sprouting can occur

Parameters

cutoff the vessel end cutoff

Definition at line 71 of file AbstractSproutingRule.cpp.

References AbstractSproutingRule< DIM >::mVesselEndCutoff.

template<unsigned DIM>

void AbstractSproutingRule< DIM >::SetVesselNetwork ( boost::shared_ptr< VesselNetwork< DIM > > pVesselNetwork )

Set the vessel network

Parameters

pVesselNetwork pointer to a new method for the class

Definition at line 77 of file AbstractSproutingRule.cpp.

References AbstractSproutingRule< DIM >::mpVesselNetwork.

Member Data Documentation

template<unsigned DIM>

boost::shared_ptr<AbstractDiscreteContinuumSolver<DIM> > AbstractSproutingRule< DIM >::mpSolver

protected

A DiscreteContinuum solver containing a solution field of interest

Definition at line 61 of file AbstractSproutingRule.hpp.

Referenced by Owen2011SproutingRule< DIM >::GetSprouts(), OffLatticeSproutingRule< DIM >::GetSprouts(), and AbstractSproutingRule< DIM >::SetDiscreteContinuumSolver().

template<unsigned DIM>

boost::shared_ptr<VesselNetwork<DIM> > AbstractSproutingRule< DIM >::mpVesselNetwork

protected

Vessel network, useful if sprouting depends on neighbouring nodes

Definition at line 71 of file AbstractSproutingRule.hpp.

Referenced by LatticeBasedSproutingRule< DIM >::GetSprouts(), Owen2011SproutingRule< DIM >::GetSprouts(), OffLatticeSproutingRule< DIM >::GetSprouts(), and AbstractSproutingRule< DIM >::SetVesselNetwork().

template<unsigned DIM>

units::quantity<unit::rate> AbstractSproutingRule< DIM >::mSproutingProbability

protected

The probability that a sprout will form per unit time

Definition at line 66 of file AbstractSproutingRule.hpp.

Referenced by LatticeBasedSproutingRule< DIM >::GetSprouts(), Owen2011SproutingRule< DIM >::GetSprouts(), OffLatticeSproutingRule< DIM >::GetSprouts(), OffLatticeSproutingRule< DIM >::OffLatticeSproutingRule(), Owen2011SproutingRule< DIM >::Owen2011SproutingRule(), and AbstractSproutingRule< DIM >::SetSproutingProbability().

template<unsigned DIM>

units::quantity<unit::length> AbstractSproutingRule< DIM >::mVesselEndCutoff

protected

How far from vessel ends can sprouts form

Definition at line 76 of file AbstractSproutingRule.hpp.

Referenced by LatticeBasedSproutingRule< DIM >::GetSprouts(), Owen2011SproutingRule< DIM >::GetSprouts(), OffLatticeSproutingRule< DIM >::GetSprouts(), Owen2011SproutingRule< DIM >::Owen2011SproutingRule(), and AbstractSproutingRule< DIM >::SetVesselEndCutoff().

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

projects/MicrovesselChaste/src/simulation/angiogenesis/sprouting_rules/AbstractSproutingRule.hpp
projects/MicrovesselChaste/src/simulation/angiogenesis/sprouting_rules/AbstractSproutingRule.cpp

Public Member Functions

Protected Attributes

Detailed Description

template<unsigned DIM> class AbstractSproutingRule< DIM >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<unsigned DIM>
class AbstractSproutingRule< DIM >