Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
ToroidalHoneycombVertexMeshGenerator Class Reference

#include <ToroidalHoneycombVertexMeshGenerator.hpp>

+ Inheritance diagram for ToroidalHoneycombVertexMeshGenerator:
+ Collaboration diagram for ToroidalHoneycombVertexMeshGenerator:

Public Member Functions

 ToroidalHoneycombVertexMeshGenerator (unsigned numElementsAcross, unsigned numElementsUp, double cellRearrangementThreshold=0.01, double t2Threshold=0.001)
 
boost::shared_ptr< MutableVertexMesh< 2, 2 > > GetMesh ()
 
boost::shared_ptr< Toroidal2dVertexMeshGetToroidalMesh ()
 

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 "toroidal" mesh (one in which periodicity is imposed on the left and right and top and bottom boundaries) for use with vertex-based simulations.

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

Definition at line 53 of file ToroidalHoneycombVertexMeshGenerator.hpp.

Constructor & Destructor Documentation

◆ ToroidalHoneycombVertexMeshGenerator()

ToroidalHoneycombVertexMeshGenerator::ToroidalHoneycombVertexMeshGenerator ( unsigned  numElementsAcross,
unsigned  numElementsUp,
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. This MUST be an even number.
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
Todo:
This should be an exception

Definition at line 40 of file ToroidalHoneycombVertexMeshGenerator.cpp.

References HoneycombVertexMeshGenerator::mpMesh.

Member Function Documentation

◆ GetMesh()

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

Reimplemented from HoneycombVertexMeshGenerator.

Definition at line 122 of file ToroidalHoneycombVertexMeshGenerator.cpp.

References EXCEPTION, and HoneycombVertexMeshGenerator::mpMesh.

◆ GetToroidalMesh()

boost::shared_ptr< Toroidal2dVertexMesh > ToroidalHoneycombVertexMeshGenerator::GetToroidalMesh ( )
Returns
a 2D honeycomb mesh with periodic left/right and top/bottom boundaries

Definition at line 128 of file ToroidalHoneycombVertexMeshGenerator.cpp.

References HoneycombVertexMeshGenerator::mpMesh.


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