AbstractCellPopulationBoundaryCondition< DIM > Class Template Reference

#include <AbstractCellPopulationBoundaryCondition.hpp>

Inheritance diagram for AbstractCellPopulationBoundaryCondition< DIM >:

[legend]

Collaboration diagram for AbstractCellPopulationBoundaryCondition< DIM >:

[legend]

List of all members.

Public Member Functions
	AbstractCellPopulationBoundaryCondition (AbstractCellPopulation< DIM > *pCellPopulation)
virtual	~AbstractCellPopulationBoundaryCondition ()
virtual void	ImposeBoundaryCondition ()=0
virtual bool	VerifyBoundaryCondition ()=0
const AbstractCellPopulation < DIM > *	GetCellPopulation () const
void	OutputCellPopulationBoundaryConditionInfo (out_stream &rParamsFile)
virtual void	OutputCellPopulationBoundaryConditionParameters (out_stream &rParamsFile)=0
Protected Attributes
AbstractCellPopulation< DIM > *	mpCellPopulation
Private Member Functions
template<class Archive>
void	serialize (Archive &archive, const unsigned int version)
Friends
class	boost::serialization::access

---

Detailed Description

template<unsigned DIM>
class AbstractCellPopulationBoundaryCondition< DIM >

An abstract cell population boundary condition class, for use in cell-based simulations.

Definition at line 41 of file AbstractCellPopulationBoundaryCondition.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

AbstractCellPopulationBoundaryCondition< DIM >::AbstractCellPopulationBoundaryCondition

(

AbstractCellPopulation< DIM > *

pCellPopulation

)

[inline]

Constructor.

Parameters:

pCellPopulation

pointer to the cell population.

Definition at line 32 of file AbstractCellPopulationBoundaryCondition.cpp.

template<unsigned DIM>

AbstractCellPopulationBoundaryCondition< DIM >::~AbstractCellPopulationBoundaryCondition

(

)

[inline, virtual]

Destructor.

Definition at line 38 of file AbstractCellPopulationBoundaryCondition.cpp.

---

Member Function Documentation

template<unsigned DIM>

template<class Archive>

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

Serialize the object and its member variables.

Parameters:

	archive	the archive
	version	the current version of this class

Reimplemented in PlaneBoundaryCondition< DIM >.

Definition at line 53 of file AbstractCellPopulationBoundaryCondition.hpp.

template<unsigned DIM>

virtual void AbstractCellPopulationBoundaryCondition< DIM >::ImposeBoundaryCondition

(

)

[pure virtual]

Impose the boundary condition on each node.

As this method is pure virtual, it must be overridden in subclasses.

Implemented in PlaneBoundaryCondition< DIM >.

template<unsigned DIM>

virtual bool AbstractCellPopulationBoundaryCondition< DIM >::VerifyBoundaryCondition

(

)

[pure virtual]

Pure method which should verify the boundary condition has been applied. This is called after ImposeBoundaryCondition() to ensure the condition is still satisfied.

As this method is pure virtual, it must be overridden in subclasses.

Returns:

whether the boundary condition is satisfied.

Implemented in PlaneBoundaryCondition< DIM >.

template<unsigned DIM>

const AbstractCellPopulation< DIM > * AbstractCellPopulationBoundaryCondition< DIM >::GetCellPopulation

(

)

const [inline]

Get a pointer to the cell population.

Returns:

A const pointer to the mpCellPopulation

Definition at line 43 of file AbstractCellPopulationBoundaryCondition.cpp.

References AbstractCellPopulationBoundaryCondition< DIM >::mpCellPopulation.

template<unsigned DIM>

void AbstractCellPopulationBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionInfo

(

out_stream &

rParamsFile

)

[inline]

Output cell population boundary condition used in the simulation to file and then call OutputCellPopulationBoundaryConditionParameters() to output all relevant parameters.

Parameters:

rParamsFile

the file stream to which the parameters are output

Definition at line 49 of file AbstractCellPopulationBoundaryCondition.cpp.

References Identifiable::GetIdentifier(), and AbstractCellPopulationBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters().

template<unsigned DIM>

void AbstractCellPopulationBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters

(

out_stream &

rParamsFile

)

[inline, pure virtual]

Output cell population boundary condition parameters to file.

As this method is pure virtual, it must be overridden in subclasses.

Parameters:

rParamsFile

the file stream to which the parameters are output

Implemented in PlaneBoundaryCondition< DIM >.

Definition at line 59 of file AbstractCellPopulationBoundaryCondition.cpp.

Referenced by AbstractCellPopulationBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionInfo(), and PlaneBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters().

---

Friends And Related Function Documentation

template<unsigned DIM>

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented in PlaneBoundaryCondition< DIM >.

Definition at line 45 of file AbstractCellPopulationBoundaryCondition.hpp.

---

Member Data Documentation

template<unsigned DIM>

AbstractCellPopulation<DIM>* AbstractCellPopulationBoundaryCondition< DIM >::mpCellPopulation [protected]

The cell population.

Definition at line 61 of file AbstractCellPopulationBoundaryCondition.hpp.

Referenced by AbstractCellPopulationBoundaryCondition< DIM >::GetCellPopulation(), PlaneBoundaryCondition< DIM >::ImposeBoundaryCondition(), PlaneBoundaryCondition< DIM >::PlaneBoundaryCondition(), and PlaneBoundaryCondition< DIM >::VerifyBoundaryCondition().

---

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

• cell_based/src/population/boundary_conditions/AbstractCellPopulationBoundaryCondition.hpp
• cell_based/src/population/boundary_conditions/AbstractCellPopulationBoundaryCondition.cpp