Skip to content

Commit

Permalink
improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
zjiaqi2018 committed Sep 18, 2021
1 parent 4c70ad8 commit 2b646f6
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions include/deal.II/matrix_free/matrix_free.h
Original file line number Diff line number Diff line change
Expand Up @@ -377,10 +377,9 @@ class MatrixFree : public Subscriptor
* determinants (JxW), quadrature points, data for Hessians (derivative of
* Jacobians), and normal vectors.
*
* @note In order to be able to perform a `face_operation` or
* `boundary_operation` in the MatrixFree::loop()`, either this field or
* @p mapping_update_flags_inner_faces must be set to a value different
* from UpdateFlags::update_default.
* @note In order to be able to perform a `boundary_operation` in the
* MatrixFree::loop(), this field must be set to a value different from
* UpdateFlags::update_default.
*/
UpdateFlags mapping_update_flags_boundary_faces;

Expand All @@ -398,10 +397,9 @@ class MatrixFree : public Subscriptor
* determinants (JxW), quadrature points, data for Hessians (derivative of
* Jacobians), and normal vectors.
*
* @note In order to be able to perform a `face_operation` or
* `boundary_operation` in the MatrixFree::loop()`, either this field or
* @p mapping_update_flags_boundary_faces must be set to a value different
* from UpdateFlags::update_default.
* @note In order to be able to perform a `face_operation`
* in the MatrixFree::loop(), this field must be set to a value different from
* UpdateFlags::update_default.
*/
UpdateFlags mapping_update_flags_inner_faces;

Expand Down Expand Up @@ -1668,6 +1666,8 @@ class MatrixFree : public Subscriptor
* in general. The face range in @p loop runs from zero to
* n_inner_face_batches() (exclusive), so this is the appropriate size if
* you want to store arrays of data for all interior faces to be worked on.
* Note that it returns 0 unless mapping_update_flags_inner_faces is set
* to a value different from UpdateFlags::update_default.
*/
unsigned int
n_inner_face_batches() const;
Expand All @@ -1679,6 +1679,8 @@ class MatrixFree : public Subscriptor
* n_inner_face_batches()+n_boundary_face_batches() (exclusive), so if you
* need to store arrays that hold data for all boundary faces but not the
* interior ones, this number gives the appropriate size.
* Note that it returns 0 unless mapping_update_flags_boundary_faces is set
* to a value different from UpdateFlags::update_default.
*/
unsigned int
n_boundary_face_batches() const;
Expand Down

0 comments on commit 2b646f6

Please sign in to comment.