]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
documentation
authorkanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 25 Apr 2007 01:39:47 +0000 (01:39 +0000)
committerkanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 25 Apr 2007 01:39:47 +0000 (01:39 +0000)
git-svn-id: https://svn.dealii.org/trunk@14640 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/multigrid/mg_base.h
deal.II/doc/doxygen/headers/glossary.h

index 9bcd3fcfb305899041ecca9e06450e2e4efa5f69..87a2185dddb5ba37be910a55296180029d813010 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors
+//    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -120,12 +120,26 @@ class MGCoarseGridBase : public Subscriptor
  * types and numbering of the fine-grid discretization and of the
  * multi-level implementation are independent.
  *
- * If you use multigrid for your complete system of equations, you
+ * If you use multigrid for a single PDF or for your complete system
+ * of equations, you
  * will use MGTransferPrebuilt together with Multigrid. The vector
  * types used on the fine grid as well as for the multilevel
  * operations may be Vector or BlockVector. In both cases,
  * MGTransferPrebuilt will operate on all components of the solution.
  *
+ * @note For the following, it is important to realize the difference
+ * between a solution @ref GlossComponent "component" and a solution
+ * @ref GlossBlock "block". The distinction only applies if vector valued
+ * elements are used, but is quite important then. This is reflected
+ * in the fact that it is not possible right now to use transfer
+ * classes based on MGTransferComponentBase for genuine vector valued
+ * elements, but descendants of MGTransferBlockBase would have to be
+ * applied. In the following text, we will use the term
+ * <em>block</em>, but remark that it might refer to components as well.
+ *
+ * @todo update the following documentation, since it does not reflect
+ * the latest changes in structure.
+ *
  * For mixed systems, it may be required to do multigrid only for a
  * single component or for some components. The classes
  * MGTransferSelect and MGTransferBlock handle these cases.
@@ -141,7 +155,7 @@ class MGCoarseGridBase : public Subscriptor
  * whether this case is really useful. Therefore, a tested
  * implementation of this case will be supplied when needed.
  *
- * @author Wolfgang Bangerth, Guido Kanschat, 1999, 2002
+ * @author Wolfgang Bangerth, Guido Kanschat, 1999, 2002, 2007
  */
  template <class VECTOR>
  class MGTransferBase : public Subscriptor
index 01798d0ea3b87d4aedb9c82b2fc93b76df052c7a..620d776a8c4eafb8337764612e293a169c2be0cf 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 2005, 2006 by the deal.II authors
+//    Copyright (C) 2005, 2006, 2007 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -53,7 +53,7 @@
  * "blocks", but since the introduction of non-@ref GlossPrimitive
  * "primitive" elements, they have to be distinguished. See
  * FiniteElementData::n_components() and the documentation of
- * FimiteElement</dd>
+ * FiniteElement</dd>
  *
  * <dt class="glossary">@anchor GlossFaceOrientation Face orientation</dt>
  * <dd>In a triangulation, the normal vector to a face
  * function FiniteElementBase::has_support_points() returns
  * <tt>true</tt>. Naturally, these support points are on the
  * @ref GlossReferenceCell "reference cell".  Then, FEValues can be used
- * (in conjuncton with a Mapping) to access support points on the
+ * (in conjunction with a Mapping) to access support points on the
  * actual grid cells.
  *
  * @note The concept of @ref GlossSupport "support points" is

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.