From: Matthias Maier <tamiko@43-1.org>
Date: Tue, 15 Sep 2015 04:46:28 +0000 (-0500)
Subject: tensor.h: Let outer_product return its result
X-Git-Tag: v8.4.0-rc2~418^2~2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1e3667c013fc6bfb44e5df476148d69646e86f67;p=dealii.git

tensor.h: Let outer_product return its result

All other function signatures also return their result - do the same here
and deprecate the old signatures
---

diff --git a/include/deal.II/base/tensor.h b/include/deal.II/base/tensor.h
index 44c295d0cc..71ee4d13dc 100644
--- a/include/deal.II/base/tensor.h
+++ b/include/deal.II/base/tensor.h
@@ -1506,6 +1506,30 @@ operator * (const Tensor<rank_1, dim, Number> &src1,
 }
 
 
+/**
+ * The outer product of two tensors of @p rank_1 and @p rank_2: Returns a
+ * tensor of rank $(\text{rank\_1} + \text{rank\_2})$:
+ * @f[
+ *   \text{result}_{i_1,..,i_{r1},j_1,..,j_{r2}}
+ *   = \text{left}_{i_1,..,i_{r1}}\,\text{right}_{j_1,..,j_{r2}.}
+ * @f]
+ *
+ * @relates Tensor
+ * @relates ProductType
+ */
+template <int rank_1, int rank_2, int dim,
+          typename Number, typename OtherNumber>
+inline
+Tensor<rank_1 + rank_2, dim, typename ProductType<Number, OtherNumber>::type>
+outer_product(const Tensor<rank_1, dim, Number> &src1,
+              const Tensor<rank_2, dim, OtherNumber> &src2)
+{
+  typename Tensor<rank_1 + rank_2, dim, typename ProductType<Number, OtherNumber>::type>::tensor_type result;
+  TensorAccessors::contract<0, rank_1, rank_2, dim>(result, src1, src2);
+  return result;
+}
+
+
 //@}
 /**
  * @name To be refactored
@@ -2000,102 +2024,6 @@ contract3 (const Tensor<2,dim,Number> &t1,
 }
 
 
-/**
- * Form the outer product of two tensors of rank 1 and 1, i.e. <tt>dst[i][j] =
- * src1[i] * src2[j]</tt>.
- *
- * @relates Tensor
- * @author Wolfgang Bangerth, 2000
- */
-template <int dim, typename Number>
-void outer_product (Tensor<2,dim,Number>       &dst,
-                    const Tensor<1,dim,Number> &src1,
-                    const Tensor<1,dim,Number> &src2)
-{
-  for (unsigned int i=0; i<dim; ++i)
-    for (unsigned int j=0; j<dim; ++j)
-      dst[i][j] = src1[i] * src2[j];
-}
-
-
-/**
- * Form the outer product of two tensors of rank 1 and 2, i.e.
- * <tt>dst[i][j][k] = src1[i] * src2[j][k]</tt>.
- *
- * @relates Tensor
- * @author Wolfgang Bangerth, 2000
- */
-template <int dim, typename Number>
-void outer_product (Tensor<3,dim,Number>       &dst,
-                    const Tensor<1,dim,Number> &src1,
-                    const Tensor<2,dim,Number> &src2)
-{
-  for (unsigned int i=0; i<dim; ++i)
-    for (unsigned int j=0; j<dim; ++j)
-      for (unsigned int k=0; k<dim; ++k)
-        dst[i][j][k] = src1[i] * src2[j][k];
-}
-
-
-/**
- * Form the outer product of two tensors of rank 2 and 1, i.e.
- * <tt>dst[i][j][k] = src1[i][j] * src2[k]</tt>.
- *
- * @relates Tensor
- * @author Wolfgang Bangerth, 2000
- */
-template <int dim, typename Number>
-void outer_product (Tensor<3,dim,Number>       &dst,
-                    const Tensor<2,dim,Number> &src1,
-                    const Tensor<1,dim,Number> &src2)
-{
-  for (unsigned int i=0; i<dim; ++i)
-    for (unsigned int j=0; j<dim; ++j)
-      for (unsigned int k=0; k<dim; ++k)
-        dst[i][j][k] = src1[i][j] * src2[k];
-}
-
-
-/**
- * Form the outer product of two tensors of rank 0 and 1, i.e. <tt>dst[i] =
- * src1 * src2[i]</tt>. Of course, this is only a scaling of <tt>src2</tt>,
- * but we consider this an outer product for completeness of these functions
- * and since this is sometimes needed when writing templates that depend on
- * the rank of a tensor, which may sometimes be zero (i.e. a scalar).
- *
- * @relates Tensor
- * @author Wolfgang Bangerth, 2000
- */
-template <int dim, typename Number>
-void outer_product (Tensor<1,dim,Number>       &dst,
-                    const Number                src1,
-                    const Tensor<1,dim,Number> &src2)
-{
-  for (unsigned int i=0; i<dim; ++i)
-    dst[i] = src1 * src2[i];
-}
-
-
-/**
- * Form the outer product of two tensors of rank 1 and 0, i.e. <tt>dst[i] =
- * src1[i] * src2</tt>. Of course, this is only a scaling of <tt>src1</tt>,
- * but we consider this an outer product for completeness of these functions
- * and since this is sometimes needed when writing templates that depend on
- * the rank of a tensor, which may sometimes be zero (i.e. a scalar).
- *
- * @relates Tensor
- * @author Wolfgang Bangerth, 2000
- */
-template <int dim, typename Number>
-void outer_product (Tensor<1,dim,Number>       &dst,
-                    const Tensor<1,dim,Number>  src1,
-                    const Number         src2)
-{
-  for (unsigned int i=0; i<dim; ++i)
-    dst[i] = src1[i] * src2;
-}
-
-
 /**
  * Compute the scalar product $a:b=\sum_{i,j} a_{ij}b_{ij}$ between two
  * tensors $a,b$ of rank 2. We don't use <code>operator*</code> for this
diff --git a/include/deal.II/base/tensor_deprecated.h b/include/deal.II/base/tensor_deprecated.h
index 9bc6663167..b6dfeb343a 100644
--- a/include/deal.II/base/tensor_deprecated.h
+++ b/include/deal.II/base/tensor_deprecated.h
@@ -29,7 +29,6 @@ DEAL_II_NAMESPACE_OPEN
  */
 //@{
 
