Chaste  Build::
VesselFlowProperties< DIM > Class Template Reference

#include <VesselFlowProperties.hpp>

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

Public Member Functions

 VesselFlowProperties ()
 
 ~VesselFlowProperties ()
 
void CheckSegments () const
 
units::quantity< unit::dimensionless > GetHaematocrit () const
 
units::quantity< unit::flow_impedance > GetImpedance () const
 
units::quantity< unit::flow_rate > GetFlowRate () const
 
units::quantity< unit::dynamic_viscosity > GetViscosity () const
 
units::quantity< unit::pressure > GetWallShearStress () const
 
units::quantity< unit::rate > GetGrowthStimulus () const
 
std::map< std::string, double > GetOutputData () const
 
units::quantity< unit::time > GetRegressionTime () const
 
bool HasRegressionTimerStarted ()
 
bool HasVesselRegressed (units::quantity< unit::time > simulationReferenceTime)
 
void ResetRegressionTimer ()
 
void SetHaematocrit (units::quantity< unit::dimensionless > haematocrit)
 
void SetFlowRate (units::quantity< unit::flow_rate > flowRate)
 
void SetImpedance (units::quantity< unit::flow_impedance > impedance)
 
void SetViscosity (units::quantity< unit::dynamic_viscosity > viscosity)
 
void SetWallShearStress (units::quantity< unit::pressure > wallShear)
 
void SetGrowthStimulus (units::quantity< unit::rate > stimulus)
 
void SetTimeUntilRegression (units::quantity< unit::time > time, units::quantity< unit::time > simulationReferenceTime)
 
void SetRegressionTime (units::quantity< unit::time > time)
 
void UpdateSegments (std::vector< boost::shared_ptr< VesselSegment< DIM > > > segments)
 
- Public Member Functions inherited from AbstractVesselNetworkComponentFlowProperties< DIM >
 AbstractVesselNetworkComponentFlowProperties ()
 
virtual ~AbstractVesselNetworkComponentFlowProperties ()
 
units::quantity< unit::pressure > GetPressure () const
 
virtual void SetPressure (units::quantity< unit::pressure > pressure)
 
- Public Member Functions inherited from AbstractVesselNetworkComponentProperties< DIM >
 AbstractVesselNetworkComponentProperties ()
 
virtual ~AbstractVesselNetworkComponentProperties ()
 

Private Attributes

std::vector< boost::shared_ptr< VesselSegment< DIM > > > mSegments
 
bool mUndergoingRegression
 
bool mRemoveViaRegression
 
units::quantity< unit::time > mRegressionTime
 

Additional Inherited Members

- Protected Attributes inherited from AbstractVesselNetworkComponentFlowProperties< DIM >
units::quantity< unit::pressure > mPressure
 

Detailed Description

template<unsigned DIM>
class VesselFlowProperties< DIM >

This is a class for vessel flow properties.

This class calculates vessel data for vessel network flow problems. Each vessel has an instance of the class.

Definition at line 57 of file VesselFlowProperties.hpp.

Constructor & Destructor Documentation

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

Constructor

Definition at line 39 of file VesselFlowProperties.cpp.

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

Destructor

Definition at line 48 of file VesselFlowProperties.cpp.

Member Function Documentation

template<unsigned DIM>
units::quantity< unit::flow_rate > VesselFlowProperties< DIM >::GetFlowRate ( ) const

Return the flow rate

Returns
the segment flow rate

Definition at line 75 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::CheckSegments(), and VesselFlowProperties< DIM >::mSegments.

Referenced by VesselFlowProperties< DIM >::GetOutputData().

template<unsigned DIM>
units::quantity< unit::rate > VesselFlowProperties< DIM >::GetGrowthStimulus ( ) const

Return the growth stimulus of this vessel segment

Returns
the segment growth stimulus

Definition at line 127 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::CheckSegments(), and VesselFlowProperties< DIM >::mSegments.

Referenced by VesselFlowProperties< DIM >::GetOutputData().

template<unsigned DIM>
units::quantity< unit::dimensionless > VesselFlowProperties< DIM >::GetHaematocrit ( ) const

Return the 'dimensional' haematocrit

Returns
the segment haematocrit

Definition at line 62 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::CheckSegments(), and VesselFlowProperties< DIM >::mSegments.

Referenced by VesselFlowProperties< DIM >::GetOutputData().

template<unsigned DIM>
units::quantity< unit::flow_impedance > VesselFlowProperties< DIM >::GetImpedance ( ) const

Return the impedance

Returns
the segment impedance

Definition at line 88 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::CheckSegments(), and VesselFlowProperties< DIM >::mSegments.

Referenced by VesselFlowProperties< DIM >::GetOutputData().

template<unsigned DIM>
std::map< std::string, double > VesselFlowProperties< DIM >::GetOutputData ( ) const
virtual
template<unsigned DIM>
units::quantity< unit::time > VesselFlowProperties< DIM >::GetRegressionTime ( ) const

Return the regression time

Returns
the regression time

Definition at line 155 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::mRegressionTime.

template<unsigned DIM>
units::quantity< unit::dynamic_viscosity > VesselFlowProperties< DIM >::GetViscosity ( ) const

Return the segment viscosity

Returns
the segment viscosity

