Skip to content

Commit

Permalink
Add doc string to partitioner
Browse files Browse the repository at this point in the history
  • Loading branch information
schnellerhase committed Sep 19, 2024
1 parent face987 commit 965c28b
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion cpp/dolfinx/refinement/refine.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down

0 comments on commit 965c28b

Please sign in to comment.