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

document MatrixFree mapping_update_flags #14789

Merged
merged 1 commit into from
Feb 12, 2023
Merged

document MatrixFree mapping_update_flags #14789

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
22 changes: 12 additions & 10 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 @@ -352,15 +352,17 @@ class MatrixFree : public Subscriptor
unsigned int tasks_block_size;

/**
* This flag determines the mapping data on cells that is cached. This
* class can cache data needed for gradient computations (inverse
* Jacobians), Jacobian determinants (JxW), quadrature points as well as
* data for Hessians (derivative of Jacobians). By default, only data for
* gradients and Jacobian determinants times quadrature weights, JxW, are
* cached. If quadrature points or second derivatives are needed, they
* must be specified by this field (even though second derivatives might
* still be evaluated on Cartesian cells without this option set here,
* since there the Jacobian describes the mapping completely).
* This flag determines what data needs to be computed and cached on cells.
*
* If your computations require operations like quadrature point locations
* or Hessians, these need to specified here (update_quadrature_points
* or update_hessians, respectively). Note that values, gradients, and
* Jacobian determinants (JxW values) are always computed regardless of the
* flags specified here.
*
* Note that some additional flags might be set automatically (for example
* second derivatives might be evaluated on Cartesian cells since there
* the Jacobian describes the mapping completely).
*/
UpdateFlags mapping_update_flags;

Expand Down Expand Up @@ -500,7 +502,7 @@ class MatrixFree : public Subscriptor
* being a category) but can also be useful in other contexts where one
* would like to control which cells together can form a batch of cells.
* Such an example is "local time stepping", where cells of different
* caterogries progress with different time-step sizes and, as a
* categories progress with different time-step sizes and, as a
* consequence, can only processed together with cells with the same
* category.
*
Expand Down