HoneycombVertexMeshGenerator Class Reference

#include <HoneycombVertexMeshGenerator.hpp>

Inherited by CylindricalHoneycombVertexMeshGenerator [private], and ToroidalHoneycombVertexMeshGenerator [private].

Collaboration diagram for HoneycombVertexMeshGenerator:

[legend]

List of all members.

Public Member Functions
	HoneycombVertexMeshGenerator (unsigned numElementsAcross, unsigned numElementsUp, bool isFlatBottom=false, double cellRearrangementThreshold=0.01, double t2Threshold=0.001)
	HoneycombVertexMeshGenerator ()
virtual	~HoneycombVertexMeshGenerator ()
virtual MutableVertexMesh< 2, 2 > *	GetMesh ()
Protected Attributes
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 50 of file HoneycombVertexMeshGenerator.hpp.

---

Constructor & Destructor Documentation

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

Constructor.

Parameters:

	numElementsAcross	The number of columns of elements in the mesh
	numElementsUp	The number of rows of elements in the mesh
	isFlatBottom	Whether to enforce a flat bottom to the mesh (defaults to false)
	cellRearrangementThreshold	the minimum threshold distance for element rearrangement (defaults to 0.01)
	t2Threshold	the maximum threshold distance for Type 2 swaps (defaults to 0.001)

Definition at line 38 of file HoneycombVertexMeshGenerator.cpp.

References mpMesh.

HoneycombVertexMeshGenerator::HoneycombVertexMeshGenerator

(

)

[inline]

Null constructor for derived classes to call.

Definition at line 77 of file HoneycombVertexMeshGenerator.hpp.

HoneycombVertexMeshGenerator::~HoneycombVertexMeshGenerator

(

)

[virtual]

Destructor - deletes the mesh object and pointer.

Definition at line 147 of file HoneycombVertexMeshGenerator.cpp.

References mpMesh.

---

Member Function Documentation

MutableVertexMesh< 2, 2 > * HoneycombVertexMeshGenerator::GetMesh

(

)

[virtual]

Returns:

a 2D honeycomb mesh

Reimplemented in CylindricalHoneycombVertexMeshGenerator, and ToroidalHoneycombVertexMeshGenerator.

Definition at line 152 of file HoneycombVertexMeshGenerator.cpp.

References mpMesh.

---

Member Data Documentation

MutableVertexMesh<2,2>* HoneycombVertexMeshGenerator::mpMesh [protected]

A pointer to the mesh this class creates

Definition at line 55 of file HoneycombVertexMeshGenerator.hpp.

Referenced by CylindricalHoneycombVertexMeshGenerator::CylindricalHoneycombVertexMeshGenerator(), CylindricalHoneycombVertexMeshGenerator::GetCylindricalMesh(), ToroidalHoneycombVertexMeshGenerator::GetMesh(), GetMesh(), CylindricalHoneycombVertexMeshGenerator::GetMesh(), ToroidalHoneycombVertexMeshGenerator::GetToroidalMesh(), HoneycombVertexMeshGenerator(), ToroidalHoneycombVertexMeshGenerator::ToroidalHoneycombVertexMeshGenerator(), and ~HoneycombVertexMeshGenerator().

---

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

• mesh/src/vertex/HoneycombVertexMeshGenerator.hpp
• mesh/src/vertex/HoneycombVertexMeshGenerator.cpp