PdeAndBoundaryConditions< DIM > Class Template Reference

#include <PdeAndBoundaryConditions.hpp>

Collaboration diagram for PdeAndBoundaryConditions< DIM >:

[legend]

List of all members.

Public Member Functions
	PdeAndBoundaryConditions (AbstractLinearEllipticPde< DIM, DIM > *pPde, double boundaryValue=0.0, bool isNeumannBoundaryCondition=true)
	~PdeAndBoundaryConditions ()
AbstractLinearEllipticPde< DIM, DIM > *	GetPde ()
Vec	GetSolution ()
void	SetSolution (Vec solution)
bool	IsNeumannBoundaryCondition ()
double	GetBoundaryValue ()
bool	HasAveragedSourcePde ()
void	DestroySolution ()
void	SetUpSourceTermsForAveragedSourcePde (TetrahedralMesh< DIM, DIM > *pMesh)
Private Attributes
AbstractLinearEllipticPde< DIM, DIM > *	mpPde
double	mBoundaryValue
bool	mIsNeumannBoundaryCondition
Vec	mCurrentSolution

---

Detailed Description

template<unsigned DIM>
class PdeAndBoundaryConditions< DIM >

A helper class for use in CellBasedSimulationWithPdes. The class contains a pointer to a linear elliptic PDE, which is to be solved on the domain defined by the cell population. The class also contains information describing the boundary conditions that are to be imposed when solving the PDE. Currently we allow constant boundary conditions only (i.e. the same boundary condition is imposed on the entire boundary), which may be Neumann (imposed flux) or Dirichlet (imposed value).

Definition at line 46 of file PdeAndBoundaryConditions.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

PdeAndBoundaryConditions< DIM >::PdeAndBoundaryConditions	(	AbstractLinearEllipticPde< DIM, DIM > *	pPde,
		double	boundaryValue = 0.0,
		bool	isNeumannBoundaryCondition = true
	)			[inline]

Constructor.

Parameters:

	pPde	A pointer to a linear elliptic PDE object
	boundaryValue	The value of the constant boundary condition (defaults to zero)
	isNeumannBoundaryCondition	Whether the boundary condition is Neumann (defaults to true)

Definition at line 32 of file PdeAndBoundaryConditions.cpp.

template<unsigned DIM>

PdeAndBoundaryConditions< DIM >::~PdeAndBoundaryConditions

(

)

[inline]

Destructor.

Definition at line 43 of file PdeAndBoundaryConditions.cpp.

References PdeAndBoundaryConditions< DIM >::mCurrentSolution.

---

Member Function Documentation

template<unsigned DIM>

AbstractLinearEllipticPde< DIM, DIM > * PdeAndBoundaryConditions< DIM >::GetPde

(

)

[inline]

Returns:

mpPde

Definition at line 52 of file PdeAndBoundaryConditions.cpp.

References PdeAndBoundaryConditions< DIM >::mpPde.

Referenced by CellBasedSimulationWithPdes< DIM >::SolvePde(), and CellBasedSimulationWithPdes< DIM >::SolvePdeUsingCoarseMesh().

template<unsigned DIM>

Vec PdeAndBoundaryConditions< DIM >::GetSolution

(

)

[inline]

Returns:

mCurrentSolution

Definition at line 58 of file PdeAndBoundaryConditions.cpp.

References PdeAndBoundaryConditions< DIM >::mCurrentSolution.

Referenced by CellBasedSimulationWithPdes< DIM >::SolvePde(), and CellBasedSimulationWithPdes< DIM >::SolvePdeUsingCoarseMesh().

template<unsigned DIM>

void PdeAndBoundaryConditions< DIM >::SetSolution

(

Vec

solution

)

[inline]

Set mCurrentSolution.

Parameters:

solution

the current solution

Definition at line 64 of file PdeAndBoundaryConditions.cpp.

References PdeAndBoundaryConditions< DIM >::mCurrentSolution.

Referenced by CellBasedSimulationWithPdes< DIM >::SolvePde(), and CellBasedSimulationWithPdes< DIM >::SolvePdeUsingCoarseMesh().

template<unsigned DIM>

bool PdeAndBoundaryConditions< DIM >::IsNeumannBoundaryCondition

(

)

[inline]

Returns:

mIsNeumannBoundaryCondition

Definition at line 70 of file PdeAndBoundaryConditions.cpp.

