From 6bd60d4b2b898cfc053d6ee0f081fc388121eb94 Mon Sep 17 00:00:00 2001 From: Marc Fehling Date: Thu, 2 Nov 2023 12:23:34 -0600 Subject: [PATCH] Remove hp::DoFHandler from doxygen headers. --- doc/doxygen/headers/concepts.h | 9 -------- doc/doxygen/headers/dofs.h | 6 ++---- doc/doxygen/headers/hp.h | 2 +- doc/doxygen/headers/iterators.h | 37 +++++++++++---------------------- 4 files changed, 15 insertions(+), 39 deletions(-) diff --git a/doc/doxygen/headers/concepts.h b/doc/doxygen/headers/concepts.h index 668bdce00e..2c192b898f 100644 --- a/doc/doxygen/headers/concepts.h +++ b/doc/doxygen/headers/concepts.h @@ -73,15 +73,6 @@ * *
* - *
@anchor ConceptDoFHandlerType DoFHandlerType
- * - *
- * 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. - *
- * *
@anchor ConceptMatrixType MatrixType
* *
diff --git a/doc/doxygen/headers/dofs.h b/doc/doxygen/headers/dofs.h index 94c584b289..931d511fd9 100644 --- a/doc/doxygen/headers/dofs.h +++ b/doc/doxygen/headers/dofs.h @@ -22,12 +22,10 @@ * 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 basis of diff --git a/doc/doxygen/headers/hp.h b/doc/doxygen/headers/hp.h index c3ff48e364..8ea799c0db 100644 --- a/doc/doxygen/headers/hp.h +++ b/doc/doxygen/headers/hp.h @@ -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 diff --git a/doc/doxygen/headers/iterators.h b/doc/doxygen/headers/iterators.h index 21461519dd..f3bbae1dd6 100644 --- a/doc/doxygen/headers/iterators.h +++ b/doc/doxygen/headers/iterators.h @@ -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: @@ -288,11 +287,6 @@ as the function that generate such objects: - - - - -
typename DoFHandler::cell_iterator DoFHandler::begin()
hp::DoFHandlertypename hp::DoFHandler::cell_iteratorhp::DoFHandler::begin()
The Triangulation class supports iterating across cell faces with typename @@ -317,11 +311,6 @@ Active iterators have the following properties: typename DoFHandler::active_cell_iterator DoFHandler::begin_active() - - hp::DoFHandler - typename hp::DoFHandler::active_cell_iterator - hp::DoFHandler::begin_active() - 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, +- internal::TriangulationImplementation::Iterators<1,spacedim>, internal::TriangulationImplementation::Iterators<2,spacedim>, and internal::TriangulationImplementation::Iterators<3,spacedim> classes for Triangulation iterators, - internal::DoFHandler::Iterators<DoFHandlerType<1,spacedim>, -lda>, internal::DoFHandler::Iterators<DoFHandlerType<1,spacedim>, -lda>, and internal::DoFHandler::Iterators<DoFHandlerType<1,spacedim>, -lda> 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>, internal::DoFHandlerImplementation::Iterators<2,spacedim,lda>, and internal::DoFHandlerImplementation::Iterators<3,spacedim,lda> classes for DoFHandler iterators. + @section IteratorAccessorInternals Iterator and accessor internals -- 2.39.5