From 20e49069e3adf5e49d53586c969c6da249ecdf20 Mon Sep 17 00:00:00 2001
From: Julian Heinze <julian.heinze@ufz.de>
Date: Fri, 9 Jun 2023 14:45:12 +0200
Subject: [PATCH] changed docu for removeUnusedGridCells

-now in header
---
 MeshToolsLib/MeshGenerators/VoxelGridFromMesh.cpp | 1 -
 MeshToolsLib/MeshGenerators/VoxelGridFromMesh.h   | 1 +
 2 files changed, 1 insertion(+), 1 deletion(-)

diff --git a/MeshToolsLib/MeshGenerators/VoxelGridFromMesh.cpp b/MeshToolsLib/MeshGenerators/VoxelGridFromMesh.cpp
index 37a3e9d331d..a8d0284f27b 100644
--- a/MeshToolsLib/MeshGenerators/VoxelGridFromMesh.cpp
+++ b/MeshToolsLib/MeshGenerators/VoxelGridFromMesh.cpp
@@ -86,7 +86,6 @@ std::vector<int> assignCellIds(vtkSmartPointer<vtkUnstructuredGrid> const& mesh,
     return cell_ids;
 }
 
-// PropertyVector is required to contain parameter cell_id_name
 bool removeUnusedGridCells(vtkSmartPointer<vtkUnstructuredGrid> const& mesh,
                            std::unique_ptr<MeshLib::Mesh>& grid)
 {
diff --git a/MeshToolsLib/MeshGenerators/VoxelGridFromMesh.h b/MeshToolsLib/MeshGenerators/VoxelGridFromMesh.h
index 13f6598d349..aef731e64cd 100644
--- a/MeshToolsLib/MeshGenerators/VoxelGridFromMesh.h
+++ b/MeshToolsLib/MeshGenerators/VoxelGridFromMesh.h
@@ -43,6 +43,7 @@ std::vector<int> assignCellIds(vtkSmartPointer<vtkUnstructuredGrid> const& mesh,
                                std::array<std::size_t, 3> const& dims,
                                std::array<double, 3> const& cellsize);
 
+// grid has to contain a PropertyVector with the name 'CellIds'
 bool removeUnusedGridCells(vtkSmartPointer<vtkUnstructuredGrid> const& mesh,
                            std::unique_ptr<MeshLib::Mesh>& grid);
 
-- 
GitLab