]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Remove hp::DoFHandler from doxygen headers. 16234/head
authorMarc Fehling <mafehling.git@gmail.com>
Thu, 2 Nov 2023 18:23:34 +0000 (12:23 -0600)
committerMarc Fehling <mafehling.git@gmail.com>
Thu, 2 Nov 2023 18:29:07 +0000 (12:29 -0600)
doc/doxygen/headers/concepts.h
doc/doxygen/headers/dofs.h
doc/doxygen/headers/hp.h
doc/doxygen/headers/iterators.h

index 668bdce00eab38384d39464eba3203722276ac33..2c192b898f24deb0509b9c95520ca64179564b29 100644 (file)
  *
  * <dl>
  *
- * <dt class="concepts">@anchor ConceptDoFHandlerType <b>DoFHandlerType</b></dt>
- *
- * <dd>
- * deal.II includes both DoFHandler and hp::DoFHandler as objects which manage
- * degrees of freedom on a mesh. Though the two do not share any sort of
- * inheritance relationship, they are similar enough that many functions just
- * need something which resembles a DoFHandler to work correctly.
- * </dd>
- *
  * <dt class="concepts">@anchor ConceptMatrixType <b>MatrixType</b></dt>
  *
  * <dd>
index 94c584b2890015556cfe59e16c9122e6996fc908..931d511fd93674bc71cedb4b90a2ec1b0f0fe9a0 100644 (file)
  * DoFHandler class: it is built on top of a triangulation and a
  * finite element class and allocated degrees of freedom on each cell
  * of the triangulation as required for the finite element space
- * described by the finite element object. There are other variants of
- * the DoFHandler class such as hp::DoFHandler that do similar
- * things for more special cases.
+ * described by the finite element object.
  *
  * DoFHandler objects are used together with objects of type FiniteElement
- * (or hp::FECollection in the case of hp::DoFHandler) to enumerate all the
+ * (or hp::FECollection) to enumerate all the
  * degrees of freedom that exist in a triangulation for this particular
  * finite element. As such, the combination of mesh, finite element, and
  * DoF handler object can be thought of as providing a <i>basis</i> of
index c3ff48e3644108e7d62558cd009a1df96ee2961e..8ea799c0db53598693f8a03c3aca35b048e2ded2 100644 (file)
@@ -32,7 +32,7 @@
  *
  * In the implementation of the hp-finite element method, each cell might have
  * a different finite element associated with it. To handle this, the
- * hp::DoFHandler must have a whole set of finite element classes associated
+ * DoFHandler must have a whole set of finite element classes associated
  * with it. This concept is represented by the hp::FECollection class: Objects
  * of this type act as containers that hold a whole set of finite element
  * objects. Instead of storing pointers to finite element objects on each
