From: Wolfgang Bangerth Date: Thu, 30 Jul 2009 18:25:55 +0000 (+0000) Subject: Augment documentation. X-Git-Tag: v8.0.0~7423 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6a05f9e8c1228f35c8a33b0719bba5fcadbfee16;p=dealii.git Augment documentation. git-svn-id: https://svn.dealii.org/trunk@19142 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/grid/tria_boundary.h b/deal.II/deal.II/include/grid/tria_boundary.h index d0b5f65eca..ef8b5ee517 100644 --- a/deal.II/deal.II/include/grid/tria_boundary.h +++ b/deal.II/deal.II/include/grid/tria_boundary.h @@ -295,6 +295,14 @@ class Boundary : public Subscriptor * that were on the boundary * remain on the boundary. * + * If spacedim==1, then the line + * represented by the line + * iterator is the entire space + * (i.e. it is a cell, not a part + * of the boundary), and the + * returned point equals the + * given input point. + * * Derived classes do not need to * implement this function unless * mesh smoothing algorithms are @@ -315,6 +323,14 @@ class Boundary : public Subscriptor * projected onto the area * characterized by the given * quad. + * + * If spacedim==2, then the line + * represented by the quad + * iterator is the entire space + * (i.e. it is a cell, not a part + * of the boundary), and the + * returned point equals the + * given input point. */ virtual Point @@ -447,6 +463,14 @@ class StraightBoundary : public Boundary * point onto the line through * the two vertices of the given * line iterator. + * + * If spacedim==1, then the line + * represented by the line + * iterator is the entire space + * (i.e. it is a cell, not a part + * of the boundary), and the + * returned point equals the + * given input point. */ virtual Point @@ -466,6 +490,14 @@ class StraightBoundary : public Boundary * surface spanned by the four * vertices of the given quad * iterator. + * + * If spacedim==2, then the line + * represented by the quad + * iterator is the entire space + * (i.e. it is a cell, not a part + * of the boundary), and the + * returned point equals the + * given input point. */ virtual Point