]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Documentation update
authorkanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 16 Mar 2012 16:38:20 +0000 (16:38 +0000)
committerkanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 16 Mar 2012 16:38:20 +0000 (16:38 +0000)
git-svn-id: https://svn.dealii.org/trunk@25293 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/include/deal.II/meshworker/simple.h

index 6aec7dcd698f33084fd001155a291acf5736635f..edab5351ff7ef866927aaaececcb872448f289dd 100644 (file)
@@ -107,14 +107,20 @@ namespace MeshWorker
     };
 
 /**
- * Assemble local matrices into a single global matrix without using
- * block structure.
+ * Assemble local matrices into a single global matrix. If this global
+ * matrix has a block structure, this structure is not used, but
+ * rather the global numbering of degrees of freedom.
  *
  * After being initialized with a SparseMatrix object (or another
  * matrix offering the same functionality as SparseMatrix::add()),
  * this class can be used in a MeshWorker::loop() to assemble the cell
  * and face matrices into the global matrix.
  *
+ * If a ConstraintMatrix has been provided during initialization, this
+ * matrix will be used
+ * (ConstraintMatrix::distribute_local_to_global(), to be precise) to
+ * enter the local matrix into the global sparse matrix.
+ *
  * The assembler can handle two different types of local data. First,
  * by default, the obvious choice of taking a single local matrix with
  * dimensions equal to the number of degrees of freedom of the
@@ -125,9 +131,6 @@ namespace MeshWorker
  * initialize_local_blocks() has to be called before initialize_info()
  * to take the desired effect.
  *
- * @todo On locally refined meshes, a ConstraintMatrix should be used
- * to automatically eliminate hanging nodes.
- *
  * @ingroup MeshWorker
  * @author Guido Kanschat, 2009
  */
@@ -151,8 +154,16 @@ namespace MeshWorker
        void initialize(MATRIX& m);
                                         /**
                                          * Initialize the
-                                         * constraints for laer use
-                                         * by the assemble functions. 
+                                         * constraints. After this
+                                         * function has been called
+                                         * with a valid
+                                         * ConstraintMatrix, the
+                                         * function
+                                         * ConstraintMatrix::distribute_local_to_global()
+                                         * will be used by assemble()
+                                         * to distribute the cell and
+                                         * face matrices into a
+                                         * global sparse matrix.
                                          */
         void initialize(const ConstraintMatrix& constraints);
        
@@ -191,10 +202,8 @@ namespace MeshWorker
        
                                         /**
                                          * Initialize the local data
-                                         * in the
-                                         * DoFInfo
-                                         * object used later for
-                                         * assembling.
+                                         * in the DoFInfo object used
+                                         * later for assembling.
                                          *
                                          * The info object refers to
                                          * a cell if

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.