From: Wolfgang Bangerth Date: Thu, 10 Dec 2015 15:07:29 +0000 (-0600) Subject: Update documentation in a couple of places. X-Git-Tag: v8.4.0-rc2~159^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F1972%2Fhead;p=dealii.git Update documentation in a couple of places. --- diff --git a/include/deal.II/fe/fe_poly_tensor.h b/include/deal.II/fe/fe_poly_tensor.h index 1d014d47f5..3fd0a77695 100644 --- a/include/deal.II/fe/fe_poly_tensor.h +++ b/include/deal.II/fe/fe_poly_tensor.h @@ -132,31 +132,46 @@ public: requires_update_flags (const UpdateFlags update_flags) const; /** - * Since these elements are vector valued, an exception is thrown. + * Compute the (scalar) value of shape function @p i at + * the given quadrature point @p p. + * Since the elements represented by this class are vector + * valued, there is no such scalar value and the function therefore + * throws an exception. */ virtual double shape_value (const unsigned int i, const Point &p) const; + // documentation inherited from the base class virtual double shape_value_component (const unsigned int i, const Point &p, const unsigned int component) const; /** - * Since these elements are vector valued, an exception is thrown. + * Compute the gradient of (scalar) shape function @p i at + * the given quadrature point @p p. + * Since the elements represented by this class are vector + * valued, there is no such scalar value and the function therefore + * throws an exception. */ virtual Tensor<1,dim> shape_grad (const unsigned int i, const Point &p) const; + // documentation inherited from the base class virtual Tensor<1,dim> shape_grad_component (const unsigned int i, const Point &p, const unsigned int component) const; /** - * Since these elements are vector valued, an exception is thrown. + * Compute the Hessian of (scalar) shape function @p i at + * the given quadrature point @p p. + * Since the elements represented by this class are vector + * valued, there is no such scalar value and the function therefore + * throws an exception. */ virtual Tensor<2,dim> shape_grad_grad (const unsigned int i, const Point &p) const; + // documentation inherited from the base class virtual Tensor<2,dim> shape_grad_grad_component (const unsigned int i, const Point &p, const unsigned int component) const; @@ -389,7 +404,7 @@ protected: // for shape_gradient computations mutable std::vector > transformed_shape_grads; mutable std::vector > untransformed_shape_grads; - //for shape_hessian computations + // for shape_hessian computations mutable std::vector > transformed_shape_hessians; mutable std::vector > untransformed_shape_hessian_tensors; };