From 7df3b1dd8c148fecbd21554937606e5705c8925a Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Mon, 3 Apr 2000 12:39:05 +0000 Subject: [PATCH] Mostly doc updates. git-svn-id: https://svn.dealii.org/trunk@2658 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/grid/tria_accessor.h | 79 +++++++++++++++----- 1 file changed, 62 insertions(+), 17 deletions(-) diff --git a/deal.II/deal.II/include/grid/tria_accessor.h b/deal.II/deal.II/include/grid/tria_accessor.h index 155615d034..7c3d454eba 100644 --- a/deal.II/deal.II/include/grid/tria_accessor.h +++ b/deal.II/deal.II/include/grid/tria_accessor.h @@ -339,8 +339,17 @@ class TriaObjectAccessor : public TriaAccessor unsigned int quad_index (const unsigned int i) const; /** - * Test for the element being used - * or not. + * Test for the element being + * used or not. The return + * value is #true# for all + * iterators that are either + * normal iterators or active + * iterators, only raw iterators + * can return #false#. Since raw + * iterators are only used in + * the interiors of the library, + * you will not usually need + * this function. */ bool used () const; @@ -692,18 +701,29 @@ class TriaObjectAccessor<1, dim> : public TriaAccessor Point & vertex (const unsigned int i) const; /** - * Test for the element being used - * or not. + * Test for the element being + * used or not. The return + * value is #true# for all + * iterators that are either + * normal iterators or active + * iterators, only raw iterators + * can return #false#. Since raw + * iterators are only used in + * the interiors of the library, + * you will not usually need + * this function. */ bool used () const; /** - * Set the #used# flag. + * Set the #used# flag. Only for + * internal use in the library. */ void set_used_flag () const; /** - * Clear the #used# flag. + * Clear the #used# flag. Only for + * internal use in the library. */ void clear_used_flag () const; @@ -765,7 +785,8 @@ class TriaObjectAccessor<1, dim> : public TriaAccessor * Return a pointer to the #i#th * child. */ - TriaIterator > child (const unsigned int i) const; + TriaIterator > + child (const unsigned int i) const; /** * Return the index of the #i#th child. @@ -1021,7 +1042,8 @@ class TriaObjectAccessor<2, dim> : public TriaAccessor * Return a pointer to the #i#th line * bounding this #Quad#. */ - TriaIterator > line (const unsigned int i) const; + TriaIterator > + line (const unsigned int i) const; /** * Return the line index of the #i#th @@ -1031,8 +1053,17 @@ class TriaObjectAccessor<2, dim> : public TriaAccessor unsigned int line_index (const unsigned int i) const; /** - * Test for the element being used - * or not. + * Test for the element being + * used or not. The return + * value is #true# for all + * iterators that are either + * normal iterators or active + * iterators, only raw iterators + * can return #false#. Since raw + * iterators are only used in + * the interiors of the library, + * you will not usually need + * this function. */ bool used () const; @@ -1383,7 +1414,8 @@ class TriaObjectAccessor<3, dim> : public TriaAccessor * Return a pointer to the #i#th line * bounding this #Hex#. */ - TriaIterator > line (const unsigned int i) const; + TriaIterator > + line (const unsigned int i) const; /** * Return the line index of the #i#th @@ -1396,7 +1428,8 @@ class TriaObjectAccessor<3, dim> : public TriaAccessor * Return a pointer to the #i#th quad * bounding this #Hex#. */ - TriaIterator > quad (const unsigned int i) const; + TriaIterator > + quad (const unsigned int i) const; /** * Return the quad index of the #i#th @@ -1406,8 +1439,17 @@ class TriaObjectAccessor<3, dim> : public TriaAccessor unsigned int quad_index (const unsigned int i) const; /** - * Test for the element being used - * or not. + * Test for the element being + * used or not. The return + * value is #true# for all + * iterators that are either + * normal iterators or active + * iterators, only raw iterators + * can return #false#. Since raw + * iterators are only used in + * the interiors of the library, + * you will not usually need + * this function. */ bool used () const; @@ -1485,7 +1527,8 @@ class TriaObjectAccessor<3, dim> : public TriaAccessor * Return a pointer to the #i#th * child. */ - TriaIterator > child (const unsigned int i) const; + TriaIterator > + child (const unsigned int i) const; /** * Return the index of the #i#th child. @@ -1734,7 +1777,8 @@ class CellAccessor : public TriaObjectAccessor * If the neighbor does not exist, an * invalid iterator is returned. */ - TriaIterator > neighbor (const unsigned int i) const; + TriaIterator > + neighbor (const unsigned int i) const; /** * Return the index of the #i#th neighbor. @@ -1841,7 +1885,8 @@ class CellAccessor : public TriaObjectAccessor * child. Overloaded version which returns * a more reasonable iterator class. */ - TriaIterator > child (const unsigned int i) const; + TriaIterator > + child (const unsigned int i) const; /** * Return an iterator to the #i#th face -- 2.39.5