-
 /**
  * The cross-product of 2 vectors in 3d.
  *
@@ -43,9 +42,42 @@ cross_product (Tensor<1,dim,Number>       &dst,
                const Tensor<1,dim,Number> &src1,
                const Tensor<1,dim,Number> &src2) DEAL_II_DEPRECATED;
 
+/**
+ * Form the outer product of two tensors.
+ *
+ * @deprecated Use the generic version that returns its result instead.
+ * @relates Tensor
+ */
+template <int rank_1, int rank_2, int dim, typename Number>
+void outer_product(Tensor<rank_1 + rank_2, dim, Number> &dst,
+                   const Tensor<rank_1, dim, Number>    &src1,
+                   const Tensor<rank_2, dim, Number>    &src2) DEAL_II_DEPRECATED;
 
-#ifndef DOXYGEN
+/**
+ * Multiply a Tensor<1,dim,Number> with a Number.
+ *
+ * @deprecated Use operator* instead.
+ * @relates Tensor
+ */
+template <int dim, typename Number>
+void outer_product (Tensor<1,dim,Number>       &dst,
+                    const Number                src1,
+                    const Tensor<1,dim,Number> &src2) DEAL_II_DEPRECATED;
 
+/**
+ * Multiply a Tensor<1,dim,Number> with a Number.
+ *
+ * @deprecated Use operator* instead.
+ * @relates Tensor
+ */
+template <int dim, typename Number>
+void outer_product (Tensor<1,dim,Number>       &dst,
+                    const Tensor<1,dim,Number>  src1,
+                    const Number                src2) DEAL_II_DEPRECATED;
+
+//@}
+
+#ifndef DOXYGEN
 
 template <int dim, typename Number>
 inline
@@ -57,9 +89,33 @@ cross_product (Tensor<1,dim,Number>       &dst,
   dst = cross_product(src1, src2);
 }
 
-#endif /* DOXYGEN */
+template <int rank_1, int rank_2, int dim, typename Number>
+void outer_product(Tensor<rank_1 + rank_2, dim, Number> &dst,
+                   const Tensor<rank_1, dim, Number>    &src1,
+                   const Tensor<rank_2, dim, Number>    &src2)
+{
+  TensorAccessors::contract<0, rank_1, rank_2, dim>(dst, src1, src2);
+}
 
-//@}
+template <int dim, typename Number>
+void outer_product (Tensor<1,dim,Number>       &dst,
+                    const Number                src1,
+                    const Tensor<1,dim,Number> &src2)
+{
+  for (unsigned int i=0; i<dim; ++i)
+    dst[i] = src1 * src2[i];
+}
+
+template <int dim, typename Number>
+void outer_product (Tensor<1,dim,Number>       &dst,
+                    const Tensor<1,dim,Number>  src1,
+                    const Number         src2)
+{
+  for (unsigned int i=0; i<dim; ++i)
+    dst[i] = src1[i] * src2;
+}
+
+#endif /* DOXYGEN */
 
 DEAL_II_NAMESPACE_CLOSE