]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Reword the documentation that seems to be a left-over from 1997.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 28 Mar 2005 17:27:54 +0000 (17:27 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 28 Mar 2005 17:27:54 +0000 (17:27 +0000)
git-svn-id: https://svn.dealii.org/trunk@10248 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/tensor_base.h

index 6133fbcb41d6d118a8057a8804baa8ab22a54838..a66e9b6be832757fac7bc3b89fe9412347c09746 100644 (file)
@@ -43,11 +43,21 @@ template <int dim> class Tensor<1,dim>;
 
 /**
  * This class is a specialized version of the <tt>Tensor<rank,dim></tt> class.
- * It handles tensors with one index, i.e. vectors, of fixed dimension
- * and offers the functionality needed for tensors of higher rank.
+ * It handles tensors with one index, i.e. vectors, of fixed dimension and
+ * provides the basis for the functionality needed for tensors of higher rank.
  *
- * In many cases, you will want to use the more specialized <tt>Point</tt> class
- * which acts as a tensor of rank one but has more functionality.
+ * Within deal.II, the distinction between this class and its derived class
+ * <tt>Point</tt> is that we use the <tt>Point</tt> class mainly to denote the
+ * points that make up geometric objects. As such, they have a small number of
+ * additional operations over general tensors of rank 1 for which we use the
+ * <tt>Tensor<1,dim></tt> class. In particular, there is a distance() function
+ * to compute the Euclidian distance between two points in space.
+ *
+ * However, the <tt>Point</tt> class is really only used where the coordinates
+ * of an object can be thought to possess the dimension of a length. For all
+ * other uses, such as the gradient of a scalar function (which is a tensor of
+ * rank 1, or vector, with as many elements as a point object, but with
+ * different physical units), we use the <tt>Tensor<1,dim></tt> class.
  */
 template <int dim>
 class Tensor<1,dim>

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.