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

#include <CellStateDependentDiscreteSource.hpp>

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

Public Member Functions

 CellStateDependentDiscreteSource ()
 
virtual ~CellStateDependentDiscreteSource ()
 
std::vector< units::quantity< unit::concentration_flow_rate > > GetConstantInUMeshValues ()
 
std::vector< units::quantity< unit::rate > > GetLinearInUMeshValues ()
 
std::vector< units::quantity< unit::concentration_flow_rate > > GetConstantInURegularGridValues ()
 
std::vector< units::quantity< unit::rate > > GetLinearInURegularGridValues ()
 
void SetStateRateMap (std::map< unsigned, units::quantity< unit::concentration_flow_rate > > stateRateMap)
 
void SetStateRateThresholdMap (std::map< unsigned, units::quantity< unit::concentration > > stateThresholdMap)
 
- Public Member Functions inherited from DiscreteSource< DIM >
 DiscreteSource ()
 
virtual ~DiscreteSource ()
 
void SetLabelName (const std::string &rLabel)
 
void SetPoints (std::vector< DimensionalChastePoint< DIM > > points)
 
void SetRegularGrid (boost::shared_ptr< RegularGrid< DIM > > pRegularGrid)
 
void SetMesh (boost::shared_ptr< DiscreteContinuumMesh< DIM, DIM > > pMesh)
 
void SetConstantInUValue (units::quantity< unit::concentration_flow_rate > value)
 
void SetLinearInUValue (units::quantity< unit::rate > value)
 

Static Public Member Functions

static boost::shared_ptr< CellStateDependentDiscreteSource< DIM > > Create ()
 
- Static Public Member Functions inherited from DiscreteSource< DIM >
static boost::shared_ptr< DiscreteSource< DIM > > Create ()
 

Private Attributes

std::map< unsigned, units::quantity< unit::concentration_flow_rate > > mStateRateMap
 
std::map< unsigned, units::quantity< unit::concentration > > mStateRateThresholdMap
 
units::quantity< unit::flow_rate > mConsumptionRatePerUnitConcentration
 

Additional Inherited Members

- Protected Attributes inherited from DiscreteSource< DIM >
boost::shared_ptr< RegularGrid< DIM > > mpRegularGrid
 
boost::shared_ptr< DiscreteContinuumMesh< DIM, DIM > > mpMesh
 
std::vector< DimensionalChastePoint< DIM > > mPoints
 
std::string mLabel
 
units::quantity< unit::concentration_flow_rate > mConstantInUValue
 
units::quantity< unit::rate > mLinearInUValue
 

Detailed Description

template<unsigned DIM>
class CellStateDependentDiscreteSource< DIM >

Specialization of discrete sources for cell state specific sink and source strengths

Definition at line 53 of file CellStateDependentDiscreteSource.hpp.

Constructor & Destructor Documentation

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

Constructor

Definition at line 41 of file CellStateDependentDiscreteSource.cpp.

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

Destructor

Definition at line 51 of file CellStateDependentDiscreteSource.cpp.

Member Function Documentation

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

Factory constructor method

Returns
a pointer to an instance of the class

Definition at line 57 of file CellStateDependentDiscreteSource.cpp.

template<unsigned DIM>
std::vector< units::quantity< unit::concentration_flow_rate > > CellStateDependentDiscreteSource< DIM >::GetConstantInUMeshValues ( )
virtual

Return the values of the source strengths sampled on the mesh elements

Returns
a vector of source strengths

Reimplemented from DiscreteSource< DIM >.

Definition at line 64 of file CellStateDependentDiscreteSource.cpp.

template<unsigned DIM>
std::vector< units::quantity< unit::concentration_flow_rate > > CellStateDependentDiscreteSource< DIM >::GetConstantInURegularGridValues ( )
virtual

Return the values of the source strengths sampled on the regular grid

Returns
a vector of source strengths

Reimplemented from DiscreteSource< DIM >.

Definition at line 76 of file CellStateDependentDiscreteSource.cpp.

References DiscreteSource< DIM >::mConstantInUValue, DiscreteSource< DIM >::mLabel, DiscreteSource< DIM >::mpRegularGrid, CellStateDependentDiscreteSource< DIM >::mStateRateMap, and CellStateDependentDiscreteSource< DIM >::mStateRateThresholdMap.

template<unsigned DIM>
std::vector< units::quantity< unit::rate > > CellStateDependentDiscreteSource< DIM >::GetLinearInUMeshValues ( )
virtual

Return the values of the source strengths sampled on the mesh elements

Returns
a vector of source strengths

Reimplemented from DiscreteSource< DIM >.

Definition at line 70 of file CellStateDependentDiscreteSource.cpp.

template<unsigned DIM>
std::vector< units::quantity< unit::rate > > CellStateDependentDiscreteSource< DIM >::GetLinearInURegularGridValues ( )
virtual

Return the values of the source strengths sampled on the regular grid

Returns
a vector of source strengths

Reimplemented from DiscreteSource< DIM >.

Definition at line 159 of file CellStateDependentDiscreteSource.cpp.

References DiscreteSource< DIM >::mpRegularGrid.

template<unsigned DIM>
void CellStateDependentDiscreteSource< DIM >::SetStateRateMap ( std::map< unsigned, units::quantity< unit::concentration_flow_rate > >  stateRateMap)

Set cell 'color' specific consumption rates. 'Color' is a property of the cell mutation state set in its constructor. It is up to the user to ensure that different mutation states of interest have different 'color' values assigned. If a cell 'color' key is requested from the map that does not have a value assigned then its consumption rate will be 0.0.

Parameters
stateRateMapthe label for the source strength value

Definition at line 166 of file CellStateDependentDiscreteSource.cpp.

References CellStateDependentDiscreteSource< DIM >::mStateRateMap.

template<unsigned DIM>
void CellStateDependentDiscreteSource< DIM >::SetStateRateThresholdMap ( std::map< unsigned, units::quantity< unit::concentration > >  stateThresholdMap)

Set cell 'color' specific consumption rate thresholds. If a cell 'color' key is requested from the map that does not have a value assigned then its consumption rate threshold will be 0.0.

Parameters
stateThresholdMapthe label for the source strength value

Definition at line 172 of file CellStateDependentDiscreteSource.cpp.

References CellStateDependentDiscreteSource< DIM >::mStateRateThresholdMap.

Member Data Documentation

template<unsigned DIM>
units::quantity<unit::flow_rate> CellStateDependentDiscreteSource< DIM >::mConsumptionRatePerUnitConcentration
private

The consumption rate per unit species concentration

Definition at line 71 of file CellStateDependentDiscreteSource.hpp.

template<unsigned DIM>
std::map<unsigned, units::quantity<unit::concentration_flow_rate> > CellStateDependentDiscreteSource< DIM >::mStateRateMap
private

Cells of different 'color' (i.e. mutation state label) can have different sink rates.

Definition at line 61 of file CellStateDependentDiscreteSource.hpp.

Referenced by CellStateDependentDiscreteSource< DIM >::GetConstantInURegularGridValues(), and CellStateDependentDiscreteSource< DIM >::SetStateRateMap().

template<unsigned DIM>
std::map<unsigned, units::quantity<unit::concentration> > CellStateDependentDiscreteSource< DIM >::mStateRateThresholdMap
private

Cells of different 'color' (i.e. mutation state label) can have different sink rate thresholds.

Definition at line 66 of file CellStateDependentDiscreteSource.hpp.

Referenced by CellStateDependentDiscreteSource< DIM >::GetConstantInURegularGridValues(), and CellStateDependentDiscreteSource< DIM >::SetStateRateThresholdMap().

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