From 6484c3f50f8aa6e0c647d023816e96fbb36420e5 Mon Sep 17 00:00:00 2001 From: kanschat Date: Wed, 25 Apr 2007 01:39:47 +0000 Subject: [PATCH] documentation git-svn-id: https://svn.dealii.org/trunk@14640 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/multigrid/mg_base.h | 20 +++++++++++++++++--- deal.II/doc/doxygen/headers/glossary.h | 6 +++--- 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/deal.II/deal.II/include/multigrid/mg_base.h b/deal.II/deal.II/include/multigrid/mg_base.h index 9bcd3fcfb3..87a2185ddd 100644 --- a/deal.II/deal.II/include/multigrid/mg_base.h +++ b/deal.II/deal.II/include/multigrid/mg_base.h @@ -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 + * block, 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 MGTransferBase : public Subscriptor diff --git a/deal.II/doc/doxygen/headers/glossary.h b/deal.II/doc/doxygen/headers/glossary.h index 01798d0ea3..620d776a8c 100644 --- a/deal.II/doc/doxygen/headers/glossary.h +++ b/deal.II/doc/doxygen/headers/glossary.h @@ -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 + * FiniteElement * *
@anchor GlossFaceOrientation Face orientation
*
In a triangulation, the normal vector to a face @@ -189,7 +189,7 @@ * function FiniteElementBase::has_support_points() returns * true. 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 -- 2.39.5