References PdeAndBoundaryConditions< DIM >::mIsNeumannBoundaryCondition.

Referenced by CellBasedSimulationWithPdes< DIM >::SolvePde(), and CellBasedSimulationWithPdes< DIM >::SolvePdeUsingCoarseMesh().

template<unsigned DIM>

double PdeAndBoundaryConditions< DIM >::GetBoundaryValue

(

)

[inline]

Returns:

mBoundaryValue

Definition at line 76 of file PdeAndBoundaryConditions.cpp.

References PdeAndBoundaryConditions< DIM >::mBoundaryValue.

Referenced by CellBasedSimulationWithPdes< DIM >::SolvePde(), and CellBasedSimulationWithPdes< DIM >::SolvePdeUsingCoarseMesh().

template<unsigned DIM>

bool PdeAndBoundaryConditions< DIM >::HasAveragedSourcePde

(

)

[inline]

Returns:

whether the PDE is of type AveragedSourcePde

Definition at line 82 of file PdeAndBoundaryConditions.cpp.

References PdeAndBoundaryConditions< DIM >::mpPde.

Referenced by PdeAndBoundaryConditions< DIM >::SetUpSourceTermsForAveragedSourcePde().

template<unsigned DIM>

void PdeAndBoundaryConditions< DIM >::DestroySolution

(

)

[inline]

Call VecDestroy on mCurrentSolution.

Definition at line 88 of file PdeAndBoundaryConditions.cpp.

References PdeAndBoundaryConditions< DIM >::mCurrentSolution.

Referenced by CellBasedSimulationWithPdes< DIM >::SolvePde(), and CellBasedSimulationWithPdes< DIM >::SolvePdeUsingCoarseMesh().

template<unsigned DIM>

void PdeAndBoundaryConditions< DIM >::SetUpSourceTermsForAveragedSourcePde

(

TetrahedralMesh< DIM, DIM > *

pMesh

)

[inline]

In the case where mpPde is of type AveragedSourcePde, set the source terms using the information in the given mesh.

Parameters:

pMesh

Pointer to a tetrahedral mesh

Definition at line 97 of file PdeAndBoundaryConditions.cpp.

References PdeAndBoundaryConditions< DIM >::HasAveragedSourcePde(), and PdeAndBoundaryConditions< DIM >::mpPde.

Referenced by CellBasedSimulationWithPdes< DIM >::SolvePdeUsingCoarseMesh().

---

Member Data Documentation

template<unsigned DIM>

AbstractLinearEllipticPde<DIM,DIM>* PdeAndBoundaryConditions< DIM >::mpPde [private]

Pointer to a linear elliptic PDE object.

Definition at line 53 of file PdeAndBoundaryConditions.hpp.

Referenced by PdeAndBoundaryConditions< DIM >::GetPde(), PdeAndBoundaryConditions< DIM >::HasAveragedSourcePde(), and PdeAndBoundaryConditions< DIM >::SetUpSourceTermsForAveragedSourcePde().

template<unsigned DIM>

double PdeAndBoundaryConditions< DIM >::mBoundaryValue [private]

The value of the constant boundary condition.

Definition at line 58 of file PdeAndBoundaryConditions.hpp.

Referenced by PdeAndBoundaryConditions< DIM >::GetBoundaryValue().

template<unsigned DIM>

bool PdeAndBoundaryConditions< DIM >::mIsNeumannBoundaryCondition [private]

Whether the boundary condition is Neumann (false corresponds to a Dirichlet boundary condition).

Definition at line 64 of file PdeAndBoundaryConditions.hpp.

Referenced by PdeAndBoundaryConditions< DIM >::IsNeumannBoundaryCondition().

template<unsigned DIM>

Vec PdeAndBoundaryConditions< DIM >::mCurrentSolution [private]

Current solution to the PDE problem, for use as an initial guess when solving at the next time step.

Definition at line 70 of file PdeAndBoundaryConditions.hpp.

Referenced by PdeAndBoundaryConditions< DIM >::DestroySolution(), PdeAndBoundaryConditions< DIM >::GetSolution(), PdeAndBoundaryConditions< DIM >::SetSolution(), and PdeAndBoundaryConditions< DIM >::~PdeAndBoundaryConditions().

---

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

• cell_based/src/population/pdes/PdeAndBoundaryConditions.hpp
• cell_based/src/population/pdes/PdeAndBoundaryConditions.cpp