]> https://gitweb.dealii.org/ - dealii.git/commitdiff
more documentation
authorGuido Kanschat <dr.guido.kanschat@gmail.com>
Tue, 19 Dec 2000 08:58:49 +0000 (08:58 +0000)
committerGuido Kanschat <dr.guido.kanschat@gmail.com>
Tue, 19 Dec 2000 08:58:49 +0000 (08:58 +0000)
git-svn-id: https://svn.dealii.org/trunk@3566 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/tensor_product_polynomials.h

index ceade27a832a201820e4e9ff8cd2d56016c87627..2971eb48a10542fdb2c7dfe44c10b66a8b439a5e 100644 (file)
 /**
  * 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 <int dim>
 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<SmartPointer<Polynomial> > &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<dim> &unit_point,
                                vector<double> &values,

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.