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

#include <ShrinkingStimulusCalculator.hpp>

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

Public Member Functions

 ShrinkingStimulusCalculator ()
 
 ~ShrinkingStimulusCalculator ()
 
units::quantity< unit::rate > GetStimulus ()
 
void SetStimulus (units::quantity< unit::rate > stimulus)
 
void Calculate ()
 
- Public Member Functions inherited from AbstractVesselNetworkCalculator< DIM >
 AbstractVesselNetworkCalculator ()
 
virtual ~AbstractVesselNetworkCalculator ()
 
void SetVesselNetwork (boost::shared_ptr< VesselNetwork< DIM > > pNetwork)
 

Static Public Member Functions

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

Private Attributes

units::quantity< unit::rate > mDefaultStimulus
 

Additional Inherited Members

- Protected Attributes inherited from AbstractVesselNetworkCalculator< DIM >
boost::shared_ptr< VesselNetwork< DIM > > mpNetwork
 

Detailed Description

template<unsigned DIM>
class ShrinkingStimulusCalculator< DIM >

Calculate a stimulus related to the tendency of the vasculature to shrink See Alarcon et al. (2003), JTB, 225, pp257-274.

Definition at line 48 of file ShrinkingStimulusCalculator.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 40 of file ShrinkingStimulusCalculator.cpp.

template<unsigned DIM>
ShrinkingStimulusCalculator< DIM >::~ShrinkingStimulusCalculator ( )

Destructor.

Definition at line 47 of file ShrinkingStimulusCalculator.cpp.

Member Function Documentation

template<unsigned DIM>
void ShrinkingStimulusCalculator< DIM >::Calculate ( )
virtual

Do the solve

Implements AbstractVesselNetworkCalculator< DIM >.

Definition at line 72 of file ShrinkingStimulusCalculator.cpp.

References ShrinkingStimulusCalculator< DIM >::mDefaultStimulus, and AbstractVesselNetworkCalculator< DIM >::mpNetwork.

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

Factor constructor. 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 53 of file ShrinkingStimulusCalculator.cpp.

template<unsigned DIM>
units::quantity< unit::rate > ShrinkingStimulusCalculator< DIM >::GetStimulus ( )

Get the default value of the shrinking stimulus

Returns
stimulus the value of the stimulus

Definition at line 60 of file ShrinkingStimulusCalculator.cpp.

References ShrinkingStimulusCalculator< DIM >::mDefaultStimulus.

template<unsigned DIM>
void ShrinkingStimulusCalculator< DIM >::SetStimulus ( units::quantity< unit::rate >  stimulus)

Set the default value of the shrinking stimulus

Parameters
stimulusthe stimulus

Definition at line 66 of file ShrinkingStimulusCalculator.cpp.

References ShrinkingStimulusCalculator< DIM >::mDefaultStimulus.

Member Data Documentation

template<unsigned DIM>
units::quantity<unit::rate> ShrinkingStimulusCalculator< DIM >::mDefaultStimulus
private

The default value of the shrinking stimulus

Definition at line 53 of file ShrinkingStimulusCalculator.hpp.

Referenced by ShrinkingStimulusCalculator< DIM >::Calculate(), ShrinkingStimulusCalculator< DIM >::GetStimulus(), and ShrinkingStimulusCalculator< DIM >::SetStimulus().

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