]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update documentation in DataOutFaces. 13655/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Thu, 28 Apr 2022 21:33:26 +0000 (15:33 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Thu, 28 Apr 2022 21:33:26 +0000 (15:33 -0600)
include/deal.II/numerics/data_out_faces.h

index 840e3269eb659035085885dc70a8221f62cc4cf1..fb9a4f8a51e1eb04825ffa08f40295cc95b2f351 100644 (file)
@@ -126,8 +126,15 @@ public:
       cell_iterator;
 
   /**
-   * Constructor determining whether a surface mesh (default) or the whole
-   * wire basket is written.
+   * Constructor.
+   *
+   * @param[in] surface_only If `true`, then this class only generates
+   *   output on faces that lie on the boundary of the domain. This
+   *   is typically what this class is used for: To output information
+   *   about the solution, fluxes, and other quantities that live on
+   *   the boundary of the domain. On the other hand, it is sometimes
+   *   useful to also visualize data on internal faces. This is
+   *   facilitated by setting this argument to `false`.
    */
   DataOutFaces(const bool surface_only = true);
 

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.