From 47baa8e43931d04f7544528c4155e0c18ed66fc8 Mon Sep 17 00:00:00 2001 From: grahambenharper Date: Mon, 27 Jan 2020 14:26:49 -0700 Subject: [PATCH] Update documentation/implementation of some polynomial classes --- include/deal.II/base/polynomial_space.h | 8 ++++---- include/deal.II/base/polynomials_adini.h | 14 +++++++------- include/deal.II/base/polynomials_rannacher_turek.h | 2 +- include/deal.II/base/tensor_product_polynomials.h | 10 +++++----- .../base/tensor_product_polynomials_bubbles.h | 8 ++++---- .../base/tensor_product_polynomials_const.h | 8 ++++---- source/base/polynomials_adini.cc | 8 ++++---- 7 files changed, 29 insertions(+), 29 deletions(-) diff --git a/include/deal.II/base/polynomial_space.h b/include/deal.II/base/polynomial_space.h index 368bda6d18..ed1a0a5cfd 100644 --- a/include/deal.II/base/polynomial_space.h +++ b/include/deal.II/base/polynomial_space.h @@ -154,7 +154,7 @@ public: * Compute the value of the ith polynomial at unit point * p. * - * Consider using compute() instead. + * Consider using evaluate() instead. */ double compute_value(const unsigned int i, const Point &p) const; @@ -163,7 +163,7 @@ public: * Compute the orderth derivative of the ith polynomial * at unit point p. * - * 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 ith polynomial at unit point * p. * - * Consider using compute() instead. + * Consider using evaluate() instead. */ Tensor<1, dim> compute_grad(const unsigned int i, const Point &p) const; @@ -184,7 +184,7 @@ public: * Compute the second derivative (grad_grad) of the ith polynomial * at unit point p. * - * Consider using compute() instead. + * Consider using evaluate() instead. */ Tensor<2, dim> compute_grad_grad(const unsigned int i, const Point &p) const; diff --git a/include/deal.II/base/polynomials_adini.h b/include/deal.II/base/polynomials_adini.h index 3c2b0a2df9..535be7ee15 100644 --- a/include/deal.II/base/polynomials_adini.h +++ b/include/deal.II/base/polynomials_adini.h @@ -61,15 +61,15 @@ public: */ void - compute(const Point<2> & unit_point, - std::vector & values, - std::vector> &grads, - std::vector> &grad_grads) const; + evaluate(const Point<2> & unit_point, + std::vector & values, + std::vector> &grads, + std::vector> &grad_grads) const; /** * Compute the value of the ith polynomial at unit_point. * - * Consider using compute() instead. + * Consider using evaluate() instead. */ double @@ -79,7 +79,7 @@ public: * Compute the gradient of the ith polynomial at * unit_point. * - * Consider using compute() instead. + * Consider using evaluate() instead. */ Tensor<1, 2> @@ -88,7 +88,7 @@ public: * Compute the second derivative (grad_grad) of the ith polynomial * at unit_point. * - * Consider using compute() instead. + * Consider using evaluate() instead. */ Tensor<2, 2> diff --git a/include/deal.II/base/polynomials_rannacher_turek.h b/include/deal.II/base/polynomials_rannacher_turek.h index 86744575dc..0b56598ba1 100644 --- a/include/deal.II/base/polynomials_rannacher_turek.h +++ b/include/deal.II/base/polynomials_rannacher_turek.h @@ -63,7 +63,7 @@ public: /** * order-th of basis function @p i at @p p. * - * Consider using compute() instead. + * Consider using evaluate() instead. */ template Tensor diff --git a/include/deal.II/base/tensor_product_polynomials.h b/include/deal.II/base/tensor_product_polynomials.h index 25e23d5e54..9b36fabe87 100644 --- a/include/deal.II/base/tensor_product_polynomials.h +++ b/include/deal.II/base/tensor_product_polynomials.h @@ -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 * values.size()==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 * grads.size()==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 * grad_grads.size()==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. * diff --git a/include/deal.II/base/tensor_product_polynomials_bubbles.h b/include/deal.II/base/tensor_product_polynomials_bubbles.h index 351c9b7e81..1bfcaaf4d4 100644 --- a/include/deal.II/base/tensor_product_polynomials_bubbles.h +++ b/include/deal.II/base/tensor_product_polynomials_bubbles.h @@ -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 * values.size()==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 * grads.size()==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 * grad_grads.size()==n() to get the point value of all tensor * polynomials all at once and in a much more efficient way. */ diff --git a/include/deal.II/base/tensor_product_polynomials_const.h b/include/deal.II/base/tensor_product_polynomials_const.h index 504098bc2f..dc069adef4 100644 --- a/include/deal.II/base/tensor_product_polynomials_const.h +++ b/include/deal.II/base/tensor_product_polynomials_const.h @@ -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 * values.size()==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 * grads.size()==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 * grad_grads.size()==n() to get the point value of all tensor * polynomials all at once and in a much more efficient way. */ diff --git a/source/base/polynomials_adini.cc b/source/base/polynomials_adini.cc index 238fb17a37..d3eefc6434 100644 --- a/source/base/polynomials_adini.cc +++ b/source/base/polynomials_adini.cc @@ -126,10 +126,10 @@ PolynomialsAdini::PolynomialsAdini() } void -PolynomialsAdini::compute(const Point<2> & unit_point, - std::vector & values, - std::vector> &grads, - std::vector> &grad_grads) const +PolynomialsAdini::evaluate(const Point<2> & unit_point, + std::vector & values, + std::vector> &grads, + std::vector> &grad_grads) const { if (values.empty() == false) // do not bother if empty { -- 2.39.5