]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update documentation/implementation of some polynomial classes 9437/head
authorgrahambenharper <grahambenharper@gmail.com>
Mon, 27 Jan 2020 21:26:49 +0000 (14:26 -0700)
committergrahambenharper <grahambenharper@gmail.com>
Mon, 27 Jan 2020 21:26:49 +0000 (14:26 -0700)
include/deal.II/base/polynomial_space.h
include/deal.II/base/polynomials_adini.h
include/deal.II/base/polynomials_rannacher_turek.h
include/deal.II/base/tensor_product_polynomials.h
include/deal.II/base/tensor_product_polynomials_bubbles.h
include/deal.II/base/tensor_product_polynomials_const.h
source/base/polynomials_adini.cc

index 368bda6d18b11b00ccb6d8cfd2acbfc75506fa2f..ed1a0a5cfd09d95818f1cc742a8d30cc24302762 100644 (file)
@@ -154,7 +154,7 @@ public:
    * Compute the value of the <tt>i</tt>th polynomial at unit point
    * <tt>p</tt>.
    *
-   * Consider using compute() instead.
+   * Consider using evaluate() instead.
    */
   double
   compute_value(const unsigned int i, const Point<dim> &p) const;
@@ -163,7 +163,7 @@ public:
    * Compute the <tt>order</tt>th derivative of the <tt>i</tt>th polynomial
    * at unit point <tt>p</tt>.
    *
-   * Consider using compute() instead.
+   * Consider using evaluate() instead.
    *
    * @tparam order The order of the derivative.
    */
@@ -175,7 +175,7 @@ public:
    * Compute the gradient of the <tt>i</tt>th polynomial at unit point
    * <tt>p</tt>.
    *
-   * Consider using compute() instead.
+   * Consider using evaluate() instead.
    */
   Tensor<1, dim>
   compute_grad(const unsigned int i, const Point<dim> &p) const;
@@ -184,7 +184,7 @@ public:
    * Compute the second derivative (grad_grad) of the <tt>i</tt>th polynomial
    * at unit point <tt>p</tt>.
    *
-   * Consider using compute() instead.
+   * Consider using evaluate() instead.
    */
   Tensor<2, dim>
   compute_grad_grad(const unsigned int i, const Point<dim> &p) const;
index 3c2b0a2df92c17c90f6e5c2002152b135a0348f7..535be7ee157fffec2e5e1f0d3c37e252bfbb96cd 100644 (file)
@@ -61,15 +61,15 @@ public:
    */
 
   void
-  compute(const Point<2> &           unit_point,
-          std::vector<double> &      values,
-          std::vector<Tensor<1, 2>> &grads,
-          std::vector<Tensor<2, 2>> &grad_grads) const;
+  evaluate(const Point<2> &           unit_point,
+           std::vector<double> &      values,
+           std::vector<Tensor<1, 2>> &grads,
+           std::vector<Tensor<2, 2>> &grad_grads) const;
 
   /**
    * Compute the value of the <tt>i</tt>th polynomial at <tt>unit_point</tt>.
    *
-   * Consider using compute() instead.
+   * Consider using evaluate() instead.
    */
 
   double
@@ -79,7 +79,7 @@ public:
    * Compute the gradient of the <tt>i</tt>th polynomial at
    * <tt>unit_point</tt>.
    *
-   * Consider using compute() instead.
+   * Consider using evaluate() instead.
    */
 
   Tensor<1, 2>
@@ -88,7 +88,7 @@ public:
    * Compute the second derivative (grad_grad) of the <tt>i</tt>th polynomial
    * at <tt>unit_point</tt>.
    *
-   * Consider using compute() instead.
+   * Consider using evaluate() instead.
    */
 
   Tensor<2, 2>
index 86744575dcba7a38e66a37573b28e730c40ae12b..0b56598ba130c9783f841d4fcb2623158f0fa908 100644 (file)
@@ -63,7 +63,7 @@ public:
   /**
    * <tt>order</tt>-th of basis function @p i at @p p.
    *
-   * Consider using compute() instead.
+   * Consider using evaluate() instead.
    */
   template <int order>
   Tensor<order, dim>
index 25e23d5e543efc9a99202f21c26ab3bbdf3690c3..9b36fabe87d96d87c756f0d7fd63024f028969b6 100644 (file)
@@ -142,7 +142,7 @@ public:
    * Note, that using this function within a loop over all tensor product
    * polynomials is not efficient, because then each point value of the
    * underlying (one-dimensional) polynomials is (unnecessarily) computed
-   * several times.  Instead use the compute() function with
+   * several times.  Instead use the evaluate() function with
    * <tt>values.size()==</tt>n() to get the point values of all tensor
    * polynomials all at once and in a much more efficient way.
    */
@@ -157,7 +157,7 @@ public:
    * Note, that using this function within a loop over all tensor product
    * polynomials is not efficient, because then each derivative value of the
    * underlying (one-dimensional) polynomials is (unnecessarily) computed
-   * several times.  Instead use the compute() function, see above, with the
+   * several times.  Instead use the evaluate() function, see above, with the
    * size of the appropriate parameter set to n() to get the point value of
    * all tensor polynomials all at once and in a much more efficient way.
    *
@@ -175,7 +175,7 @@ public:
    * Note, that using this function within a loop over all tensor product
    * polynomials is not efficient, because then each derivative value of the
    * underlying (one-dimensional) polynomials is (unnecessarily) computed
-   * several times.  Instead use the compute() function, see above, with
+   * several times.  Instead use the evaluate() function, see above, with
    * <tt>grads.size()==</tt>n() to get the point value of all tensor
    * polynomials all at once and in a much more efficient way.
    */
