Merge pull request #14836 from bangerth/concepts

Play with C++20 concepts

cmake/checks/check_01_cxx_features.cmake

@@ -66,6 +66,8 @@ macro(_test_cxx20_support)
   # of the C++20 standard (which will have "202002L" when finalized). gcc-10
   # exports this version number when configured with C++20 support.
   # clang-10 exports the final "202002L" version instead, as does gcc-11.
+  #
+  # Beyond this, check for some features we actually need.
   CHECK_CXX_SOURCE_COMPILES(
     "
     #include <cmath>
@@ -79,6 +81,20 @@ macro(_test_cxx20_support)
     #  error \"insufficient support for C++20\"
     #endif
 
+
+    // Test concepts and requires clauses
+    template <int dim, int spacedim>
+    concept is_valid_dim_spacedim = (dim >= 1 && spacedim <= 3 &&
+                                     dim <= spacedim);
+
+    template <int dim, int spacedim>
+    requires is_valid_dim_spacedim<dim,spacedim>
+    class Triangulation 
+    {};
+
+    Triangulation<1,3> t;
+
+
     int main()
     {
     }

include/deal.II/base/config.h.in

@@ -150,6 +150,18 @@
 #cmakedefine DEAL_II_HAVE_CXX17
 #cmakedefine DEAL_II_HAVE_CXX20
 
+/**
+ * If we have C++20 available, we can have concepts and requires
+ * clauses. We want to avoid using too many `#ifdef` statements, so
+ * define a convenience macro that allows us to write a 'requires'
+ * clause that is simply removed when not using C++20.
+ */
+#ifdef DEAL_II_HAVE_CXX20
+#  define DEAL_II_CXX20_REQUIRES(condition) requires(condition)
+#else
+#  define DEAL_II_CXX20_REQUIRES(condition)
+#endif
+
 #cmakedefine DEAL_II_HAVE_FP_EXCEPTIONS
 #cmakedefine DEAL_II_HAVE_COMPLEX_OPERATOR_OVERLOADS
 #cmakedefine DEAL_II_HAVE_CXX17_BESSEL_FUNCTIONS
@@ -174,9 +186,10 @@
 #cmakedefine DEAL_II_FALLTHROUGH @DEAL_II_FALLTHROUGH@
 #cmakedefine DEAL_II_CONSTEXPR @DEAL_II_CONSTEXPR@
 
-// defined for backwards compatibility with older deal.II versions
+// The following two are defined for backwards compatibility with older deal.II versions:
 #define DEAL_II_WITH_CXX11
 #define DEAL_II_WITH_CXX14
+
 #ifdef DEAL_II_HAVE_CXX17
 #  define DEAL_II_WITH_CXX17
 #endif

include/deal.II/base/point.h

@@ -105,6 +105,7 @@ DEAL_II_NAMESPACE_OPEN
  * @ingroup geomprimitives
  */
 template <int dim, typename Number = double>
+DEAL_II_CXX20_REQUIRES(dim >= 0)
 class Point : public Tensor<1, dim, Number>
 {
 public:

include/deal.II/base/template_constraints.h

@@ -680,6 +680,29 @@ struct EnableIfScalar<std::complex<T>>
 };
 
 
+/**
+ * A namespace that is used to declare concepts used in C++20-style
+ * `requires` clauses.
+ */
+namespace concepts
+{
+#ifdef DEAL_II_HAVE_CXX20
+  /**
+   * A concept that tests that a combination of `dim` and `spacedim`
+   * template arguments is valid. Specifically, we must have that
+   * - `dim>=1`
+   * - `spacedim<=3`
+   * - `dim<=spacedim`.
+   * These are the kinds of requirements that are imposed, for
+   * example, on class Triangulation.
+   */
+  template <int dim, int spacedim>
+  concept is_valid_dim_spacedim = (dim >= 1 && spacedim <= 3 &&
+                                   dim <= spacedim);
+#endif
+} // namespace concepts
+
+
 DEAL_II_NAMESPACE_CLOSE
 
 #endif

include/deal.II/base/tensor.h

@@ -38,8 +38,11 @@ DEAL_II_NAMESPACE_OPEN
 #ifndef DOXYGEN
 template <typename ElementType, typename MemorySpace>
 class ArrayView;
+
 template <int dim, typename Number>
+DEAL_II_CXX20_REQUIRES(dim >= 0)
 class Point;
+
 template <int rank_, int dim, typename Number = double>
 class Tensor;
 template <typename Number>

include/deal.II/base/utilities.h

@@ -48,6 +48,7 @@ DEAL_II_NAMESPACE_OPEN
 // forward declare Point
 #ifndef DOXYGEN
 template <int dim, typename Number>
+DEAL_II_CXX20_REQUIRES(dim >= 0)
 class Point;
 #endif
 

include/deal.II/distributed/p4est_wrappers.h

@@ -47,6 +47,7 @@ namespace parallel
   namespace distributed
   {
     template <int dim, int spacedim>
+    DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
     class Triangulation;
   }
 } // namespace parallel

