]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Augment documentation of FE::get_(sub)face_data. 1822/head
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 2 Nov 2015 07:35:39 +0000 (01:35 -0600)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 2 Nov 2015 07:35:39 +0000 (01:35 -0600)
include/deal.II/fe/fe.h

index c5a990ff67bb69c6e29d8052b4346826e45a7d31..77e14eb77cebc97bfef30eedd19b9e47f042572d 100644 (file)
@@ -2232,7 +2232,7 @@ protected:
 
   /**
    * Prepare internal data structures and fill in values independent of the
-   * cell. Returns a pointer to an object of which the caller of this function
+   * cell. Return a pointer to an object of which the caller of this function
    * then has to assume ownership (which includes destruction when it is no
    * more needed).
    *
@@ -2247,9 +2247,18 @@ protected:
 
   /**
    * Prepare internal data structure for transformation of faces and fill in
-   * values independent of the cell. Returns a pointer to an object of which
+   * values independent of the cell. Return a pointer to an object of which
    * the caller of this function then has to assume ownership (which includes
    * destruction when it is no more needed).
+   *
+   * The default implementation of this function converts the face quadrature
+   * into a cell quadrature with appropriate quadrature point locations,
+   * and with that calls the get_data() function above that has to be
+   * implemented in derived classes.
+   *
+   * An extensive discussion of the interaction between this function and
+   * FEValues can be found in the @ref FE_vs_Mapping_vs_FEValues documentation
+   * module.
    */
   virtual InternalDataBase *
   get_face_data (const UpdateFlags        flags,
@@ -2258,9 +2267,18 @@ protected:
 
   /**
    * Prepare internal data structure for transformation of children of faces
-   * and fill in values independent of the cell. Returns a pointer to an
+   * and fill in values independent of the cell. Return a pointer to an
    * object of which the caller of this function then has to assume ownership
    * (which includes destruction when it is no more needed).
+   *
+   * The default implementation of this function converts the face quadrature
+   * into a cell quadrature with appropriate quadrature point locations,
+   * and with that calls the get_data() function above that has to be
+   * implemented in derived classes.
+   *
+   * An extensive discussion of the interaction between this function and
+   * FEValues can be found in the @ref FE_vs_Mapping_vs_FEValues documentation
+   * module.
    */
   virtual InternalDataBase *
   get_subface_data (const UpdateFlags        flags,

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.