Chaste  Build::
MappableGridGenerator Class Reference

#include <MappableGridGenerator.hpp>

+ Collaboration diagram for MappableGridGenerator:

Public Member Functions

 MappableGridGenerator ()
 
 ~MappableGridGenerator ()
 
boost::shared_ptr< Part< 3 > > GeneratePlane (unsigned numX, unsigned numY, bool withEndCaps=true)
 
boost::shared_ptr< Part< 3 > > GenerateCylinder (double cylinderRadius, double cylinderThickness, double cylinderHeight, unsigned numX, unsigned numY, double cylinderAngle=2.0 *M_PI)
 
boost::shared_ptr< Part< 3 > > GenerateHemisphere (double sphereRadius, double sphereThickness, unsigned numX, unsigned numY, double sphereAzimuthAngle=2.0 *M_PI, double spherePolarAngle=0.5 *M_PI)
 

Private Attributes

units::quantity< unit::length > mReferenceLength
 

Detailed Description

Generate a part consisting of a grid of unit rectangles or cuboids. It is useful for mapping onto more complex geometries for subsequent meshing. 3-D only.

Definition at line 46 of file MappableGridGenerator.hpp.

Constructor & Destructor Documentation

MappableGridGenerator::MappableGridGenerator ( )

Constructor

Definition at line 44 of file MappableGridGenerator.cpp.

MappableGridGenerator::~MappableGridGenerator ( )

Destructor

Definition at line 49 of file MappableGridGenerator.cpp.

Member Function Documentation

boost::shared_ptr< Part< 3 > > MappableGridGenerator::GenerateCylinder ( double  cylinderRadius,
double  cylinderThickness,
double  cylinderHeight,
unsigned  numX,
unsigned  numY,
double  cylinderAngle = 2.0 * M_PI 
)

Generate a cylindrical grid, where the planar grid is mapped on to a cylinder of specified dimensions.

Parameters
cylinderRadiusradius of the cylinder
cylinderThicknessthickness of the cylinder
cylinderAnglesweep angle of the cylinder (radians)
cylinderHeightheight of the cylinder
numXnumber of blocks around the cylinder circumference
numYnumber of blocks over the cylinder height
Returns
pointer to a Part representation of the cylinder

Definition at line 203 of file MappableGridGenerator.cpp.

References GeneratePlane(), and mReferenceLength.

boost::shared_ptr< Part< 3 > > MappableGridGenerator::GenerateHemisphere ( double  sphereRadius,
double  sphereThickness,
unsigned  numX,
unsigned  numY,
double  sphereAzimuthAngle = 2.0 * M_PI,
double  spherePolarAngle = 0.5 * M_PI 
)

Generate a hemispherical grid, where the planar grid is mapped on to a sphere of specified dimensions.

Parameters
sphereRadiusradius of the sphere
sphereThicknessthickness of the cylinder
sphereAzimuthAngleazimuth angle of the hemisphere (radians)
spherePolarAnglepolar angle of the hemisphere (radians)
numXnumber of blocks around the cylinder circumference
numYnumber of blocks over the cylinder height
Returns
pointer to a Part representation of the hemisphere

Definition at line 250 of file MappableGridGenerator.cpp.

References GeneratePlane(), and mReferenceLength.

boost::shared_ptr< Part< 3 > > MappableGridGenerator::GeneratePlane ( unsigned  numX,
unsigned  numY,
bool  withEndCaps = true 
)

Generate a planar grid with one block in the z direction

Parameters
numXnumber of blocks in the x direction
numYnumber of blocks in the y direction
withEndCapsinclude polygons at the ends of the plane, turned off for closed cylinder generation
Returns
pointer to a Part representation of the plane

Definition at line 54 of file MappableGridGenerator.cpp.

References Part< DIM >::Create(), and mReferenceLength.

Referenced by GenerateCylinder(), and GenerateHemisphere().

Member Data Documentation

units::quantity<unit::length> MappableGridGenerator::mReferenceLength
private

The reference length scale

Definition at line 51 of file MappableGridGenerator.hpp.

Referenced by GenerateCylinder(), GenerateHemisphere(), and GeneratePlane().


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