From 3bd07145089aefaef7e2106ffdef51c33b08362d Mon Sep 17 00:00:00 2001 From: Martin Kronbichler Date: Tue, 18 Jun 2024 15:19:58 +0200 Subject: [PATCH] Matrix-free MappingInfo: Update documentation of internal functions --- .../matrix_free/mapping_info.templates.h | 42 ++++++++++++++----- 1 file changed, 31 insertions(+), 11 deletions(-) diff --git a/include/deal.II/matrix_free/mapping_info.templates.h b/include/deal.II/matrix_free/mapping_info.templates.h index 44d38e9c6e..5e33d54a33 100644 --- a/include/deal.II/matrix_free/mapping_info.templates.h +++ b/include/deal.II/matrix_free/mapping_info.templates.h @@ -597,6 +597,14 @@ namespace internal + /** + * This function computes and tabulates the mapping information for + * generic mappings on a range of cells by a call to FEValues with the + * respective UpdateFlags set. There is a specialized function + * mapping_q_compute_range function that provides a faster + * initialization for mappings derived from MappingQ and suitable + * quadrature formulas. + */ template void initialize_cell_range( @@ -984,9 +992,11 @@ namespace internal /** - * This invokes the FEValues part of the initialization of MappingQ, - * storing the resulting quadrature points and an initial representation - * of Jacobians in two arrays. + * This function is the preparatory step for the faster MappingQ-based + * setup of the data structures in Mapping Info, using FEValues as an + * initial query mechanism into MappingQ, storing the resulting + * quadrature points and an initial representation of the Jacobians in + * two arrays. */ template void @@ -1140,10 +1150,11 @@ namespace internal /** - * This evaluates the mapping information on a range of cells calling - * into the tensor product interpolators of the matrix-free framework, - * using a polynomial expansion of the cell geometry in terms of - * MappingQ. + * This function computes and tabulates the mapping information for + * MappingQ-derived mappings on a range of cells calling into the tensor + * product evaluators of the matrix-free framework, using a + * polynomial expansion of the cell geometry underlying the MappingQ + * class. */ template void initialize_face_range( @@ -2069,10 +2088,11 @@ namespace internal /** - * This evaluates the mapping information on a range of cells calling - * into the tensor product interpolators of the matrix-free framework, - * using a polynomial expansion of the cell geometry in terms of - * MappingQ. + * This function computes and tabulates the mapping information for + * MappingQ-derived mappings on a range of faces calling into the tensor + * product face evaluators interpolators of the matrix-free framework, + * using a polynomial expansion of the cell geometry underlying the + * MappingQ class. */ template