From 6b95fc4892d5c7397c1c5832663097e3f1d0dbe2 Mon Sep 17 00:00:00 2001 From: bangerth Date: Fri, 17 Jun 2011 16:17:33 +0000 Subject: [PATCH] Augment documentation for a case that two students have independently gotten wrong in the last two days. git-svn-id: https://svn.dealii.org/trunk@23831 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/grid/grid_tools.h | 41 ++++++++++++++++++++--- 1 file changed, 37 insertions(+), 4 deletions(-) diff --git a/deal.II/include/deal.II/grid/grid_tools.h b/deal.II/include/deal.II/grid/grid_tools.h index 1a0df7faa5..ad1f5fa8d6 100644 --- a/deal.II/include/deal.II/grid/grid_tools.h +++ b/deal.II/include/deal.II/grid/grid_tools.h @@ -753,10 +753,43 @@ class GridTools * content of @p result will be * deleted. * - * The function assumes that the - * two input triangulations are - * derived from the same coarse - * grid. + * @note This function is intended + * to create an adaptively refined + * triangulation that contains the + * most refined cells from + * two input triangulations that + * were derived from the same + * coarse grid by adaptive refinement. + * This is an operation sometimes + * needed when one solves for two + * variables of a coupled problem + * on separately refined meshes on + * the same domain (for example + * because these variables have + * boundary layers in different places) + * but then needs to compute something + * that involves both variables or + * wants to output the result into a + * single file. In both cases, in + * order not to lose information, + * the two solutions can not be + * interpolated onto the respectively + * other mesh because that may be + * coarser than the ones on which + * the variable was computed. Rather, + * one needs to have a mesh for the + * domain that is at least as fine + * as each of the two initial meshes. + * This function computes such a mesh. + * + * @note If you want to create + * a mesh that is the merger of + * two other coarse meshes, for + * example in order to compose a mesh + * for a complicated geometry from + * meshes for simpler geometries, + * take a look at + * GridGenerator::merge_triangulations . */ template static -- 2.39.5