From: bangerth Date: Mon, 12 Sep 2011 05:24:11 +0000 (+0000) Subject: Add documentation to a function. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d9e6921777954bceca5e5e990bcd73fa442acb4d;p=dealii-svn.git Add documentation to a function. git-svn-id: https://svn.dealii.org/trunk@24309 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/distributed/tria.h b/deal.II/include/deal.II/distributed/tria.h index 13c877498c..5a8b0d97ff 100644 --- a/deal.II/include/deal.II/distributed/tria.h +++ b/deal.II/include/deal.II/distributed/tria.h @@ -709,11 +709,16 @@ namespace parallel */ MPI_Comm get_communicator () const; - /** - * */ - const std::vector & + /** + * Returns a permutation vector for the order the coarse + * cells are handed of to p4est. For example the first + * element i in this vector denotes that the first cell + * in hierarchical ordering is the ith deal cell starting + * from begin(0). + */ + const std::vector & get_p4est_tree_to_coarse_cell_permutation() const; - + /** * Return the subdomain id of * those cells that are owned