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

#include <LatticeBasedSproutingRule.hpp>

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

Public Member Functions

 LatticeBasedSproutingRule ()
 
virtual ~LatticeBasedSproutingRule ()
 
virtual std::vector< boost::shared_ptr< VesselNode< DIM > > > GetSprouts (const std::vector< boost::shared_ptr< VesselNode< DIM > > > &rNodes)
 
void SetGrid (boost::shared_ptr< RegularGrid< DIM > > pGrid)
 
- Public Member Functions inherited from AbstractSproutingRule< DIM >
 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)
 

Static Public Member Functions

static boost::shared_ptr< LatticeBasedSproutingRule< DIM > > Create ()
 

Protected Attributes

boost::shared_ptr< RegularGrid< DIM > > mpGrid
 
units::quantity< unit::length > mTipExclusionRadius
 
- Protected Attributes inherited from AbstractSproutingRule< DIM >
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 LatticeBasedSproutingRule< DIM >

A simple random lattice based sprouting rule, useful for code testing.

Definition at line 51 of file LatticeBasedSproutingRule.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 43 of file LatticeBasedSproutingRule.cpp.

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

Destructor.

Definition at line 59 of file LatticeBasedSproutingRule.cpp.

Member Function Documentation

template<unsigned DIM>
boost::shared_ptr< LatticeBasedSproutingRule< DIM > > LatticeBasedSproutingRule< 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 52 of file LatticeBasedSproutingRule.cpp.

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

Overwritten method to return nodes which may sprout

Parameters
rNodesnodes to check for sprouting
Returns
a vector of nodes which may sprout

Reimplemented from AbstractSproutingRule< DIM >.

Reimplemented in Owen2011SproutingRule< DIM >.

Definition at line 71 of file LatticeBasedSproutingRule.cpp.

References BaseUnits::GetReferenceTimeScale(), BaseUnits::Instance(), AbstractSproutingRule< DIM >::mpVesselNetwork, AbstractSproutingRule< DIM >::mSproutingProbability, LatticeBasedSproutingRule< DIM >::mTipExclusionRadius, and AbstractSproutingRule< DIM >::mVesselEndCutoff.

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

Set the lattice/grid for the vessel network

Parameters
pGridthe grid for the vessel network

Reimplemented from AbstractSproutingRule< DIM >.

Definition at line 65 of file LatticeBasedSproutingRule.cpp.

References LatticeBasedSproutingRule< DIM >::mpGrid.

Member Data Documentation

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

The lattice/grid for the vessel simulation

Definition at line 59 of file LatticeBasedSproutingRule.hpp.

Referenced by Owen2011SproutingRule< DIM >::GetSprouts(), and LatticeBasedSproutingRule< DIM >::SetGrid().

template<unsigned DIM>
units::quantity<unit::length> LatticeBasedSproutingRule< DIM >::mTipExclusionRadius
protected

Tip exclusion radius

Definition at line 64 of file LatticeBasedSproutingRule.hpp.

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

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