From f387825fa348306d16b3e92d64e09a8d9f13347c Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Sun, 20 Oct 2019 18:15:42 -0600 Subject: [PATCH] Augment the description of CellId::to_string(). --- include/deal.II/grid/cell_id.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/include/deal.II/grid/cell_id.h b/include/deal.II/grid/cell_id.h index 3787b97801..721e51b416 100644 --- a/include/deal.II/grid/cell_id.h +++ b/include/deal.II/grid/cell_id.h @@ -117,7 +117,16 @@ public: CellId(); /** - * Return a human readable string representation of this CellId. + * Return a human-readable string representation of this CellId. + * + * The string returned by this function consists of only ASCII characters + * and will look, for example, like this: `"0_3:006"`. It *can* be + * interpreted by humans as saying "This cell originates from the zeroth + * coarse mesh cell, lives on refinement level 3, and the path from the + * coarse mesh cell to its children and grand children is given by 006". + * But it is not *meant* to be interpreted in any meaningful way: It's just + * a way of representing the internal state of the current object using + * only ASCII characters in the printable range. */ std::string to_string() const; -- 2.39.5