From 243642543b3e5a3c5f026f347e32ebe756024dfa Mon Sep 17 00:00:00 2001 From: kanschat Date: Wed, 25 Nov 2009 06:46:09 +0000 Subject: [PATCH] add group MeshWorker git-svn-id: https://svn.dealii.org/trunk@20166 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/numerics/mesh_worker.h | 4 ++++ .../deal.II/include/numerics/mesh_worker_assembler.h | 12 ++++++++++++ deal.II/deal.II/include/numerics/mesh_worker_info.h | 4 ++++ deal.II/deal.II/include/numerics/mesh_worker_loop.h | 4 ++++ 4 files changed, 24 insertions(+) diff --git a/deal.II/deal.II/include/numerics/mesh_worker.h b/deal.II/deal.II/include/numerics/mesh_worker.h index 3e8dff06c4..4910541b8f 100644 --- a/deal.II/deal.II/include/numerics/mesh_worker.h +++ b/deal.II/deal.II/include/numerics/mesh_worker.h @@ -107,6 +107,7 @@ template class MGDoFHandler; * info_box, integrator); * @endcode * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ namespace MeshWorker @@ -169,6 +170,8 @@ namespace MeshWorker /** * Worker object for integration of functionals, residuals or matrices. * + * @ingroup MeshWorker + * @author Guido Kanschat, 2009 */ template class IntegrationWorker : public LocalWorker @@ -360,6 +363,7 @@ namespace MeshWorker * You do the necessary initializations of this @p integrator and then * you have a worker object suitable for integration_loop(). * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template diff --git a/deal.II/deal.II/include/numerics/mesh_worker_assembler.h b/deal.II/deal.II/include/numerics/mesh_worker_assembler.h index 3eae97e495..e09a43f39b 100644 --- a/deal.II/deal.II/include/numerics/mesh_worker_assembler.h +++ b/deal.II/deal.II/include/numerics/mesh_worker_assembler.h @@ -72,6 +72,7 @@ namespace MeshWorker * each base element, it is not quite clear a priori, which data model * is more efficient. * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ namespace Assembler @@ -82,6 +83,7 @@ namespace MeshWorker * * * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template @@ -146,6 +148,7 @@ namespace MeshWorker * Compute cell and face contributions of one or several functionals, * typically for error estimates. * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template @@ -253,6 +256,9 @@ namespace MeshWorker * entries numbered from zero to DoFHandler::n_dofs(). No BlockInfo is * required and the global vector may be any type of vector having * element access through operator() (unsigned int) + * + * @ingroup MeshWorker + * @author Guido Kanschat, 2009 */ template class ResidualSimple @@ -320,6 +326,7 @@ namespace MeshWorker * * @todo Comprehensive model currently not implemented. * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template @@ -399,6 +406,7 @@ namespace MeshWorker * @todo On locally refined meshes, a ConstraintMatrix should be used * to automatically eliminate hanging nodes. * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template @@ -493,6 +501,7 @@ namespace MeshWorker * @todo The matrix structures needed for assembling level matrices * with local refinement and continuous elements are missing. * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template @@ -633,6 +642,7 @@ namespace MeshWorker * FESystem::base_element(). These blocks can be generated separately * and will be assembled into the correct matrix block by this object. * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template @@ -749,6 +759,7 @@ namespace MeshWorker * participating matrices will be assembled from the cell and face * matrices automatically. * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template @@ -881,6 +892,7 @@ namespace MeshWorker * objects in LocalResults and this class will assemble * them into matrix and vector objects. * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template diff --git a/deal.II/deal.II/include/numerics/mesh_worker_info.h b/deal.II/deal.II/include/numerics/mesh_worker_info.h index f07d1722e9..947a66b23a 100644 --- a/deal.II/deal.II/include/numerics/mesh_worker_info.h +++ b/deal.II/deal.II/include/numerics/mesh_worker_info.h @@ -32,6 +32,7 @@ namespace MeshWorker * The local matrices initialized by reinit() of the info object and * then assembled into the global system by Assembler classes. * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template @@ -165,6 +166,7 @@ namespace MeshWorker * block structure changes, for instance because of mesh refinement, * the DoFInfo class will automatically use the new structures. * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template @@ -318,6 +320,7 @@ namespace MeshWorker * triggered by calling BlockInfo::initialize_local() before * using initialize() in this class. * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template @@ -523,6 +526,7 @@ namespace MeshWorker * A simple container collecting the five info objects required by the * integration loops. * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template diff --git a/deal.II/deal.II/include/numerics/mesh_worker_loop.h b/deal.II/deal.II/include/numerics/mesh_worker_loop.h index 1ab93d548f..edcba4a04b 100644 --- a/deal.II/deal.II/include/numerics/mesh_worker_loop.h +++ b/deal.II/deal.II/include/numerics/mesh_worker_loop.h @@ -60,6 +60,9 @@ namespace MeshWorker * The extend of the second loop will be determined by the two control * variables LocalWorker::boundary_fluxes and * LocalWorker::interior_fluxes. + * + * @ingroup MeshWorker + * @author Guido Kanschat, 2009 */ template void loop(ITERATOR begin, ENDITERATOR end, @@ -174,6 +177,7 @@ namespace MeshWorker /** * Simplified interface for loop() if specialized for integration. * + * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ template -- 2.39.5