From: Peter Munch <peterrmuench@gmail.com>
Date: Thu, 10 Dec 2020 17:39:17 +0000 (+0100)
Subject: Add comment to FE_Poly::get_poly_space_numbering()
X-Git-Tag: v9.3.0-rc1~767^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F11353%2Fhead;p=dealii.git

Add comment to FE_Poly::get_poly_space_numbering()
---

diff --git a/include/deal.II/fe/fe_poly.h b/include/deal.II/fe/fe_poly.h
index 4acb9184b3..d6ea12ba42 100644
--- a/include/deal.II/fe/fe_poly.h
+++ b/include/deal.II/fe/fe_poly.h
@@ -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;