From d46d02b9cb51338fa89c01ab24b6783c134e1e4f Mon Sep 17 00:00:00 2001
From: Marc Fehling <mafehling.git@gmail.com>
Date: Fri, 20 Nov 2020 19:20:45 -0700
Subject: [PATCH] Deprecated DoFHandlerType in DataOutStack.

---
 .../incompatibilities/20201120Fehling-2       |  4 ++
 include/deal.II/numerics/data_out_stack.h     | 31 +++++++--
 source/numerics/data_out_stack.cc             | 66 ++++++++-----------
 source/numerics/data_out_stack.inst.in        | 34 ++++------
 4 files changed, 70 insertions(+), 65 deletions(-)
 create mode 100644 doc/news/changes/incompatibilities/20201120Fehling-2

diff --git a/doc/news/changes/incompatibilities/20201120Fehling-2 b/doc/news/changes/incompatibilities/20201120Fehling-2
new file mode 100644
index 0000000000..3b31b67b63
--- /dev/null
+++ b/doc/news/changes/incompatibilities/20201120Fehling-2
@@ -0,0 +1,4 @@
+Deprecated: The DoFHandlerType template argument for the DataOutStack
+class has been deprecated. Use DataOutStack<dim, spacedim> instead.
+<br>
+(Marc Fehling, 2020/11/20)
diff --git a/include/deal.II/numerics/data_out_stack.h b/include/deal.II/numerics/data_out_stack.h
index 43436d7a26..d3116d22c8 100644
--- a/include/deal.II/numerics/data_out_stack.h
+++ b/include/deal.II/numerics/data_out_stack.h
@@ -37,6 +37,25 @@ template <int dim, int spacedim>
 class DoFHandler;
 #endif
 
+/**
+ * @deprecated Use DataOutStack<dim, spacedim> instead.
+ */
+template <int dim, int spacedim = dim, typename DoFHandlerType = void>
+class DataOutStack;
+
+#ifndef DOXYGEN
+// prevent doxygen from complaining about potential recursive class relations
+template <int dim, int spacedim, typename DoFHandlerType>
+class DataOutStack : public DataOutStack<dim, spacedim, void>
+{
+public:
+  DEAL_II_DEPRECATED
+  DataOutStack()
+    : DataOutStack<dim, spacedim, void>()
+  {}
+};
+#endif // DOXYGEN
+
 /**
  * This class is used to stack the output from several computations into one
  * output file by stacking the data sets in another co-ordinate direction
@@ -111,10 +130,8 @@ class DoFHandler;
  *
  * @ingroup output
  */
