From: Guido Kanschat Date: Tue, 19 Dec 2000 08:58:49 +0000 (+0000) Subject: more documentation X-Git-Tag: v8.0.0~19874 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=36041eecedf580d761fb52f7b687672f9774af9c;p=dealii.git more documentation git-svn-id: https://svn.dealii.org/trunk@3566 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/base/include/base/tensor_product_polynomials.h b/deal.II/base/include/base/tensor_product_polynomials.h index ceade27a83..2971eb48a1 100644 --- a/deal.II/base/include/base/tensor_product_polynomials.h +++ b/deal.II/base/include/base/tensor_product_polynomials.h @@ -26,7 +26,11 @@ /** * Tensor product of given polynomials. * - * @author Ralf Hartmann, 2000 + * Given a vector of @{n} one-dimensional polynomials @{P1} to @{Pn}, + * this class generates @p{n} to the power of @p{dim} polynomials of + * the form @p{ Qijk(x,y,z) = Pi(x)Pj(y)Pk(z)}. + * + * @author Ralf Hartmann, 2000, documentation Guido Kanschat */ template class TensorProductPolynomials @@ -34,17 +38,21 @@ class TensorProductPolynomials public: /** * Constructor. @p{pols} is a - * vector of 1d polynomial - * functions. For polynomials of - * order @p{p} there should be - * @p{p+1} polynomials. + * vector of pointers to + * one-dimensional polynomials. */ TensorProductPolynomials(const vector > &pols); /** - * Calculates the shape values - * and shape grads at the + * Calculates the polynomials + * and their derivatives at * @p{unit_point}. + * + * The vectors must either have + * length @p{0} or number of + * polynomials. In the first + * case, the function will not + * compute these values. */ void shape_values_and_grads(const Point &unit_point, vector &values,