From cbdc4a23ec42beefcec552e27893b9db405846de Mon Sep 17 00:00:00 2001 From: wolf Date: Wed, 6 Apr 2005 16:07:46 +0000 Subject: [PATCH] Write documentation. git-svn-id: https://svn.dealii.org/trunk@10390 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/tensor.h | 96 ++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) diff --git a/deal.II/base/include/base/tensor.h b/deal.II/base/include/base/tensor.h index 9e1fca1fc6..3d57c48719 100644 --- a/deal.II/base/include/base/tensor.h +++ b/deal.II/base/include/base/tensor.h @@ -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 contract function, but returns the result as + * a return value, rather than writing it into the reference given as + * the first argument to the contract function. + * + * Note that for the Tensor 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 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 contract function, but returns the result as + * a return value, rather than writing it into the reference given as + * the first argument to the contract function. + * + * Note that for the Tensor 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 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 contract function, but returns the result as + * a return value, rather than writing it into the reference given as + * the first argument to the contract function. + * + * Note that for the Tensor 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 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 contract function, but returns the result as + * a return value, rather than writing it into the reference given as + * the first argument to the contract function. + * + * Note that for the Tensor 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 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 contract function, but returns the result as + * a return value, rather than writing it into the reference given as + * the first argument to the contract function. + * + * Note that for the Tensor 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 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 contract function, but returns the result as + * a return value, rather than writing it into the reference given as + * the first argument to the contract function. + * + * Note that for the Tensor 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 inline Tensor<3,dim> -- 2.39.5