From 271bd7c5700993e03bd045e449c802a7efe13ff0 Mon Sep 17 00:00:00 2001 From: bangerth Date: Tue, 22 Jan 2013 20:27:26 +0000 Subject: [PATCH] Augment documentation. git-svn-id: https://svn.dealii.org/trunk@28160 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/dofs/dof_handler.h | 35 ++++++++++---------- deal.II/include/deal.II/hp/dof_handler.h | 37 ++++++++++++---------- 2 files changed, 38 insertions(+), 34 deletions(-) diff --git a/deal.II/include/deal.II/dofs/dof_handler.h b/deal.II/include/deal.II/dofs/dof_handler.h index 20402cdf36..a69f3d467a 100644 --- a/deal.II/include/deal.II/dofs/dof_handler.h +++ b/deal.II/include/deal.II/dofs/dof_handler.h @@ -1,7 +1,7 @@ //--------------------------------------------------------------------------- // $Id$ // -// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 by the deal.II authors +// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -288,25 +288,26 @@ public: const FiniteElement &fe); /** - * Go through the triangulation and - * distribute the degrees of freedoms - * needed for the given finite element - * according to the given distribution - * method. The purpose of this function + * Go through the triangulation and "distribute" the degrees of + * freedoms needed for the given finite element. "Distributing" + * degrees of freedom involved allocating memory to store the + * information that describes it (e.g., whether it is located on a + * vertex, edge, face, etc) and to sequentially enumerate all + * degrees of freedom. In other words, while the mesh and the finite + * element object by themselves simply define a finite element space + * $V_h$, the process of distributing degrees of freedom makes sure + * that there is a basis for this space and that the shape functions + * of this basis are enumerated in an indexable, predictable way. + * + * The purpose of this function * is first discussed in the introduction * to the step-2 tutorial program. * - * A pointer of the transferred - * finite element is - * stored. Therefore, the - * lifetime of the finite element - * object shall be longer than - * that of this object. If you - * don't want this behaviour, you - * may want to call the @p clear - * member function which also - * releases the lock of this - * object to the finite element. + * @note A pointer of the finite element given as argument is + * stored. Therefore, the lifetime of the finite element object + * shall be longer than that of this object. If you don't want this + * behavior, you may want to call the @p clear member function which + * also releases the lock of this object to the finite element. */ virtual void distribute_dofs (const FiniteElement &fe); diff --git a/deal.II/include/deal.II/hp/dof_handler.h b/deal.II/include/deal.II/hp/dof_handler.h index ab10917eeb..e9c7928db9 100644 --- a/deal.II/include/deal.II/hp/dof_handler.h +++ b/deal.II/include/deal.II/hp/dof_handler.h @@ -1,7 +1,7 @@ //---------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 by the deal.II authors +// Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -175,23 +175,26 @@ namespace hp virtual ~DoFHandler (); /** - * Go through the triangulation and - * distribute the degrees of freedoms - * needed for the given finite element - * according to the current distribution - * of active fe indices. + * Go through the triangulation and "distribute" the degrees of + * freedoms needed for the given finite element. "Distributing" + * degrees of freedom involved allocating memory to store the + * information that describes it (e.g., whether it is located on a + * vertex, edge, face, etc) and to sequentially enumerate all + * degrees of freedom. In other words, while the mesh and the finite + * element object by themselves simply define a finite element space + * $V_h$, the process of distributing degrees of freedom makes sure + * that there is a basis for this space and that the shape functions + * of this basis are enumerated in an indexable, predictable way. + * + * The purpose of this function + * is first discussed in the introduction + * to the step-2 tutorial program. * - * A pointer of the transferred - * finite element is - * stored. Therefore, the - * lifetime of the finite element - * object shall be longer than - * that of this object. If you - * don't want this behaviour, you - * may want to call the @p clear - * member function which also - * releases the lock of this - * object to the finite element. + * @note A pointer of the finite element given as argument is + * stored. Therefore, the lifetime of the finite element object + * shall be longer than that of this object. If you don't want this + * behavior, you may want to call the @p clear member function which + * also releases the lock of this object to the finite element. */ virtual void distribute_dofs (const hp::FECollection &fe); -- 2.39.5