]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
A comment was wrong. Fix it and recommend something.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 6 Apr 2005 04:19:52 +0000 (04:19 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 6 Apr 2005 04:19:52 +0000 (04:19 +0000)
git-svn-id: https://svn.dealii.org/trunk@10375 0785d39b-7218-0410-832d-ea1e28bc413d

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

index 5af05ade35c7c727a3c3cf193c25f5a0e27d3058..9e2ff62c30320f39aa40c9837b14233c054bbcad 100644 (file)
@@ -604,9 +604,20 @@ class SymmetricTensor
                                      /**
                                       * Constructor. Generate a symmetric
                                       * tensor from a general one. Assumes
-                                      * that @p t is already symmetric, but
-                                      * this is not checked: we simply copy
-                                      * only a subset of elements.
+                                      * that @p t is already symmetric, and in
+                                      * debug mode this is in fact
+                                      * checked. Note that no provision is
+                                      * made to assure that the tensor is
+                                      * symmetric only up to round-off error:
+                                      * if the incoming tensor is not exactly
+                                      * symmetric, then an exception is
+                                      * thrown. If you know that incoming
+                                      * tensor is symmetric only up to
+                                      * round-off, then you may want to call
+                                      * the <tt>symmetrize</tt> function
+                                      * first. If you aren't sure, it is good
+                                      * practice to check before calling
+                                      * <tt>symmetrize</tt>.
                                       */
     SymmetricTensor (const Tensor<2,dim> &t);
 

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.