]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Group member functions in hp::FECollection for doxygen. 12682/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Thu, 19 Aug 2021 23:59:49 +0000 (17:59 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Fri, 20 Aug 2021 00:31:36 +0000 (18:31 -0600)
include/deal.II/fe/fe.h
include/deal.II/hp/fe_collection.h

index 08489c54a7cc5c2666436c7a3fc3c66250836db3..7c75f0eb7833f1c78f88378f6c49167c47a89ece 100644 (file)
@@ -1270,7 +1270,7 @@ public:
   //@}
 
   /**
-   * @name Functions to support hp
+   * @name Functions to support hp-adaptivity
    * @{
    */
 
@@ -1312,7 +1312,7 @@ public:
 
 
   /**
-   * @name Functions to support hp-
+   * @name Functions to support hp-adaptivity
    * @{
    */
 
index 1331776fe307f2ae5a89f5f46f03581d13a54776..57f73ebd184f9317ee8ccc076ec72ef2eda83d5e 100644 (file)
@@ -180,6 +180,14 @@ namespace hp
     void
     push_back(const FiniteElement<dim, spacedim> &new_fe);
 
+    /**
+     * @name Querying information about the elements in the collection
+     */
+
+    /**
+     * @{
+     */
+
     /**
      * Return the number of vector components of the finite elements in this
      * collection.  This number must be the same for all elements in the
@@ -260,6 +268,17 @@ namespace hp
     unsigned int
     max_dofs_per_cell() const;
 
+    /**
+     * @}
+     */
+
+    /**
+     * @name Functions to support hp-adaptivity
+     */
+
+    /**
+     * @{
+     */
 
     /**
      * Return whether all elements in this collection implement the hanging
@@ -456,6 +475,18 @@ namespace hp
     find_dominated_fe_extended(const std::set<unsigned int> &fes,
                                const unsigned int            codim = 0) const;
 
+    /**
+     * @}
+     */
+
+    /**
+     * @name Describing hierarchical relationships between elements
+     */
+
+    /**
+     * @{
+     */
+
     /**
      * Set functions determining the hierarchy of finite elements, i.e. a
      * function @p next that returns the index of the finite element following
@@ -532,6 +563,18 @@ namespace hp
     unsigned int
     previous_in_hierarchy(const unsigned int fe_index) const;
 
+    /**
+     * @}
+     */
+
+    /**
+     * @name Components and blocks of elements
+     */
+
+    /**
+     * @{
+     */
+
     /**
      * Return a component mask with as many elements as this object has vector
      * components and of which exactly the one component is true that
@@ -725,6 +768,10 @@ namespace hp
     BlockMask
     block_mask(const ComponentMask &component_mask) const;
 
+    /**
+     * @}
+     */
+
     /**
      * @name Exceptions
      * @{

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.