Skip to content

Commit

Permalink
Merge pull request #13655 from bangerth/doc-77
Browse files Browse the repository at this point in the history
Update documentation in DataOutFaces.
  • Loading branch information
kronbichler committed Apr 29, 2022
2 parents f875ac3 + 8ffdd6e commit b1b07ce
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions include/deal.II/numerics/data_out_faces.h
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,15 @@ class DataOutFaces : public DataOut_DoFData<dim, dim - 1, spacedim, spacedim>
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);

Expand Down

0 comments on commit b1b07ce

Please sign in to comment.