]> https://gitweb.dealii.org/ - dealii.git/commitdiff
doxygen: don't use @ingroup simplex 13887/head
authorTimo Heister <timo.heister@gmail.com>
Wed, 1 Jun 2022 17:04:46 +0000 (13:04 -0400)
committerTimo Heister <timo.heister@gmail.com>
Wed, 1 Jun 2022 17:04:46 +0000 (13:04 -0400)
fixes #13509

include/deal.II/base/quadrature_lib.h
include/deal.II/fe/fe_pyramid_p.h
include/deal.II/fe/fe_simplex_p.h
include/deal.II/fe/fe_wedge_p.h
include/deal.II/fe/mapping_fe.h
include/deal.II/grid/grid_generator.h
include/deal.II/grid/grid_in.h

index 4cb866f49b99ff0ae28806729863e01efe3ab231..bbf666ab4747abfe1eccb0aff5a1882d00ca2595 100644 (file)
@@ -814,8 +814,6 @@ public:
  * For 1D, the quadrature rule degenerates to a
  * `dealii::QGauss<1>(n_points_1D)`.
  *
- * @ingroup simplex
- *
  * @note The quadrature rules implemented by this class come from a variety of
  * sources, but all of them have positive quadrature weights.
  *
@@ -823,6 +821,8 @@ public:
  * respect to the vertices - i.e., the locations of the mapped quadrature points
  * depends on the numbering of the cell vertices. If you need rules that are
  * independent of the vertex numbering then use QWitherdenVincentSimplex.
+ *
+ * @relates simplex
  */
 template <int dim>
 class QGaussSimplex : public QSimplex<dim>
@@ -863,7 +863,7 @@ public:
  * @note Some rules (2D 2 odd and 3D 2 even) do not yet exist and instead a
  * higher-order rule is used in their place.
  *
- * @ingroup simplex
+ * @relates simplex
  */
 template <int dim>
 class QWitherdenVincentSimplex : public QSimplex<dim>
index 243a5c615eba28e104747068f316af5e8d2974ec..456267c69539db4ffba5d780718ee5b8a18a8c2e 100644 (file)
@@ -29,7 +29,7 @@ DEAL_II_NAMESPACE_OPEN
  *
  * @note Only implemented for 3D.
  *
- * @ingroup simplex
+ * @relates simplex
  */
 template <int dim, int spacedim = dim>
 class FE_PyramidPoly : public dealii::FE_Poly<dim, spacedim>
@@ -59,7 +59,7 @@ public:
  * @note Currently, only linear polynomials (degree=1) are implemented. See
  * also the documentation of ScalarLagrangePolynomialPyramid.
  *
- * @ingroup simplex
+ * @relates simplex
  */
 template <int dim, int spacedim = dim>
 class FE_PyramidP : public FE_PyramidPoly<dim, spacedim>
@@ -121,7 +121,7 @@ public:
  * @note Currently, only linear polynomials (degree=1) are implemented. See
  * also the documentation of ScalarLagrangePolynomialPyramid.
  *
- * @ingroup simplex
+ * @relates simplex
  */
 template <int dim, int spacedim = dim>
 class FE_PyramidDGP : public FE_PyramidPoly<dim, spacedim>
index e99e7b7a98961aa9749de7edea15cb915bfe0153..3bbadd90e4dd7e04e67530bd15a0415e7f6ea3fc 100644 (file)
@@ -29,7 +29,7 @@ DEAL_II_NAMESPACE_OPEN
  *
  * @note Only implemented for 2D and 3D.
  *
- * @ingroup simplex
+ * @relates simplex
  */
 template <int dim, int spacedim = dim>
 class FE_SimplexPoly : public dealii::FE_Poly<dim, spacedim>
@@ -120,7 +120,7 @@ protected:
  * the finite element space of continuous, piecewise polynomials of
  * degree $k$.
  *
- * @ingroup simplex
+ * @relates simplex
  */
 template <int dim, int spacedim = dim>
 class FE_SimplexP : public FE_SimplexPoly<dim, spacedim>
@@ -175,7 +175,7 @@ public:
  * element space of discontinuous, piecewise polynomials of degree
  * $k$.
  *
