]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Augment documentation.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 1 Jun 2005 00:26:08 +0000 (00:26 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 1 Jun 2005 00:26:08 +0000 (00:26 +0000)
git-svn-id: https://svn.dealii.org/trunk@10800 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/symmetric_tensor.h

index d2dc48d252c2f1912daa45781e7705b73f5bb7b2..f8848cc07532e592f7962bbd59e4ac12b7a2c56b 100644 (file)
@@ -2129,6 +2129,12 @@ identity_tensor ()
  * Return the tensor of rank 4 that is the outer product of the two tensors
  * given as arguments, i.e. the result <tt>T=t1 \otimes t2</tt> satisfies
  * <tt>T phi = t1 (t2 : phi)</tt> for all symmetric tensors <tt>phi</tt>.
+ *
+ * For example, the deviator tensor can be computed as
+ * <tt>identity_tensor<dim>() -
+ * 1/d*outer_product(unit_symmetric_tensor<dim>(),
+ * unit_symmetric_tensor<dim>())</tt>, since the (double) contraction with the
+ * unit tensor yields the trace of a symmetric tensor.
  * 
  * @relates SymmetricTensor
  * @author Wolfgang Bangerth, 2005

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.