From: Julius Witte Date: Mon, 16 Mar 2020 08:12:41 +0000 (+0100) Subject: Documentation X-Git-Tag: v9.2.0-rc1~349^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b1ea3ec17fd4b805500a07410a0bc7e421ca83a0;p=dealii.git Documentation --- diff --git a/include/deal.II/matrix_free/shape_info.h b/include/deal.II/matrix_free/shape_info.h index 26d22a0f7c..86edd780db 100644 --- a/include/deal.II/matrix_free/shape_info.h +++ b/include/deal.II/matrix_free/shape_info.h @@ -94,9 +94,24 @@ namespace internal tensor_symmetric_plus_dg0 = 5 }; + + + /** + * This struct stores the shape functions, their gradients and Hessians + * evaluated for a one-dimensional section of a tensor product finite + * element and tensor product quadrature formula in reference + * coordinates. This data structure also includes the evaluation of + * quantities at the cell boundary and on the sub-interval $(0, 0.5)$ and + * $(0.5, 1)$ for face integrals. + * + * @author Katharina Kormann, Martin Kronbichler, Julius Witte, 2010-2020 + */ template struct UnivariateShapeData { + /** + * Empty constructor. Sets default configuration. + */ UnivariateShapeData(); /** @@ -260,14 +275,16 @@ namespace internal /** - * The class that stores the shape functions, gradients and Hessians - * evaluated for a tensor product finite element and tensor product - * quadrature formula on the unit cell. Because of this structure, only - * one-dimensional data is stored. + * This struct stores a tensor (Kronecker) product view of the finite + * element and quadrature formula used for evaluation. It is based on a + * single or a collection of UnivariateShapeData object(s) that describe + * one-dimensional ingredients, plus some additional information about how + * these are combined and how indices are laid out in the multi-dimensional + * case such as the hierarchical -> lexicographic ordering of FE_Q. * * @ingroup matrixfree * - * @author Katharina Kormann and Martin Kronbichler, 2010, 2011 + * @author Katharina Kormann, Martin Kronbichler, Julius Witte, 2010-2020 */ template struct ShapeInfo diff --git a/include/deal.II/matrix_free/shape_info.templates.h b/include/deal.II/matrix_free/shape_info.templates.h index 37c15930bb..0457509b7a 100644 --- a/include/deal.II/matrix_free/shape_info.templates.h +++ b/include/deal.II/matrix_free/shape_info.templates.h @@ -42,9 +42,6 @@ namespace internal { namespace MatrixFreeFunctions { - // ----------------- actual UnivariateShapeData functions - // -------------------- - template UnivariateShapeData::UnivariateShapeData() : element_type(tensor_general) @@ -54,6 +51,7 @@ namespace internal {} + // ----------------- actual ShapeInfo functions -------------------- template