- * @ingroup simplex
+ * @relates simplex
  */
 template <int dim, int spacedim = dim>
 class FE_SimplexDGP : public FE_SimplexPoly<dim, spacedim>
index 18d3227c19b7d1be3b4544f03b551f1c2394ccdb..b9b90d6a275505e5558f15e877cc1c2f4b004c5f 100644 (file)
@@ -29,7 +29,7 @@ DEAL_II_NAMESPACE_OPEN
  *
  * @note Only implemented for 3D.
  *
- * @ingroup simplex
+ * @relates simplex
  */
 template <int dim, int spacedim = dim>
 class FE_WedgePoly : public dealii::FE_Poly<dim, spacedim>
@@ -60,7 +60,7 @@ public:
  *   (degree=2) are implemented. See also the documentation of
  *   ScalarLagrangePolynomialWedge.
  *
- * @ingroup simplex
+ * @relates simplex
  */
 template <int dim, int spacedim = dim>
 class FE_WedgeP : public FE_WedgePoly<dim, spacedim>
@@ -123,7 +123,7 @@ public:
  *   (degree=2) are implemented. See also the documentation of
  *   ScalarLagrangePolynomialWedge.
  *
- * @ingroup simplex
+ * @relates simplex
  */
 template <int dim, int spacedim = dim>
 class FE_WedgeDGP : public FE_WedgePoly<dim, spacedim>
index 2fba288dd502dab98fa60a6d44e7951f1dceeb58..529d75e54857aa102d60776a4644a8ec23cacb67 100644 (file)
@@ -52,7 +52,7 @@ DEAL_II_NAMESPACE_OPEN
  * @note Currently, only implemented for elements with tensor_degree==1 and
  *   n_components==1.
  *
- * @ingroup simplex
+ * @relates simplex
  */
 template <int dim, int spacedim = dim>
 class MappingFE : public Mapping<dim, spacedim>
index d93d88e0eccb93a2dac03c5ca453511684026e5c..cce757f44a1c36ba9467119b33d548d341f453ff 100644 (file)
@@ -2183,7 +2183,7 @@ namespace GridGenerator
    *     out_tria.set_manifold(i, in_tria.get_manifold(i));
    * @endcode
    *
-   * @ingroup simplex
+   * @relates simplex
    */
   template <int dim, int spacedim>
   void
@@ -2399,7 +2399,7 @@ namespace GridGenerator
    *
    * @note Currently, this function only works for `dim==spacedim`.
    *
-   * @ingroup simplex
+   * @relates simplex
    */
   template <int dim, int spacedim>
   void
@@ -2422,7 +2422,7 @@ namespace GridGenerator
    * quadrilateral/hexahedral cells and subdivides these into 2/5
    * triangular/tetrahedral cells.
    *
-   * @ingroup simplex
+   * @relates simplex
    */
   template <int dim, int spacedim>
   void
index 2832fec37b37fb5a94fa3c3614bef21ae3c1e0a4..7e74bdc2cd0e677092a296479f41b9545efc87f5 100644 (file)
@@ -411,7 +411,7 @@ public:
    * The companion GridOut::write_vtk function can be used to write VTK files
    * compatible with this method.
    *
-   * @ingroup simplex
+   * @relates simplex
    */
   void
   read_vtk(std::istream &in);
@@ -516,7 +516,7 @@ public:
    * Read grid data from an msh file. The %Gmsh formats are documented at
    * http://www.gmsh.info/.
    *
-   * @ingroup simplex
+   * @relates simplex
    */
   void
   read_msh(std::istream &in);
@@ -575,7 +575,7 @@ public:
    * as a boundary or material id.  Physical surface numbers created in Gmsh,
    * which can be seen in the .geo file, become material IDs.
    *
-   * @ingroup simplex
+   * @relates simplex
    */
   void
   read_msh(const std::string &filename);
@@ -614,7 +614,7 @@ public:
    * @image html "comsol-mesh-boundary-lines.png"
    * @image html "comsol-mesh-boundary-triangles.png"
    *
-   * @ingroup simplex
+   * @relates simplex
    */
   void
   read_comsol_mphtxt(std::istream &in);

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.