]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add a note to two .h files about the design pattern used there. 9413/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Tue, 21 Jan 2020 23:44:36 +0000 (16:44 -0700)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 22 Jan 2020 07:29:05 +0000 (00:29 -0700)
include/deal.II/fe/fe_values.h
include/deal.II/numerics/data_out_dof_data.h

index b207d8086333ec5057a27c51a3de29d0e4728f19..7d377fdc182840631c486573609b392fc8aa5fd0 100644 (file)
@@ -3307,7 +3307,7 @@ public:
 
 protected:
   /**
-   * Objects of the FEValues class need to store a pointer (i.e. an iterator)
+   * Objects of the FEValues class need to store an iterator
    * to the present cell in order to be able to extract the values of the
    * degrees of freedom on this cell in the get_function_values() and assorted
    * functions. On the other hand, this class should also work for different
@@ -3332,6 +3332,10 @@ protected:
    * This way, the use of virtual functions is restricted to only this class,
    * and other users of iterators do not have to bear the negative effects.
    *
+   * @note This class is an example of the
+   * <a href="https://www.artima.com/cppsource/type_erasure.html">type
+   * erasure</a> design pattern.
+   *
    * @author Wolfgang Bangerth, 2003
    */
   class CellIteratorBase;
index a8c3cc8fc58901b95734ce1c50e5a07e7e43cefe..44a5686709166a5af9c3dfbd765f395d214e5099 100644 (file)
@@ -211,6 +211,10 @@ namespace internal
      * Since the vectors all have the same interface, this is no big problem,
      * as they can all use the same general templatized code.
      *
+     * @note This class is an example of the
+     * <a href="https://www.artima.com/cppsource/type_erasure.html">type
+     * erasure</a> design pattern.
+     *
      * @author Wolfgang Bangerth, 2004
      */
     template <typename DoFHandlerType>

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.