]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Write documentation.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Wed, 6 Apr 2005 16:07:46 +0000 (16:07 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Wed, 6 Apr 2005 16:07:46 +0000 (16:07 +0000)
git-svn-id: https://svn.dealii.org/trunk@10390 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/tensor.h

index 9e1fca1fc6951bbeb3ca16c87f110b859004d2a3..3d57c48719523707a975fa63654f5627b960cb1f 100644 (file)
@@ -513,6 +513,22 @@ double contract (const Tensor<1,dim> &src1,
 
 
 
+/**
+ * Multiplication operator performing a contraction of the last index
+ * of the first argument and the first index of the second
+ * argument. This function therefore does the same as the
+ * corresponding <tt>contract</tt> function, but returns the result as
+ * a return value, rather than writing it into the reference given as
+ * the first argument to the <tt>contract</tt> function.
+ *
+ * Note that for the <tt>Tensor</tt> class, the multiplication
+ * operator only performs a contraction over a single pair of
+ * indices. This is in contrast to the multiplication operator for
+ * symmetric tensors, which does the double contraction.
+ *
+ * @relates Tensor
+ * @author Wolfgang Bangerth, 2005
+ */
 template <int dim>
 inline
 double
@@ -545,6 +561,22 @@ void contract (Tensor<1,dim>       &dest,
 
 
 
+/**
+ * Multiplication operator performing a contraction of the last index
+ * of the first argument and the first index of the second
+ * argument. This function therefore does the same as the
+ * corresponding <tt>contract</tt> function, but returns the result as
+ * a return value, rather than writing it into the reference given as
+ * the first argument to the <tt>contract</tt> function.
+ *
+ * Note that for the <tt>Tensor</tt> class, the multiplication
+ * operator only performs a contraction over a single pair of
+ * indices. This is in contrast to the multiplication operator for
+ * symmetric tensors, which does the double contraction.
+ *
+ * @relates Tensor
+ * @author Wolfgang Bangerth, 2005
+ */
 template <int dim>
 Tensor<1,dim>
 operator * (const Tensor<2,dim> &src1,
@@ -580,6 +612,22 @@ void contract (Tensor<1,dim>       &dest,
 
 
 
+/**
+ * Multiplication operator performing a contraction of the last index
+ * of the first argument and the first index of the second
+ * argument. This function therefore does the same as the
+ * corresponding <tt>contract</tt> function, but returns the result as
+ * a return value, rather than writing it into the reference given as
+ * the first argument to the <tt>contract</tt> function.
+ *
+ * Note that for the <tt>Tensor</tt> class, the multiplication
+ * operator only performs a contraction over a single pair of
+ * indices. This is in contrast to the multiplication operator for
+ * symmetric tensors, which does the double contraction.
+ *
+ * @relates Tensor
+ * @author Wolfgang Bangerth, 2005
+ */
 template <int dim>
 inline
 Tensor<1,dim>
@@ -617,6 +665,22 @@ void contract (Tensor<2,dim>       &dest,
 
 
 
+/**
+ * Multiplication operator performing a contraction of the last index
+ * of the first argument and the first index of the second
+ * argument. This function therefore does the same as the
+ * corresponding <tt>contract</tt> function, but returns the result as
+ * a return value, rather than writing it into the reference given as
+ * the first argument to the <tt>contract</tt> function.
+ *
+ * Note that for the <tt>Tensor</tt> class, the multiplication
+ * operator only performs a contraction over a single pair of
+ * indices. This is in contrast to the multiplication operator for
+ * symmetric tensors, which does the double contraction.
+ *
+ * @relates Tensor
+ * @author Wolfgang Bangerth, 2005
+ */
 template <int dim>
 inline
 Tensor<2,dim>
@@ -780,6 +844,22 @@ void contract (Tensor<3,dim>       &dest,
 
 
 
+/**
+ * Multiplication operator performing a contraction of the last index
+ * of the first argument and the first index of the second
+ * argument. This function therefore does the same as the
+ * corresponding <tt>contract</tt> function, but returns the result as
+ * a return value, rather than writing it into the reference given as
+ * the first argument to the <tt>contract</tt> function.
+ *
+ * Note that for the <tt>Tensor</tt> class, the multiplication
+ * operator only performs a contraction over a single pair of
+ * indices. This is in contrast to the multiplication operator for
+ * symmetric tensors, which does the double contraction.
+ *
+ * @relates Tensor
+ * @author Wolfgang Bangerth, 2005
+ */
 template <int dim>
 inline
 Tensor<3,dim>
@@ -820,6 +900,22 @@ void contract (Tensor<3,dim>       &dest,
 
 
 
+/**
+ * Multiplication operator performing a contraction of the last index
+ * of the first argument and the first index of the second
+ * argument. This function therefore does the same as the
+ * corresponding <tt>contract</tt> function, but returns the result as
+ * a return value, rather than writing it into the reference given as
+ * the first argument to the <tt>contract</tt> function.
+ *
+ * Note that for the <tt>Tensor</tt> class, the multiplication
+ * operator only performs a contraction over a single pair of
+ * indices. This is in contrast to the multiplication operator for
+ * symmetric tensors, which does the double contraction.
+ *
+ * @relates Tensor
+ * @author Wolfgang Bangerth, 2005
+ */
 template <int dim>
 inline
 Tensor<3,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.