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

#include <UniformSourceEllipticPde.hpp>

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

Public Member Functions

 UniformSourceEllipticPde (double constantSourceCoefficient=0.0, double linearSourceCoefficient=0.0, double diffusionCoefficient=1.0)
 
double GetConstantCoefficient () const
 
double GetLinearCoefficient () const
 
double GetDiffusionCoefficient () const
 
double ComputeConstantInUSourceTerm (const ChastePoint< DIM > &rX, Element< DIM, DIM > *pElement) override
 
double ComputeLinearInUCoeffInSourceTerm (const ChastePoint< DIM > &rX, Element< DIM, DIM > *pElement) override
 
c_matrix< double, DIM, DIM > ComputeDiffusionTerm (const ChastePoint< DIM > &rX) override
 
- Public Member Functions inherited from AbstractLinearEllipticPde< DIM, DIM >
 AbstractLinearEllipticPde ()
 
 ~AbstractLinearEllipticPde () override=default
 
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 ()
 

Private Member Functions

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

Private Attributes

double mConstantSourceCoefficient
 
double mLinearSourceCoefficient
 
double mDiffusionCoefficient
 

Friends

class TestCellBasedEllipticPdes
 
class boost::serialization::access
 

Detailed Description

template<unsigned DIM>
class UniformSourceEllipticPde< 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

D Grad.(Grad(u)) + a*u + b = 0,

where the scalars a, b and D are specified by the members 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 UniformSourceEllipticPde.hpp.

Constructor & Destructor Documentation

◆ UniformSourceEllipticPde()

template<unsigned DIM>
UniformSourceEllipticPde< DIM >::UniformSourceEllipticPde ( double  constantSourceCoefficient = 0.0,
double  linearSourceCoefficient = 0.0,
double  diffusionCoefficient = 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)

Definition at line 39 of file UniformSourceEllipticPde.cpp.

Member Function Documentation

◆ ComputeConstantInUSourceTerm()

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

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 65 of file UniformSourceEllipticPde.cpp.

◆ ComputeDiffusionTerm()

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

Overridden ComputeDiffusionTerm() method.

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

Definition at line 77 of file UniformSourceEllipticPde.cpp.

◆ ComputeLinearInUCoeffInSourceTerm()

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

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 71 of file UniformSourceEllipticPde.cpp.

◆ GetConstantCoefficient()

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

Definition at line 47 of file UniformSourceEllipticPde.cpp.

◆ GetDiffusionCoefficient()

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

Definition at line 59 of file UniformSourceEllipticPde.cpp.

◆ GetLinearCoefficient()

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

Definition at line 53 of file UniformSourceEllipticPde.cpp.

◆ serialize()

template<unsigned DIM>
template<class Archive >
void UniformSourceEllipticPde< 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 75 of file UniformSourceEllipticPde.hpp.

References UniformSourceEllipticPde< DIM >::mConstantSourceCoefficient, UniformSourceEllipticPde< DIM >::mDiffusionCoefficient, and UniformSourceEllipticPde< DIM >::mLinearSourceCoefficient.

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 UniformSourceEllipticPde.hpp.

◆ TestCellBasedEllipticPdes

template<unsigned DIM>
friend class TestCellBasedEllipticPdes
friend

Definition at line 62 of file UniformSourceEllipticPde.hpp.

Member Data Documentation

◆ mConstantSourceCoefficient

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

Coefficient of constant source term.

Definition at line 84 of file UniformSourceEllipticPde.hpp.

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

◆ mDiffusionCoefficient

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

Diffusion coefficient.

Definition at line 90 of file UniformSourceEllipticPde.hpp.

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

◆ mLinearSourceCoefficient

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

Coefficient of linear source term.

Definition at line 87 of file UniformSourceEllipticPde.hpp.

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


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