From: Wolfgang Bangerth <bangerth@math.tamu.edu>
Date: Mon, 2 Nov 2015 07:35:39 +0000 (-0600)
Subject: Augment documentation of FE::get_(sub)face_data.
X-Git-Tag: v8.4.0-rc2~262^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F1822%2Fhead;p=dealii.git

Augment documentation of FE::get_(sub)face_data.
---

diff --git a/include/deal.II/fe/fe.h b/include/deal.II/fe/fe.h
index c5a990ff67..77e14eb77c 100644
--- a/include/deal.II/fe/fe.h
+++ b/include/deal.II/fe/fe.h
@@ -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,