]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Added doxygen documentation for QGaussLobatto class.
authorprill <prill@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 6 Nov 2006 07:34:44 +0000 (07:34 +0000)
committerprill <prill@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 6 Nov 2006 07:34:44 +0000 (07:34 +0000)
git-svn-id: https://svn.dealii.org/trunk@14165 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/quadrature_lib.h

index a1362d1078d158f33d17b3d3a2b6beb449a89d88..6e2111e0b6eff9497aceb60630301d4068679585 100644 (file)
@@ -85,7 +85,10 @@ class QGaussLobatto : public Quadrature<dim>
   protected:
                                     /**
                                      * Compute Legendre-Gauss-Lobatto quadrature
-                                     * points in the interval [-1, +1].
+                                     * points in the interval [-1, +1] which are
+                                     * equal to the roots of the corresponding
+                                     * Jacobi polynomial (specified by
+                                     * @p alpha, @p beta).
                                      * @param q  number of points.
                                      * @return vector containing nodes.
                                      */
@@ -97,6 +100,9 @@ class QGaussLobatto : public Quadrature<dim>
                                     /**
                                      * Compute Legendre-Gauss-Lobatto quadrature
                                      * weights.
+                                     * The quadrature points and weights are
+                                     * related to Jacobi polynomial specified
+                                     * by @p alpha, @p beta.
                                      * @param x  quadrature points.
                                      * @return vector containing weights.
                                      */
@@ -107,7 +113,9 @@ class QGaussLobatto : public Quadrature<dim>
     
                                     /**
                                      * Evaluate a Jacobi polynomial
-                                     * $ P^{\alpha, \beta}_n(x) $. 
+                                     * $ P^{\alpha, \beta}_n(x) $
+                                     * specified by the parameters
+                                     * @p alpha, @p beta, @p n.
                                      * Note: The Jacobi polynomials are
                                      * not orthonormal and defined on
                                      * the interval [-1, +1].

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.