]> https://gitweb.dealii.org/ - dealii.git/commitdiff
FiniteElement: Update documentation
authorMatthias Maier <tamiko@43-1.org>
Thu, 31 Aug 2017 15:56:13 +0000 (10:56 -0500)
committerMatthias Maier <tamiko@43-1.org>
Thu, 31 Aug 2017 18:04:17 +0000 (13:04 -0500)
doc/news/changes/major/20170831MatthiasMaierLucaHeltai
include/deal.II/fe/fe.h

index 79561db0ff8185c77db731becb33a26fff048442..eee4b7aaa9bd40671448edcc2153ab6312e45793 100644 (file)
@@ -1,4 +1,4 @@
-Improved: The support for non-lagrangian elements with generalized support
+Improved: The support for non-Lagrangian elements with generalized support
 points has been vastly improved: FESystem::get_generalized_support_point()
 now returns a list of unique generalized support points for the finite
 element system; TODO
index ebf915637c165b03d898cd2194f7381092befd23..65558405ef14beb47cc1c3e1de382dd44facc6c3 100644 (file)
@@ -1910,7 +1910,7 @@ public:
   /**
    * Return whether a finite element has defined support points on faces. If
    * the result is true, then a call to the get_unit_face_support_points()
-   * yields a non-empty array.
+   * yields a non-empty vector.
    *
    * For more information, see the documentation for the has_support_points()
    * function.
@@ -1928,6 +1928,11 @@ public:
   /**
    * Return a vector of generalized support points.
    *
+   * @note The vector returned by this function is always a minimal set of
+   * *unique* support points. This is in contrast to the behavior of
+   * get_unit_support_points() that returns a repeated list of unit support
+   * points for an FESystem of numerous (Lagrangian) base elements.
+   *
    * See the
    * @ref GlossGeneralizedSupport "glossary entry on generalized support points"
    * for more information.
@@ -1936,8 +1941,9 @@ public:
   get_generalized_support_points () const;
 
   /**
-   * Return <tt>true</tt> if the class provides nonempty vectors either from
-   * get_unit_support_points() or get_generalized_support_points().
+   * Return whether a finite element has defined generalized support
+   * points. If the result is true, then a call to the
+   * get_generalized_support_points() yields a non-empty vector.
    *
    * See the
    * @ref GlossGeneralizedSupport "glossary entry on generalized support points"

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.