CylindricalHoneycombVertexMeshGenerator Class Reference

#include <CylindricalHoneycombVertexMeshGenerator.hpp>

Inheritance diagram for CylindricalHoneycombVertexMeshGenerator:

Collaboration diagram for CylindricalHoneycombVertexMeshGenerator:

List of all members.

Public Member Functions

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

MutableVertexMesh< 2, 2 > * GetMesh ()

Cylindrical2dVertexMesh * GetCylindricalMesh ()

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 44 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

MutableVertexMesh< 2, 2 > * CylindricalHoneycombVertexMeshGenerator::GetMesh ( ) [virtual]

Returns:: a 2D honeycomb mesh

Reimplemented from HoneycombVertexMeshGenerator.

Definition at line 135 of file CylindricalHoneycombVertexMeshGenerator.cpp.

References EXCEPTION, and HoneycombVertexMeshGenerator::mpMesh.

Cylindrical2dVertexMesh * CylindricalHoneycombVertexMeshGenerator::GetCylindricalMesh ( )

Returns:: a 2D honeycomb mesh with periodic left/right 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


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