]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Clarify documentation.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 3 Feb 2004 16:40:14 +0000 (16:40 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 3 Feb 2004 16:40:14 +0000 (16:40 +0000)
git-svn-id: https://svn.dealii.org/trunk@8390 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/fe/fe_values.h

index 583dd4325132703461598f3acf3828aedaa2df40..caf9f6c12e076ecbf765be600c5c62b48e2f79ed 100644 (file)
@@ -438,7 +438,12 @@ class FEValuesBase : protected FEValuesData<dim>
                                      * input vector may be either a
                                      * @p{Vector<double>},
                                      * @p{Vector<float>}, or
-                                     * @p{BlockVector<double,...>}.
+                                     * @p{BlockVector<double>}. It
+                                     * represents a global vector of
+                                     * DoF values associated with the
+                                     * @ref{DofHandler} object with
+                                     * which this @ref{FEValues}
+                                     * object was last initialized.
                                      */
     template <class InputVector, typename number>
     void get_function_values (const InputVector& fe_function,
@@ -458,7 +463,12 @@ class FEValuesBase : protected FEValuesData<dim>
                                      * input vector may be either a
                                      * @p{Vector<double>},
                                      * @p{Vector<float>}, or
-                                     * @p{BlockVector<double,...>}.
+                                     * @p{BlockVector<double>}. It
+                                     * represents a global vector of
+                                     * DoF values associated with the
+                                     * @ref{DofHandler} object with
+                                     * which this @ref{FEValues}
+                                     * object was last initialized.
                                      */
     template <class InputVector, typename number>
     void get_function_values (const InputVector       &fe_function,
@@ -544,7 +554,18 @@ class FEValuesBase : protected FEValuesData<dim>
                                      * input vector may be either a
                                      * @p{Vector<double>},
                                      * @p{Vector<float>}, or
-                                     * @p{BlockVector<double,...>}.
+                                     * @p{BlockVector<double>}. It
+                                     * represents a global vector of
+                                     * DoF values associated with the
+                                     * @ref{DofHandler} object with
+                                     * which this @ref{FEValues}
+                                     * object was last initialized.
+                                     *
+                                     * The output are the gradients
+                                     * of the function represented by
+                                     * these DoF values, as computed
+                                     * in real space (as opposed to
+                                     * on the unit cell).
                                      */
     template <class InputVector>
     void get_function_grads (const InputVector      &fe_function,
@@ -573,7 +594,18 @@ class FEValuesBase : protected FEValuesData<dim>
                                      * input vector may be either a
                                      * @p{Vector<double>},
                                      * @p{Vector<float>}, or
-                                     * @p{BlockVector<double,...>}.
+                                     * @p{BlockVector<double>}. It
+                                     * represents a global vector of
+                                     * DoF values associated with the
+                                     * @ref{DofHandler} object with
+                                     * which this @ref{FEValues}
+                                     * object was last initialized.
+                                     *
+                                     * The output are the gradients
+                                     * of the function represented by
+                                     * these DoF values, as computed
+                                     * in real space (as opposed to
+                                     * on the unit cell).
                                      */
     template <class InputVector>
     void get_function_grads (const InputVector               &fe_function,
@@ -660,7 +692,18 @@ class FEValuesBase : protected FEValuesData<dim>
                                      * input vector may be either a
                                      * @p{Vector<double>},
                                      * @p{Vector<float>}, or
-                                     * @p{BlockVector<double,...>}.
+                                     * @p{BlockVector<double>}. It
+                                     * represents a global vector of
+                                     * DoF values associated with the
+                                     * @ref{DofHandler} object with
+                                     * which this @ref{FEValues}
+                                     * object was last initialized.
+                                     *
+                                     * The output are the second derivatives
+                                     * of the function represented by
+                                     * these DoF values, as computed
+                                     * in real space (as opposed to
+                                     * on the unit cell).
                                      */
     template <class InputVector>
     void get_function_2nd_derivatives (const InputVector& fe_function,
@@ -687,7 +730,18 @@ class FEValuesBase : protected FEValuesData<dim>
                                      * input vector may be either a
                                      * @p{Vector<double>},
                                      * @p{Vector<float>}, or
-                                     * @p{BlockVector<double,...>}.
+                                     * @p{BlockVector<double>}. It
+                                     * represents a global vector of
+                                     * DoF values associated with the
+                                     * @ref{DofHandler} object with
+                                     * which this @ref{FEValues}
+                                     * object was last initialized.
+                                     *
+                                     * The output are the second derivatives
+                                     * of the function represented by
+                                     * these DoF values, as computed
+                                     * in real space (as opposed to
+                                     * on the unit cell).
                                      */
     template <class InputVector>
     void get_function_2nd_derivatives (const InputVector      &fe_function,

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.