From 965c28bdcb59166da33a36a2cb51efffe044c39c Mon Sep 17 00:00:00 2001
From: schnellerhase <56360279+schnellerhase@users.noreply.github.com>
Date: Thu, 19 Sep 2024 07:53:48 +0200
Subject: [PATCH] Add doc string to partitioner

---
 cpp/dolfinx/refinement/refine.h | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/cpp/dolfinx/refinement/refine.h b/cpp/dolfinx/refinement/refine.h
index e55245d475..4d1420e746 100644
--- a/cpp/dolfinx/refinement/refine.h
+++ b/cpp/dolfinx/refinement/refine.h
@@ -21,7 +21,15 @@
 namespace dolfinx::refinement
 {
 
-/// TODO: Document function
+/// @brief Partitioner that maintains the regional destribution for a refined
+/// mesh. Meaning, process local data is just maintained and no redistribution
+/// happens.
+///
+/// @param[in] comm MPI Communicator
+/// @param[in] nparts Number of partitions (input has no effect)
+/// @param[in] cell_types Cell types in the mesh
+/// @param[in] cells Lists of cells of each cell type.
+/// @return Destination ranks for each cell on this process
 graph::AdjacencyList<std::int32_t> maintain_coarse_partitioner(
     MPI_Comm comm, int, const std::vector<mesh::CellType>& cell_types,
     const std::vector<std::span<const std::int64_t>>& cell_topology);