]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Augment documentation.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 25 May 2011 17:05:45 +0000 (17:05 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 25 May 2011 17:05:45 +0000 (17:05 +0000)
git-svn-id: https://svn.dealii.org/trunk@23744 0785d39b-7218-0410-832d-ea1e28bc413d

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

index 97ecfd61d63c8d354e85304f400757f0206b70d8..f30324bfcb2aab5e8fd8a2d75109ea29c98104f7 100644 (file)
@@ -603,6 +603,12 @@ namespace FEValuesViews
                                        * of the finite element, the
                                        * symmetrized gradient is a
                                        * <code>SymmetricTensor@<2,spacedim@></code>.
+                                       *
+                                       * The symmetric gradient of a vector
+                                       * field $\mathbf v$ is defined as
+                                       * $\varepsilon(\mathbf v)=\frac 12
+                                       * (\nabla \mathbf v + \nabla \mathbf
+                                       * v^T)$.
                                        */
       typedef dealii::SymmetricTensor<2,spacedim> symmetric_gradient_type;
 
@@ -817,8 +823,14 @@ namespace FEValuesViews
                                        * the <tt>reinit</tt> function of the
                                        * FEValues object was called.
                                        *
-                                       * There is no equivalent function such
-                                       * as
+                                       * The symmetric gradient of a vector
+                                       * field $\mathbf v$ is defined as
+                                       * $\varepsilon(\mathbf v)=\frac 12
+                                       * (\nabla \mathbf v + \nabla \mathbf
+                                       * v^T)$.
+                                       *
+                                       * @note There is no equivalent
+                                       * function such as
                                        * FEValuesBase::get_function_symmetric_gradients
                                        * in the FEValues classes but the
                                        * information can be obtained from
@@ -826,8 +838,9 @@ namespace FEValuesViews
                                        * of course.
                                        */
       template <class InputVector>
-      void get_function_symmetric_gradients (const InputVector& fe_function,
-                   std::vector<symmetric_gradient_type>& symmetric_gradients) const;
+      void
+      get_function_symmetric_gradients (const InputVector& fe_function,
+                                       std::vector<symmetric_gradient_type>& symmetric_gradients) const;
 
                                       /**
                                        * Return the divergence of the selected

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.