PlaneBoundaryCondition< DIM > Class Template Reference

#include <PlaneBoundaryCondition.hpp>

Inheritance diagram for PlaneBoundaryCondition< DIM >:

[legend]

Collaboration diagram for PlaneBoundaryCondition< DIM >:

[legend]

List of all members.

Public Member Functions
	PlaneBoundaryCondition (AbstractCellPopulation< DIM > *pCellPopulation, c_vector< double, DIM > point, c_vector< double, DIM > normal)
const c_vector< double, DIM > &	rGetPointOnPlane () const
const c_vector< double, DIM > &	rGetNormalToPlane () const
void	ImposeBoundaryCondition ()
bool	VerifyBoundaryCondition ()
void	OutputCellPopulationBoundaryConditionParameters (out_stream &rParamsFile)
Private Member Functions
template<class Archive>
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
c_vector< double, DIM >	mPointOnPlane
c_vector< double, DIM >	mNormalToPlane
Friends
class	boost::serialization::access

---

Detailed Description

template<unsigned DIM>
class PlaneBoundaryCondition< DIM >

A plane cell population boundary condition class, which stops nodes moving through a specified plane in the domain.

Todo:

The naming of this class indicates that it is specific to 3D (see #1589)

Definition at line 44 of file PlaneBoundaryCondition.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

PlaneBoundaryCondition< DIM >::PlaneBoundaryCondition	(	AbstractCellPopulation< DIM > *	pCellPopulation,
		c_vector< double, DIM >	point,
		c_vector< double, DIM >	normal
	)			[inline]

Constructor.

Parameters:

	pCellPopulation	pointer to the cell population
	point	a point on the boundary plane
	normal	the outward-facing unit normal vector to the boundary plane

Definition at line 33 of file PlaneBoundaryCondition.cpp.

References PlaneBoundaryCondition< DIM >::mNormalToPlane, and AbstractCellPopulationBoundaryCondition< DIM >::mpCellPopulation.

---

Member Function Documentation

template<unsigned DIM>

template<class Archive>

void PlaneBoundaryCondition< 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 from AbstractCellPopulationBoundaryCondition< DIM >.

Definition at line 67 of file PlaneBoundaryCondition.hpp.

template<unsigned DIM>

const c_vector< double, DIM > & PlaneBoundaryCondition< DIM >::rGetPointOnPlane

(

)

const [inline]

Returns:

mPointOnPlane.

Definition at line 46 of file PlaneBoundaryCondition.cpp.

References PlaneBoundaryCondition< DIM >::mPointOnPlane.

template<unsigned DIM>

const c_vector< double, DIM > & PlaneBoundaryCondition< DIM >::rGetNormalToPlane

(

)

const [inline]

Returns:

mNormalToPlane.

Definition at line 52 of file PlaneBoundaryCondition.cpp.

References PlaneBoundaryCondition< DIM >::mNormalToPlane.

template<unsigned DIM>

void PlaneBoundaryCondition< DIM >::ImposeBoundaryCondition

(

)

[inline, virtual]

Overridden ImposeBoundaryCondition() method.

Apply the cell population boundary conditions.

Todo:

this is only for AbstractCentreBasedCellPopulations (see #1589)

Implements AbstractCellPopulationBoundaryCondition< DIM >.

Definition at line 58 of file PlaneBoundaryCondition.cpp.

References EXCEPTION, PlaneBoundaryCondition< DIM >::mNormalToPlane, AbstractCellPopulationBoundaryCondition< DIM >::mpCellPopulation, PlaneBoundaryCondition< DIM >::mPointOnPlane, and Node< SPACE_DIM >::rGetModifiableLocation().

template<unsigned DIM>

bool PlaneBoundaryCondition< DIM >::VerifyBoundaryCondition

(

)

[inline, virtual]

Overridden VerifyBoundaryCondition() method. Verify the boundary conditions have been applied. This is called after ImposeBoundaryCondition() to ensure the condition is still satisfied.

Returns:

whether the boundary conditions are satisfied.

Implements AbstractCellPopulationBoundaryCondition< DIM >.

Definition at line 91 of file PlaneBoundaryCondition.cpp.

References EXCEPTION, PlaneBoundaryCondition< DIM >::mNormalToPlane, AbstractCellPopulationBoundaryCondition< DIM >::mpCellPopulation, and PlaneBoundaryCondition< DIM >::mPointOnPlane.

template<unsigned DIM>

void PlaneBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters

(

out_stream &

rParamsFile

)

[inline, virtual]

Overridden OutputCellPopulationBoundaryConditionParameters() method. Output cell population boundary condition parameters to file.

Parameters:

rParamsFile

the file stream to which the parameters are output

Implements AbstractCellPopulationBoundaryCondition< DIM >.

Definition at line 119 of file PlaneBoundaryCondition.cpp.

References PlaneBoundaryCondition< DIM >::mNormalToPlane, PlaneBoundaryCondition< DIM >::mPointOnPlane, and AbstractCellPopulationBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters().

---

Friends And Related Function Documentation

template<unsigned DIM>

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

Needed for serialization.

Reimplemented from AbstractCellPopulationBoundaryCondition< DIM >.

Definition at line 59 of file PlaneBoundaryCondition.hpp.

---

Member Data Documentation

template<unsigned DIM>

c_vector<double, DIM> PlaneBoundaryCondition< DIM >::mPointOnPlane [private]

A point on the boundary plane.

Definition at line 51 of file PlaneBoundaryCondition.hpp.

Referenced by PlaneBoundaryCondition< DIM >::ImposeBoundaryCondition(), PlaneBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters(), PlaneBoundaryCondition< DIM >::rGetPointOnPlane(), and PlaneBoundaryCondition< DIM >::VerifyBoundaryCondition().

template<unsigned DIM>

c_vector<double, DIM> PlaneBoundaryCondition< DIM >::mNormalToPlane [private]

The outward-facing unit normal vector to the boundary plane.

Definition at line 56 of file PlaneBoundaryCondition.hpp.

Referenced by PlaneBoundaryCondition< DIM >::ImposeBoundaryCondition(), PlaneBoundaryCondition< DIM >::OutputCellPopulationBoundaryConditionParameters(), PlaneBoundaryCondition< DIM >::PlaneBoundaryCondition(), PlaneBoundaryCondition< DIM >::rGetNormalToPlane(), and PlaneBoundaryCondition< DIM >::VerifyBoundaryCondition().

---

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

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