PottsMeshGenerator< DIM > Class Template Reference

#include <PottsMeshGenerator.hpp>

Collaboration diagram for PottsMeshGenerator< DIM >:

Public Member Functions
	PottsMeshGenerator (unsigned numNodesAcross, unsigned numElementsAcross, unsigned elementWidth, unsigned numNodesUp=1u, unsigned numElementsUp=1u, unsigned elementHeight=1u, unsigned numNodesDeep=1u, unsigned numElementsDeep=1u, unsigned elementDepth=1u, bool startAtBottomLeft=false, bool isPeriodicInX=false, bool isPeriodicInY=false, bool isPeriodicInZ=false)
virtual	~PottsMeshGenerator ()=default
void	CaclulateNeighbouringNodeIndices (bool isPeriodicInX)
virtual boost::shared_ptr< PottsMesh< DIM > >	GetMesh ()

Protected Attributes
boost::shared_ptr< PottsMesh< DIM > >	mpMesh

Detailed Description

template<unsigned DIM>
class PottsMeshGenerator< DIM >

Generator of regular Potts meshes, used as starting points for many simulations.

This class takes in options such as width, height,

NOTE: the user should delete the mesh after use to manage memory.

Definition at line 53 of file PottsMeshGenerator.hpp.

Constructor & Destructor Documentation

PottsMeshGenerator()

template<unsigned DIM>

PottsMeshGenerator< DIM >::PottsMeshGenerator	(	unsigned	numNodesAcross,
		unsigned	numElementsAcross,
		unsigned	elementWidth,
		unsigned	numNodesUp = 1u,
		unsigned	numElementsUp = 1u,
		unsigned	elementHeight = 1u,
		unsigned	numNodesDeep = 1u,
		unsigned	numElementsDeep = 1u,
		unsigned	elementDepth = 1u,
		bool	startAtBottomLeft = false,
		bool	isPeriodicInX = false,
		bool	isPeriodicInY = false,
		bool	isPeriodicInZ = false
	)

Constructor.

Parameters

numNodesAcross	The number of columns of nodes in the mesh
numElementsAcross	The number of columns of elements in the mesh
elementWidth	Width of the elements
numNodesUp	The number of rows of nodes in the mesh (defaults to 1)
numElementsUp	The number of rows of elements in the mesh (defaults to 1)
elementHeight	Height of the elements (defaults to 1)
numNodesDeep	The number nodes deep for this mesh (defaults to 1)
numElementsDeep	The number of elements deep for this mesh (defaults to 1)
elementDepth	The number of rows of nodes in each element (defaults to 1)
startAtBottomLeft	If true then the mesh starts in the bottom left corner of the domain rather than the centre, used for simple tests (defaults to false)
isPeriodicInX	If true then the mesh is periodic in the x dimension (defaults to false)
isPeriodicInY	If true then the mesh is periodic in the y dimension (defaults to false)
isPeriodicInZ	If true then the mesh is periodic in the y dimension (defaults to false)

Definition at line 43 of file PottsMeshGenerator.cpp.

References NEVER_REACHED.

~PottsMeshGenerator()

template<unsigned DIM>

virtual PottsMeshGenerator< DIM >::~PottsMeshGenerator ( )

virtualdefault

Empty destructor.

Member Function Documentation

CaclulateNeighbouringNodeIndices()

template<unsigned DIM>

void PottsMeshGenerator< DIM >::CaclulateNeighbouringNodeIndices

(

bool

isPeriodicInX

)

Helper method to calculate the Moore and Von Neumann Neighbourhoods of all nodes

Parameters

isPeriodicInX

If true then the mesh is periodic in the x dimension

GetMesh()

template<unsigned DIM>

boost::shared_ptr< PottsMesh< DIM > > PottsMeshGenerator< DIM >::GetMesh ( )

virtual

Returns

a Cuboid or rectangular Potts mesh.

Definition at line 743 of file PottsMeshGenerator.cpp.

Member Data Documentation

mpMesh

template<unsigned DIM>

boost::shared_ptr<PottsMesh<DIM> > PottsMeshGenerator< DIM >::mpMesh

protected

A pointer to the mesh this class creates

Definition at line 58 of file PottsMeshGenerator.hpp.

---

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

• cell_based/src/mesh/PottsMeshGenerator.hpp
• cell_based/src/mesh/PottsMeshGenerator.cpp