From: Martin Kronbichler Date: Sat, 14 Nov 2020 11:50:08 +0000 (+0100) Subject: Avoid name macro_cell in matrix-free implementation X-Git-Tag: v9.3.0-rc1~900^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F11184%2Fhead;p=dealii.git Avoid name macro_cell in matrix-free implementation --- diff --git a/include/deal.II/matrix_free/matrix_free.h b/include/deal.II/matrix_free/matrix_free.h index 77421d1bd5..82bc2adab1 100644 --- a/include/deal.II/matrix_free/matrix_free.h +++ b/include/deal.II/matrix_free/matrix_free.h @@ -1614,7 +1614,7 @@ public: /** * @deprecated Use n_cell_batches() instead. */ - unsigned int + DEAL_II_DEPRECATED unsigned int n_macro_cells() const; /** @@ -1680,7 +1680,7 @@ public: * sorting by lanes in the VectorizedArray. */ std::array - get_faces_by_cells_boundary_id(const unsigned int macro_cell, + get_faces_by_cells_boundary_id(const unsigned int cell_batch_index, const unsigned int face_number) const; /** @@ -1705,34 +1705,36 @@ public: get_dof_handler(const unsigned int dof_handler_index = 0) const; /** - * Return the cell iterator in deal.II speak to a given cell in the - * renumbering of this structure. + * Return the cell iterator in deal.II speak to a given cell batch + * (populating several lanes in a VectorizedArray) and the lane index within + * the vectorization across cells in the renumbering of this structure. * * Note that the cell iterators in deal.II go through cells differently to * what the cell loop of this class does. This is because several cells are - * worked on together (vectorization), and since cells with neighbors on - * different MPI processors need to be accessed at a certain time when - * accessing remote data and overlapping communication with computation. + * processed together (vectorization across cells), and since cells with + * neighbors on different MPI processors need to be accessed at a certain + * time when accessing remote data and overlapping communication with + * computation. */ typename DoFHandler::cell_iterator - get_cell_iterator(const unsigned int macro_cell_number, - const unsigned int vector_number, + get_cell_iterator(const unsigned int cell_batch_index, + const unsigned int lane_index, const unsigned int dof_handler_index = 0) const; /** - * This returns the level and index for the cell that would be - * returned by get_cell_iterator() for the same arguments @p - * macro_cell_number and @p vector_number. + * This returns the level and index for the cell that would be returned by + * get_cell_iterator() for the same arguments `cell_batch_index` and + * `lane_index`. */ std::pair - get_cell_level_and_index(const unsigned int macro_cell_number, - const unsigned int vector_number) const; + get_cell_level_and_index(const unsigned int cell_batch_index, + const unsigned int lane_index) const; /** - * Return the cell iterator in deal.II speak to a interior/exterior cell of - * given face in the renumbering of this structure. The second element - * of the pair is the face number so that the face iterator can be accessed: - * pair.first()->face(pair.second() ); + * Return the cell iterator in deal.II speak to an interior/exterior cell of + * a face in a pair of a face batch and lane index. The second element of + * the pair is the face number so that the face iterator can be accessed: + * `pair.first()->face(pair.second());` * * Note that the face iterators in deal.II go through cells differently to * what the face/boundary loop of this class does. This is because several @@ -1741,25 +1743,17 @@ public: * when accessing remote data and overlapping communication with computation. */ std::pair::cell_iterator, unsigned int> - get_face_iterator(const unsigned int face_batch_number, - const unsigned int vector_number, + get_face_iterator(const unsigned int face_batch_index, + const unsigned int lane_index, const bool interior = true, const unsigned int fe_component = 0) const; /** - * This returns the cell iterator in deal.II speak to a given cell in the - * renumbering of this structure. This function returns an exception in case - * the structure was not constructed based on an hp::DoFHandler. - * - * Note that the cell iterators in deal.II go through cells differently to - * what the cell loop of this class does. This is because several cells are - * worked on together (vectorization), and since cells with neighbors on - * different MPI processors need to be accessed at a certain time when - * accessing remote data and overlapping communication with computation. + * @deprecated Use get_cell_iterator() instead. */ - typename DoFHandler::active_cell_iterator - get_hp_cell_iterator(const unsigned int macro_cell_number, - const unsigned int vector_number, + DEAL_II_DEPRECATED typename DoFHandler::active_cell_iterator + get_hp_cell_iterator(const unsigned int cell_batch_index, + const unsigned int lane_index, const unsigned int dof_handler_index = 0) const; /** @@ -1769,34 +1763,31 @@ public: * using only this class, one usually does not need to bother about that * fact since the values are padded with zeros. However, when this class is * mixed with deal.II access to cells, care needs to be taken. This function - * returns @p true if not all @p vectorization_length cells for the given @p - * macro_cell are real cells. To find out how many cells are actually used, - * use the function @p n_active_entries_per_cell_batch. + * returns @p true if not all `n_lanes` cells for the given + * `cell_batch_index` correspond to actual cells of the mesh and some are + * merely present for padding reasons. To find out how many cells are + * actually used, use the function n_active_entries_per_cell_batch(). */ bool - at_irregular_cell(const unsigned int macro_cell_number) const; + at_irregular_cell(const unsigned int cell_batch_index) const; /** - * This query returns how many cells over the length of vectorization data - * types correspond to actual cells in the mesh. For most given @p - * cell_batch_number, this is just @p vectorization_length many, but there - * might be one or a few meshes (where the numbers do not add up) where - * there are less such components filled, indicated by the function @p - * at_irregular_cell. + * @deprecated Use n_active_entries_per_cell_batch() instead. */ - unsigned int + DEAL_II_DEPRECATED unsigned int n_components_filled(const unsigned int cell_batch_number) const; /** - * This query returns how many cells over the length of vectorization data - * types correspond to actual cells in the mesh. For most given cell batches - * in n_cell_batches(), this is just @p vectorization_length many, but there - * might be one or a few meshes (where the numbers do not add up) where - * there are less such components filled, indicated by the function @p - * at_irregular_cell. + * This query returns how many cells among the `VectorizedArrayType::size()` + * many cells within a cell batch to actual cells in the mesh, rather than + * being present for padding reasons. For most given cell batches in + * n_cell_batches(), this number is equal to `VectorizedArrayType::size()`, + * but there might be one or a few cell batches in the mesh (where the + * numbers do not add up) where only some of the cells within a batch are + * used, indicated by the function at_irregular_cell(). */ unsigned int - n_active_entries_per_cell_batch(const unsigned int cell_batch_number) const; + n_active_entries_per_cell_batch(const unsigned int cell_batch_index) const; /** * Use this function to find out how many faces over the length of @@ -1808,7 +1799,7 @@ public: * where there are less such lanes filled. */ unsigned int - n_active_entries_per_face_batch(const unsigned int face_batch_number) const; + n_active_entries_per_face_batch(const unsigned int face_batch_index) const; /** * Return the number of degrees of freedom per cell for a given hp index. @@ -1861,7 +1852,7 @@ public: * and return the active FE index in the hp-adaptive case. */ unsigned int - get_cell_category(const unsigned int macro_cell) const; + get_cell_category(const unsigned int cell_batch_index) const; /** * Return the category on the cells on the two sides of the current batch of @@ -1975,7 +1966,7 @@ public: */ const internal::MatrixFreeFunctions::FaceToCellTopology< VectorizedArrayType::size()> & - get_face_info(const unsigned int face_batch_number) const; + get_face_info(const unsigned int face_batch_index) const; /** @@ -2344,17 +2335,20 @@ MatrixFree::get_boundary_id( template inline std::array MatrixFree::get_faces_by_cells_boundary_id( - const unsigned int macro_cell, + const unsigned int cell_batch_index, const unsigned int face_number) const { - AssertIndexRange(macro_cell, n_cell_batches()); + AssertIndexRange(cell_batch_index, n_cell_batches()); AssertIndexRange(face_number, GeometryInfo::faces_per_cell); Assert(face_info.cell_and_face_boundary_id.size(0) >= n_cell_batches(), ExcNotInitialized()); std::array result; result.fill(numbers::invalid_boundary_id); - for (unsigned int v = 0; v < n_active_entries_per_cell_batch(macro_cell); ++v) - result[v] = face_info.cell_and_face_boundary_id(macro_cell, face_number, v); + for (unsigned int v = 0; + v < n_active_entries_per_cell_batch(cell_batch_index); + ++v) + result[v] = + face_info.cell_and_face_boundary_id(cell_batch_index, face_number, v); return result; } @@ -2450,12 +2444,14 @@ MatrixFree::create_cell_subrange_hp( template inline bool MatrixFree::at_irregular_cell( - const unsigned int macro_cell) const + const unsigned int cell_batch_index) const { - AssertIndexRange(macro_cell, task_info.cell_partition_data.back()); + AssertIndexRange(cell_batch_index, task_info.cell_partition_data.back()); return VectorizedArrayType::size() > 1 && - cell_level_index[(macro_cell + 1) * VectorizedArrayType::size() - 1] == - cell_level_index[(macro_cell + 1) * VectorizedArrayType::size() - 2]; + cell_level_index[(cell_batch_index + 1) * VectorizedArrayType::size() - + 1] == cell_level_index[(cell_batch_index + 1) * + VectorizedArrayType::size() - + 2]; } @@ -2463,9 +2459,9 @@ MatrixFree::at_irregular_cell( template inline unsigned int MatrixFree::n_components_filled( - const unsigned int cell_batch_number) const + const unsigned int cell_batch_index) const { - return n_active_entries_per_cell_batch(cell_batch_number); + return n_active_entries_per_cell_batch(cell_batch_index); } @@ -2473,14 +2469,14 @@ MatrixFree::n_components_filled( template inline unsigned int MatrixFree::n_active_entries_per_cell_batch( - const unsigned int cell_batch_number) const + const unsigned int cell_batch_index) const { - AssertIndexRange(cell_batch_number, task_info.cell_partition_data.back()); + AssertIndexRange(cell_batch_index, task_info.cell_partition_data.back()); unsigned int n_lanes = VectorizedArrayType::size(); while (n_lanes > 1 && - cell_level_index[cell_batch_number * VectorizedArrayType::size() + + cell_level_index[cell_batch_index * VectorizedArrayType::size() + n_lanes - 1] == - cell_level_index[cell_batch_number * VectorizedArrayType::size() + + cell_level_index[cell_batch_index * VectorizedArrayType::size() + n_lanes - 2]) --n_lanes; AssertIndexRange(n_lanes - 1, VectorizedArrayType::size()); @@ -2492,12 +2488,12 @@ MatrixFree::n_active_entries_per_cell_batch( template inline unsigned int MatrixFree::n_active_entries_per_face_batch( - const unsigned int face_batch_number) const + const unsigned int face_batch_index) const { - AssertIndexRange(face_batch_number, face_info.faces.size()); + AssertIndexRange(face_batch_index, face_info.faces.size()); unsigned int n_lanes = VectorizedArrayType::size(); while (n_lanes > 1 && - face_info.faces[face_batch_number].cells_interior[n_lanes - 1] == + face_info.faces[face_batch_index].cells_interior[n_lanes - 1] == numbers::invalid_unsigned_int) --n_lanes; AssertIndexRange(n_lanes - 1, VectorizedArrayType::size()); @@ -2650,14 +2646,14 @@ MatrixFree::get_face_quadrature( template inline unsigned int MatrixFree::get_cell_category( - const unsigned int macro_cell) const + const unsigned int cell_batch_index) const { AssertIndexRange(0, dof_info.size()); - AssertIndexRange(macro_cell, dof_info[0].cell_active_fe_index.size()); + AssertIndexRange(cell_batch_index, dof_info[0].cell_active_fe_index.size()); if (dof_info[0].cell_active_fe_index.empty()) return 0; else - return dof_info[0].cell_active_fe_index[macro_cell]; + return dof_info[0].cell_active_fe_index[cell_batch_index]; } diff --git a/include/deal.II/matrix_free/matrix_free.templates.h b/include/deal.II/matrix_free/matrix_free.templates.h index bbb211e0b9..3b5643dd84 100644 --- a/include/deal.II/matrix_free/matrix_free.templates.h +++ b/include/deal.II/matrix_free/matrix_free.templates.h @@ -166,17 +166,17 @@ MatrixFree::get_dof_handler( template typename DoFHandler::cell_iterator MatrixFree::get_cell_iterator( - const unsigned int macro_cell_number, - const unsigned int vector_number, + const unsigned int cell_batch_index, + const unsigned int lane_index, const unsigned int dof_handler_index) const { AssertIndexRange(dof_handler_index, dof_handlers.size()); - AssertIndexRange(macro_cell_number, task_info.cell_partition_data.back()); - AssertIndexRange(vector_number, n_components_filled(macro_cell_number)); + AssertIndexRange(cell_batch_index, task_info.cell_partition_data.back()); + AssertIndexRange(lane_index, n_components_filled(cell_batch_index)); std::pair index = - cell_level_index[macro_cell_number * VectorizedArrayType::size() + - vector_number]; + cell_level_index[cell_batch_index * VectorizedArrayType::size() + + lane_index]; return typename DoFHandler::cell_iterator( &dof_handlers[dof_handler_index]->get_triangulation(), index.first, @@ -189,15 +189,15 @@ MatrixFree::get_cell_iterator( template std::pair MatrixFree::get_cell_level_and_index( - const unsigned int macro_cell_number, - const unsigned int vector_number) const + const unsigned int cell_batch_index, + const unsigned int lane_index) const { - AssertIndexRange(macro_cell_number, task_info.cell_partition_data.back()); - AssertIndexRange(vector_number, n_components_filled(macro_cell_number)); + AssertIndexRange(cell_batch_index, task_info.cell_partition_data.back()); + AssertIndexRange(lane_index, n_components_filled(cell_batch_index)); std::pair level_index_pair = - cell_level_index[macro_cell_number * VectorizedArrayType::size() + - vector_number]; + cell_level_index[cell_batch_index * VectorizedArrayType::size() + + lane_index]; return level_index_pair; } @@ -206,26 +206,26 @@ MatrixFree::get_cell_level_and_index( template std::pair::cell_iterator, unsigned int> MatrixFree::get_face_iterator( - const unsigned int face_batch_number, - const unsigned int vector_number, + const unsigned int face_batch_index, + const unsigned int lane_index, const bool interior, const unsigned int fe_component) const { AssertIndexRange(fe_component, dof_handlers.size()); - AssertIndexRange(face_batch_number, + AssertIndexRange(face_batch_index, n_inner_face_batches() + (interior ? n_boundary_face_batches() : 0)); - AssertIndexRange(vector_number, - n_active_entries_per_face_batch(face_batch_number)); + AssertIndexRange(lane_index, + n_active_entries_per_face_batch(face_batch_index)); const internal::MatrixFreeFunctions::FaceToCellTopology< VectorizedArrayType::size()> - face2cell_info = get_face_info(face_batch_number); + face2cell_info = get_face_info(face_batch_index); - const unsigned int cell_index = - interior ? face2cell_info.cells_interior[vector_number] : - face2cell_info.cells_exterior[vector_number]; + const unsigned int cell_index = interior ? + face2cell_info.cells_interior[lane_index] : + face2cell_info.cells_exterior[lane_index]; std::pair index = cell_level_index[cell_index]; @@ -243,17 +243,17 @@ MatrixFree::get_face_iterator( template typename DoFHandler::active_cell_iterator MatrixFree::get_hp_cell_iterator( - const unsigned int macro_cell_number, - const unsigned int vector_number, + const unsigned int cell_batch_index, + const unsigned int lane_index, const unsigned int dof_handler_index) const { AssertIndexRange(dof_handler_index, dof_handlers.size()); - AssertIndexRange(macro_cell_number, task_info.cell_partition_data.back()); - AssertIndexRange(vector_number, n_components_filled(macro_cell_number)); + AssertIndexRange(cell_batch_index, task_info.cell_partition_data.back()); + AssertIndexRange(lane_index, n_components_filled(cell_batch_index)); std::pair index = - cell_level_index[macro_cell_number * VectorizedArrayType::size() + - vector_number]; + cell_level_index[cell_batch_index * VectorizedArrayType::size() + + lane_index]; return typename DoFHandler::cell_iterator( &dof_handlers[dof_handler_index]->get_triangulation(), index.first, @@ -1027,10 +1027,10 @@ namespace internal irregular_cells); task_info.guess_block_size(dof_info[0].dofs_per_cell[0]); - unsigned int n_macro_cells_before = + unsigned int n_cell_batches_before = *(task_info.cell_partition_data.end() - 2); unsigned int n_ghost_slots = - *(task_info.cell_partition_data.end() - 1) - n_macro_cells_before; + *(task_info.cell_partition_data.end() - 1) - n_cell_batches_before; unsigned int start_nonboundary = numbers::invalid_unsigned_int; if (task_info.scheme == @@ -1072,7 +1072,7 @@ namespace internal std::vector> renumbering_fe_index; renumbering_fe_index.resize(dof_info[0].max_fe_index); unsigned int counter; - n_macro_cells_before = 0; + n_cell_batches_before = 0; for (counter = 0; counter < std::min(start_nonboundary * n_lanes, task_info.n_active_cells); @@ -1091,9 +1091,9 @@ namespace internal for (const auto jj : renumbering_fe_index[j]) renumbering[counter++] = jj; irregular_cells[renumbering_fe_index[j].size() / n_lanes + - n_macro_cells_before] = + n_cell_batches_before] = renumbering_fe_index[j].size() % n_lanes; - n_macro_cells_before += + n_cell_batches_before += (renumbering_fe_index[j].size() + n_lanes - 1) / n_lanes; renumbering_fe_index[j].resize(0); } @@ -1114,19 +1114,19 @@ namespace internal for (const auto jj : renumbering_fe_index[j]) renumbering[counter++] = jj; irregular_cells[renumbering_fe_index[j].size() / n_lanes + - n_macro_cells_before] = + n_cell_batches_before] = renumbering_fe_index[j].size() % n_lanes; - n_macro_cells_before += + n_cell_batches_before += (renumbering_fe_index[j].size() + n_lanes - 1) / n_lanes; } - AssertIndexRange(n_macro_cells_before, + AssertIndexRange(n_cell_batches_before, task_info.cell_partition_data.back() + 2 * dof_info[0].max_fe_index + 1); - irregular_cells.resize(n_macro_cells_before + n_ghost_slots); + irregular_cells.resize(n_cell_batches_before + n_ghost_slots); *(task_info.cell_partition_data.end() - 2) = - n_macro_cells_before; + n_cell_batches_before; *(task_info.cell_partition_data.end() - 1) = - n_macro_cells_before + n_ghost_slots; + n_cell_batches_before + n_ghost_slots; } } diff --git a/source/matrix_free/task_info.cc b/source/matrix_free/task_info.cc index 7f3de4fe12..dcf1c19497 100644 --- a/source/matrix_free/task_info.cc +++ b/source/matrix_free/task_info.cc @@ -1654,7 +1654,7 @@ namespace internal ExcInternalError()); { - unsigned int n_macro_cells_before = 0; + unsigned int n_cell_batches_before = 0; // Create partitioning within partitions. // For each block of cells, this variable saves to which partitions @@ -1741,7 +1741,7 @@ namespace internal // put the cells into separate lists for each FE index // within one partition-partition missing_macros = 0; - std::vector remaining_per_macro_cell( + std::vector remaining_per_cell_batch( max_fe_index + 1); std::vector> renumbering_fe_index; @@ -1764,10 +1764,10 @@ namespace internal // check how many more cells are needed in the lists for (unsigned int j = 0; j < max_fe_index + 1; j++) { - remaining_per_macro_cell[j] = + remaining_per_cell_batch[j] = renumbering_fe_index[j].size() % vectorization_length; - if (remaining_per_macro_cell[j] != 0) + if (remaining_per_cell_batch[j] != 0) filled = false; missing_macros += ((renumbering_fe_index[j].size() + @@ -1777,12 +1777,12 @@ namespace internal } else { - remaining_per_macro_cell.resize(1); - remaining_per_macro_cell[0] = + remaining_per_cell_batch.resize(1); + remaining_per_cell_batch[0] = partition_counter % vectorization_length; missing_macros = partition_counter / vectorization_length; - if (remaining_per_macro_cell[0] != 0) + if (remaining_per_cell_batch[0] != 0) { filled = false; missing_macros++; @@ -1840,7 +1840,7 @@ namespace internal // a macro cell with the FE index that is // not yet fully populated if (missing_macros > 0 || - remaining_per_macro_cell[this_index] > 0) + remaining_per_cell_batch[this_index] > 0) { cell_partition_l2[neighbor->column()] = partition_l2; @@ -1853,16 +1853,16 @@ namespace internal neighbor->column(); counter++; partition_counter++; - if (remaining_per_macro_cell + if (remaining_per_cell_batch [this_index] == 0 && missing_macros > 0) missing_macros--; - remaining_per_macro_cell[this_index]++; - if (remaining_per_macro_cell + remaining_per_cell_batch[this_index]++; + if (remaining_per_cell_batch [this_index] == vectorization_length) { - remaining_per_macro_cell[this_index] = + remaining_per_cell_batch[this_index] = 0; } if (missing_macros == 0) @@ -1871,7 +1871,7 @@ namespace internal for (unsigned int fe_ind = 0; fe_ind < max_fe_index + 1; ++fe_ind) - if (remaining_per_macro_cell + if (remaining_per_cell_batch [fe_ind] != 0) filled = false; } @@ -1897,10 +1897,10 @@ namespace internal 0) irregular_cells[renumbering_fe_index[j].size() / vectorization_length + - n_macro_cells_before] = + n_cell_batches_before] = renumbering_fe_index[j].size() % vectorization_length; - n_macro_cells_before += + n_cell_batches_before += (renumbering_fe_index[j].size() + vectorization_length - 1) / vectorization_length; @@ -1909,17 +1909,17 @@ namespace internal } else { - n_macro_cells_before += + n_cell_batches_before += partition_counter / vectorization_length; if (partition_counter % vectorization_length != 0) { - irregular_cells[n_macro_cells_before] = + irregular_cells[n_cell_batches_before] = partition_counter % vectorization_length; - n_macro_cells_before++; + n_cell_batches_before++; } } } - cell_partition_data.push_back(n_macro_cells_before); + cell_partition_data.push_back(n_cell_batches_before); partition_l2++; } neighbor_list = neighbor_neighbor_list;