Skip to content
Snippets Groups Projects
Commit e77edb00 authored by Norihiro Watanabe's avatar Norihiro Watanabe
Browse files

add a comment about the algorithm

parent dbf9575a
No related branches found
No related tags found
No related merge requests found
...@@ -424,6 +424,8 @@ Mesh* generateRegularPrismMesh(const unsigned n_x_cells, ...@@ -424,6 +424,8 @@ Mesh* generateRegularPrismMesh(const unsigned n_x_cells,
/** /**
* Generate a regular 3D Tet-Element mesh. * Generate a regular 3D Tet-Element mesh.
* *
* This algorithm generates regular grid points and split each grid cell into six tetrahedrals.
*
* \param div_x Subdivision operator in x direction * \param div_x Subdivision operator in x direction
* \param div_y Subdivision operator in y direction * \param div_y Subdivision operator in y direction
* \param div_z Subdivision operator in z direction * \param div_z Subdivision operator in z direction
...@@ -439,6 +441,8 @@ Mesh* generateRegularTetMesh(const BaseLib::ISubdivision &div_x, ...@@ -439,6 +441,8 @@ Mesh* generateRegularTetMesh(const BaseLib::ISubdivision &div_x,
/** /**
* Generate a regular 3D Tet-Element mesh. * Generate a regular 3D Tet-Element mesh.
* *
* This algorithm generates regular grid points and split each grid cell into six tetrahedrals.
*
* \param x_length Mesh dimension in x-direction. * \param x_length Mesh dimension in x-direction.
* \param y_length Mesh dimension in y-direction. * \param y_length Mesh dimension in y-direction.
* \param z_length Mesh dimension in z-direction. * \param z_length Mesh dimension in z-direction.
...@@ -460,6 +464,8 @@ Mesh* generateRegularTetMesh(const double x_length, ...@@ -460,6 +464,8 @@ Mesh* generateRegularTetMesh(const double x_length,
/** /**
* Generate a regular 3D Tet-Element mesh. * Generate a regular 3D Tet-Element mesh.
* *
* This algorithm generates regular grid points and split each grid cell into six tetrahedrals.
*
* \param n_x_cells Number of cells in x-direction. * \param n_x_cells Number of cells in x-direction.
* \param n_y_cells Number of cells in y-direction. * \param n_y_cells Number of cells in y-direction.
* \param n_z_cells Number of cells in z-direction. * \param n_z_cells Number of cells in z-direction.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment