Reference documentation for deal.II version 9.5.0
|
#include <deal.II/matrix_free/fe_point_evaluation.h>
Public Types | |
using | number_type = Number |
using | ScalarNumber = typename internal::VectorizedArrayTrait< Number >::value_type |
using | VectorizedArrayType = typename ::internal::VectorizedArrayTrait< Number >::vectorized_value_type |
using | ETT = typename internal::FEPointEvaluation::EvaluatorTypeTraits< dim, n_components, Number > |
using | value_type = typename ETT::value_type |
using | scalar_value_type = typename ETT::scalar_value_type |
using | vectorized_value_type = typename ETT::vectorized_value_type |
using | gradient_type = typename ETT::gradient_type |
using | interface_vectorized_gradient_type = typename ETT::interface_vectorized_gradient_type |
Public Member Functions | |
FEPointEvaluation (const Mapping< dim > &mapping, const FiniteElement< dim > &fe, const UpdateFlags update_flags, const unsigned int first_selected_component=0) | |
FEPointEvaluation (NonMatching::MappingInfo< dim, spacedim, Number > &mapping_info, const FiniteElement< dim > &fe, const unsigned int first_selected_component=0) | |
FEPointEvaluation (FEPointEvaluation &other) noexcept | |
FEPointEvaluation (FEPointEvaluation &&other) noexcept | |
~FEPointEvaluation () | |
void | reinit (const typename Triangulation< dim, spacedim >::cell_iterator &cell, const ArrayView< const Point< dim > > &unit_points) |
void | reinit () |
void | reinit (const unsigned int cell_index) |
void | reinit (const unsigned int cell_index, const unsigned int face_number) |
void | evaluate (const ArrayView< const ScalarNumber > &solution_values, const EvaluationFlags::EvaluationFlags &evaluation_flags) |
void | integrate (const ArrayView< ScalarNumber > &solution_values, const EvaluationFlags::EvaluationFlags &integration_flags) |
void | test_and_sum (const ArrayView< ScalarNumber > &solution_values, const EvaluationFlags::EvaluationFlags &integration_flags) |
const value_type & | get_value (const unsigned int point_index) const |
void | submit_value (const value_type &value, const unsigned int point_index) |
const gradient_type & | get_gradient (const unsigned int point_index) const |
const gradient_type & | get_unit_gradient (const unsigned int point_index) const |
void | submit_gradient (const gradient_type &, const unsigned int point_index) |
DerivativeForm< 1, dim, spacedim, Number > | jacobian (const unsigned int point_index) const |
DerivativeForm< 1, spacedim, dim, Number > | inverse_jacobian (const unsigned int point_index) const |
Number | JxW (const unsigned int point_index) const |
Tensor< 1, spacedim, Number > | normal_vector (const unsigned int point_index) const |
Point< spacedim, Number > | real_point (const unsigned int point_index) const |
Point< dim, Number > | unit_point (const unsigned int point_index) const |
std_cxx20::ranges::iota_view< unsigned int, unsigned int > | quadrature_point_indices () const |
Static Public Attributes | |
static constexpr unsigned int | dimension = dim |
static constexpr unsigned int | n_components = n_components_ |
Private Member Functions | |
void | setup (const unsigned int first_selected_component) |
void | do_reinit () |
void | prepare_evaluate_fast (const ArrayView< const ScalarNumber > &solution_values, const EvaluationFlags::EvaluationFlags &evaluation_flags) |
void | compute_evaluate_fast (const EvaluationFlags::EvaluationFlags &evaluation_flags, const unsigned int n_shapes, const unsigned int qb, vectorized_value_type &value, interface_vectorized_gradient_type &gradient) |
void | evaluate_fast (const ArrayView< const ScalarNumber > &solution_values, const EvaluationFlags::EvaluationFlags &evaluation_flags) |
void | evaluate_slow (const ArrayView< const ScalarNumber > &solution_values, const EvaluationFlags::EvaluationFlags &evaluation_flags) |
void | compute_integrate_fast (const EvaluationFlags::EvaluationFlags &integration_flags, const unsigned int n_shapes, const unsigned int qb, const vectorized_value_type &value, const interface_vectorized_gradient_type &gradient) |
void | finish_integrate_fast (const ArrayView< ScalarNumber > &solution_values, const EvaluationFlags::EvaluationFlags &integration_flags) |
template<bool do_JxW> | |
void | integrate_fast (const ArrayView< ScalarNumber > &solution_values, const EvaluationFlags::EvaluationFlags &integration_flags) |
template<bool do_JxW> | |
void | integrate_slow (const ArrayView< ScalarNumber > &solution_values, const EvaluationFlags::EvaluationFlags &integration_flags) |
template<bool do_JxW> | |
void | do_integrate (const ArrayView< ScalarNumber > &solution_values, const EvaluationFlags::EvaluationFlags &integration_flags) |
Static Private Attributes | |
static constexpr std::size_t | n_lanes_user_interface |
static constexpr std::size_t | n_lanes_internal |
static constexpr std::size_t | stride |
This class provides an interface to the evaluation of interpolated solution values and gradients on cells on arbitrary reference point positions. These points can change from cell to cell, both with respect to their quantity as well to the location. The two typical use cases are evaluations on non-matching grids and particle simulations.
The use of this class is similar to FEValues or FEEvaluation: The class is first initialized to a cell by calling FEPointEvaluation::reinit(cell,
unit_points)
, with the main difference to the other concepts that the underlying points in reference coordinates need to be passed along. Then, upon call to evaluate() or integrate(), the user can compute information at the give points. Eventually, the access functions get_value() or get_gradient() allow to query this information at a specific point index.
The functionality is similar to creating an FEValues object with a Quadrature object on the unit_points
on every cell separately and then calling FEValues::get_function_values or FEValues::get_function_gradients, and for some elements and mappings this is what actually happens internally. For specific combinations of Mapping and FiniteElement realizations, however, there is a much more efficient implementation that avoids the memory allocation and other expensive start-up cost of FEValues. Currently, the functionality is specialized for mappings derived from MappingQ and MappingCartesian and for finite elements with tensor product structure that work with the Matrix-free infrastructure module. In those cases, the cost implied by this class is similar (or sometimes even somewhat lower) than using FEValues::reinit(cell)
followed by FEValues::get_function_gradients
.
Definition at line 721 of file fe_point_evaluation.h.
using FEPointEvaluation< n_components_, dim, spacedim, Number >::number_type = Number |
Definition at line 727 of file fe_point_evaluation.h.
using FEPointEvaluation< n_components_, dim, spacedim, Number >::ScalarNumber = typename internal::VectorizedArrayTrait<Number>::value_type |
Definition at line 729 of file fe_point_evaluation.h.
using FEPointEvaluation< n_components_, dim, spacedim, Number >::VectorizedArrayType = typename ::internal::VectorizedArrayTrait< Number>::vectorized_value_type |
Definition at line 731 of file fe_point_evaluation.h.
using FEPointEvaluation< n_components_, dim, spacedim, Number >::ETT = typename internal::FEPointEvaluation:: EvaluatorTypeTraits<dim, n_components, Number> |
Definition at line 733 of file fe_point_evaluation.h.
using FEPointEvaluation< n_components_, dim, spacedim, Number >::value_type = typename ETT::value_type |
Definition at line 735 of file fe_point_evaluation.h.
using FEPointEvaluation< n_components_, dim, spacedim, Number >::scalar_value_type = typename ETT::scalar_value_type |
Definition at line 736 of file fe_point_evaluation.h.
using FEPointEvaluation< n_components_, dim, spacedim, Number >::vectorized_value_type = typename ETT::vectorized_value_type |
Definition at line 737 of file fe_point_evaluation.h.
using FEPointEvaluation< n_components_, dim, spacedim, Number >::gradient_type = typename ETT::gradient_type |
Definition at line 738 of file fe_point_evaluation.h.
using FEPointEvaluation< n_components_, dim, spacedim, Number >::interface_vectorized_gradient_type = typename ETT::interface_vectorized_gradient_type |
Definition at line 739 of file fe_point_evaluation.h.
FEPointEvaluation< n_components_, dim, spacedim, Number >::FEPointEvaluation | ( | const Mapping< dim > & | mapping, |
const FiniteElement< dim > & | fe, | ||
const UpdateFlags | update_flags, | ||
const unsigned int | first_selected_component = 0 |
||
) |
Constructor.
mapping | The Mapping class describing the actual geometry of a cell passed to the evaluate() function. |
fe | The FiniteElement object that is used for the evaluation, which is typically the same on all cells to be evaluated. |
update_flags | Specify the quantities to be computed by the mapping during the call of reinit(). During evaluate() or integrate(), this data is queried to produce the desired result (e.g., the gradient of a finite element solution). |
first_selected_component | For multi-component FiniteElement objects, this parameter allows to select a range of n_components components starting from this parameter. |
Definition at line 1338 of file fe_point_evaluation.h.
FEPointEvaluation< n_components_, dim, spacedim, Number >::FEPointEvaluation | ( | NonMatching::MappingInfo< dim, spacedim, Number > & | mapping_info, |
const FiniteElement< dim > & | fe, | ||
const unsigned int | first_selected_component = 0 |
||
) |
Constructor to make the present class able to re-use the geometry data also used by other FEPointEvaluation
objects.
mapping_info | The MappingInfo class describes the geometry-related data for evaluating finite-element solutions. This object enables to construct such an object on the outside, possibly re-using it between several objects or between several calls to the same cell and unit points. |
fe | The FiniteElement object that is used for the evaluation, which is typically the same on all cells to be evaluated. |
first_selected_component | For multi-component FiniteElement objects, this parameter allows to select a range of n_components components starting from this parameter. |
Definition at line 1365 of file fe_point_evaluation.h.
|
noexcept |
Copy constructor.
Definition at line 1389 of file fe_point_evaluation.h.
|
noexcept |
Move constructor.
Definition at line 1431 of file fe_point_evaluation.h.
FEPointEvaluation< n_components_, dim, spacedim, Number >::~FEPointEvaluation |
Destructor.
Definition at line 1468 of file fe_point_evaluation.h.
void FEPointEvaluation< n_components_, dim, spacedim, Number >::reinit | ( | const typename Triangulation< dim, spacedim >::cell_iterator & | cell, |
const ArrayView< const Point< dim > > & | unit_points | ||
) |
Set up the mapping information for the given cell, e.g., by computing the Jacobian of the mapping for the given points if gradients of the functions are requested.
[in] | cell | An iterator to the current cell |
[in] | unit_points | List of points in the reference locations of the current cell where the FiniteElement object should be evaluated/integrated in the evaluate() and integrate() functions. |
Definition at line 1560 of file fe_point_evaluation.h.
void FEPointEvaluation< n_components_, dim, spacedim, Number >::reinit |
Reinitialize the evaluator to point to the correct precomputed mapping of the single cell in the MappingInfo object.
Definition at line 1587 of file fe_point_evaluation.h.
void FEPointEvaluation< n_components_, dim, spacedim, Number >::reinit | ( | const unsigned int | cell_index | ) |
Reinitialize the evaluator to point to the correct precomputed mapping of the cell in the MappingInfo object.
Definition at line 1599 of file fe_point_evaluation.h.
void FEPointEvaluation< n_components_, dim, spacedim, Number >::reinit | ( | const unsigned int | cell_index, |
const unsigned int | face_number | ||
) |
Reinitialize the evaluator to point to the correct precomputed mapping of the face in the MappingInfo object.
Definition at line 1612 of file fe_point_evaluation.h.
void FEPointEvaluation< n_components_, dim, spacedim, Number >::evaluate | ( | const ArrayView< const ScalarNumber > & | solution_values, |
const EvaluationFlags::EvaluationFlags & | evaluation_flags | ||
) |
This function interpolates the finite element solution, represented by solution_values
, on the cell and unit_points
passed to reinit().
[in] | solution_values | This array is supposed to contain the unknown values on the element as returned by cell->get_dof_values(global_vector,
solution_values) . |
[in] | evaluation_flags | Flags specifying which quantities should be evaluated at the points. |
Definition at line 2054 of file fe_point_evaluation.h.
void FEPointEvaluation< n_components_, dim, spacedim, Number >::integrate | ( | const ArrayView< ScalarNumber > & | solution_values, |
const EvaluationFlags::EvaluationFlags & | integration_flags | ||
) |
This function multiplies the quantities passed in by previous submit_value() or submit_gradient() calls by the value or gradient of the test functions, and performs summation over all given points multiplied be the Jacobian determinant times the quadrature weight (JxW).
[out] | solution_values | This array will contain the result of the integral, which can be used to during cell->set_dof_values(solution_values, global_vector) or cell->distribute_local_to_global(solution_values, global_vector) . Note that for multi-component systems where only some of the components are selected by the present class, the entries in solution_values not touched by this class will be set to zero. |
[in] | integration_flags | Flags specifying which quantities should be integrated at the points. |
Definition at line 2465 of file fe_point_evaluation.h.
void FEPointEvaluation< n_components_, dim, spacedim, Number >::test_and_sum | ( | const ArrayView< ScalarNumber > & | solution_values, |
const EvaluationFlags::EvaluationFlags & | integration_flags | ||
) |
This function multiplies the quantities passed in by previous submit_value() or submit_gradient() calls by the value or gradient of the test functions, and performs summation over all given points. This is similar to the integration of a bilinear form in terms of the test function, with the difference that this formula does not include a JxW
factor (in contrast to the integrate function of this class). This allows the class to naturally embed point information (e.g. particles) into a finite element formulation.
[out] | solution_values | This array will contain the result of the integral, which can be used to during cell->set_dof_values(solution_values, global_vector) or cell->distribute_local_to_global(solution_values, global_vector) . Note that for multi-component systems where only some of the components are selected by the present class, the entries in solution_values not touched by this class will be set to zero. |
[in] | integration_flags | Flags specifying which quantities should be integrated at the points. |
Definition at line 2476 of file fe_point_evaluation.h.
|
inline |
Return the value at quadrature point number point_index
after a call to FEPointEvaluation::evaluate() with EvaluationFlags::values set, or the value that has been stored there with a call to FEPointEvaluation::submit_value(). If the object is vector-valued, a vector-valued return argument is given.
Definition at line 2488 of file fe_point_evaluation.h.
|
inline |
Write a value to the field containing the values on points with component point_index. Access to the same field as through get_value(). If applied before the function FEPointEvaluation::integrate() with EvaluationFlags::values set is called, this specifies the value which is tested by all basis function on the current cell and integrated over.
Definition at line 2527 of file fe_point_evaluation.h.
|
inline |
Return the gradient in real coordinates at the point with index point_index
after a call to FEPointEvaluation::evaluate() with EvaluationFlags::gradients set, or the gradient that has been stored there with a call to FEPointEvaluation::submit_gradient(). The gradient in real coordinates is obtained by taking the unit gradient (also accessible via get_unit_gradient()) and applying the inverse Jacobian of the mapping. If the object is vector-valued, a vector-valued return argument is given.
Definition at line 2500 of file fe_point_evaluation.h.
|
inline |
Return the gradient in unit coordinates at the point with index point_index
after a call to FEPointEvaluation::evaluate() with EvaluationFlags::gradients set, or the gradient that has been stored there with a call to FEPointEvaluation::submit_gradient(). If the object is vector-valued, a vector-valued return argument is given. Note that when vectorization is enabled, values from several points are grouped together.
Definition at line 2512 of file fe_point_evaluation.h.
|
inline |
Write a contribution that is tested by the gradient to the field containing the values on points with the given point_index
. Access to the same field as through get_gradient(). If applied before the function FEPointEvaluation::integrate(EvaluationFlags::gradients) is called, this specifies what is tested by all basis function gradients on the current cell and integrated over.
Definition at line 2539 of file fe_point_evaluation.h.
|
inline |
Return the Jacobian of the transformation on the current cell with the given point index. Prerequisite: This class needs to be constructed with UpdateFlags containing update_jacobian
.
Definition at line 2551 of file fe_point_evaluation.h.
|
inline |
Return the inverse of the Jacobian of the transformation on the current cell with the given point index. Prerequisite: This class needs to be constructed with UpdateFlags containing update_inverse_jacobian
or update_gradients
.
Definition at line 2566 of file fe_point_evaluation.h.
|
inline |
Return the Jacobian determinant multiplied by the quadrature weight. This class or the MappingInfo object passed to this function needs to be constructed with UpdateFlags containing update_JxW_values
.
Definition at line 2581 of file fe_point_evaluation.h.
|
inline |
Return the normal vector. This class or the MappingInfo object passed to this function needs to be constructed with UpdateFlags containing update_normal_vectors
.
Definition at line 2596 of file fe_point_evaluation.h.
|
inline |
Return the position in real coordinates of the given point index among the points passed to reinit().
Definition at line 2611 of file fe_point_evaluation.h.
|
inline |
Return the position in unit/reference coordinates of the given point index, i.e., the respective point passed to the reinit() function.
Definition at line 2626 of file fe_point_evaluation.h.
|
inline |
Return an object that can be thought of as an array containing all indices from zero to n_quadrature_points. This allows to write code using range-based for loops.
Definition at line 2642 of file fe_point_evaluation.h.
|
private |
Common setup function for both constructors. Does the setup for both fast and slow path.
first_selected_component | For multi-component FiniteElement objects, this parameter allows to select a range of n_components components starting from this parameter. |
Definition at line 1477 of file fe_point_evaluation.h.
|
inlineprivate |
Shared functionality of all reinit()
functions. Resizes data fields and precomputes the shapes
vector, holding the evaluation of 1D basis functions of tensor product polynomials, if necessary.
Definition at line 1626 of file fe_point_evaluation.h.
|
inlineprivate |
Resizes necessary data fields, reads in and renumbers solution values. Interpolates onto face if face path is selected.
Definition at line 1717 of file fe_point_evaluation.h.
|
inlineprivate |
Evaluates the actual interpolation on the cell or face for a quadrature batch.
Definition at line 1796 of file fe_point_evaluation.h.
|
inlineprivate |
Fast path of the evaluate function.
Definition at line 1926 of file fe_point_evaluation.h.
|
inlineprivate |
Slow path of the evaluate function using FEValues.
Definition at line 1972 of file fe_point_evaluation.h.
|
inlineprivate |
Integrates the product of the data passed in by submit_value() and submit_gradient() with the values or gradients of test functions on the cell or face for a given quadrature batch.
Definition at line 2081 of file fe_point_evaluation.h.
|
inlineprivate |
Addition across the lanes of VectorizedArray as accumulated by the compute_integrate_fast_function(), writing the sum into the result vector. Applies face contributions to cell contributions for face path.
Definition at line 2191 of file fe_point_evaluation.h.
|
inlineprivate |
Fast path of the integrate function.
Definition at line 2260 of file fe_point_evaluation.h.
|
inlineprivate |
Slow path of the integrate function using FEValues.
Definition at line 2350 of file fe_point_evaluation.h.
|
private |
Implementation of the integrate/test_and_sum function.
Definition at line 2426 of file fe_point_evaluation.h.
|
staticconstexpr |
Definition at line 724 of file fe_point_evaluation.h.
|
staticconstexpr |
Definition at line 725 of file fe_point_evaluation.h.
|
staticconstexprprivate |
Definition at line 1012 of file fe_point_evaluation.h.
|
staticconstexprprivate |
Definition at line 1014 of file fe_point_evaluation.h.
|
staticconstexprprivate |
Definition at line 1016 of file fe_point_evaluation.h.
|
private |
Number of quadrature batches of the current cell/face.
Definition at line 1123 of file fe_point_evaluation.h.
|
private |
Number of quadrature points of the current cell/face.
Definition at line 1128 of file fe_point_evaluation.h.
|
private |
Pointer to the Mapping object passed to the constructor.
Definition at line 1133 of file fe_point_evaluation.h.
|
private |
Pointer to the FiniteElement object passed to the constructor.
Definition at line 1138 of file fe_point_evaluation.h.
|
private |
Description of the 1d polynomial basis for tensor product elements used for the fast path of this class using tensor product evaluators.
Definition at line 1144 of file fe_point_evaluation.h.
|
private |
Store whether the polynomials are linear with nodes at 0 and 1.
Definition at line 1149 of file fe_point_evaluation.h.
|
private |
Renumbering between the unknowns of unknowns implied by the FiniteElement class and a lexicographic numbering used for the tensorized code path.
Definition at line 1155 of file fe_point_evaluation.h.
|
private |
Temporary array to store the solution_values
passed to the evaluate() function in a format compatible with the tensor product evaluators. For vector-valued setups, this array uses a Tensor<1, n_components, ScalarNumber>
type to collect the unknowns for a particular basis function.
Definition at line 1164 of file fe_point_evaluation.h.
|
private |
Temporary array to store a vectorized version of the solution_values
computed during integrate()
in a format compatible with the tensor product evaluators. For vector-valued setups, this array uses a Tensor<1, n_components, VectorizedArrayType>
format.
Definition at line 1172 of file fe_point_evaluation.h.
|
private |
Temporary array for the use_face_path path (scalar).
Definition at line 1177 of file fe_point_evaluation.h.
|
private |
Temporary array to store the values at the points.
Definition at line 1182 of file fe_point_evaluation.h.
|
private |
Temporary array to store the gradients in unit coordinates at the points.
Definition at line 1187 of file fe_point_evaluation.h.
|
private |
Temporary array to store the gradients in real coordinates at the points.
Definition at line 1192 of file fe_point_evaluation.h.
|
private |
Pointer to first unit point batch of current cell/face from MappingInfo, set internally during do_reinit().
Definition at line 1198 of file fe_point_evaluation.h.
|
private |
Pointer to first unit point batch of current face from MappingInfo, set internally during do_reinit(). Needed for use_face_path path.
Definition at line 1204 of file fe_point_evaluation.h.
|
private |
Pointer to real point of first quadrature point of current cell/face from MappingInfo, set internally during do_reinit().
Definition at line 1210 of file fe_point_evaluation.h.
|
private |
Pointer to Jacobian of first quadrature point of current cell/face from MappingInfo, set internally during do_reinit().
Definition at line 1216 of file fe_point_evaluation.h.
|
private |
Pointer to inverse Jacobian of first quadrature point of current cell/face from MappingInfo, set internally during do_reinit().
Definition at line 1222 of file fe_point_evaluation.h.
|
private |
Pointer to normal vector of first quadrature point of current cell/face from MappingInfo, set internally during do_reinit().
Definition at line 1228 of file fe_point_evaluation.h.
|
private |
Pointer to Jacobian determinant times quadrature weight of first quadrature point of current cell/face from MappingInfo, set internally during do_reinit().
Definition at line 1235 of file fe_point_evaluation.h.
|
private |
Number of unknowns per component, i.e., number of unique basis functions, for the chosen FiniteElement (or base element).
Definition at line 1241 of file fe_point_evaluation.h.
|
private |
Number of unknowns per component, i.e., number of unique basis functions, for a restriction to the face of the chosen FiniteElement (or base element). This means a (dim-1)-dimensional basis.
Definition at line 1248 of file fe_point_evaluation.h.
|
private |
Bool indicating if use_face_path path should be chosen. Set during do_reinit().
Definition at line 1254 of file fe_point_evaluation.h.
|
private |
Scalar ShapeInfo object needed for use_face_path path.
Definition at line 1259 of file fe_point_evaluation.h.
|
private |
The first selected component in the active base element.
Definition at line 1264 of file fe_point_evaluation.h.
|
private |
For complicated FiniteElement objects this variable informs us about which unknowns actually carry degrees of freedom in the selected components.
Definition at line 1271 of file fe_point_evaluation.h.
|
private |
The desired update flags for the evaluation.
Definition at line 1276 of file fe_point_evaluation.h.
|
private |
The FEValues object underlying the slow evaluation path.
Definition at line 1281 of file fe_point_evaluation.h.
|
private |
Pointer to mapping info on the fly computed during reinit.
Definition at line 1287 of file fe_point_evaluation.h.
|
private |
Pointer to currently used mapping info (either on the fly or external precomputed).
Definition at line 1293 of file fe_point_evaluation.h.
|
private |
The current cell index to access mapping data from mapping info.
Definition at line 1298 of file fe_point_evaluation.h.
|
private |
The current face number to access mapping data from mapping info.
Definition at line 1303 of file fe_point_evaluation.h.
|
private |
Bool indicating if fast path is chosen.
Definition at line 1308 of file fe_point_evaluation.h.
|
private |
Connection to NonMatching::MappingInfo to check whether mapping data has been invalidated.
Definition at line 1314 of file fe_point_evaluation.h.
|
private |
Bool indicating if class is reinitialized and data vectors a resized.
Definition at line 1319 of file fe_point_evaluation.h.
|
private |
Vector containing tensor product shape functions evaluated (during reinit()) at the vectorized unit points.
Definition at line 1325 of file fe_point_evaluation.h.
|
private |
Vector containing tensor product shape functions evaluated (during reinit()) at the vectorized unit points on faces.
Definition at line 1331 of file fe_point_evaluation.h.