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

#include <CellBasedDiscreteSource.hpp>

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

Public Member Functions

 CellBasedDiscreteSource ()
 
virtual ~CellBasedDiscreteSource ()
 
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 SetConstantInUConsumptionRatePerCell (units::quantity< unit::molar_flow_rate > value)
 
void SetLinearInUConsumptionRatePerCell (units::quantity< unit::rate > value)
 
- 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< CellBasedDiscreteSource< DIM > > Create ()
 
- Static Public Member Functions inherited from DiscreteSource< DIM >
static boost::shared_ptr< DiscreteSource< DIM > > Create ()
 

Protected Attributes

units::quantity< unit::molar_flow_rate > mCellConstantInUValue
 
units::quantity< unit::rate > mCellLinearInUValue
 
- 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 CellBasedDiscreteSource< DIM >

This class calculates the value of discrete sources at grid/mesh locations for cells

Definition at line 52 of file CellBasedDiscreteSource.hpp.

Constructor & Destructor Documentation

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

Constructor

Definition at line 43 of file CellBasedDiscreteSource.cpp.

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

Destructor

Definition at line 52 of file CellBasedDiscreteSource.cpp.

Member Function Documentation

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

Factory constructor method

Returns
a pointer to an instance of the class

Definition at line 58 of file CellBasedDiscreteSource.cpp.

template<unsigned DIM>
std::vector< units::quantity< unit::concentration_flow_rate > > CellBasedDiscreteSource< 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 65 of file CellBasedDiscreteSource.cpp.

References CellBasedDiscreteSource< DIM >::mCellConstantInUValue, and DiscreteSource< DIM >::mpMesh.

template<unsigned DIM>
std::vector< units::quantity< unit::concentration_flow_rate > > CellBasedDiscreteSource< 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 104 of file CellBasedDiscreteSource.cpp.

References CellBasedDiscreteSource< DIM >::mCellConstantInUValue, and DiscreteSource< DIM >::mpRegularGrid.

template<unsigned DIM>
std::vector< units::quantity< unit::rate > > CellBasedDiscreteSource< 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 87 of file CellBasedDiscreteSource.cpp.

References CellBasedDiscreteSource< DIM >::mCellLinearInUValue, and DiscreteSource< DIM >::mpMesh.

template<unsigned DIM>
std::vector< units::quantity< unit::rate > > CellBasedDiscreteSource< 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 125 of file CellBasedDiscreteSource.cpp.

References CellBasedDiscreteSource< DIM >::mCellLinearInUValue, and DiscreteSource< DIM >::mpRegularGrid.

template<unsigned DIM>
void CellBasedDiscreteSource< DIM >::SetConstantInUConsumptionRatePerCell ( units::quantity< unit::molar_flow_rate >  value)

Set the value of the source for PRESCRIBED type sources

Parameters
valuethe value of the source

Definition at line 142 of file CellBasedDiscreteSource.cpp.

References CellBasedDiscreteSource< DIM >::mCellConstantInUValue.

template<unsigned DIM>
void CellBasedDiscreteSource< DIM >::SetLinearInUConsumptionRatePerCell ( units::quantity< unit::rate >  value)

Set the value of the source for PRESCRIBED type sources

Parameters
valuethe value of the source

Definition at line 148 of file CellBasedDiscreteSource.cpp.

References CellBasedDiscreteSource< DIM >::mCellLinearInUValue.

Member Data Documentation

template<unsigned DIM>
units::quantity<unit::molar_flow_rate> CellBasedDiscreteSource< DIM >::mCellConstantInUValue
protected

The linear in U rate of consumption per cell

Definition at line 60 of file CellBasedDiscreteSource.hpp.

Referenced by CellBasedDiscreteSource< DIM >::GetConstantInUMeshValues(), CellBasedDiscreteSource< DIM >::GetConstantInURegularGridValues(), and CellBasedDiscreteSource< DIM >::SetConstantInUConsumptionRatePerCell().

template<unsigned DIM>
units::quantity<unit::rate> CellBasedDiscreteSource< DIM >::mCellLinearInUValue
protected

The constant in U rate of consumption per cell

Definition at line 65 of file CellBasedDiscreteSource.hpp.

Referenced by CellBasedDiscreteSource< DIM >::GetLinearInUMeshValues(), CellBasedDiscreteSource< DIM >::GetLinearInURegularGridValues(), and CellBasedDiscreteSource< DIM >::SetLinearInUConsumptionRatePerCell().

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