HoneycombVertexMeshGenerator Class Reference

#include <HoneycombVertexMeshGenerator.hpp>

Inheritance diagram for HoneycombVertexMeshGenerator:

[legend]

Collaboration diagram for HoneycombVertexMeshGenerator:

[legend]

List of all members.

Public Member Functions
	HoneycombVertexMeshGenerator (unsigned numElementsAcross, unsigned numElementsUp)
	HoneycombVertexMeshGenerator ()
virtual	~HoneycombVertexMeshGenerator ()
virtual VertexMesh< 2, 2 > *	GetMesh ()
Protected Attributes
VertexMesh< 2, 2 > *	mpMesh

---

Detailed Description

Generator of honeycomb meshes, used as starting points for many simulations.

This class takes in options such as width, height, number of ghost nodes and generates a honeycomb mesh (with equal distance between nodes).

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

Definition at line 44 of file HoneycombVertexMeshGenerator.hpp.

---

Constructor & Destructor Documentation

HoneycombVertexMeshGenerator::HoneycombVertexMeshGenerator	(	unsigned	numElementsAcross,
		unsigned	numElementsUp
	)

Constructor.

Parameters:

	numElementsAcross	The number of columns of elements in the mesh
	numElementsUp	The number of rows of elements in the mesh

Definition at line 32 of file HoneycombVertexMeshGenerator.cpp.

References mpMesh.

HoneycombVertexMeshGenerator::HoneycombVertexMeshGenerator

(

)

[inline]

Null constructor for derived classes to call...

Definition at line 65 of file HoneycombVertexMeshGenerator.hpp.

HoneycombVertexMeshGenerator::~HoneycombVertexMeshGenerator

(

)

[virtual]

Destructor - deletes the mesh object and pointer

Definition at line 136 of file HoneycombVertexMeshGenerator.cpp.

References mpMesh.

---

Member Function Documentation

VertexMesh< 2, 2 > * HoneycombVertexMeshGenerator::GetMesh

(

)

[virtual]

Returns:

a mutable honeycomb mesh based on a 2D plane.

Reimplemented in HoneycombMutableVertexMeshGenerator, and CylindricalHoneycombVertexMeshGenerator.

Definition at line 141 of file HoneycombVertexMeshGenerator.cpp.

References mpMesh.

---

Member Data Documentation

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

A pointer to the mesh this class creates

Definition at line 49 of file HoneycombVertexMeshGenerator.hpp.

Referenced by CylindricalHoneycombVertexMeshGenerator::CylindricalHoneycombVertexMeshGenerator(), CylindricalHoneycombVertexMeshGenerator::GetCylindricalMesh(), GetMesh(), HoneycombMutableVertexMeshGenerator::GetMesh(), CylindricalHoneycombVertexMeshGenerator::GetMesh(), HoneycombMutableVertexMeshGenerator::GetMutableMesh(), HoneycombMutableVertexMeshGenerator::HoneycombMutableVertexMeshGenerator(), HoneycombVertexMeshGenerator(), and ~HoneycombVertexMeshGenerator().

---

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

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