From 0da6d18a3a16ade110a2c94fe649db572337811e Mon Sep 17 00:00:00 2001 From: Sebastian Kinnewig Date: Tue, 16 Apr 2024 10:07:56 +0200 Subject: [PATCH] Write Doxygen entries for get_shape_value_component(), get_shape_grad_component() and get_shape_grad_grad_component(). --- include/deal.II/fe/fe_nedelec_sz.h | 33 ++++++++++++++++++++++++------ 1 file changed, 27 insertions(+), 6 deletions(-) diff --git a/include/deal.II/fe/fe_nedelec_sz.h b/include/deal.II/fe/fe_nedelec_sz.h index d0508b2776..c31be00046 100644 --- a/include/deal.II/fe/fe_nedelec_sz.h +++ b/include/deal.II/fe/fe_nedelec_sz.h @@ -112,14 +112,21 @@ public: clone() const override; /** - * This element is vector-valued so this function will + * Return the value of the ith shape function at the point + * p. See the FiniteElement base class for more information about + * the semantics of this function. + * + * Since this element is vector-valued, this function will * throw an exception. */ virtual double shape_value(const unsigned int i, const Point &p) const override; /** - * Not implemented. + * Return the value of the componentth vector component of the + * ith shape function at the point p. See the + * FiniteElement base class for more information about the semantics of this + * function. */ virtual double shape_value_component(const unsigned int i, @@ -127,14 +134,21 @@ public: const unsigned int component) const override; /** - * This element is vector-valued so this function will + * Return the gradient of the ith shape function at the point + * p. See the FiniteElement base class for more information about + * the semantics of this function. + * + * Since this element is vector-valued, this function will * throw an exception. */ virtual Tensor<1, dim> shape_grad(const unsigned int i, const Point &p) const override; /** - * Not implemented. + * Return the gradient of the componentth vector component of the + * ith shape function at the point p. See the + * FiniteElement base class for more information about the semantics of this + * function. */ virtual Tensor<1, dim> shape_grad_component(const unsigned int i, @@ -142,14 +156,21 @@ public: const unsigned int component) const override; /** - * This element is vector-valued so this function will + * Return the tensor of second derivatives of the ith shape + * function at point p on the unit cell. See the FiniteElement base + * class for more information about the semantics of this function. + * + * Since this element is vector-valued, this function will * throw an exception. */ virtual Tensor<2, dim> shape_grad_grad(const unsigned int i, const Point &p) const override; /** - * Not implemented. + * Return the second derivative of the componentth vector component + * of the ith shape function at the point p. See the + * FiniteElement base class for more information about the semantics of this + * function. */ virtual Tensor<2, dim> shape_grad_grad_component(const unsigned int i, -- 2.39.5