@@ -190,7 +190,7 @@ public:
    * Note, that using this function within a loop over all tensor product
    * polynomials is not efficient, because then each derivative value of the
    * underlying (one-dimensional) polynomials is (unnecessarily) computed
-   * several times.  Instead use the compute() function, see above, with
+   * several times.  Instead use the evaluate() function, see above, with
    * <tt>grad_grads.size()==</tt>n() to get the point value of all tensor
    * polynomials all at once and in a much more efficient way.
    */
@@ -350,7 +350,7 @@ public:
    * Note, that using this function within a loop over all tensor product
    * polynomials is not efficient, because then each derivative value of the
    * underlying (one-dimensional) polynomials is (unnecessarily) computed
-   * several times.  Instead use the compute() function, see above, with the
+   * several times.  Instead use the evaluate() function, see above, with the
    * size of the appropriate parameter set to n() to get the point value of
    * all tensor polynomials all at once and in a much more efficient way.
    *
index 351c9b7e81b2c7b91bfbba27fdcb4e8d716d4df5..1bfcaaf4d4f8f6b4d8e2982f3e70199fbf510335 100644 (file)
@@ -115,7 +115,7 @@ public:
    * Note, that using this function within a loop over all tensor product
    * polynomials is not efficient, because then each point value of the
    * underlying (one-dimensional) polynomials is (unnecessarily) computed
-   * several times.  Instead use the compute() function with
+   * several times.  Instead use the evaluate() function with
    * <tt>values.size()==</tt>n() to get the point values of all tensor
    * polynomials all at once and in a much more efficient way.
    */
@@ -130,7 +130,7 @@ public:
    * Note, that using this function within a loop over all tensor product
    * polynomials is not efficient, because then each derivative value of the
    * underlying (one-dimensional) polynomials is (unnecessarily) computed
-   * several times.  Instead use the compute() function, see above, with the
+   * several times.  Instead use the evaluate() function, see above, with the
    * size of the appropriate parameter set to n() to get the point value of
    * all tensor polynomials all at once and in a much more efficient way.
    */
@@ -146,7 +146,7 @@ public:
    * Note, that using this function within a loop over all tensor product
    * polynomials is not efficient, because then each derivative value of the
    * underlying (one-dimensional) polynomials is (unnecessarily) computed
-   * several times.  Instead use the compute() function, see above, with
+   * several times.  Instead use the evaluate() function, see above, with
    * <tt>grads.size()==</tt>n() to get the point value of all tensor
    * polynomials all at once and in a much more efficient way.
    */
@@ -161,7 +161,7 @@ public:
    * Note, that using this function within a loop over all tensor product
    * polynomials is not efficient, because then each derivative value of the
    * underlying (one-dimensional) polynomials is (unnecessarily) computed
-   * several times.  Instead use the compute() function, see above, with
+   * several times.  Instead use the evaluate() function, see above, with
    * <tt>grad_grads.size()==</tt>n() to get the point value of all tensor
    * polynomials all at once and in a much more efficient way.
    */
index 504098bc2f2a14b013d4b184d33fab0809ca087f..dc069adef485ef06b79113bc1357ad34c38d00dc 100644 (file)
@@ -116,7 +116,7 @@ public:
    * Note, that using this function within a loop over all tensor product
    * polynomials is not efficient, because then each point value of the
    * underlying (one-dimensional) polynomials is (unnecessarily) computed
-   * several times.  Instead use the compute() function with
+   * several times.  Instead use the evaluate() function with
    * <tt>values.size()==</tt>n() to get the point values of all tensor
    * polynomials all at once and in a much more efficient way.
    */
@@ -131,7 +131,7 @@ public:
    * Note, that using this function within a loop over all tensor product
    * polynomials is not efficient, because then each derivative value of the
    * underlying (one-dimensional) polynomials is (unnecessarily) computed
-   * several times.  Instead use the compute() function, see above, with the
+   * several times.  Instead use the evaluate() function, see above, with the
    * size of the appropriate parameter set to n() to get the point value of
    * all tensor polynomials all at once and in a much more efficient way.
    *
@@ -149,7 +149,7 @@ public:
    * Note, that using this function within a loop over all tensor product
    * polynomials is not efficient, because then each derivative value of the
    * underlying (one-dimensional) polynomials is (unnecessarily) computed
-   * several times.  Instead use the compute() function, see above, with
+   * several times.  Instead use the evaluate() function, see above, with
    * <tt>grads.size()==</tt>n() to get the point value of all tensor
    * polynomials all at once and in a much more efficient way.
    */
@@ -164,7 +164,7 @@ public:
    * Note, that using this function within a loop over all tensor product
    * polynomials is not efficient, because then each derivative value of the
    * underlying (one-dimensional) polynomials is (unnecessarily) computed
-   * several times.  Instead use the compute() function, see above, with
+   * several times.  Instead use the evaluate() function, see above, with
    * <tt>grad_grads.size()==</tt>n() to get the point value of all tensor
    * polynomials all at once and in a much more efficient way.
    */
index 238fb17a373b57b7b2efc90a0efcab82a9eb9b58..d3eefc64341b3defa6c877063119beb2c22b61d2 100644 (file)
@@ -126,10 +126,10 @@ PolynomialsAdini::PolynomialsAdini()
 }
 
 void
-PolynomialsAdini::compute(const Point<2> &           unit_point,
-                          std::vector<double> &      values,
-                          std::vector<Tensor<1, 2>> &grads,
-                          std::vector<Tensor<2, 2>> &grad_grads) const
+PolynomialsAdini::evaluate(const Point<2> &           unit_point,
+                           std::vector<double> &      values,
+                           std::vector<Tensor<1, 2>> &grads,
+                           std::vector<Tensor<2, 2>> &grad_grads) const
 {
   if (values.empty() == false) // do not bother if empty
     {

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.