From: David Wells <wellsd2@rpi.edu>
Date: Sat, 10 Feb 2018 00:17:52 +0000 (-0500)
Subject: Make Mapping::clone return a unique_ptr<Mapping>.
X-Git-Tag: v9.0.0-rc1~443^2~1
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fd1bf6a6f846ae259d8a33dc7b4b3621dec60212;p=dealii.git

Make Mapping::clone return a unique_ptr<Mapping>.

This commit converts the current interface into one based on smart
pointers. It also gets rid of the use of a covariant return type in
MappingQ1::clone and MappingQ1Eulerian::clone.
---

diff --git a/doc/news/changes/incompatibilities/20180208DavidWells b/doc/news/changes/incompatibilities/20180208DavidWells
new file mode 100644
index 0000000000..c66292b039
--- /dev/null
+++ b/doc/news/changes/incompatibilities/20180208DavidWells
@@ -0,0 +1,3 @@
+Changed: The function Mapping::clone (and all inheriting classes' implementations, such as MappingQ1Eulerian::clone) now return a <code>unique_ptr<Mapping<dim,spacedim>></code>.
+<br>
+(David Wells, 2018/02/08)
diff --git a/include/deal.II/fe/mapping.h b/include/deal.II/fe/mapping.h
index 8ccc3d71cf..558ad22393 100644
--- a/include/deal.II/fe/mapping.h
+++ b/include/deal.II/fe/mapping.h
@@ -24,6 +24,7 @@
 
 #include <array>
 #include <cmath>
+#include <memory>
 
 DEAL_II_NAMESPACE_OPEN
 
@@ -303,7 +304,7 @@ public:
    * This function is mainly used by the hp::MappingCollection class.
    */
   virtual
-  Mapping<dim,spacedim> *clone () const = 0;
+  std::unique_ptr<Mapping<dim,spacedim>> clone () const = 0;
 
   /**
    * Return the mapped vertices of a cell.
diff --git a/include/deal.II/fe/mapping_c1.h b/include/deal.II/fe/mapping_c1.h
index c240165b25..7406099ddd 100644
--- a/include/deal.II/fe/mapping_c1.h
+++ b/include/deal.II/fe/mapping_c1.h
@@ -50,7 +50,7 @@ public:
    * then assumes ownership of it.
    */
   virtual
-  Mapping<dim,spacedim> *clone () const;
+  std::unique_ptr<Mapping<dim,spacedim>> clone () const override;
 
 protected:
 
diff --git a/include/deal.II/fe/mapping_cartesian.h b/include/deal.II/fe/mapping_cartesian.h
index 5ef8c219ab..9cbdfd35ec 100644
--- a/include/deal.II/fe/mapping_cartesian.h
+++ b/include/deal.II/fe/mapping_cartesian.h
@@ -64,7 +64,7 @@ public:
 
   // for documentation, see the Mapping base class
   virtual
-  Mapping<dim, spacedim> *clone () const;
+  std::unique_ptr<Mapping<dim, spacedim>> clone () const override;
 
   /**
    * Return @p true because MappingCartesian preserves vertex
diff --git a/include/deal.II/fe/mapping_fe_field.h b/include/deal.II/fe/mapping_fe_field.h
index 11ec2f41ce..fa9b9155d3 100644
--- a/include/deal.II/fe/mapping_fe_field.h
+++ b/include/deal.II/fe/mapping_fe_field.h
@@ -123,7 +123,7 @@ public:
    * then assumes ownership of it.
    */
   virtual
-  Mapping<dim,spacedim> *clone () const;
+  std::unique_ptr<Mapping<dim,spacedim>> clone () const override;
 
 
 
diff --git a/include/deal.II/fe/mapping_manifold.h b/include/deal.II/fe/mapping_manifold.h
index 443c5b4722..7d0b483c40 100644
--- a/include/deal.II/fe/mapping_manifold.h
+++ b/include/deal.II/fe/mapping_manifold.h
@@ -72,7 +72,7 @@ public:
 
   // for documentation, see the Mapping base class
   virtual
-  Mapping<dim,spacedim> *clone () const;
+  std::unique_ptr<Mapping<dim,spacedim>> clone () const override;
 
   /**
    * Always returns @p true because this class assumes that the
diff --git a/include/deal.II/fe/mapping_q.h b/include/deal.II/fe/mapping_q.h
index c115f1e88d..1b09075a0a 100644
--- a/include/deal.II/fe/mapping_q.h
+++ b/include/deal.II/fe/mapping_q.h
@@ -201,7 +201,7 @@ public:
    * then assumes ownership of it.
    */
   virtual
-  Mapping<dim,spacedim> *clone () const;
+  std::unique_ptr<Mapping<dim,spacedim>> clone () const override;
 
 
   /**
diff --git a/include/deal.II/fe/mapping_q1.h b/include/deal.II/fe/mapping_q1.h
index 770aa5c66f..3faae61e43 100644
--- a/include/deal.II/fe/mapping_q1.h
+++ b/include/deal.II/fe/mapping_q1.h
@@ -63,7 +63,7 @@ public:
 
   // for documentation, see the Mapping base class
   virtual
-  MappingQ1<dim,spacedim> *clone () const;
+  std::unique_ptr<Mapping<dim,spacedim>> clone () const override;
 };
 
 
diff --git a/include/deal.II/fe/mapping_q1_eulerian.h b/include/deal.II/fe/mapping_q1_eulerian.h
index faa5480f14..1675899df9 100644
--- a/include/deal.II/fe/mapping_q1_eulerian.h
+++ b/include/deal.II/fe/mapping_q1_eulerian.h
@@ -123,7 +123,7 @@ public:
    * then assumes ownership of it.
    */
   virtual
-  MappingQ1Eulerian<dim,VectorType,spacedim> *clone () const;
+  std::unique_ptr<Mapping<dim,spacedim>> clone () const override;
 
   /**
    * Always returns @p false because MappingQ1Eulerian does not in general
diff --git a/include/deal.II/fe/mapping_q_eulerian.h b/include/deal.II/fe/mapping_q_eulerian.h
index 8216d645c3..98c20b21f2 100644
--- a/include/deal.II/fe/mapping_q_eulerian.h
+++ b/include/deal.II/fe/mapping_q_eulerian.h
@@ -126,7 +126,7 @@ public:
    * then assumes ownership of it.
    */
   virtual
-  Mapping<dim,spacedim> *clone () const;
+  std::unique_ptr<Mapping<dim,spacedim>> clone () const override;
 
   /**
    * Always return @p false because MappingQEulerian does not in general
diff --git a/include/deal.II/fe/mapping_q_generic.h b/include/deal.II/fe/mapping_q_generic.h
index 085985555a..1e3086c53d 100644
--- a/include/deal.II/fe/mapping_q_generic.h
+++ b/include/deal.II/fe/mapping_q_generic.h
@@ -142,7 +142,7 @@ public:
 
   // for documentation, see the Mapping base class
   virtual
-  Mapping<dim,spacedim> *clone () const;
+  std::unique_ptr<Mapping<dim,spacedim>> clone () const override;
 
   /**
    * Return the degree of the mapping, i.e. the value which was passed to the
diff --git a/source/fe/mapping_c1.cc b/source/fe/mapping_c1.cc
index 5ff2ecdfb2..0532e863af 100644
--- a/source/fe/mapping_c1.cc
+++ b/source/fe/mapping_c1.cc
@@ -13,10 +13,14 @@
 //
 // ---------------------------------------------------------------------
 
+#include <deal.II/base/std_cxx14/memory.h>
+
 #include <deal.II/grid/tria_accessor.h>
 #include <deal.II/grid/tria_iterator.h>
 #include <deal.II/grid/tria_boundary.h>
+
 #include <deal.II/fe/mapping_c1.h>
+
 #include <cmath>
 
 DEAL_II_NAMESPACE_OPEN
@@ -208,10 +212,10 @@ MappingC1<dim,spacedim>::MappingC1Generic::add_quad_support_points (const typena
 
 
 template <int dim, int spacedim>
-Mapping<dim, spacedim> *
+std::unique_ptr<Mapping<dim,spacedim> >
 MappingC1<dim,spacedim>::clone () const
 {
-  return new MappingC1<dim,spacedim>();
+  return std_cxx14::make_unique<MappingC1<dim,spacedim>>();
 }
 
 
diff --git a/source/fe/mapping_cartesian.cc b/source/fe/mapping_cartesian.cc
index 033e0de12c..3d70bfb63e 100644
--- a/source/fe/mapping_cartesian.cc
+++ b/source/fe/mapping_cartesian.cc
@@ -13,7 +13,7 @@
 //
 // ---------------------------------------------------------------------
 
-
+#include <deal.II/base/std_cxx14/memory.h>
 #include <deal.II/base/array_view.h>
 #include <deal.II/base/tensor.h>
 #include <deal.II/base/quadrature.h>
@@ -1064,10 +1064,10 @@ MappingCartesian<dim, spacedim>::transform_real_to_unit_cell (
 
 
 template <int dim, int spacedim>
-Mapping<dim, spacedim> *
+std::unique_ptr<Mapping<dim, spacedim> >
 MappingCartesian<dim, spacedim>::clone () const
 {
-  return new MappingCartesian<dim, spacedim>(*this);
+  return std_cxx14::make_unique<MappingCartesian<dim,spacedim>>(*this);
 }
 
 
diff --git a/source/fe/mapping_fe_field.cc b/source/fe/mapping_fe_field.cc
index 0cf9191b1b..b72b2ffdc4 100644
--- a/source/fe/mapping_fe_field.cc
+++ b/source/fe/mapping_fe_field.cc
@@ -20,6 +20,7 @@
 #include <deal.II/base/quadrature_lib.h>
 #include <deal.II/base/qprojector.h>
 #include <deal.II/base/memory_consumption.h>
+#include <deal.II/base/std_cxx14/memory.h>
 #include <deal.II/base/utilities.h>
 #include <deal.II/lac/full_matrix.h>
 #include <deal.II/lac/vector.h>
@@ -1974,10 +1975,10 @@ MappingFEField<dim,spacedim,VectorType,DoFHandlerType>::get_component_mask() con
 
 
 template <int dim, int spacedim, typename VectorType, typename DoFHandlerType>
-Mapping<dim,spacedim> *
+std::unique_ptr<Mapping<dim,spacedim> >
 MappingFEField<dim,spacedim,VectorType,DoFHandlerType>::clone () const
 {
-  return new MappingFEField<dim,spacedim,VectorType,DoFHandlerType>(*this);
+  return std_cxx14::make_unique<MappingFEField<dim,spacedim,VectorType,DoFHandlerType>>(*this);
 }
 
 
diff --git a/source/fe/mapping_manifold.cc b/source/fe/mapping_manifold.cc
index cfcc15b121..b5b7b422e6 100644
--- a/source/fe/mapping_manifold.cc
+++ b/source/fe/mapping_manifold.cc
@@ -19,6 +19,7 @@
 #include <deal.II/base/quadrature.h>
 #include <deal.II/base/qprojector.h>
 #include <deal.II/base/quadrature_lib.h>
+#include <deal.II/base/std_cxx14/memory.h>
 #include <deal.II/base/tensor_product_polynomials.h>
 #include <deal.II/base/memory_consumption.h>
 #include <deal.II/lac/full_matrix.h>
@@ -176,10 +177,10 @@ MappingManifold<dim,spacedim>::MappingManifold (const MappingManifold<dim,spaced
 
 
 template <int dim, int spacedim>
-Mapping<dim,spacedim> *
+std::unique_ptr<Mapping<dim,spacedim> >
 MappingManifold<dim,spacedim>::clone () const
 {
-  return new MappingManifold<dim,spacedim>(*this);
+  return std_cxx14::make_unique<MappingManifold<dim,spacedim>>(*this);
 }
 
 
diff --git a/source/fe/mapping_q.cc b/source/fe/mapping_q.cc
index d924a86e27..25f641e662 100644
--- a/source/fe/mapping_q.cc
+++ b/source/fe/mapping_q.cc
@@ -18,6 +18,7 @@
 #include <deal.II/base/quadrature.h>
 #include <deal.II/base/quadrature_lib.h>
 #include <deal.II/base/memory_consumption.h>
+#include <deal.II/base/std_cxx14/memory.h>
 #include <deal.II/base/tensor_product_polynomials.h>
 #include <deal.II/base/utilities.h>
 #include <deal.II/lac/full_matrix.h>
@@ -77,7 +78,7 @@ MappingQ<dim,spacedim>::MappingQ (const unsigned int degree,
   // created via the shared_ptr objects
   qp_mapping (this->polynomial_degree>1
               ?
-              std::shared_ptr<const MappingQGeneric<dim,spacedim> >(new MappingQGeneric<dim,spacedim>(degree))
+              std::make_shared<const MappingQGeneric<dim,spacedim>>(degree)
               :
               q1_mapping)
 {}
@@ -88,18 +89,27 @@ template <int dim, int spacedim>
 MappingQ<dim,spacedim>::MappingQ (const MappingQ<dim,spacedim> &mapping)
   :
   polynomial_degree (mapping.polynomial_degree),
-  use_mapping_q_on_all_cells (mapping.use_mapping_q_on_all_cells),
-  // clone the Q1 mapping for use on interior cells (if necessary)
-  // or to create a good initial guess in transform_real_to_unit_cell()
-  q1_mapping (dynamic_cast<MappingQGeneric<dim,spacedim>*>(mapping.q1_mapping->clone())),
-  // create a Q_p mapping; if p=1, simply share the Q_1 mapping already
-  // created via the shared_ptr objects
-  qp_mapping (this->polynomial_degree>1
-              ?
-              std::shared_ptr<const MappingQGeneric<dim,spacedim> >(dynamic_cast<MappingQGeneric<dim,spacedim>*>(mapping.qp_mapping->clone()))
-              :
-              q1_mapping)
-{}
+  use_mapping_q_on_all_cells (mapping.use_mapping_q_on_all_cells)
+{
+  // Note that we really do have to use clone() here, since mapping.q1_mapping
+  // may be MappingQ1Eulerian and mapping.qp_mapping may be MappingQEulerian.
+  std::shared_ptr<const Mapping<dim,spacedim>> other_q1_map = mapping.q1_mapping->clone();
+  q1_mapping = std::dynamic_pointer_cast<const MappingQGeneric<dim,spacedim>>(other_q1_map);
+  Assert(q1_mapping != nullptr, ExcInternalError());
+  Assert(q1_mapping->get_degree() == 1, ExcInternalError());
+
+  // Same as the other constructor: if possible reuse the Q1 mapping
+  if (this->polynomial_degree == 1)
+    {
+      qp_mapping = q1_mapping;
+    }
+  else
+    {
+      std::shared_ptr<const Mapping<dim,spacedim>> other_qp_map = mapping.qp_mapping->clone();
+      qp_mapping = std::dynamic_pointer_cast<const MappingQGeneric<dim,spacedim>>(other_qp_map);
+      Assert(qp_mapping != nullptr, ExcInternalError());
+    }
+}
 
 
 
@@ -502,11 +512,11 @@ transform_real_to_unit_cell (const typename Triangulation<dim,spacedim>::cell_it
 
 
 template <int dim, int spacedim>
-Mapping<dim,spacedim> *
+std::unique_ptr<Mapping<dim,spacedim> >
 MappingQ<dim,spacedim>::clone () const
 {
-  return new MappingQ<dim,spacedim>(this->polynomial_degree,
-                                    this->use_mapping_q_on_all_cells);
+  return std_cxx14::make_unique<MappingQ<dim,spacedim>>(this->polynomial_degree,
+                                                        this->use_mapping_q_on_all_cells);
 }
 
 
diff --git a/source/fe/mapping_q1.cc b/source/fe/mapping_q1.cc
index c02161d39e..0261ceb3ca 100644
--- a/source/fe/mapping_q1.cc
+++ b/source/fe/mapping_q1.cc
@@ -20,6 +20,7 @@
 #include <deal.II/base/quadrature_lib.h>
 #include <deal.II/base/tensor_product_polynomials.h>
 #include <deal.II/base/memory_consumption.h>
+#include <deal.II/base/std_cxx14/memory.h>
 #include <deal.II/lac/full_matrix.h>
 #include <deal.II/grid/tria.h>
 #include <deal.II/grid/tria_iterator.h>
@@ -49,10 +50,10 @@ MappingQ1<dim,spacedim>::MappingQ1 ()
 
 
 template <int dim, int spacedim>
-MappingQ1<dim,spacedim> *
+std::unique_ptr<Mapping<dim,spacedim> >
 MappingQ1<dim,spacedim>::clone () const
 {
-  return new MappingQ1<dim,spacedim>(*this);
+  return std_cxx14::make_unique<MappingQ1<dim,spacedim>>(*this);
 }
 
 //---------------------------------------------------------------------------
diff --git a/source/fe/mapping_q1_eulerian.cc b/source/fe/mapping_q1_eulerian.cc
index 4a9f487d52..c2cc75a909 100644
--- a/source/fe/mapping_q1_eulerian.cc
+++ b/source/fe/mapping_q1_eulerian.cc
@@ -13,6 +13,8 @@
 //
 // ---------------------------------------------------------------------
 
+#include <deal.II/base/std_cxx14/memory.h>
+
 #include <deal.II/fe/mapping_q1_eulerian.h>
 #include <deal.II/lac/vector.h>
 #include <deal.II/lac/block_vector.h>
@@ -116,10 +118,10 @@ compute_mapping_support_points(const typename Triangulation<dim,spacedim>::cell_
 
 
 template <int dim, class VectorType, int spacedim>
-MappingQ1Eulerian<dim,VectorType,spacedim> *
+std::unique_ptr<Mapping<dim,spacedim> >
 MappingQ1Eulerian<dim, VectorType, spacedim>::clone () const
 {
-  return new MappingQ1Eulerian<dim,VectorType,spacedim>(*this);
+  return std_cxx14::make_unique<MappingQ1Eulerian<dim,VectorType,spacedim>>(*this);
 }
 
 
diff --git a/source/fe/mapping_q_eulerian.cc b/source/fe/mapping_q_eulerian.cc
index 36732d36d3..f7ccc78f4a 100644
--- a/source/fe/mapping_q_eulerian.cc
+++ b/source/fe/mapping_q_eulerian.cc
@@ -15,6 +15,7 @@
 
 #include <deal.II/base/utilities.h>
 #include <deal.II/base/quadrature_lib.h>
+#include <deal.II/base/std_cxx14/memory.h>
 #include <deal.II/lac/vector.h>
 #include <deal.II/lac/block_vector.h>
 #include <deal.II/lac/la_vector.h>
@@ -79,12 +80,11 @@ MappingQEulerian (const unsigned int              degree,
 
 
 template <int dim, class VectorType, int spacedim>
-Mapping<dim,spacedim> *
+std::unique_ptr<Mapping<dim,spacedim> >
 MappingQEulerian<dim, VectorType, spacedim>::clone () const
 {
-  return new MappingQEulerian<dim,VectorType,spacedim>(this->get_degree(),
-                                                       *euler_dof_handler,
-                                                       *euler_vector);
+  return std_cxx14::make_unique<MappingQEulerian<dim,VectorType,spacedim>>
+         (this->get_degree(), *euler_dof_handler, *euler_vector);
 }
 
 
diff --git a/source/fe/mapping_q_generic.cc b/source/fe/mapping_q_generic.cc
index 9c2647fd0d..f15410062a 100644
--- a/source/fe/mapping_q_generic.cc
+++ b/source/fe/mapping_q_generic.cc
@@ -22,6 +22,7 @@
 #include <deal.II/base/table.h>
 #include <deal.II/base/tensor_product_polynomials.h>
 #include <deal.II/base/memory_consumption.h>
+#include <deal.II/base/std_cxx14/memory.h>
 #include <deal.II/lac/full_matrix.h>
 #include <deal.II/lac/tensor_product_matrix.h>
 #include <deal.II/grid/tria.h>
@@ -2154,10 +2155,10 @@ MappingQGeneric<dim,spacedim>::MappingQGeneric (const MappingQGeneric<dim,spaced
 
 
 template <int dim, int spacedim>
-Mapping<dim,spacedim> *
+std::unique_ptr<Mapping<dim,spacedim> >
 MappingQGeneric<dim,spacedim>::clone () const
 {
-  return new MappingQGeneric<dim,spacedim>(*this);
+  return std_cxx14::make_unique<MappingQGeneric<dim,spacedim>>(*this);
 }
 
 
diff --git a/tests/hp/mapping_collection_03.cc b/tests/hp/mapping_collection_03.cc
index a0a7caba34..09cb1f3afe 100644
--- a/tests/hp/mapping_collection_03.cc
+++ b/tests/hp/mapping_collection_03.cc
@@ -31,9 +31,9 @@ void test ()
 {
   MappingQ<dim> mapping(2);
   deallog << "Cloning..." << std::endl;
-  Mapping<dim> *copy = mapping.clone();
+  std::unique_ptr<Mapping<dim>> copy = mapping.clone();
   deallog << "Deleting clone..." << std::endl;
-  delete copy;
+  copy.reset();
   deallog << "Destroying original..." << std::endl;
 }