AveragedSourcePde< DIM > Class Template Reference

#include <AveragedSourcePde.hpp>

Inherits AbstractLinearEllipticPde< DIM, DIM >.

Inherited by VolumeDependentAveragedSourcePde< DIM >.

Collaboration diagram for AveragedSourcePde< DIM >:

Public Member Functions
	AveragedSourcePde (AbstractCellPopulation< DIM > &rCellPopulation, double coefficient=0.0)
const AbstractCellPopulation < DIM > &	rGetCellPopulation () const
double	GetCoefficient () const
virtual void	SetupSourceTerms (TetrahedralMesh< DIM, DIM > &rCoarseMesh, std::map< CellPtr, unsigned > *pCellPdeElementMap=NULL)
double	ComputeConstantInUSourceTerm (const ChastePoint< DIM > &rX, Element< DIM, DIM > *pElement)
double	ComputeLinearInUCoeffInSourceTerm (const ChastePoint< DIM > &rX, Element< DIM, DIM > *pElement)
c_matrix< double, DIM, DIM >	ComputeDiffusionTerm (const ChastePoint< DIM > &rX)
double	GetUptakeRateForElement (unsigned elementIndex)
Protected Attributes
AbstractCellPopulation< DIM > &	mrCellPopulation
double	mCoefficient
std::vector< double >	mCellDensityOnCoarseElements
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Friends
class	TestCellBasedPdes
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class AveragedSourcePde< DIM >

A PDE which calculates the source term by adding the number of cells in the element containing that point and scaling by the element area.

Definition at line 45 of file AveragedSourcePde.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

AveragedSourcePde< DIM >::AveragedSourcePde	(	AbstractCellPopulation< DIM > &	rCellPopulation,
		double	coefficient = `0.0`
	)			`[inline]`

Constructor.

Parameters:

	rCellPopulation	reference to the cell population
	coefficient	the coefficient of consumption of nutrient by cells (defaults to 0.0)

Definition at line 34 of file AveragedSourcePde.cpp.

Member Function Documentation

template<unsigned DIM>

double AveragedSourcePde< DIM >::ComputeConstantInUSourceTerm	(	const ChastePoint< DIM > &	rX,
		Element< DIM, DIM > *	pElement
	)			`[inline]`

Overridden ComputeConstantInUSourceTerm() method.

Parameters:

	rX	The point in space
	pElement	the element

Returns:: the constant in u part of the source term, i.e g(x) in Div(D Grad u) + f(x)u + g(x) = 0.

Definition at line 99 of file AveragedSourcePde.cpp.

template<unsigned DIM>

c_matrix< double, DIM, DIM > AveragedSourcePde< DIM >::ComputeDiffusionTerm ( const ChastePoint< DIM > & rX ) [inline]

Overridden ComputeDiffusionTerm() method.

Parameters:

rX

The point in space at which the diffusion term is computed

Returns:: a matrix.

Definition at line 112 of file AveragedSourcePde.cpp.

template<unsigned DIM>

double AveragedSourcePde< DIM >::ComputeLinearInUCoeffInSourceTerm	(	const ChastePoint< DIM > &	rX,
		Element< DIM, DIM > *	pElement
	)			`[inline]`

Overridden ComputeLinearInUCoeffInSourceTerm() method.

Parameters:

	rX	The point in space
	pElement	the element

Returns:: the coefficient of u in the linear part of the source term, i.e f(x) in Div(D Grad u) + f(x)u + g(x) = 0.

Definition at line 105 of file AveragedSourcePde.cpp.

References AbstractElement< ELEMENT_DIM, SPACE_DIM >::GetIndex(), AveragedSourcePde< DIM >::mCellDensityOnCoarseElements, and AveragedSourcePde< DIM >::mCoefficient.

template<unsigned DIM>

double AveragedSourcePde< DIM >::GetCoefficient ( ) const [inline]

Returns:: mCoefficient (used in archiving).

Definition at line 47 of file AveragedSourcePde.cpp.

References AveragedSourcePde< DIM >::mCoefficient.

template<unsigned DIM>

double AveragedSourcePde< DIM >::GetUptakeRateForElement ( unsigned elementIndex ) [inline]

Returns the uptake rate.

Parameters:

elementIndex

the element we wish to return the uptake rate for

Definition at line 118 of file AveragedSourcePde.cpp.

References AveragedSourcePde< DIM >::mCellDensityOnCoarseElements.

template<unsigned DIM>

const AbstractCellPopulation< DIM > & AveragedSourcePde< DIM >::rGetCellPopulation ( ) const [inline]

Returns:: const reference to the cell population (used in archiving).

Definition at line 41 of file AveragedSourcePde.cpp.

References AveragedSourcePde< DIM >::mrCellPopulation.

template<unsigned DIM>

template<class Archive >

void AveragedSourcePde< DIM >::serialize	(	Archive &	archive,
		const unsigned int	version
	)			`[inline, private]`

Serialize the PDE and its member variables.

Parameters:

	archive	the archive
	version	the current version of this class

Reimplemented from AbstractLinearEllipticPde< DIM, DIM >.

Reimplemented in VolumeDependentAveragedSourcePde< DIM >.

Definition at line 60 of file AveragedSourcePde.hpp.

References AveragedSourcePde< DIM >::mCellDensityOnCoarseElements, and AveragedSourcePde< DIM >::mCoefficient.

template<unsigned DIM>

void AveragedSourcePde< DIM >::SetupSourceTerms	(	TetrahedralMesh< DIM, DIM > &	rCoarseMesh,
		std::map< CellPtr, unsigned > *	pCellPdeElementMap = `NULL`
	)			`[inline, virtual]`