From e77edb0043a903daf77746b6a449c25fa75ef60d Mon Sep 17 00:00:00 2001
From: Norihiro Watanabe <norihiro.watanabe@ufz.de>
Date: Thu, 25 Aug 2016 12:23:01 +0200
Subject: [PATCH] add a comment about the algorithm

---
 MeshLib/MeshGenerators/MeshGenerator.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/MeshLib/MeshGenerators/MeshGenerator.h b/MeshLib/MeshGenerators/MeshGenerator.h
index 9340a48f5d0..b10b114a61a 100644
--- a/MeshLib/MeshGenerators/MeshGenerator.h
+++ b/MeshLib/MeshGenerators/MeshGenerator.h
@@ -424,6 +424,8 @@ Mesh* generateRegularPrismMesh(const unsigned n_x_cells,
 /**
  * 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_y Subdivision operator in y direction
  * \param div_z Subdivision operator in z direction
@@ -439,6 +441,8 @@ Mesh* generateRegularTetMesh(const BaseLib::ISubdivision &div_x,
 /**
  * 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 y_length      Mesh dimension in y-direction.
  * \param z_length      Mesh dimension in z-direction.
@@ -460,6 +464,8 @@ Mesh* generateRegularTetMesh(const double x_length,
 /**
  * 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_y_cells    Number of cells in y-direction.
  * \param n_z_cells    Number of cells in z-direction.
-- 
GitLab