Chaste Commit::30a3e656d4b131f8c595cc6eb2becd297337570f
UniformSourceParabolicPde< DIM > Class Template Reference

#include <UniformSourceParabolicPde.hpp>

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

Public Member Functions

 UniformSourceParabolicPde (double constantSourceCoefficient=0.0, double linearSourceCoefficient=0.0, double diffusionCoefficient=1.0, double duDtCoefficient=1.0)
 
double GetConstantCoefficient () const
 
double GetLinearCoefficient () const
 
double GetDiffusionCoefficient () const
 
double GetDuDtCoefficient () const
 
double ComputeSourceTerm (const ChastePoint< DIM > &rX, double u, Element< DIM, DIM > *pElement=nullptr) override
 
c_matrix< double, DIM, DIM > ComputeDiffusionTerm (const ChastePoint< DIM > &rX, Element< DIM, DIM > *pElement=nullptr) override
 
double ComputeDuDtCoefficientFunction (const ChastePoint< DIM > &rX) override
 
- Public Member Functions inherited from AbstractLinearParabolicPde< DIM, DIM >
 AbstractLinearParabolicPde ()
 
virtual ~AbstractLinearParabolicPde ()
 
virtual double ComputeDuDtCoefficientFunction (const ChastePoint< SPACE_DIM > &rX)=0
 
virtual double ComputeSourceTerm (const ChastePoint< SPACE_DIM > &rX, double u, Element< ELEMENT_DIM, SPACE_DIM > *pElement=nullptr)=0
 
virtual double ComputeSourceTermAtNode (const Node< SPACE_DIM > &rNode, double u)
 
virtual c_matrix< double, SPACE_DIM, SPACE_DIM > ComputeDiffusionTerm (const ChastePoint< SPACE_DIM > &rX, Element< ELEMENT_DIM, SPACE_DIM > *pElement)=0
 
- Public Member Functions inherited from AbstractLinearPde< ELEMENT_DIM, SPACE_DIM >
 AbstractLinearPde ()
 
virtual ~AbstractLinearPde ()
 

Private Member Functions

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

Private Attributes

double mConstantSourceCoefficient
 
double mLinearSourceCoefficient
 
double mDiffusionCoefficient
 
double mDuDtCoefficient
 

Friends

class TestCellBasedParabolicPdes
 
class boost::serialization::access
 

Detailed Description

template<unsigned DIM>
class UniformSourceParabolicPde< DIM >

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

The PDE takes the form

c*du/dt = D Grad.(Grad(u)) + a*u + b,

where the scalars c, a, b and D are specified by the members mDuDtCoefficient, mConstantSourceCoefficient, mLinearSourceCoefficient, and mDiffusionCoefficient respectively whose values must be set in the constructor.

Thus, there is no direct coupling between the cell-based simulation and the terms of the PDE; here, the cell population just defines the spatial domain on which to solve the PDE.

Definition at line 60 of file UniformSourceParabolicPde.hpp.

Constructor & Destructor Documentation

◆ UniformSourceParabolicPde()

template<unsigned DIM>
UniformSourceParabolicPde< DIM >::UniformSourceParabolicPde ( double  constantSourceCoefficient = 0.0,
double  linearSourceCoefficient = 0.0,
double  diffusionCoefficient = 1.0,
double  duDtCoefficient = 1.0 
)

Constructor.

Parameters
constantSourceCoefficientthe constant source term coefficient (defaults to 0.0)
linearSourceCoefficientthe linear source term coefficient (defaults to 0.0)
diffusionCoefficientthe rate of diffusion (defaults to 1.0)
duDtCoefficientrate of reaction (defaults to 1.0)

Definition at line 39 of file UniformSourceParabolicPde.cpp.

Member Function Documentation

◆ ComputeDiffusionTerm()

template<unsigned DIM>
c_matrix< double, DIM, DIM > UniformSourceParabolicPde< DIM >::ComputeDiffusionTerm ( const ChastePoint< DIM > &  rX,
Element< DIM, DIM > *  pElement = nullptr 
)
override

Overridden ComputeDiffusionTerm() method.

Parameters
rXthe point in space at which the diffusion term is computed
pElementthe mesh element that x is contained in (optional; defaults to NULL).
Returns
a matrix.

Definition at line 81 of file UniformSourceParabolicPde.cpp.

◆ ComputeDuDtCoefficientFunction()

template<unsigned DIM>
double UniformSourceParabolicPde< DIM >::ComputeDuDtCoefficientFunction ( const ChastePoint< DIM > &  rX)
override

Overridden ComputeDuDtCoefficientFunction() method.

Returns
the function c(x) in "c(x) du/dt = Grad.(DiffusionTerm(x)*Grad(u))+LinearSourceTerm(x)+NonlinearSourceTerm(x, u)"
Parameters
rXthe point in space at which the function c is computed

Definition at line 87 of file UniformSourceParabolicPde.cpp.

◆ ComputeSourceTerm()

template<unsigned DIM>
double UniformSourceParabolicPde< DIM >::ComputeSourceTerm ( const ChastePoint< DIM > &  rX,
double  u,
Element< DIM, DIM > *  pElement = nullptr 
)
override

Overridden ComputeSourceTerm() method.

Parameters
rXthe point in space at which the nonlinear source term is computed
uthe value of the dependent variable at the point
pElementThe element
Returns
the source term.

Definition at line 75 of file UniformSourceParabolicPde.cpp.

◆ GetConstantCoefficient()

template<unsigned DIM>
double UniformSourceParabolicPde< DIM >::GetConstantCoefficient ( ) const
Returns
mConstantSourceCoefficient

Definition at line 51 of file UniformSourceParabolicPde.cpp.

◆ GetDiffusionCoefficient()

template<unsigned DIM>
double UniformSourceParabolicPde< DIM >::GetDiffusionCoefficient ( ) const
Returns
mDiffusionCoefficient

Definition at line 63 of file UniformSourceParabolicPde.cpp.

◆ GetDuDtCoefficient()

template<unsigned DIM>
double UniformSourceParabolicPde< DIM >::GetDuDtCoefficient ( ) const
Returns
mDuDtCoefficient

Definition at line 69 of file UniformSourceParabolicPde.cpp.

◆ GetLinearCoefficient()

template<unsigned DIM>
double UniformSourceParabolicPde< DIM >::GetLinearCoefficient ( ) const
Returns
mLinearSourceCoefficient

Definition at line 57 of file UniformSourceParabolicPde.cpp.

◆ serialize()

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

Friends And Related Symbol Documentation

◆ boost::serialization::access

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

Needed for serialization.

Definition at line 67 of file UniformSourceParabolicPde.hpp.

◆ TestCellBasedParabolicPdes

template<unsigned DIM>
friend class TestCellBasedParabolicPdes
friend

Definition at line 62 of file UniformSourceParabolicPde.hpp.

Member Data Documentation

◆ mConstantSourceCoefficient

template<unsigned DIM>
double UniformSourceParabolicPde< DIM >::mConstantSourceCoefficient
private

Coefficient of constant source term.

Definition at line 85 of file UniformSourceParabolicPde.hpp.

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

◆ mDiffusionCoefficient

template<unsigned DIM>
double UniformSourceParabolicPde< DIM >::mDiffusionCoefficient
private

Diffusion coefficient.

Definition at line 91 of file UniformSourceParabolicPde.hpp.

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

◆ mDuDtCoefficient

template<unsigned DIM>
double UniformSourceParabolicPde< DIM >::mDuDtCoefficient
private

Coefficient of rate of change term.

Definition at line 94 of file UniformSourceParabolicPde.hpp.

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

◆ mLinearSourceCoefficient

template<unsigned DIM>
double UniformSourceParabolicPde< DIM >::mLinearSourceCoefficient
private

Coefficient of linear source term.

Definition at line 88 of file UniformSourceParabolicPde.hpp.

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


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