Add Documentation to Geometry Export to .dat File

temf · Feb 15, 2024 · c7e3af0 · c7e3af0
1 parent 582e207
commit c7e3af0
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/Bembel/src/Geometry/GeometryIO.hpp b/Bembel/src/Geometry/GeometryIO.hpp
@@ -190,6 +190,16 @@ void WritePatch(const std::string &file_name, int current_patch_number,
   file.close();
 }
 
+/**
+ * \ingroup Geometry
+ * \brief exports a geometry from Bembel to a .dat file.
+ *
+ * Limitation: This functions assumes a p-open knot vector without internal
+ * knots.
+ *
+ * \param std::vector of NURBS::Patch describing geometry
+ * \param name path/filename to be written to
+ */
 void WriteDATFile(const std::vector<Patch> &Geometry,
                   const std::string &file_name) {
   const int number_of_patches = Geometry.size();