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

matrix-free documentation #12769

Merged
merged 1 commit into from
Sep 20, 2021
Merged

matrix-free documentation #12769

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
16 changes: 9 additions & 7 deletions include/deal.II/matrix_free/matrix_free.h
View file
Open in desktop
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,9 +397,8 @@ 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
* @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