]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add comment to FE_Poly::get_poly_space_numbering() 11353/head
authorPeter Munch <peterrmuench@gmail.com>
Thu, 10 Dec 2020 17:39:17 +0000 (18:39 +0100)
committerPeter Munch <peterrmuench@gmail.com>
Thu, 10 Dec 2020 17:39:17 +0000 (18:39 +0100)
include/deal.II/fe/fe_poly.h

index 4acb9184b339effb18d0b440bac8293dd5565d21..d6ea12ba42f4b9a6538cc29783fc9963ae6070db 100644 (file)
@@ -108,6 +108,11 @@ public:
    * Return the numbering of the underlying polynomial space compared to
    * lexicographic ordering of the basis functions. Returns
    * PolynomialType::get_numbering().
+   *
+   * @note Some implementations of this class do not support this function,
+   *   since no lexicographic ordering of the basis functions is possible
+   *   for them. Examples are: Simplex::FE_P, Simplex::FE_WedgeP, and
+   *   Simplex::FE_PyramidP.
    */
   std::vector<unsigned int>
   get_poly_space_numbering() const;
@@ -115,6 +120,8 @@ public:
   /**
    * Return the inverse numbering of the underlying polynomial space. Returns
    * PolynomialType::get_numbering_inverse().
+   *
+   * @note See note of get_poly_space_numbering().
    */
   std::vector<unsigned int>
   get_poly_space_numbering_inverse() const;

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.