Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
Public Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
CellwiseSourceEllipticPde< DIM > Class Template Reference

#include <CellwiseSourceEllipticPde.hpp>

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

Public Member Functions

 CellwiseSourceEllipticPde (AbstractCellPopulation< DIM, DIM > &rCellPopulation, double sourceCoefficient=0.0)
 
const AbstractCellPopulation< DIM > & rGetCellPopulation () const
 
double GetCoefficient () const
 
virtual double ComputeConstantInUSourceTerm (const ChastePoint< DIM > &rX, Element< DIM, DIM > *pElement)
 
virtual double ComputeLinearInUCoeffInSourceTerm (const ChastePoint< DIM > &rX, Element< DIM, DIM > *pElement)
 
virtual double ComputeLinearInUCoeffInSourceTermAtNode (const Node< DIM > &rNode)
 
virtual c_matrix< double, DIM, DIM > ComputeDiffusionTerm (const ChastePoint< DIM > &rX)
 
- Public Member Functions inherited from AbstractLinearEllipticPde< DIM, DIM >
 AbstractLinearEllipticPde ()
 
virtual ~AbstractLinearEllipticPde ()
 
virtual double ComputeConstantInUSourceTerm (const ChastePoint< SPACE_DIM > &rX, Element< ELEMENT_DIM, SPACE_DIM > *pElement)=0
 
virtual double ComputeLinearInUCoeffInSourceTerm (const ChastePoint< SPACE_DIM > &rX, Element< ELEMENT_DIM, SPACE_DIM > *pElement)=0
 
virtual c_matrix< double, SPACE_DIM, SPACE_DIM > ComputeDiffusionTerm (const ChastePoint< SPACE_DIM > &rX)=0
 
virtual double ComputeConstantInUSourceTermAtNode (const Node< SPACE_DIM > &rNode)
 
virtual double ComputeLinearInUCoeffInSourceTermAtNode (const Node< SPACE_DIM > &rNode)
 
- Public Member Functions inherited from AbstractLinearPde< ELEMENT_DIM, SPACE_DIM >
 AbstractLinearPde ()
 
virtual ~AbstractLinearPde ()
 

Protected Attributes

AbstractCellPopulation< DIM, DIM > & mrCellPopulation
 
double mSourceCoefficient
 

Private Member Functions

template<class Archive >
void serialize (Archive &archive, const unsigned int version)
 

Friends

class TestCellBasedEllipticPdes
 
class boost::serialization::access
 

Detailed Description

template<unsigned DIM>
class CellwiseSourceEllipticPde< DIM >

An elliptic PDE to be solved numerically using the finite element method, for coupling to a cell-based simulation.

The PDE takes the form

Grad.(Grad(u)) + k*u*rho(x) = 0,

where the scalar k is specified by the member mSourceCoefficient, whose value must be set in the constructor.

For a node of the finite element mesh with location x, the function rho(x) equals one if there is a non-apoptotic cell associated with x, and zero otherwise. Here, 'associated with' takes a different meaning for each cell population class, and is encoded in the method IsPdeNodeAssociatedWithNonApoptoticCell().

Todo:
make member names and methods consistent with those of CellwiseSourceParabolicPde

Definition at line 64 of file CellwiseSourceEllipticPde.hpp.

Constructor & Destructor Documentation

◆ CellwiseSourceEllipticPde()

template<unsigned DIM>
CellwiseSourceEllipticPde< DIM >::CellwiseSourceEllipticPde ( AbstractCellPopulation< DIM, DIM > &  rCellPopulation,
double  sourceCoefficient = 0.0 
)

Constructor.

Parameters
rCellPopulationreference to the cell population
sourceCoefficientthe source term coefficient (defaults to 0.0)

Definition at line 39 of file CellwiseSourceEllipticPde.cpp.

Member Function Documentation

◆ ComputeConstantInUSourceTerm()

template<unsigned DIM>
double CellwiseSourceEllipticPde< DIM >::ComputeConstantInUSourceTerm ( const ChastePoint< DIM > &  rX,
Element< DIM, DIM > *  pElement 
)
virtual

Overridden ComputeConstantInUSourceTerm() method.

Parameters
rXThe point in space
pElementThe 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 58 of file CellwiseSourceEllipticPde.cpp.

◆ ComputeDiffusionTerm()

template<unsigned DIM>
c_matrix< double, DIM, DIM > CellwiseSourceEllipticPde< DIM >::ComputeDiffusionTerm ( const ChastePoint< DIM > &  rX)
virtual

Overridden ComputeDiffusionTerm() method.

Parameters
rXThe point in space at which the diffusion term is computed
Returns
a matrix.

Definition at line 86 of file CellwiseSourceEllipticPde.cpp.

◆ ComputeLinearInUCoeffInSourceTerm()

template<unsigned DIM>
double CellwiseSourceEllipticPde< DIM >::ComputeLinearInUCoeffInSourceTerm ( const ChastePoint< DIM > &  rX,
Element< DIM, DIM > *  pElement 
)
virtual

Overridden ComputeLinearInUCoeffInSourceTerm() method.

Parameters
rXThe point in space
pElementthe 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 65 of file CellwiseSourceEllipticPde.cpp.

References NEVER_REACHED.

◆ ComputeLinearInUCoeffInSourceTermAtNode()

template<unsigned DIM>
double CellwiseSourceEllipticPde< DIM >::ComputeLinearInUCoeffInSourceTermAtNode ( const Node< DIM > &  rNode)
virtual

Overridden ComputeLinearInUCoeffInSourceTermAtNode() method.

Parameters
rNodereference to the node
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 73 of file CellwiseSourceEllipticPde.cpp.

References Node< SPACE_DIM >::GetIndex().

◆ GetCoefficient()

template<unsigned DIM>
double CellwiseSourceEllipticPde< DIM >::GetCoefficient ( ) const
Returns
mSourceCoefficient (used in archiving).

Definition at line 52 of file CellwiseSourceEllipticPde.cpp.

◆ rGetCellPopulation()

template<unsigned DIM>
const AbstractCellPopulation< DIM, DIM > & CellwiseSourceEllipticPde< DIM >::rGetCellPopulation ( ) const
Returns
const reference to the cell population (used in archiving).

Definition at line 46 of file CellwiseSourceEllipticPde.cpp.

◆ serialize()

template<unsigned DIM>
template<class Archive >
void CellwiseSourceEllipticPde< DIM >::serialize ( Archive &  archive,
const unsigned int  version 
)
inlineprivate

Serialize the PDE and its member variables.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 79 of file CellwiseSourceEllipticPde.hpp.

References CellwiseSourceEllipticPde< DIM >::mSourceCoefficient.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<unsigned DIM>
friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 71 of file CellwiseSourceEllipticPde.hpp.

◆ TestCellBasedEllipticPdes

template<unsigned DIM>
friend class TestCellBasedEllipticPdes
friend

Definition at line 66 of file CellwiseSourceEllipticPde.hpp.

Member Data Documentation

◆ mrCellPopulation

template<unsigned DIM>
AbstractCellPopulation<DIM, DIM>& CellwiseSourceEllipticPde< DIM >::mrCellPopulation
protected

The cell population member.

Definition at line 88 of file CellwiseSourceEllipticPde.hpp.

◆ mSourceCoefficient

template<unsigned DIM>
double CellwiseSourceEllipticPde< DIM >::mSourceCoefficient
protected

Coefficient of the source term.

Definition at line 91 of file CellwiseSourceEllipticPde.hpp.

Referenced by CellwiseSourceEllipticPde< DIM >::serialize().

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