#include <SemMeshGenerator.hpp>
Collaboration diagram for SemMeshGenerator< DIM >:
Public Member Functions | |
| SemMeshGenerator (unsigned numCellsAcross, unsigned numCellsUp=1, unsigned numCellsDeep=1, unsigned numSubCellularElementsPerCellAcross=10, unsigned numSubCellularElementsPerCellUp=10, unsigned numSubCellularElementsPerCellDeep=1) | |
| SemMeshGenerator () | |
| double | GetEquilibriumDistance () |
| virtual | ~SemMeshGenerator () |
| virtual SemMesh< DIM > * | GetMesh () |
Protected Attributes | |
| SemMesh< DIM > * | mpMesh |
| unsigned | mTotalSubcellularElementsPerCell |
| double | mNodeEquilibriumDistance |
Detailed Description
template<unsigned DIM>
class SemMeshGenerator< DIM >
Generator of regular SemMesh.
This takes in a request for a mesh with a given number of cells in each direction, and an inital number of subcellular elements per cell, and constructs cuboid cells in that configuration.
Definition at line 52 of file SemMeshGenerator.hpp.
Constructor & Destructor Documentation
| SemMeshGenerator< DIM >::SemMeshGenerator | ( | unsigned | numCellsAcross, |
| unsigned | numCellsUp = 1, |
||
| unsigned | numCellsDeep = 1, |
||
| unsigned | numSubCellularElementsPerCellAcross = 10, |
||
| unsigned | numSubCellularElementsPerCellUp = 10, |
||
| unsigned | numSubCellularElementsPerCellDeep = 1 |
||
| ) |
Constructor.
Some garb here about how the size of each cell is determined.
- Parameters:
-
numCellsAcross the number of cells in the x-direction numCellsUp the number of cells in the y-direction defaults to one for a string of cells. numCellsDeep the number of cells in the z-direction. defaults to one for a flat plane of cells. numSubCellularElementsPerCellAcross the number of subcellular elements per cell along the x-axis, represented by Nodes defaults to 10 numSubCellularElementsPerCellUp the number of subcellular elements per cell along the y-axis, represented by Nodes defaults to 10 numSubCellularElementsPerCellDeep the number of subcellular elements per cell along the z-axis, represented by Nodes defaults to 0 for 2D.
Equlibrium distance between subcellular elements is given in Sandersius and Newman 2008. doi:10.1088/1478-3975/5/1/015002.
The packing density of spheres (circles) given is from Sandersius et al. doi:10.1088/1478-3975/8/4/045007
Definition at line 39 of file SemMeshGenerator.cpp.
References EXCEPTION, and NEVER_REACHED.
| SemMeshGenerator< DIM >::SemMeshGenerator | ( | ) | [inline] |
Null constructor for derived classes to call.
Definition at line 89 of file SemMeshGenerator.hpp.
| SemMeshGenerator< DIM >::~SemMeshGenerator | ( | ) | [virtual] |
Destructor - deletes the mesh object and pointer
Definition at line 141 of file SemMeshGenerator.cpp.
Member Function Documentation
| double SemMeshGenerator< DIM >::GetEquilibriumDistance | ( | ) |
Return the calculated equilibrium distance between two nodes.
- Returns:
- mNodeEquilibriumDistance
Definition at line 147 of file SemMeshGenerator.cpp.
| SemMesh< DIM > * SemMeshGenerator< DIM >::GetMesh | ( | ) | [virtual] |
- Returns:
- a Cubouid or rectangulr Potts mesh.
Definition at line 153 of file SemMeshGenerator.cpp.
Member Data Documentation
double SemMeshGenerator< DIM >::mNodeEquilibriumDistance [protected] |
The equilibrium distance between nodes
Definition at line 63 of file SemMeshGenerator.hpp.
SemMesh<DIM>* SemMeshGenerator< DIM >::mpMesh [protected] |
A pointer to the mesh this class creates
Definition at line 57 of file SemMeshGenerator.hpp.
unsigned SemMeshGenerator< DIM >::mTotalSubcellularElementsPerCell [protected] |
The total number of subcellular elements per cell
Definition at line 60 of file SemMeshGenerator.hpp.
The documentation for this class was generated from the following files:
- cell_based/src/mesh/SemMeshGenerator.hpp
- cell_based/src/mesh/SemMeshGenerator.cpp