include/deal.II/dofs/block_info.h

@@ -20,6 +20,7 @@
 
 #include <deal.II/base/memory_consumption.h>
 #include <deal.II/base/subscriptor.h>
+#include <deal.II/base/template_constraints.h>
 
 #include <deal.II/lac/block_indices.h>
 
@@ -30,6 +31,7 @@ DEAL_II_NAMESPACE_OPEN
 // Forward declarations
 #ifndef DOXYGEN
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 #endif
 

include/deal.II/dofs/dof_accessor.h

@@ -739,6 +739,7 @@ class DoFAccessor : public dealii::internal::DoFAccessorImplementation::
   // Make the DoFHandler class a friend so that it can call the set_xxx()
   // functions.
   template <int, int>
+  DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
   friend class DoFHandler;
 
   friend struct dealii::internal::DoFHandlerImplementation::Policy::
@@ -1208,7 +1209,8 @@ class DoFAccessor<0, 1, spacedim, level_dof_access>
 
   // Make the DoFHandler class a friend so that it can call the set_xxx()
   // functions.
-  template <int, int>
+  template <int dim1, int spacedim1>
+  DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim1, spacedim1>))
   friend class DoFHandler;
 
   friend struct dealii::internal::DoFHandlerImplementation::Policy::

include/deal.II/dofs/dof_handler.h

@@ -50,6 +50,7 @@ DEAL_II_NAMESPACE_OPEN
 template <int dim, int spacedim>
 class FiniteElement;
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class Triangulation;
 
 namespace internal
