Chaste Commit::1fd4e48e3990e67db148bc1bc4cf6991a0049d0c
HoneycombVertexMeshGenerator Class Reference

#include <HoneycombVertexMeshGenerator.hpp>

+ Inheritance diagram for HoneycombVertexMeshGenerator:
+ Collaboration diagram for HoneycombVertexMeshGenerator:

Public Member Functions

 HoneycombVertexMeshGenerator (unsigned numElementsAcross, unsigned numElementsUp, bool isFlatBottom=false, double cellRearrangementThreshold=0.01, double t2Threshold=0.001, double elementArea=0.5 *sqrt(3.0))
 
 HoneycombVertexMeshGenerator ()
 
virtual ~HoneycombVertexMeshGenerator ()=default
 
virtual boost::shared_ptr< MutableVertexMesh< 2, 2 > > GetMesh ()
 

Protected Attributes

boost::shared_ptr< MutableVertexMesh< 2, 2 > > mpMesh
 

Detailed Description

Honeycomb mesh generator that creates a 2D honeycomb mesh (with equal distance between nodes) for use in vertex simulations.

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

Definition at line 51 of file HoneycombVertexMeshGenerator.hpp.

Constructor & Destructor Documentation

◆ HoneycombVertexMeshGenerator() [1/2]

HoneycombVertexMeshGenerator::HoneycombVertexMeshGenerator ( unsigned  numElementsAcross,
unsigned  numElementsUp,
bool  isFlatBottom = false,
double  cellRearrangementThreshold = 0.01,
double  t2Threshold = 0.001,
double  elementArea = 0.5*sqrt(3.0) 
)

Constructor.

Parameters
numElementsAcrossThe number of columns of elements in the mesh
numElementsUpThe number of rows of elements in the mesh
isFlatBottomWhether to enforce a flat bottom to the mesh (defaults to false)
cellRearrangementThresholdthe minimum threshold distance for element rearrangement (defaults to 0.01)
t2Thresholdthe maximum threshold distance for Type 2 swaps (defaults to 0.001)
elementAreathe element area, which has default value 0.5*sqrt(3.0)

Definition at line 40 of file HoneycombVertexMeshGenerator.cpp.

References mpMesh.

◆ HoneycombVertexMeshGenerator() [2/2]

HoneycombVertexMeshGenerator::HoneycombVertexMeshGenerator ( )
inline

Null constructor for derived classes to call.

Definition at line 80 of file HoneycombVertexMeshGenerator.hpp.

◆ ~HoneycombVertexMeshGenerator()

virtual HoneycombVertexMeshGenerator::~HoneycombVertexMeshGenerator ( )
virtualdefault

Empty destructor.

Member Function Documentation

◆ GetMesh()

boost::shared_ptr< MutableVertexMesh< 2, 2 > > HoneycombVertexMeshGenerator::GetMesh ( )
virtual
Returns
a 2D honeycomb mesh

Reimplemented in CylindricalHoneycombVertexMeshGenerator, and ToroidalHoneycombVertexMeshGenerator.

Definition at line 209 of file HoneycombVertexMeshGenerator.cpp.

References mpMesh.

Member Data Documentation

◆ mpMesh


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