]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add simplex module page 10699/head
authorPeter Munch <peterrmuench@gmail.com>
Sun, 12 Jul 2020 16:26:00 +0000 (18:26 +0200)
committerPeter Munch <peterrmuench@gmail.com>
Sun, 12 Jul 2020 16:26:00 +0000 (18:26 +0200)
doc/doxygen/headers/simplex.h [new file with mode: 0644]
include/deal.II/simplex/grid_generator.h
include/deal.II/simplex/polynomials.h
include/deal.II/simplex/quadrature_lib.h

diff --git a/doc/doxygen/headers/simplex.h b/doc/doxygen/headers/simplex.h
new file mode 100644 (file)
index 0000000..b54c67a
--- /dev/null
@@ -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.
+ */
index 492a8ae9aae12bda0c0332e1af713dbab8a2ccca..de0cf2d7db896f08e77f2984482927b41a51b053 100644 (file)
@@ -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
   {
index a99ceb2c31183dc88b7fb234b7d33aec99bd6d06..07c3d999e42c35167a8046fbb67e45a8d3874ea4 100644 (file)
@@ -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 <int dim>
   class ScalarPolynomial : public ScalarPolynomialsBase<dim>
index fbe4f8824172ee72fbaf02b27590054264e0ae24..82c9017d4c6e42e30c2bff37e4288581c4843b0f 100644 (file)
@@ -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 <int dim>
   class PGauss : public QSimplex<dim>

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.