Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
Public Member Functions | List of all members
CylindricalHoneycombMeshGenerator Class Reference

#include <CylindricalHoneycombMeshGenerator.hpp>

+ Inheritance diagram for CylindricalHoneycombMeshGenerator:
+ Collaboration diagram for CylindricalHoneycombMeshGenerator:

Public Member Functions

 CylindricalHoneycombMeshGenerator (unsigned numNodesAlongWidth, unsigned numNodesAlongLength, unsigned ghosts=3, double scaleFactor=1.0)
 
boost::shared_ptr< MutableMesh< 2, 2 > > GetMesh ()
 
boost::shared_ptr< Cylindrical2dMesh > GetCylindricalMesh ()
 
- Public Member Functions inherited from HoneycombMeshGenerator
 HoneycombMeshGenerator (unsigned numNodesAlongWidth, unsigned numNodesAlongLength, unsigned ghosts=0, double scaleFactor=1.0)
 
 HoneycombMeshGenerator ()
 
virtual ~HoneycombMeshGenerator ()=default
 
std::vector< unsigned > GetCellLocationIndices ()
 
boost::shared_ptr< MutableMesh< 2, 2 > > GetCircularMesh (double radius)
 
double GetDomainDepth ()
 
double GetDomainWidth ()
 

Additional Inherited Members

- Protected Attributes inherited from HoneycombMeshGenerator
boost::shared_ptr< MutableMesh< 2, 2 > > mpMesh
 
std::set< unsigned > mGhostNodeIndices
 
std::string mMeshFilename
 
double mDomainWidth
 
double mDomainDepth
 
double mBottom
 
double mTop
 
unsigned mNumCellWidth
 
unsigned mNumCellLength
 

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 cell-centre simulations.

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

Definition at line 53 of file CylindricalHoneycombMeshGenerator.hpp.

Constructor & Destructor Documentation

◆ CylindricalHoneycombMeshGenerator()

CylindricalHoneycombMeshGenerator::CylindricalHoneycombMeshGenerator ( unsigned  numNodesAlongWidth,
unsigned  numNodesAlongLength,
unsigned  ghosts = 3,
double  scaleFactor = 1.0 
)

Default constructor.

Parameters
numNodesAlongWidthThe number of cells you want along the bottom of the domain
numNodesAlongLengthThe number of cells you want sides of the domain
ghostsThe thickness of ghost nodes to put around the edge (defaults to 3)
scaleFactorThe scale factor for the width (circumference) of the cells (defaults to 1.0)

Definition at line 45 of file CylindricalHoneycombMeshGenerator.cpp.

References OutputFileHandler::FindFile(), OutputFileHandler::GetOutputDirectoryFullPath(), PetscTools::IsSequential(), HoneycombMeshGenerator::mBottom, HoneycombMeshGenerator::mDomainDepth, HoneycombMeshGenerator::mDomainWidth, HoneycombMeshGenerator::mGhostNodeIndices, HoneycombMeshGenerator::mMeshFilename, HoneycombMeshGenerator::mNumCellLength, HoneycombMeshGenerator::mNumCellWidth, HoneycombMeshGenerator::mpMesh, HoneycombMeshGenerator::mTop, OutputFileHandler::OpenOutputFile(), and FileFinder::Remove().

Member Function Documentation

◆ GetCylindricalMesh()

boost::shared_ptr< Cylindrical2dMesh > CylindricalHoneycombMeshGenerator::GetCylindricalMesh ( )
Returns
a 2D honeycomb mesh with periodic left/right boundaries

Definition at line 229 of file CylindricalHoneycombMeshGenerator.cpp.

References HoneycombMeshGenerator::mpMesh.

◆ GetMesh()

boost::shared_ptr< MutableMesh< 2, 2 > > CylindricalHoneycombMeshGenerator::GetMesh ( )
virtual
Returns
a 2D honeycomb mesh

Reimplemented from HoneycombMeshGenerator.

Definition at line 223 of file CylindricalHoneycombMeshGenerator.cpp.

References EXCEPTION, and HoneycombMeshGenerator::mpMesh.

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