]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Enlarge manifold_id to unsigned int, as discussed on the mailing list.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 13 Jul 2014 18:13:43 +0000 (18:13 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 13 Jul 2014 18:13:43 +0000 (18:13 +0000)
git-svn-id: https://svn.dealii.org/branches/branch_manifold_id_intermediate@33149 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/doc/doxygen/headers/glossary.h

index 8e118896515d269bc07875fc49c0eec9de162ba5..680fd110391876c36e0e7b0ea9c352a43984c24e 100644 (file)
  * is responsible to generate new points when the mesh is refined. 
  *
  * By default, all manifold indicators of a mesh are set to
- * types::invalid_manifold_id. A typical piece of code that sets the
+ * numbers::invalid_manifold_id. A typical piece of code that sets the
  * manifold indicator on a object to something else would look like
  * this, here setting the manifold indicator to 42 for all cells whose
- * center has the x component located at $-1$:
+ * center has an $x$ component less than zero:
  *
  * @code
  * for (typename Triangulation<dim>::active_cell_iterator cell =
  *     triangulation.begin_active();
  *     cell != triangulation.end(); ++cell)
- *             if (cell->center()[0] == -1)
- *                     cell->set_manifold_id (42);
+ *   if (cell->center()[0] < 0)
+ *     cell->set_manifold_id (42);
  * @endcode
  *
- * Here we call the function TriaAccessor::set_manifold_id. It may
+ * Here we call the function TriaAccessor::set_manifold_id(). It may
  * also be appropriate to call TriaAccessor::set_all_manifold_ids
  * instead, to set recursively the manifold id on each face (and edge,
  * if in 3d). To query the manifold indicator of a particular object
- * edge, use TriaAccessor::manifold_id.
+ * edge, use TriaAccessor::manifold_id().
  *
  * The code above only sets the manifold indicators of a particular
  * part of the Triangulation, but it does not by itself change the way
  * the Triangulation class treats this object for the purposes of mesh
- * refinement. For this, you need to call Triangulation::set_manifold
+ * refinement. For this, you need to call Triangulation::set_manifold()
  * to associate a manifold object with a particular manifold
  * indicator. This allows the Triangulation objects to use a different
  * method of finding new points on cells, faces or edges to be
  * @note Manifold indicators are inherited from parents to their
  * children upon mesh refinement. Some more information about manifold
  * indicators is also presented in a section of the documentation of
- * the Triangulation class.
+ * the Triangulation class as well as in the
+ * @ref manifold "Manifold documentation module".
  * </dd>
  *
  * @see @ref manifold "The module on Manifolds"

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.