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

#include <MetabolicStimulusCalculator.hpp>

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

Public Member Functions

 MetabolicStimulusCalculator ()
 
 ~MetabolicStimulusCalculator ()
 
units::quantity< unit::flow_rate > GetQRef ()
 
units::quantity< unit::rate > GetKm ()
 
units::quantity< unit::rate > GetMaxStimulus ()
 
void SetQRef (units::quantity< unit::flow_rate > qRef)
 
void SetKm (units::quantity< unit::rate > km)
 
void SetMaxStimulus (units::quantity< unit::rate > maxStimulus)
 
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< MetabolicStimulusCalculator< DIM > > Create ()
 

Private Attributes

units::quantity< unit::flow_rate > mQRef
 
units::quantity< unit::rate > mKm
 
units::quantity< unit::rate > mMaxStimulus
 

Additional Inherited Members

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

Detailed Description

template<unsigned DIM>
class MetabolicStimulusCalculator< DIM >

Calculate a stimulus related to the ability of the vasculature to adopt to the metabolic need of the tissue. See Alarcon et al. (2003), JTB, 225, pp257-274.

Definition at line 48 of file MetabolicStimulusCalculator.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 40 of file MetabolicStimulusCalculator.cpp.

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

Destructor.

Definition at line 49 of file MetabolicStimulusCalculator.cpp.

Member Function Documentation

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

Do the calculation

Implements AbstractVesselNetworkCalculator< DIM >.

Definition at line 99 of file MetabolicStimulusCalculator.cpp.

References MetabolicStimulusCalculator< DIM >::mKm, AbstractVesselNetworkCalculator< DIM >::mpNetwork, and MetabolicStimulusCalculator< DIM >::mQRef.

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

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

Returns
a pointer to a new class instance

Definition at line 55 of file MetabolicStimulusCalculator.cpp.

template<unsigned DIM>
units::quantity< unit::rate > MetabolicStimulusCalculator< DIM >::GetKm ( )

Get the stimulus constant

Returns
the stimulus constant

Definition at line 69 of file MetabolicStimulusCalculator.cpp.

References MetabolicStimulusCalculator< DIM >::mKm.

template<unsigned DIM>
units::quantity< unit::rate > MetabolicStimulusCalculator< DIM >::GetMaxStimulus ( )

Get the maximum stimulus

Returns
the maximum stimulus

Definition at line 75 of file MetabolicStimulusCalculator.cpp.

References MetabolicStimulusCalculator< DIM >::mMaxStimulus.

template<unsigned DIM>
units::quantity< unit::flow_rate > MetabolicStimulusCalculator< DIM >::GetQRef ( )

Get the reference flow rate

Returns
reference flow rate

Definition at line 63 of file MetabolicStimulusCalculator.cpp.

References MetabolicStimulusCalculator< DIM >::mQRef.

template<unsigned DIM>
void MetabolicStimulusCalculator< DIM >::SetKm ( units::quantity< unit::rate >  km)

set the stimulus constant

Parameters
kmstimulus constant

Definition at line 87 of file MetabolicStimulusCalculator.cpp.

References MetabolicStimulusCalculator< DIM >::mKm.

template<unsigned DIM>
void MetabolicStimulusCalculator< DIM >::SetMaxStimulus ( units::quantity< unit::rate >  maxStimulus)

set the maximum stimulus

Parameters
maxStimulusthe maximum stimulus

Definition at line 93 of file MetabolicStimulusCalculator.cpp.

References MetabolicStimulusCalculator< DIM >::mMaxStimulus.

template<unsigned DIM>
void MetabolicStimulusCalculator< DIM >::SetQRef ( units::quantity< unit::flow_rate >  qRef)

set the reference flow rate

Parameters
qRefreference flow rate

Definition at line 81 of file MetabolicStimulusCalculator.cpp.

References MetabolicStimulusCalculator< DIM >::mQRef.

Member Data Documentation

template<unsigned DIM>
units::quantity<unit::rate> MetabolicStimulusCalculator< DIM >::mKm
private

Metabolic Stimulus Constant

Definition at line 61 of file MetabolicStimulusCalculator.hpp.

Referenced by MetabolicStimulusCalculator< DIM >::Calculate(), MetabolicStimulusCalculator< DIM >::GetKm(), and MetabolicStimulusCalculator< DIM >::SetKm().

template<unsigned DIM>
units::quantity<unit::rate> MetabolicStimulusCalculator< DIM >::mMaxStimulus
private

Maximum stimulus

Definition at line 66 of file MetabolicStimulusCalculator.hpp.

Referenced by MetabolicStimulusCalculator< DIM >::GetMaxStimulus(), and MetabolicStimulusCalculator< DIM >::SetMaxStimulus().

template<unsigned DIM>
units::quantity<unit::flow_rate> MetabolicStimulusCalculator< DIM >::mQRef
private

Reference flow rate

Definition at line 56 of file MetabolicStimulusCalculator.hpp.

Referenced by MetabolicStimulusCalculator< DIM >::Calculate(), MetabolicStimulusCalculator< DIM >::GetQRef(), and MetabolicStimulusCalculator< DIM >::SetQRef().

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