From: bangerth Date: Wed, 25 May 2011 17:05:45 +0000 (+0000) Subject: Augment documentation. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c3ef542f4ad66a1e531feacff8d1a45a53e666ee;p=dealii-svn.git Augment documentation. git-svn-id: https://svn.dealii.org/trunk@23744 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/fe/fe_values.h b/deal.II/include/deal.II/fe/fe_values.h index 97ecfd61d6..f30324bfcb 100644 --- a/deal.II/include/deal.II/fe/fe_values.h +++ b/deal.II/include/deal.II/fe/fe_values.h @@ -603,6 +603,12 @@ namespace FEValuesViews * of the finite element, the * symmetrized gradient is a * SymmetricTensor@<2,spacedim@>. + * + * 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 reinit 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 - void get_function_symmetric_gradients (const InputVector& fe_function, - std::vector& symmetric_gradients) const; + void + get_function_symmetric_gradients (const InputVector& fe_function, + std::vector& symmetric_gradients) const; /** * Return the divergence of the selected