Chaste Commit::1fd4e48e3990e67db148bc1bc4cf6991a0049d0c
CylindricalHoneycombVertexMeshGenerator Class Reference

#include <CylindricalHoneycombVertexMeshGenerator.hpp>

+ Inheritance diagram for CylindricalHoneycombVertexMeshGenerator:
+ Collaboration diagram for CylindricalHoneycombVertexMeshGenerator:

Public Member Functions

 CylindricalHoneycombVertexMeshGenerator (unsigned numElementsAcross, unsigned numElementsUp, bool isFlatBottom=false, double cellRearrangementThreshold=0.01, double t2Threshold=0.001)
 
boost::shared_ptr< MutableVertexMesh< 2, 2 > > GetMesh ()
 
boost::shared_ptr< Cylindrical2dVertexMeshGetCylindricalMesh ()
 

Additional Inherited Members

- Private Member Functions inherited from HoneycombVertexMeshGenerator
 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
 
- Private Attributes inherited from HoneycombVertexMeshGenerator
boost::shared_ptr< MutableVertexMesh< 2, 2 > > mpMesh
 

Detailed Description

Honeycomb mesh generator that creates a 2D "cylindrical" mesh (one in which periodicity is imposed on the left and right boundaries) for use in vertex simulations.

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

Definition at line 53 of file CylindricalHoneycombVertexMeshGenerator.hpp.

Constructor & Destructor Documentation

◆ CylindricalHoneycombVertexMeshGenerator()

CylindricalHoneycombVertexMeshGenerator::CylindricalHoneycombVertexMeshGenerator ( unsigned  numElementsAcross,
unsigned  numElementsUp,
bool  isFlatBottom = false,
double  cellRearrangementThreshold = 0.01,
double  t2Threshold = 0.001 
)

Constructor.

Parameters
numElementsAcrossThe number of columns of elements in the mesh. This MUST be an even number.
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)
Todo:
This should be an exception (#2401)

Definition at line 40 of file CylindricalHoneycombVertexMeshGenerator.cpp.

References HoneycombVertexMeshGenerator::mpMesh.

Member Function Documentation

◆ GetCylindricalMesh()

boost::shared_ptr< Cylindrical2dVertexMesh > CylindricalHoneycombVertexMeshGenerator::GetCylindricalMesh ( )
Returns
a 2D honeycomb mesh with periodic left/right boundaries

Definition at line 146 of file CylindricalHoneycombVertexMeshGenerator.cpp.

References HoneycombVertexMeshGenerator::mpMesh.

◆ GetMesh()

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

Reimplemented from HoneycombVertexMeshGenerator.

Definition at line 140 of file CylindricalHoneycombVertexMeshGenerator.cpp.

References EXCEPTION, and HoneycombVertexMeshGenerator::mpMesh.


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