From: Jean-Paul Pelteret Date: Fri, 9 Dec 2016 20:25:48 +0000 (+0100) Subject: Fix some minor documentation errors from #3034 X-Git-Tag: v8.5.0-rc1~336^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d2aa545e145eebb537bd8d8db5531cd975a84f0f;p=dealii.git Fix some minor documentation errors from #3034 Predictably some minor errors were only spotted after a merge! The biggest point is ensuring that definitions of static members of the Elasticity::StandardTensors class don't get inlined in their description as "Initial values". --- diff --git a/include/deal.II/physics/elasticity/kinematics.h b/include/deal.II/physics/elasticity/kinematics.h index 28fd56f831..354635166d 100644 --- a/include/deal.II/physics/elasticity/kinematics.h +++ b/include/deal.II/physics/elasticity/kinematics.h @@ -223,7 +223,7 @@ namespace Physics * gradient). * The result is expressed as * @f[ - * \mathbf{d} := \frac{1}{2} \left[ \mathbf{l} + \mathbf{l}^{T} \right] \, . + * \mathbf{d} := \frac{1}{2} \left[ \mathbf{l} + \mathbf{l}^{T} \right] * @f] * where * @f[ @@ -246,7 +246,7 @@ namespace Physics * gradient). * The result is expressed as * @f[ - * \mathbf{w} := \frac{1}{2} \left[ \mathbf{l} - \mathbf{l}^{T} \right] \, . + * \mathbf{w} := \frac{1}{2} \left[ \mathbf{l} - \mathbf{l}^{T} \right] * @f] * where * @f[ diff --git a/include/deal.II/physics/elasticity/standard_tensors.h b/include/deal.II/physics/elasticity/standard_tensors.h index 4a58ca08a9..91c4ec3734 100644 --- a/include/deal.II/physics/elasticity/standard_tensors.h +++ b/include/deal.II/physics/elasticity/standard_tensors.h @@ -212,9 +212,9 @@ namespace Physics * as constructed from the deformation gradient tensor @p F. * The result performs the following operation: * @f[ - * \texttt{Dev_P_T} \{ \bullet \} = J^{-2/\textrm{dim}} \left[ \{ \bullet \} - - * \frac{1}{\textrm{dim}} \left[\mathbf{C}^{-1} : \{ \bullet \}\right] \mathbf{C} \right] - * := \hat{\mathcal{P}}^{T} : \{ \bullet \} + * \hat{\mathcal{P}}^{T} : \{ \bullet \} + * = J^{-2/\textrm{dim}} \left[ \{ \bullet \} - \frac{1}{\textrm{dim}} \left[\mathbf{C}^{-1} : \{ \bullet \}\right] \mathbf{C} \right] + * = \texttt{Dev_P_T} \{ \bullet \} * @f] */ template diff --git a/source/physics/elasticity/standard_tensors.cc b/source/physics/elasticity/standard_tensors.cc index 02db6735c5..665acddb31 100644 --- a/source/physics/elasticity/standard_tensors.cc +++ b/source/physics/elasticity/standard_tensors.cc @@ -18,6 +18,7 @@ DEAL_II_NAMESPACE_OPEN +#ifndef DOXYGEN template const SymmetricTensor<2, dim> @@ -42,6 +43,7 @@ template const SymmetricTensor<4, dim> Physics::Elasticity::StandardTensors::dev_P = deviator_tensor(); +#endif // DOXYGEN // explicit instantiations #include "standard_tensors.inst"