From: Timo Heister Date: Tue, 17 Nov 2020 18:59:01 +0000 (-0500) Subject: doxygen: simplify mesh_loop arguments X-Git-Tag: v9.3.0-rc1~883^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2048951f7e9b60268f27d9f275bfdf26bda35b64;p=dealii.git doxygen: simplify mesh_loop arguments The documentation of mesh_loop() has terrible readability. Fix this: - introduce "using" for the std::function types - when running doxygen, remove the std::identity<> wrappers --- diff --git a/include/deal.II/meshworker/mesh_loop.h b/include/deal.II/meshworker/mesh_loop.h index 69fd610285..807fdcca7c 100644 --- a/include/deal.II/meshworker/mesh_loop.h +++ b/include/deal.II/meshworker/mesh_loop.h @@ -98,6 +98,45 @@ namespace MeshWorker }; } // namespace internal +#ifdef DOXYGEN + /** + * This alias introduces a friendly and short name for the function type + * for the cell worker used in mesh_loop(). + */ + using CellWorkerFunctionType = std::function< + void(const CellIteratorBaseType &, ScratchData &, CopyData &)>; + + /** + * This alias introduces a friendly and short name for the function type + * for the cell worker used in mesh_loop(). + */ + using CopierFunctionType = std::function; + + /** + * This alias introduces a friendly and short name for the function type + * for the boundary worker used in mesh_loop(). + */ + using BoundaryWorkerFunctionType = + std::function; + + /** + * This alias introduces a friendly and short name for the function type + * for the face worker used in mesh_loop(). + */ + using FaceWorkerFunctionType = + std::function; +#endif + /** * This function extends the WorkStream concept to work on meshes * (cells and/or faces) and handles the complicated logic for @@ -221,6 +260,10 @@ namespace MeshWorker * helpful to keep in mind that queue_length copies of the ScratchData object * and `queue_length*chunk_size` copies of the CopyData object are generated. * + * @note The types of the function arguments and the default values (empty worker functions) + * displayed in the Doxygen documentation here are slightly simplified + * compared to the real types. + * * @note More information about requirements on template types and meaning * of @p queue_length and @p chunk_size can be found in the documentation of the * WorkStream namespace and its members. @@ -234,6 +277,25 @@ namespace MeshWorker typename internal::CellIteratorBaseType::type> void mesh_loop( +#ifdef DOXYGEN + const CellIteratorType &begin, + const CellIteratorType &end, + + const CellWorkerFunctionType &cell_worker, + const CopierType & copier, + + const ScratchData &sample_scratch_data, + const CopyData & sample_copy_data, + + const AssembleFlags flags = assemble_own_cells, + + const BoundaryWorkerFunctionType &boundary_worker = + BoundaryWorkerFunctionType(), + + const FaceWorkerFunctionType &face_worker = FaceWorkerFunctionType(), + const unsigned int queue_length = 2 * MultithreadInfo::n_threads(), + const unsigned int chunk_size = 8 +#else const CellIteratorType & begin, const typename identity::type &end, @@ -275,7 +337,9 @@ namespace MeshWorker CopyData &)>(), const unsigned int queue_length = 2 * MultithreadInfo::n_threads(), - const unsigned int chunk_size = 8) + const unsigned int chunk_size = 8 +#endif + ) { Assert( (!cell_worker) == !(flags & work_on_cells),