From: Matthias Maier Date: Fri, 15 Sep 2017 15:35:35 +0000 (-0500) Subject: Augment documentation X-Git-Tag: v9.0.0-rc1~1055^2~4 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3c9b40c2fbdf6b2e934bf74e4222feafffc3664c;p=dealii.git Augment documentation --- diff --git a/include/deal.II/fe/fe.h b/include/deal.II/fe/fe.h index b55fdcec1a..d9deb79c06 100644 --- a/include/deal.II/fe/fe.h +++ b/include/deal.II/fe/fe.h @@ -1972,15 +1972,17 @@ public: */ bool has_generalized_support_points () const; -//FIXME /** * Return the equivalent to get_generalized_support_points(), except * for faces. + * + * @deprecated In general, it is not possible to associate a unique + * subset of generalized support points describing degrees of freedom for + * a given face. Don't use this function */ const std::vector > & - get_generalized_face_support_points () const; + get_generalized_face_support_points () const DEAL_II_DEPRECATED; -//FIXME /** * Return whether a finite element has defined generalized support points on * faces. If the result is true, then a call to the @@ -1988,9 +1990,13 @@ public: * * For more information, see the documentation for the has_support_points() * function. + * + * @deprecated In general, it is not possible to associate a unique + * subset of generalized support points describing degrees of freedom for + * a given face. Don't use this function */ bool - has_generalized_face_support_points () const; + has_generalized_face_support_points () const DEAL_II_DEPRECATED; /** * For a given degree of freedom, return whether it is logically associated diff --git a/include/deal.II/fe/fe_tools.h b/include/deal.II/fe/fe_tools.h index 1d28e058bc..e9b7962f3d 100644 --- a/include/deal.II/fe/fe_tools.h +++ b/include/deal.II/fe/fe_tools.h @@ -572,16 +572,21 @@ namespace FETools * FiniteElement::convert_generalized_support_point_values_to_dof_values() * that works with arbitrary number types. * - * If the number type is double this function simply calls the - * FiniteElement::convert_generalized_support_point_values_to_dof_values() - * directly. Otherwise, temporary (per-thread storage) is used to call to - * above function. + * @param[in] finite_element The FiniteElement to compute dof values for. + * @param[in] support_point_values An array of size @p dofs_per_cell + * (which equals the number of points the get_generalized_support_points() + * function will return) where each element is a vector with as many entries + * as the element has vector components. This array should contain + * the values of a function at the generalized support points of the + * finite element. + * @param[out] dof_values An array of size @p dofs_per_cell that contains + * the node functionals of the element applied to the given function. */ template void convert_generalized_support_point_values_to_dof_values( const FiniteElement &finite_element, const std::vector > &support_point_values, - std::vector &nodal_values); + std::vector &dof_values);