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

FEEvaluation: use EvaluationFlags in documentation #14894

Merged
merged 1 commit into from
Mar 15, 2023
Merged

FEEvaluation: use EvaluationFlags in documentation #14894

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
20 changes: 10 additions & 10 deletions include/deal.II/matrix_free/fe_evaluation.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,7 +474,7 @@ class FEEvaluationBase

/**
* Return the divergence of a vector-valued finite element at quadrature
* point number @p q_point after a call to @p evaluate(...,true,...).
* point number @p q_point after a call to @p evaluate(EvaluationFlags::gradients).
*
* @note Only available for n_components_==dim.
*/
Expand All @@ -484,7 +484,7 @@ class FEEvaluationBase
/**
* Return the symmetric gradient of a vector-valued finite element at
* quadrature point number @p q_point after a call to @p
* evaluate(...,true,...). It corresponds to <tt>0.5
* evaluate(EvaluationFlags::gradients). It corresponds to <tt>0.5
* (grad+grad<sup>T</sup>)</tt>.
*
* @note Only available for n_components_==dim.
Expand All @@ -494,7 +494,7 @@ class FEEvaluationBase

/**
* Return the curl of the vector field, $\nabla \times v$ after a call to @p
* evaluate(...,true,...).
* evaluate(EvaluationFlags::gradients).
*
* @note Only available for n_components_==dim.
*/
Expand All @@ -505,7 +505,7 @@ class FEEvaluationBase
* Write a contribution that is tested by the divergence to the field
* containing the values on quadrature points with component @p q_point.
* Access to the same field as through @p get_gradient. If applied before
* the function @p integrate(...,true) is called, this specifies what is
* the function @p integrate(EvaluationFlags::gradients) is called, this specifies what is
* tested by all basis function gradients on the current cell and integrated
* over.
*
Expand All @@ -524,7 +524,7 @@ class FEEvaluationBase
* Write a contribution that is tested by the symmetric gradient to the field
* containing the values on quadrature points with component @p q_point.
* Access to the same field as through @p get_symmetric_gradient. If applied before
* the function @p integrate(...,true) is called, this specifies the
* the function @p integrate(EvaluationFlags::gradients) is called, this specifies the
* symmetric gradient which is tested by all basis function symmetric
* gradients on the current cell and integrated over.
*
Expand Down Expand Up @@ -1020,23 +1020,23 @@ class FEEvaluationAccess<dim, dim, Number, is_face, VectorizedArrayType>

/**
* Return the divergence of a vector-valued finite element at quadrature
* point number @p q_point after a call to @p evaluate(...,true,...).
* point number @p q_point after a call to @p evaluate(EvaluationFlags::gradients).
*/
VectorizedArrayType
get_divergence(const unsigned int q_point) const;

/**
* Return the symmetric gradient of a vector-valued finite element at
* quadrature point number @p q_point after a call to @p
* evaluate(...,true,...). It corresponds to <tt>0.5
* evaluate(EvaluationFlags::gradients). It corresponds to <tt>0.5
* (grad+grad<sup>T</sup>)</tt>.
*/
SymmetricTensor<2, dim, VectorizedArrayType>
get_symmetric_gradient(const unsigned int q_point) const;

/**
* Return the curl of the vector field, $\nabla \times v$ after a call to @p
* evaluate(...,true,...).
* evaluate(EvaluationFlags::gradients).
*/
Tensor<1, (dim == 2 ? 1 : dim), VectorizedArrayType>
get_curl(const unsigned int q_point) const;
Expand Down Expand Up @@ -1083,7 +1083,7 @@ class FEEvaluationAccess<dim, dim, Number, is_face, VectorizedArrayType>
* Write a contribution that is tested by the divergence to the field
* containing the values on quadrature points with component @p q_point.
* Access to the same field as through @p get_gradient. If applied before
* the function @p integrate(...,true) is called, this specifies what is
* the function @p integrate(EvaluationFlags::gradients) is called, this specifies what is
* tested by all basis function gradients on the current cell and integrated
* over.
*/
Expand All @@ -1095,7 +1095,7 @@ class FEEvaluationAccess<dim, dim, Number, is_face, VectorizedArrayType>
* Write a contribution that is tested by the symmetric gradient to the field
* containing the values on quadrature points with component @p q_point.
* Access to the same field as through @p get_symmetric_gradient. If applied before
* the function @p integrate(...,true) is called, this specifies the
* the function @p integrate(EvaluationFlags::gradients) is called, this specifies the
* symmetric gradient which is tested by all basis function symmetric
* gradients on the current cell and integrated over.
*/
Expand Down