HoneycombMutableVertexMeshGenerator Class Reference

#include <HoneycombMutableVertexMeshGenerator.hpp>

Inheritance diagram for HoneycombMutableVertexMeshGenerator:

Collaboration diagram for HoneycombMutableVertexMeshGenerator:

List of all members.

Public Member Functions

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

virtual VertexMesh< 2, 2 > * GetMesh ()

virtual MutableVertexMesh< 2, 2 > * GetMutableMesh ()

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), and ghost node information when requested.

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

Definition at line 45 of file HoneycombMutableVertexMeshGenerator.hpp.

Constructor & Destructor Documentation

HoneycombMutableVertexMeshGenerator::HoneycombMutableVertexMeshGenerator	(	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 HoneycombMutableVertexMeshGenerator.cpp.

References HoneycombVertexMeshGenerator::mpMesh.

Member Function Documentation

VertexMesh< 2, 2 > * HoneycombMutableVertexMeshGenerator::GetMesh ( ) [virtual]

Returns:: a mutable honeycomb mesh based on a 2D plane.

Reimplemented from HoneycombVertexMeshGenerator.

Definition at line 142 of file HoneycombMutableVertexMeshGenerator.cpp.

References EXCEPTION, and HoneycombVertexMeshGenerator::mpMesh.

MutableVertexMesh< 2, 2 > * HoneycombMutableVertexMeshGenerator::GetMutableMesh ( ) [virtual]

Returns:: a mutable honeycomb mesh based on a 2D plane.

Definition at line 148 of file HoneycombMutableVertexMeshGenerator.cpp.

References HoneycombVertexMeshGenerator::mpMesh.

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

mesh/src/vertex/HoneycombMutableVertexMeshGenerator.hpp
mesh/src/vertex/HoneycombMutableVertexMeshGenerator.cpp


Public Member Functions
	HoneycombMutableVertexMeshGenerator (unsigned numElementsAcross, unsigned numElementsUp, bool isFlatBottom=false, double cellRearrangementThreshold=0.01, double t2Threshold=0.001)
virtual VertexMesh< 2, 2 > *	GetMesh ()
virtual MutableVertexMesh< 2, 2 > *	GetMutableMesh ()