From f8687a1fe07a712080f014c372fd32a27296a1e9 Mon Sep 17 00:00:00 2001 From: Peter Munch Date: Sun, 12 Jul 2020 18:26:00 +0200 Subject: [PATCH] Add simplex module page --- doc/doxygen/headers/simplex.h | 21 +++++++++++++++++++++ include/deal.II/simplex/grid_generator.h | 2 ++ include/deal.II/simplex/polynomials.h | 4 ++++ include/deal.II/simplex/quadrature_lib.h | 2 ++ 4 files changed, 29 insertions(+) create mode 100644 doc/doxygen/headers/simplex.h diff --git a/doc/doxygen/headers/simplex.h b/doc/doxygen/headers/simplex.h new file mode 100644 index 0000000000..b54c67a405 --- /dev/null +++ b/doc/doxygen/headers/simplex.h @@ -0,0 +1,21 @@ +// --------------------------------------------------------------------- +// +// Copyright (C) 2020 by the deal.II authors +// +// This file is part of the deal.II library. +// +// The deal.II library is free software; you can use it, redistribute +// it, and/or modify it under the terms of the GNU Lesser General +// Public License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// The full text of the license can be found in the file LICENSE.md at +// the top level directory of deal.II. +// +// --------------------------------------------------------------------- + + +/** + * @defgroup simplex Simplex support (experimental) + * + * This module describes the experimental simplex support in deal.II. + */ diff --git a/include/deal.II/simplex/grid_generator.h b/include/deal.II/simplex/grid_generator.h index 492a8ae9aa..de0cf2d7db 100644 --- a/include/deal.II/simplex/grid_generator.h +++ b/include/deal.II/simplex/grid_generator.h @@ -32,6 +32,8 @@ namespace Simplex /** * This namespace provides a collection of functions to generate simplex * triangulations for some basic geometries. + * + * @ingroup simplex */ namespace GridGenerator { diff --git a/include/deal.II/simplex/polynomials.h b/include/deal.II/simplex/polynomials.h index a99ceb2c31..07c3d999e4 100644 --- a/include/deal.II/simplex/polynomials.h +++ b/include/deal.II/simplex/polynomials.h @@ -26,12 +26,16 @@ DEAL_II_NAMESPACE_OPEN /** * A namespace for functions and classes that provide support for simplex * reference cell entities, i.e., triangles and tetrahedrons. + * + * @ingroup simplex */ namespace Simplex { /** * Polynomials defined on dim-dimensional simplex entities. This class is * basis of Simplex::FE_P. + * + * @ingroup simplex */ template class ScalarPolynomial : public ScalarPolynomialsBase diff --git a/include/deal.II/simplex/quadrature_lib.h b/include/deal.II/simplex/quadrature_lib.h index fbe4f88241..82c9017d4c 100644 --- a/include/deal.II/simplex/quadrature_lib.h +++ b/include/deal.II/simplex/quadrature_lib.h @@ -31,6 +31,8 @@ namespace Simplex * Following number of quadrature points are currently supported: * - 2D: 1, 3, 7 * - 3D: 1, 4, 10 + * + * @ingroup simplex */ template class PGauss : public QSimplex -- 2.39.5