]> https://gitweb.dealii.org/ - dealii.git/commitdiff
add group MeshWorker
authorGuido Kanschat <dr.guido.kanschat@gmail.com>
Wed, 25 Nov 2009 06:46:09 +0000 (06:46 +0000)
committerGuido Kanschat <dr.guido.kanschat@gmail.com>
Wed, 25 Nov 2009 06:46:09 +0000 (06:46 +0000)
git-svn-id: https://svn.dealii.org/trunk@20166 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/numerics/mesh_worker.h
deal.II/deal.II/include/numerics/mesh_worker_assembler.h
deal.II/deal.II/include/numerics/mesh_worker_info.h
deal.II/deal.II/include/numerics/mesh_worker_loop.h

index 3e8dff06c49c9a5391afbe8629e65178798a77cd..4910541b8f4c7eb594763cc68a25918801be3c49 100644 (file)
@@ -107,6 +107,7 @@ template<int,int> 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 <int dim>
   class IntegrationWorker : public LocalWorker<dim>
@@ -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 <int dim, class ASSEMBLER, class INTEGRATOR>
index 3eae97e4959a8241cac9d7a8994d2323e4029c77..e09a43f39bdd5aae895620ac17530a720b8dac1f 100644 (file)
@@ -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 <typename number = double>
@@ -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 <typename number = double>
@@ -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 <tt>operator() (unsigned int)</tt>
+ *
+ * @ingroup MeshWorker
+ * @author Guido Kanschat, 2009
  */
     template <class VECTOR>
     class ResidualSimple
@@ -320,6 +326,7 @@ namespace MeshWorker
  *
  * @todo Comprehensive model currently not implemented.
  *
+ * @ingroup MeshWorker
  * @author Guido Kanschat, 2009
  */
     template <class VECTOR>
@@ -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 <class MATRIX>
@@ -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 <class MATRIX>
@@ -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 <class MATRIX, typename number = double>
@@ -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 <class MATRIX, typename number = double>
@@ -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 <class MATRIX, class VECTOR>
index f07d1722e99638d722458e1c2735373642b95b6d..947a66b23a7c7aa53962a3308735a65ca91a5c4e 100644 (file)
@@ -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 <typename number>
@@ -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<int dim, int spacedim = dim>
@@ -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<int dim, class FEVALUESBASE, int spacedim = dim>
@@ -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 <int dim, int spacedim=dim>
index 1ab93d548fedb98921121f516e753e1e0ceab30c..edcba4a04ba9633b8d4dae46a70eeb5da69fb3de 100644 (file)
@@ -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<class ITERATOR, class ENDITERATOR, class CELLINFO, class FACEINFO, class LOCALWORKER>
   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<int dim, class ITERATOR, class ENDITERATOR, class LOCALWORKER>

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.