-template <int dim,
-          int spacedim            = dim,
-          typename DoFHandlerType = DoFHandler<dim, spacedim>>
-class DataOutStack : public DataOutInterface<dim + 1>
+template <int dim, int spacedim>
+class DataOutStack<dim, spacedim, void> : public DataOutInterface<dim + 1>
 {
 public:
   /**
@@ -156,7 +173,7 @@ public:
    * value.
    */
   void
-  attach_dof_handler(const DoFHandlerType &dof_handler);
+  attach_dof_handler(const DoFHandler<dim, spacedim> &dof_handler);
 
   /**
    * Declare a data vector. The @p vector_type argument determines whether the
@@ -312,8 +329,8 @@ private:
    * DoF handler to be used for the data corresponding to the present
    * parameter value.
    */
-  SmartPointer<const DoFHandlerType,
-               DataOutStack<dim, spacedim, DoFHandlerType>>
+  SmartPointer<const DoFHandler<dim, spacedim>,
+               DataOutStack<dim, spacedim, void>>
     dof_handler;
 
   /**
diff --git a/source/numerics/data_out_stack.cc b/source/numerics/data_out_stack.cc
index 68389f23eb..c2daf74cac 100644
--- a/source/numerics/data_out_stack.cc
+++ b/source/numerics/data_out_stack.cc
@@ -37,10 +37,9 @@
 DEAL_II_NAMESPACE_OPEN
 
 
-template <int dim, int spacedim, typename DoFHandlerType>
+template <int dim, int spacedim>
 std::size_t
-DataOutStack<dim, spacedim, DoFHandlerType>::DataVector::memory_consumption()
-  const
+DataOutStack<dim, spacedim, void>::DataVector::memory_consumption() const
 {
   return (MemoryConsumption::memory_consumption(data) +
           MemoryConsumption::memory_consumption(names));
@@ -48,11 +47,10 @@ DataOutStack<dim, spacedim, DoFHandlerType>::DataVector::memory_consumption()
 
 
 
-template <int dim, int spacedim, typename DoFHandlerType>
+template <int dim, int spacedim>
 void
-DataOutStack<dim, spacedim, DoFHandlerType>::new_parameter_value(
-  const double p,
-  const double dp)
+DataOutStack<dim, spacedim, void>::new_parameter_value(const double p,
+                                                       const double dp)
 {
   parameter      = p;
   parameter_step = dp;
@@ -72,23 +70,18 @@ DataOutStack<dim, spacedim, DoFHandlerType>::new_parameter_value(
 }
 
 
-template <int dim, int spacedim, typename DoFHandlerType>
+template <int dim, int spacedim>
 void
-DataOutStack<dim, spacedim, DoFHandlerType>::attach_dof_handler(
-  const DoFHandlerType &dof)
+DataOutStack<dim, spacedim, void>::attach_dof_handler(
+  const DoFHandler<dim, spacedim> &dof)
 {
-  // Check consistency of redundant
-  // template parameter
-  Assert(dim == DoFHandlerType::dimension,
-         ExcDimensionMismatch(dim, DoFHandlerType::dimension));
-
   dof_handler = &dof;
 }
 
 
-template <int dim, int spacedim, typename DoFHandlerType>
+template <int dim, int spacedim>
 void
-DataOutStack<dim, spacedim, DoFHandlerType>::declare_data_vector(
+DataOutStack<dim, spacedim, void>::declare_data_vector(
   const std::string &name,
   const VectorType   vector_type)
 {
@@ -98,9 +91,9 @@ DataOutStack<dim, spacedim, DoFHandlerType>::declare_data_vector(
 }
 
 
-template <int dim, int spacedim, typename DoFHandlerType>
+template <int dim, int spacedim>
 void
-DataOutStack<dim, spacedim, DoFHandlerType>::declare_data_vector(
+DataOutStack<dim, spacedim, void>::declare_data_vector(
   const std::vector<std::string> &names,
   const VectorType                vector_type)
 {
@@ -140,12 +133,11 @@ DataOutStack<dim, spacedim, DoFHandlerType>::declare_data_vector(
 }
 
 
-template <int dim, int spacedim, typename DoFHandlerType>
+template <int dim, int spacedim>
 template <typename number>
 void
-DataOutStack<dim, spacedim, DoFHandlerType>::add_data_vector(
-  const Vector<number> &vec,
-  const std::string &   name)
+DataOutStack<dim, spacedim, void>::add_data_vector(const Vector<number> &vec,
+                                                   const std::string &   name)
 {
   const unsigned int n_components = dof_handler->get_fe(0).n_components();
 
@@ -175,10 +167,10 @@ DataOutStack<dim, spacedim, DoFHandlerType>::add_data_vector(
 }
 
 
-template <int dim, int spacedim, typename DoFHandlerType>
+template <int dim, int spacedim>
 template <typename number>
 void
-DataOutStack<dim, spacedim, DoFHandlerType>::add_data_vector(
+DataOutStack<dim, spacedim, void>::add_data_vector(
   const Vector<number> &          vec,
   const std::vector<std::string> &names)
 {
@@ -250,9 +242,9 @@ DataOutStack<dim, spacedim, DoFHandlerType>::add_data_vector(
 }
 
 
-template <int dim, int spacedim, typename DoFHandlerType>
+template <int dim, int spacedim>
 void
-DataOutStack<dim, spacedim, DoFHandlerType>::build_patches(
+DataOutStack<dim, spacedim, void>::build_patches(
   const unsigned int nnnn_subdivisions)
 {
   // this is mostly copied from the
@@ -276,7 +268,7 @@ DataOutStack<dim, spacedim, DoFHandlerType>::build_patches(
   // create patches of and make sure
   // there is enough memory for that
   unsigned int n_patches = 0;
-  for (typename DoFHandlerType::active_cell_iterator cell =
+  for (typename DoFHandler<dim, spacedim>::active_cell_iterator cell =
          dof_handler->begin_active();
        cell != dof_handler->end();
        ++cell)
@@ -326,7 +318,7 @@ DataOutStack<dim, spacedim, DoFHandlerType>::build_patches(
   typename std::vector<dealii::DataOutBase::Patch<dim + 1, dim + 1>>::iterator
                patch       = patches.begin() + (patches.size() - n_patches);
   unsigned int cell_number = 0;
-  for (typename DoFHandlerType::active_cell_iterator cell =
+  for (typename DoFHandler<dim, spacedim>::active_cell_iterator cell =
          dof_handler->begin_active();
        cell != dof_handler->end();
        ++cell, ++patch, ++cell_number)
@@ -436,9 +428,9 @@ DataOutStack<dim, spacedim, DoFHandlerType>::build_patches(
 }
 
 
-template <int dim, int spacedim, typename DoFHandlerType>
+template <int dim, int spacedim>
 void
-DataOutStack<dim, spacedim, DoFHandlerType>::finish_parameter_value()
+DataOutStack<dim, spacedim, void>::finish_parameter_value()
 {
   // release lock on dof handler
   dof_handler = nullptr;
@@ -455,9 +447,9 @@ DataOutStack<dim, spacedim, DoFHandlerType>::finish_parameter_value()
 
 
 
-template <int dim, int spacedim, typename DoFHandlerType>
+template <int dim, int spacedim>
 std::size_t
-DataOutStack<dim, spacedim, DoFHandlerType>::memory_consumption() const
+DataOutStack<dim, spacedim, void>::memory_consumption() const
 {
   return (DataOutInterface<dim + 1>::memory_consumption() +
           MemoryConsumption::memory_consumption(parameter) +
@@ -470,18 +462,18 @@ DataOutStack<dim, spacedim, DoFHandlerType>::memory_consumption() const
 
 
 
-template <int dim, int spacedim, typename DoFHandlerType>
+template <int dim, int spacedim>
 const std::vector<dealii::DataOutBase::Patch<dim + 1, dim + 1>> &
-DataOutStack<dim, spacedim, DoFHandlerType>::get_patches() const
+DataOutStack<dim, spacedim, void>::get_patches() const
 {
   return patches;
 }
 
 
 
-template <int dim, int spacedim, typename DoFHandlerType>
+template <int dim, int spacedim>
 std::vector<std::string>
-DataOutStack<dim, spacedim, DoFHandlerType>::get_dataset_names() const
+DataOutStack<dim, spacedim, void>::get_dataset_names() const
 {
   std::vector<std::string> names;
   for (typename std::vector<DataVector>::const_iterator dataset =
diff --git a/source/numerics/data_out_stack.inst.in b/source/numerics/data_out_stack.inst.in
index 5308b22405..12e6ff0f67 100644
--- a/source/numerics/data_out_stack.inst.in
+++ b/source/numerics/data_out_stack.inst.in
@@ -17,28 +17,20 @@
 for (deal_II_dimension : DIMENSIONS)
   {
 #if deal_II_dimension < 3
-    template class DataOutStack<deal_II_dimension,
-                                deal_II_dimension,
-                                DoFHandler<deal_II_dimension>>;
+    template class DataOutStack<deal_II_dimension, deal_II_dimension>;
 
-    template void DataOutStack<deal_II_dimension,
-                               deal_II_dimension,
-                               DoFHandler<deal_II_dimension>>::
-      add_data_vector<double>(const Vector<double> &, const std::string &);
-    template void DataOutStack<deal_II_dimension,
-                               deal_II_dimension,
-                               DoFHandler<deal_II_dimension>>::
-      add_data_vector<float>(const Vector<float> &, const std::string &);
+    template void
+    DataOutStack<deal_II_dimension, deal_II_dimension>::add_data_vector<double>(
+      const Vector<double> &, const std::string &);
+    template void
+    DataOutStack<deal_II_dimension, deal_II_dimension>::add_data_vector<float>(
+      const Vector<float> &, const std::string &);
 
-    template void DataOutStack<deal_II_dimension,
-                               deal_II_dimension,
-                               DoFHandler<deal_II_dimension>>::
-      add_data_vector<double>(const Vector<double> &,
-                              const std::vector<std::string> &);
-    template void DataOutStack<deal_II_dimension,
-                               deal_II_dimension,
-                               DoFHandler<deal_II_dimension>>::
-      add_data_vector<float>(const Vector<float> &,
-                             const std::vector<std::string> &);
+    template void
+    DataOutStack<deal_II_dimension, deal_II_dimension>::add_data_vector<double>(
+      const Vector<double> &, const std::vector<std::string> &);
+    template void
+    DataOutStack<deal_II_dimension, deal_II_dimension>::add_data_vector<float>(
+      const Vector<float> &, const std::vector<std::string> &);
 #endif
   }
-- 
2.39.5