Skip to content

Commit

Permalink
Merge pull request #14789 from tjhei/mf_doc_mapping_update_flags
Browse files Browse the repository at this point in the history
document MatrixFree mapping_update_flags
  • Loading branch information
kronbichler committed Feb 12, 2023
2 parents ef7c82f + dd900f7 commit c6083b2
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions include/deal.II/matrix_free/matrix_free.h
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

0 comments on commit c6083b2

Please sign in to comment.