]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update documentation in a couple of places. 12595/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Fri, 23 Jul 2021 18:57:14 +0000 (12:57 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Fri, 23 Jul 2021 18:57:14 +0000 (12:57 -0600)
include/deal.II/fe/fe_interface_values.h

index 8b37ce13a91ab97f6834c7ddd31d7b7fb2508187..afebebc81106134494d5b0d9e1ab52f3c070745d 100644 (file)
@@ -591,11 +591,12 @@ public:
    * the two cells. If an interface DoF is only active on one of the
    * cells, the other index will be numbers::invalid_unsigned_int.
    *
-   * For discontinuous finite elements each interface dof will correspond to
-   * exactly one DoF index.
+   * For discontinuous finite elements, each interface dof is located on exactly
+   * one side of the interface and, consequently, only one of the two values
+   * returned is valid (i.e., different from numbers::invalid_unsigned_int).
    *
-   * @note This function is only available after a call to reinit() and can
-   * change from one call to reinit() to the next.
+   * @note This function is only available after a call to reinit() and the
+   * returned values may change from one call to reinit() to the next.
    */
   std::array<unsigned int, 2>
   interface_dof_to_dof_indices(const unsigned int interface_dof_index) const;
@@ -782,7 +783,7 @@ private:
 
   /**
    * The mapping from interface dof to the two local dof indices of the
-   * FeFaceValues objects. If an interface DoF is only active on one of the
+   * FEFaceValues objects. If an interface DoF is only active on one of the
    * cells, the other one will have numbers::invalid_unsigned_int.
    */
   std::vector<std::array<unsigned int, 2>> dofmap;

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.