]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Deprecate AffineConstraints functions taking only one index set.
authorWolfgang Bangerth <bangerth@colostate.edu>
Fri, 22 Sep 2023 15:11:04 +0000 (09:11 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Mon, 25 Sep 2023 23:06:47 +0000 (17:06 -0600)
include/deal.II/lac/affine_constraints.h

index 8691247e289eabe83a7540268e3cf187d3013070..04d24c5a473a381b026260fb5cca3284519f9d5e 100644 (file)
@@ -583,10 +583,11 @@ public:
    * which is clearly wasteful and not efficient -- and should be considered
    * a bug.
    *
-   * @note This constructor is equivalent to calling the following one with
+   * @deprecated This constructor is equivalent to calling the following one with
    *   both of its arguments equal to the index set provided here. This
    *   is not wrong, but inefficient. Use the following constructor instead.
    */
+  DEAL_II_DEPRECATED_EARLY
   explicit AffineConstraints(const IndexSet &locally_stored_constraints);
 
   /**
@@ -679,7 +680,10 @@ public:
    * for which degrees of freedom this object can store constraints. See
    * the discussion in the documentation of the constructor of this class
    * that takes a single index set as argument.
+   *
+   * @deprecated Use the reinit() function with two index set arguments instead.
    */
+  DEAL_II_DEPRECATED_EARLY
   void
   reinit(const IndexSet &locally_stored_constraints);
 
@@ -698,8 +702,10 @@ public:
   /**
    * Determines if we can store a constraint for the given @p line_n. This
    * routine only matters in the distributed case and checks if the IndexSet
-   * allows storage of this line. Always returns true if not in the
-   * distributed case.
+   * provided to the constructor or reinit() function that determines
+   * which constraints to store, allows storage of the line provides
+   * as argument to this function. As a consequence, it will always return
+   * true if not in the distributed case.
    */
   bool
   can_store_line(const size_type line_n) const;
@@ -2138,6 +2144,15 @@ inline AffineConstraints<number>::AffineConstraints()
 
 
 
+template <typename number>
+inline AffineConstraints<number>::AffineConstraints(
+  const IndexSet &locally_stored_constraints)
+  : AffineConstraints<number>(locally_stored_constraints,
+                              locally_stored_constraints)
+{}
+
+
+
 template <typename number>
 inline AffineConstraints<number>::AffineConstraints(
   const IndexSet &locally_owned_dofs,
@@ -2159,15 +2174,6 @@ inline AffineConstraints<number>::AffineConstraints(
 
 
 
-template <typename number>
-inline AffineConstraints<number>::AffineConstraints(
-  const IndexSet &locally_stored_constraints)
-  : AffineConstraints<number>(locally_stored_constraints,
-                              locally_stored_constraints)
-{}
-
-
-
 template <typename number>
 inline AffineConstraints<number>::AffineConstraints(
   const AffineConstraints &affine_constraints)

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.