index 21461519dde0a878ceb456e19b3ff483201c97f5..f3bbae1dd61f4260a63d96ec3098bfa8fda67b90 100644 (file)
@@ -18,8 +18,8 @@
  @{
 
 deal.II has several classes which are understood conceptually as
-meshes. Apart from the obvious Triangulation, these are, for example,
-DoFHandler and hp::DoFHandler. All of those define a set
+meshes. Apart from the obvious Triangulation, there is, for example,
+the DoFHandler. All of those define a set
 of iterators, allowing the user to traverse the whole mesh, i.e. the
 set of cells, faces, edges, etc that comprise the mesh, or portions of
 it. These iterators are all in a sense derived from the TriaIterator
@@ -255,8 +255,7 @@ of accessor classes:
   request iterators pointing to neighbors of a cell.
 
 - The DoFAccessor class lets you access information related to degrees
-  of freedom associated with cells, faces, etc; it does so for both
-  DoFHandler and hp::DoFHandler objects. Note that the DoFAccessor
+  of freedom associated with cells, faces, etc. Note that the DoFAccessor
   class is derived from either TriaAccessor or CellAccessor (depending
   on whether the DoFAccessor points to an object of full dimension or
   not) and so is able to provide a superset of information over its
@@ -269,7 +268,7 @@ of accessor classes:
 
 Except to look up member documentation, you will not usually have to deal with
 the actual class names listed above. Rather, one uses the typedefs provided by
-the mesh classes Triangulation, DoFHandler and hp::DoFHandler, as well
+the mesh classes Triangulation and DoFHandler, as well
 as the function that generate such objects:
 
 <table border=1>
@@ -288,11 +287,6 @@ as the function that generate such objects:
     <td>typename DoFHandler::cell_iterator</td>
     <td>DoFHandler::begin()</td>
   </tr>
-  <tr>
-    <th>hp::DoFHandler</th>
-    <td>typename hp::DoFHandler::cell_iterator</td>
-    <td>hp::DoFHandler::begin()</td>
-  </tr>
 </table>
 
 The Triangulation class supports iterating across cell faces with <tt>typename
@@ -317,11 +311,6 @@ Active iterators have the following properties:
     <td>typename DoFHandler::active_cell_iterator</td>
     <td>DoFHandler::begin_active()</td>
   </tr>
-  <tr>
-    <th>hp::DoFHandler</th>
-    <td>typename hp::DoFHandler::active_cell_iterator</td>
-    <td>hp::DoFHandler::begin_active()</td>
-  </tr>
 </table>
 
 The Triangulation class also supports iterating across active cell faces with
@@ -338,18 +327,16 @@ just as the ones above, exist in active and non-active forms.
 The actual definition of all the typedefs local to the mesh classes are
 stated in the
 
-- internal::Triangulation::Iterators<1,spacedim>,
-  internal::Triangulation::Iterators<2,spacedim>, and
-  internal::Triangulation::Iterators<3,spacedim> classes for Triangulation
-  iterators,
+- <a class="el"
+href="structinternal_1_1TriangulationImplementation_1_1Iterators_3_011_00_01spacedim_01_4.html">internal::TriangulationImplementation::Iterators<1,spacedim></a>, <a class="el"
+href="structinternal_1_1TriangulationImplementation_1_1Iterators_3_012_00_01spacedim_01_4.html">internal::TriangulationImplementation::Iterators<2,spacedim></a>, and <a class="el"
+href="structinternal_1_1TriangulationImplementation_1_1Iterators_3_013_00_01spacedim_01_4.html">internal::TriangulationImplementation::Iterators<3,spacedim></a> classes for Triangulation iterators,
 
 - <a class="el"
-href="structinternal_1_1DoFHandler_1_1Iterators_3_01DoFHandlerType_3_011_00_01spacedim_01_4_00_01lda_01_4.html">internal::DoFHandler::Iterators&lt;DoFHandlerType&lt;1,spacedim&gt;,
-lda&gt;</a>, <a class="el"
-href="structinternal_1_1Triangulation_1_1Iterators_3_012_00_01spacedim_01_4.html">internal::DoFHandler::Iterators&lt;DoFHandlerType&lt;1,spacedim&gt;,
-lda&gt;</a>, and <a class="el"
-href="structinternal_1_1Triangulation_1_1Iterators_3_013_00_01spacedim_01_4.html">internal::DoFHandler::Iterators&lt;DoFHandlerType&lt;1,spacedim&gt;,
-lda&gt;</a> classes for DoFHandler and hp::DoFHandler iterators.
+href="structinternal_1_1DoFHandlerImplementation_1_1Iterators_3_011_00_01spacedim_00_01lda_01_4.html">internal::DoFHandlerImplementation::Iterators<1,spacedim,lda></a>, <a class="el"
+href="structinternal_1_1DoFHandlerImplementation_1_1Iterators_3_012_00_01spacedim_00_01lda_01_4.html">internal::DoFHandlerImplementation::Iterators<2,spacedim,lda></a>, and <a class="el"
+href="structinternal_1_1DoFHandlerImplementation_1_1Iterators_3_013_00_01spacedim_00_01lda_01_4.html">internal::DoFHandlerImplementation::Iterators<3,spacedim,lda></a> classes for DoFHandler iterators.
+
 
 @section IteratorAccessorInternals Iterator and accessor internals
 

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.