Chaste Release::3.1
Public Member Functions | Protected Attributes
PottsMeshGenerator< DIM > Class Template Reference

#include <PottsMeshGenerator.hpp>

Collaboration diagram for PottsMeshGenerator< DIM >:

List of all members.

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)
 PottsMeshGenerator ()
virtual ~PottsMeshGenerator ()
void CaclulateNeighbouringNodeIndices (bool isPeriodicInX)
virtual PottsMesh< DIM > * GetMesh ()

Protected Attributes

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 52 of file PottsMeshGenerator.hpp.

Constructor & Destructor Documentation

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:
numNodesAcrossThe number of columns of nodes in the mesh
numElementsAcrossThe number of columns of elements in the mesh
elementWidthWidth of the elements
numNodesUpThe number of rows of nodes in the mesh (defaults to 1)
numElementsUpThe number of rows of elements in the mesh (defaults to 1)
elementHeightHeight of the elements (defaults to 1)
numNodesDeepThe number nodes deep for this mesh (defaults to 1)
numElementsDeepThe number of elements deep for this mesh (defaults to 1)
elementDepthThe number of rows of nodes in each element (defaults to 1)
startAtBottomLeftIf true then the mesh starts in the bottom left corner of the domain rather than the centre, used for simple tests (defaults to false)
isPeriodicInXIf true then the mesh is periodic in the x dimension (defaults to false)
isPeriodicInYIf true then the mesh is periodic in the y dimension (defaults to false)
isPeriodicInZIf true then the mesh is periodic in the y dimension (defaults to false)

Definition at line 39 of file PottsMeshGenerator.cpp.

References NEVER_REACHED.

template<unsigned DIM>
PottsMeshGenerator< DIM >::PottsMeshGenerator ( ) [inline]

Null constructor for derived classes to call.

Definition at line 96 of file PottsMeshGenerator.hpp.

template<unsigned DIM>
PottsMeshGenerator< DIM >::~PottsMeshGenerator ( ) [virtual]

Destructor - deletes the mesh object and pointer

Definition at line 740 of file PottsMeshGenerator.cpp.

Member Function Documentation

template<unsigned DIM>
void PottsMeshGenerator< DIM >::CaclulateNeighbouringNodeIndices ( bool  isPeriodicInX)

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

Parameters:
isPeriodicInXIf true then the mesh is periodic in the x dimension
template<unsigned DIM>
PottsMesh< DIM > * PottsMeshGenerator< DIM >::GetMesh ( ) [virtual]
Returns:
a Cuboid or rectangular Potts mesh.

Definition at line 746 of file PottsMeshGenerator.cpp.

Member Data Documentation

template<unsigned DIM>
PottsMesh<DIM>* PottsMeshGenerator< DIM >::mpMesh [protected]

A pointer to the mesh this class creates

Definition at line 57 of file PottsMeshGenerator.hpp.

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