From: cvs Date: Sat, 9 Oct 1999 18:57:42 +0000 (+0000) Subject: Many doc updates. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5bc98304c78a4e9e8f89423a86f50b3e9a63d905;p=dealii-svn.git Many doc updates. git-svn-id: https://svn.dealii.org/trunk@1752 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/grid/intergrid_map.h b/deal.II/deal.II/include/grid/intergrid_map.h index ed15c1b4b5..6233332d0b 100644 --- a/deal.II/deal.II/include/grid/intergrid_map.h +++ b/deal.II/deal.II/include/grid/intergrid_map.h @@ -24,12 +24,45 @@ * Keys for this map are all cells on the source grid, whether active or * not. * + * For example, consider these two one-dimensional grids: + * \begin{verbatim} + * Grid 1: + * x--x--x-----x-----------x + * 1 2 3 4 + * + * Grid 2: + * x-----x-----x-----x-----x + * 1 2 3 4 + * \end{verbatim} + * (Cell numbers are only given as an example and will not correspond + * to real cell iterator's indices.) The mapping from grid 1 to grid 2 + * will then be as follows: + * \begin{verbatim} + * Cell on grid 1 Cell on grid 2 + * 1 ------------------> 1 + * 2 ------------------> 1 + * 3 ------------------> 2 + * 4 ------------------> mother cell of cells 3 and 4 + * (a non-active cell, not shown here) + * \end{verbatim} + * Besides the mappings shown here, the non-active cells on grid 1 are also + * valid keys. For example, the mapping for the mother cell of cells 1 and 2 + * on the first grid will point to cell 1 on the second grid. + * * The implementation of this class is such that not only cell iterators * into triangulations can be mapped, but also iterators into objects of * type #DoFHandler# and #MGDoFHandler#. The extension to other classes * offering iterator functions and some minor additional requirements is * simple. * + * Note that this class could in principle be base on the C++ #map# + * data type. Instead, it uses another data format which is more effective both + * in terms of computing time for access as well as with regard to memory + * consumpion. + * + * + * \section{Usage} + * * In practice, use of this class is as follows: * \begin{verbatim} * // have two grids, which are derived from the