]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Write Doxygen entries for get_shape_value_component(), get_shape_grad_component(...
authorSebastian Kinnewig <Sebastian@Kinnewig.org>
Tue, 16 Apr 2024 08:07:56 +0000 (10:07 +0200)
committerSebastian Kinnewig <Sebastian@Kinnewig.org>
Tue, 16 Apr 2024 08:13:22 +0000 (10:13 +0200)
include/deal.II/fe/fe_nedelec_sz.h

index d0508b2776def93101031061c8947de7d00af349..c31be00046574c483006ed60729e405cae080efd 100644 (file)
@@ -112,14 +112,21 @@ public:
   clone() const override;
 
   /**
-   * This element is vector-valued so this function will
+   * Return the value of the <tt>i</tt>th shape function at the point
+   * <tt>p</tt>. 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<dim> &p) const override;
 
   /**
-   * Not implemented.
+   * Return the value of the <tt>component</tt>th vector component of the
+   * <tt>i</tt>th shape function at the point <tt>p</tt>. 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 <tt>i</tt>th shape function at the point
+   * <tt>p</tt>. 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<dim> &p) const override;
 
   /**
-   * Not implemented.
+   * Return the gradient of the <tt>component</tt>th vector component of the
+   * <tt>i</tt>th shape function at the point <tt>p</tt>. 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 <tt>i</tt>th shape
+   * function at point <tt>p</tt> 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<dim> &p) const override;
 
   /**
-   * Not implemented.
+   * Return the second derivative of the <tt>component</tt>th vector component
+   * of the <tt>i</tt>th shape function at the point <tt>p</tt>. 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,

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.