From bfd7eafee52e34e54ba72ebd09d8d7ba5923c309 Mon Sep 17 00:00:00 2001 From: Matthias Maier Date: Thu, 31 Aug 2017 10:56:13 -0500 Subject: [PATCH] FiniteElement: Update documentation --- .../changes/major/20170831MatthiasMaierLucaHeltai | 2 +- include/deal.II/fe/fe.h | 12 +++++++++--- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/doc/news/changes/major/20170831MatthiasMaierLucaHeltai b/doc/news/changes/major/20170831MatthiasMaierLucaHeltai index 79561db0ff..eee4b7aaa9 100644 --- a/doc/news/changes/major/20170831MatthiasMaierLucaHeltai +++ b/doc/news/changes/major/20170831MatthiasMaierLucaHeltai @@ -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 diff --git a/include/deal.II/fe/fe.h b/include/deal.II/fe/fe.h index ebf915637c..65558405ef 100644 --- a/include/deal.II/fe/fe.h +++ b/include/deal.II/fe/fe.h @@ -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 true 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" -- 2.39.5