CylindricalHoneycombVertexMeshGenerator Class Reference

#include <CylindricalHoneycombVertexMeshGenerator.hpp>

Inheritance diagram for CylindricalHoneycombVertexMeshGenerator:

[legend]

Collaboration diagram for CylindricalHoneycombVertexMeshGenerator:

[legend]

List of all members.

Public Member Functions
	CylindricalHoneycombVertexMeshGenerator (unsigned numElementsAcross, unsigned numElementsUp, bool isFlatBottom=false, double cellRearrangementThreshold=0.01, double t2Threshold=0.001)
VertexMesh< 2, 2 > *	GetMesh ()
Cylindrical2dVertexMesh *	GetCylindricalMesh ()

---

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 45 of file CylindricalHoneycombVertexMeshGenerator.hpp.

---

Constructor & Destructor Documentation

CylindricalHoneycombVertexMeshGenerator::CylindricalHoneycombVertexMeshGenerator	(	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; only used if isCylindrical is true)
	cellRearrangementThreshold	the minimum threshold distance for element rearrangment (defaults to 0.01)
	t2Threshold	the maximum threshold distance for Type 2 swaps (defaults to 0.001)

Definition at line 32 of file CylindricalHoneycombVertexMeshGenerator.cpp.

References HoneycombVertexMeshGenerator::mpMesh.

---

Member Function Documentation

VertexMesh< 2, 2 > * CylindricalHoneycombVertexMeshGenerator::GetMesh

(

)

[virtual]

Returns:

a honeycomb mesh based on a 2D plane.

Reimplemented from HoneycombVertexMeshGenerator.

Definition at line 135 of file CylindricalHoneycombVertexMeshGenerator.cpp.

References EXCEPTION, and HoneycombVertexMeshGenerator::mpMesh.

Cylindrical2dVertexMesh * CylindricalHoneycombVertexMeshGenerator::GetCylindricalMesh

(

)

Returns:

a honeycomb mesh with cylindrical boundaries.

Definition at line 142 of file CylindricalHoneycombVertexMeshGenerator.cpp.

References HoneycombVertexMeshGenerator::mpMesh.

---

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

• cell_based/src/mesh/CylindricalHoneycombVertexMeshGenerator.hpp
• cell_based/src/mesh/CylindricalHoneycombVertexMeshGenerator.cpp