From: Timo Heister Date: Fri, 8 Aug 2014 20:03:52 +0000 (-0400) Subject: update notify_ready_to_unpack documentation X-Git-Tag: v8.2.0-rc1~212^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e4217bcb81a1730409cacb55fa3619696ec05063;p=dealii.git update notify_ready_to_unpack documentation --- diff --git a/include/deal.II/distributed/tria.h b/include/deal.II/distributed/tria.h index 3736656124..c67d68dcb6 100644 --- a/include/deal.II/distributed/tria.h +++ b/include/deal.II/distributed/tria.h @@ -678,17 +678,18 @@ namespace parallel void *)> &pack_callback); /** - * The given function is called for each new active cell and - * supplies a pointer to the data saved with - * register_data_attach(). - * - * This needs to be called after execute_coarsening_and_refinement() + * The supplied callback function is called for each newly locally owned + * cell and corresponding data saved with register_data_attach(). This + * function needs to be called after execute_coarsening_and_refinement() * with the offset returned by register_data_attach(). - * + * * The CellStatus will indicate if the cell was refined, coarsened, or - * persisted unchanged. Note that contrary to during - * register_data_attach() you can now access the children if the status - * is CELL_REFINE but not for CELL_COARSEN. + * persisted unchanged. The cell_iterator will either by an active, + * locally owned cell (if the cell was not refined), or the immediate + * parent if it was refined during + * execute_coarsening_and_refinement(). Therefore, contrary to during + * register_data_attach(), you can now access the children if the status + * is CELL_REFINE but no longer for callbacks with status CELL_COARSEN. */ void notify_ready_to_unpack (const unsigned int offset,