Document MeshBoundary functions and add file header

Author: Q-Minh

source/pbat/geometry/MeshBoundary.h

@@ -1,3 +1,13 @@
+/**
+ * @file MeshBoundary.h
+ * @author Quoc-Minh Ton-That ([email protected])
+ * @brief This file contains functions to compute the boundary of a mesh.
+ * @date 2025-02-12
+ *
+ * @copyright Copyright (c) 2025
+ *
+ */
+
 #ifndef PBAT_GEOMETRY_MESH_BOUNDARY_H
 #define PBAT_GEOMETRY_MESH_BOUNDARY_H
 
@@ -8,6 +18,15 @@
 namespace pbat {
 namespace geometry {
 
+/**
+ * @brief Obtains the boundary mesh of a simplex mesh.
+ *
+ * @note Only works for triangle (`C.rows()==3`) and tetrahedral (`C.rows()==4`) meshes.
+ *
+ * @param C The connectivity matrix of the mesh (i.e. the simplices)
+ * @param n The number of vertices in the mesh. If -1, the number of vertices is computed from C.
+ * @return A tuple containing the boundary vertices and the boundary facets
+ */
 std::tuple<IndexVectorX, IndexMatrixX>
 SimplexMeshBoundary(IndexMatrixX const& C, Index n = Index(-1));