@@ -105,25 +105,28 @@ class MeshTetInterface
105105
106106 /* *
107107 * This function checks the integrity of the current set of
108- * elements in the Mesh to see if they comprise a hull,
109- * that is:
108+ * elements in the Mesh to see if they comprise a topological
109+ * manifold that (if it's also geometrically valid) would define
110+ * valid hull for a tetrahedralized volume.
111+ * That is:
110112 * - If they are all TRI3 elements
111113 * - They all have non-nullptr neighbors
112114 *
113115 * \returns
114- * - 0 if the mesh forms a valid hull
116+ * - 0 if the mesh forms a topologically valid hull
115117 * - 1 if a non-TRI3 element is found
116118 * - 2 if an element with a nullptr-neighbor is found
119+ * - 3 if the mesh is empty
117120 */
118- unsigned check_hull_integrity ();
121+ [[nodiscard]] unsigned int check_hull_integrity ();
119122
120123 /* *
121- * This function prints an informative message and
122- * crashes based on the output of the check_hull_integrity()
123- * function. It is a separate function so that you
124- * can check hull integrity without crashing if you desire .
124+ * This function prints an informative message and throws an
125+ * exception based on the output of the check_hull_integrity()
126+ * function. It is a separate function so that you can check hull
127+ * integrity without exiting or catching an exception if desired .
125128 */
126- void process_hull_integrity_result (unsigned result);
129+ void process_hull_integrity_result (unsigned int result);
127130
128131 /* *
129132 * Delete original convex hull elements from the Mesh
0 commit comments