From 8ffdd6e6ae99f296185dbc62dd42c2e89267c76c Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Thu, 28 Apr 2022 15:33:26 -0600 Subject: [PATCH] Update documentation in DataOutFaces. --- include/deal.II/numerics/data_out_faces.h | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/include/deal.II/numerics/data_out_faces.h b/include/deal.II/numerics/data_out_faces.h index 840e3269eb..fb9a4f8a51 100644 --- a/include/deal.II/numerics/data_out_faces.h +++ b/include/deal.II/numerics/data_out_faces.h @@ -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); -- 2.39.5