Definition at line 101 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::CheckSegments(), and VesselFlowProperties< DIM >::mSegments.

Referenced by VesselFlowProperties< DIM >::GetOutputData().

template<unsigned DIM>
units::quantity< unit::pressure > VesselFlowProperties< DIM >::GetWallShearStress ( ) const

Return the segment wall shear stress of this vessel segment

Returns
the segment wall shear stress

Definition at line 114 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::CheckSegments(), and VesselFlowProperties< DIM >::mSegments.

Referenced by VesselFlowProperties< DIM >::GetOutputData().

template<unsigned DIM>
bool VesselFlowProperties< DIM >::HasRegressionTimerStarted ( )
Returns
whether regression timer has started.

Definition at line 268 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::mUndergoingRegression.

Referenced by VesselFlowProperties< DIM >::SetTimeUntilRegression().

template<unsigned DIM>
bool VesselFlowProperties< DIM >::HasVesselRegressed ( units::quantity< unit::time >  simulationReferenceTime)
Parameters
simulationReferenceTimethe reference time for the simulation
Returns
whether the vessel should regress (be removed).

Definition at line 161 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::mRegressionTime, VesselFlowProperties< DIM >::mRemoveViaRegression, and VesselFlowProperties< DIM >::mUndergoingRegression.

template<unsigned DIM>
void VesselFlowProperties< DIM >::ResetRegressionTimer ( )
template<unsigned DIM>
void VesselFlowProperties< DIM >::SetFlowRate ( units::quantity< unit::flow_rate >  flowRate)

Set the flow rate

Parameters
flowRatethe flow rate in the segment

Definition at line 188 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::CheckSegments(), and VesselFlowProperties< DIM >::mSegments.

template<unsigned DIM>
void VesselFlowProperties< DIM >::SetGrowthStimulus ( units::quantity< unit::rate >  stimulus)

Set the growth stimulus of this vessel segment

Parameters
stimulusthe growth stimulus in the segment

Definition at line 233 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::CheckSegments(), and VesselFlowProperties< DIM >::mSegments.

template<unsigned DIM>
void VesselFlowProperties< DIM >::SetHaematocrit ( units::quantity< unit::dimensionless >  haematocrit)

Set the haematocrit

Parameters
haematocritthe haematocrit in the segment

Definition at line 177 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::CheckSegments(), and VesselFlowProperties< DIM >::mSegments.

template<unsigned DIM>
void VesselFlowProperties< DIM >::SetImpedance ( units::quantity< unit::flow_impedance >  impedance)

Set the impedance

Parameters
impedancethe impedance in the segment

Definition at line 200 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::CheckSegments(), and VesselFlowProperties< DIM >::mSegments.

template<unsigned DIM>
void VesselFlowProperties< DIM >::SetRegressionTime ( units::quantity< unit::time >  time)

Set dimensional time at removal of vessel from network.

Parameters
timethe time at vessel removal

Definition at line 258 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::mRegressionTime, and VesselFlowProperties< DIM >::mUndergoingRegression.

template<unsigned DIM>
void VesselFlowProperties< DIM >::SetTimeUntilRegression ( units::quantity< unit::time >  time,
units::quantity< unit::time >  simulationReferenceTime 
)

Set dimensional amount of time until removal of vessel from network.

Parameters
simulationReferenceTimethe simulation reference time
timethe amount of time until vessel removal

Definition at line 244 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::HasRegressionTimerStarted(), VesselFlowProperties< DIM >::mRegressionTime, VesselFlowProperties< DIM >::mRemoveViaRegression, and VesselFlowProperties< DIM >::mUndergoingRegression.

template<unsigned DIM>
void VesselFlowProperties< DIM >::SetViscosity ( units::quantity< unit::dynamic_viscosity >  viscosity)

Set the viscosity

Parameters
viscositythe viscosity in the segment

Definition at line 211 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::CheckSegments(), and VesselFlowProperties< DIM >::mSegments.

template<unsigned DIM>
void VesselFlowProperties< DIM >::SetWallShearStress ( units::quantity< unit::pressure >  wallShear)

Set the wall shear stress of this vessel segment

Parameters
wallShearthe wall shear stress in the segment

Definition at line 222 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::CheckSegments(), and VesselFlowProperties< DIM >::mSegments.

template<unsigned DIM>
void VesselFlowProperties< DIM >::UpdateSegments ( std::vector< boost::shared_ptr< VesselSegment< DIM > > >  segments)

Update the vessel segments

Parameters
segmentsthe vessel segments

Definition at line 282 of file VesselFlowProperties.cpp.

References VesselFlowProperties< DIM >::mSegments.

Member Data Documentation

template<unsigned DIM>
bool VesselFlowProperties< DIM >::mRemoveViaRegression
private

Whether a vessel should be removed from the network. A vessel exists inside the network until they are removed.

Definition at line 76 of file VesselFlowProperties.hpp.

Referenced by VesselFlowProperties< DIM >::HasVesselRegressed(), VesselFlowProperties< DIM >::ResetRegressionTimer(), and VesselFlowProperties< DIM >::SetTimeUntilRegression().

template<unsigned DIM>
bool VesselFlowProperties< DIM >::mUndergoingRegression
private

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