Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation in DataOutFaces. #13655

Merged
merged 1 commit into from
Apr 29, 2022
Merged

Update documentation in DataOutFaces. #13655

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 9 additions & 2 deletions include/deal.II/numerics/data_out_faces.h
View file
Open in desktop
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