@@ -310,6 +311,7 @@ namespace parallel
  * @ingroup dofs
  */
 template <int dim, int spacedim = dim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler : public Subscriptor
 {
   using ActiveSelector =

include/deal.II/dofs/dof_handler_policy.h

@@ -32,7 +32,8 @@ DEAL_II_NAMESPACE_OPEN
 
 // Forward declaration
 #ifndef DOXYGEN
-template <int, int>
+template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 #endif
 

include/deal.II/dofs/dof_iterator_selector.h

@@ -32,6 +32,7 @@ template <int dim, int spacedim, bool lda>
 class DoFCellAccessor;
 
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 
 template <typename Accessor>

include/deal.II/dofs/dof_objects.h

@@ -20,14 +20,16 @@
 #include <deal.II/base/config.h>
 
 #include <deal.II/base/exceptions.h>
+#include <deal.II/base/template_constraints.h>
 
 #include <vector>
 
 DEAL_II_NAMESPACE_OPEN
 
 // Forward declarations
 #ifndef DOXYGEN
-template <int, int>
+template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 #endif
 

include/deal.II/fe/fe_tools.h

@@ -48,6 +48,7 @@ class Quadrature;
 template <int dim, int spacedim>
 class FiniteElement;
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 template <int dim>
 class FiniteElementData;

include/deal.II/fe/mapping_q_cache.h

@@ -31,7 +31,8 @@ DEAL_II_NAMESPACE_OPEN
 
 // Forward declarations
 #ifndef DOXYGEN
-template <int, int>
+template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 #endif
 

include/deal.II/grid/cell_id.h

@@ -34,7 +34,8 @@ DEAL_II_NAMESPACE_OPEN
 
 // Forward declarations
 #ifndef DOXYGEN
-template <int, int>
+template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class Triangulation;
 #endif
 

include/deal.II/grid/grid_in.h

@@ -31,7 +31,8 @@ DEAL_II_NAMESPACE_OPEN
 
 // Forward declarations
 #ifndef DOXYGEN
-template <int dim, int space_dim>
+template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class Triangulation;
 template <int dim>
 struct CellData;

include/deal.II/grid/grid_out.h

@@ -32,6 +32,7 @@ DEAL_II_NAMESPACE_OPEN
 #ifndef DOXYGEN
 class ParameterHandler;
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class Triangulation;
 template <int dim, int spacedim>
 class Mapping;

include/deal.II/grid/grid_refinement.h

@@ -30,6 +30,7 @@ DEAL_II_NAMESPACE_OPEN
 // forward declarations
 #ifndef DOXYGEN
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class Triangulation;
 template <typename Number>
 class Vector;

include/deal.II/grid/grid_tools.h

@@ -71,7 +71,7 @@ namespace parallel
 {
   namespace distributed
   {
-    template <int, int>
+    template <int dim, int spacedim>
     class Triangulation;
   }
 } // namespace parallel

include/deal.II/grid/tria.h

@@ -1131,6 +1131,7 @@ namespace internal
  * @ingroup grid aniso
  */
 template <int dim, int spacedim = dim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class Triangulation : public Subscriptor
 {
 private:

include/deal.II/grid/tria_accessor.h

@@ -39,6 +39,7 @@ DEAL_II_NAMESPACE_OPEN
 // Forward declarations
 #ifndef DOXYGEN
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class Triangulation;
 template <typename Accessor>
 class TriaRawIterator;
@@ -54,6 +55,7 @@ namespace parallel
 }
 
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 template <int dim, int spacedim, bool lda>
 class DoFCellAccessor;
@@ -1870,6 +1872,7 @@ class TriaAccessor : public TriaAccessorBase<structdim, dim, spacedim>
 
 private:
   template <int, int>
+  DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
   friend class Triangulation;
 
   friend struct dealii::internal::TriangulationImplementation::Implementation;
@@ -4170,6 +4173,7 @@ class CellAccessor : public TriaAccessor<dim, dim, spacedim>
   set_direction_flag(const bool new_direction_flag) const;
 
   template <int, int>
+  DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
   friend class Triangulation;
 
   template <int, int>

include/deal.II/grid/tria_iterator.h

@@ -32,6 +32,7 @@ DEAL_II_NAMESPACE_OPEN
 // Forward declarations
 #ifndef DOXYGEN
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class Triangulation;
 template <int, int, int>
 class TriaAccessorBase;

include/deal.II/grid/tria_objects.h

@@ -29,6 +29,7 @@ DEAL_II_NAMESPACE_OPEN
 // Forward declarations
 #ifndef DOXYGEN
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class Triangulation;
 template <class Accessor>
 class TriaRawIterator;

include/deal.II/hp/refinement.h

@@ -34,6 +34,7 @@ template <typename Number>
 class Vector;
 
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 #endif
 

include/deal.II/multigrid/mg_constrained_dofs.h

@@ -33,6 +33,7 @@ DEAL_II_NAMESPACE_OPEN
 // Forward declaration
 #ifndef DOXYGEN
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 #endif
 

include/deal.II/multigrid/mg_tools.h

@@ -32,6 +32,7 @@ DEAL_II_NAMESPACE_OPEN
 // Forward declarations
 #ifndef DOXYGEN
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 class MGConstrainedDoFs;
 #endif

include/deal.II/multigrid/mg_transfer_block.h

@@ -38,6 +38,7 @@ DEAL_II_NAMESPACE_OPEN
 // Forward declaration
 #ifndef DOXYGEN
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 #endif
 

include/deal.II/multigrid/mg_transfer_component.h

@@ -40,6 +40,7 @@ DEAL_II_NAMESPACE_OPEN
 // Forward declaration
 #ifndef DOXYGEN
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 #endif
 

include/deal.II/numerics/data_out_stack.h

@@ -34,6 +34,7 @@ DEAL_II_NAMESPACE_OPEN
 // Forward declaration
 #ifndef DOXYGEN
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 #endif
 

include/deal.II/numerics/error_estimator.h

@@ -30,7 +30,8 @@ DEAL_II_NAMESPACE_OPEN
 
 // Forward declarations
 #ifndef DOXYGEN
-template <int, int>
+template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 template <int, int>
 class Mapping;

include/deal.II/numerics/matrix_creator.h

@@ -47,6 +47,7 @@ class SparseMatrix;
 template <int dim, int spacedim>
 class Mapping;
 template <int dim, int spacedim>
+DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
 class DoFHandler;
 
 namespace hp