From d80966b044aedf2428828c8c121222e1e43e7ab2 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Mon, 9 Jan 2006 21:51:26 +0000 Subject: [PATCH] Create a doxygen module for hp and cross-link all relevant classes there. git-svn-id: https://svn.dealii.org/trunk@11977 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/dofs/hp_dof_handler.h | 6 ----- deal.II/deal.II/include/dofs/hp_dof_levels.h | 10 ++++++++ deal.II/deal.II/include/fe/fe_collection.h | 2 ++ deal.II/deal.II/include/fe/hp_fe_values.h | 24 +++++++++++++++++-- .../deal.II/include/fe/mapping_collection.h | 2 ++ deal.II/deal.II/include/fe/q_collection.h | 2 ++ deal.II/deal.II/include/fe/select_fe_values.h | 12 ++++++++++ deal.II/doc/doxygen/headers/deal.II/dox.h | 8 ++++++- 8 files changed, 57 insertions(+), 9 deletions(-) diff --git a/deal.II/deal.II/include/dofs/hp_dof_handler.h b/deal.II/deal.II/include/dofs/hp_dof_handler.h index 21117b7394..ca3e4f7a12 100644 --- a/deal.II/deal.II/include/dofs/hp_dof_handler.h +++ b/deal.II/deal.II/include/dofs/hp_dof_handler.h @@ -27,10 +27,6 @@ #include -/*!@addtogroup hp */ -/*@{*/ - - /** * A namespace that holds all the classes that have to do with hp finite * elements. @@ -1165,8 +1161,6 @@ namespace hp } -/*@}*/ - #endif #endif diff --git a/deal.II/deal.II/include/dofs/hp_dof_levels.h b/deal.II/deal.II/include/dofs/hp_dof_levels.h index 20f994324c..da1f2af56b 100644 --- a/deal.II/deal.II/include/dofs/hp_dof_levels.h +++ b/deal.II/deal.II/include/dofs/hp_dof_levels.h @@ -26,6 +26,8 @@ namespace hp * objects of dimension @p N. Declare this general template * class, but do not actually use it. Rather, only specializations of * this class are used. + * + * @ingroup hp * * @author Wolfgang Bangerth, 1998, Oliver Kayser-Herold 2003. */ @@ -50,6 +52,8 @@ namespace hp * dimension, e.g. a field to store the index referring to the * hp::FECollection class. The data therefore corresponds to cells, rather * than vertices, lines, quads, etc. + * + * @ingroup hp */ template <> class DoFLevel<0> @@ -123,6 +127,8 @@ namespace hp * is used, the indices are stored in the @p vertex_dofs array of the * DoFHandler class. * + * + * @ingroup hp * @author Wolfgang Bangerth, 1998, Oliver Kayser-Herold 2003. */ template <> @@ -157,6 +163,8 @@ namespace hp /** * Store the indices of the degrees of freedom which are located on * quads. See @ref{DoFLevel<1>} for more information. + * + * @ingroup hp * * @author Wolfgang Bangerth, 1998, Oliver Kayser-Herold 2003. */ @@ -193,6 +201,8 @@ namespace hp /** * Store the indices of the degrees of freedom which are located on * hexhedra. See @ref{DoFLevel<1>} for more information. + * + * @ingroup hp * * @author Wolfgang Bangerth, 1998, Oliver Kayser-Herold 2003. */ diff --git a/deal.II/deal.II/include/fe/fe_collection.h b/deal.II/deal.II/include/fe/fe_collection.h index 67d01f48fe..237ad4eabc 100644 --- a/deal.II/deal.II/include/fe/fe_collection.h +++ b/deal.II/deal.II/include/fe/fe_collection.h @@ -34,6 +34,8 @@ namespace hp * the worst case when using the finite elements associated with the cells of * a triangulation. * + * @ingroup hp + * * @author Wolfgang Bangerth, 2003 */ template diff --git a/deal.II/deal.II/include/fe/hp_fe_values.h b/deal.II/deal.II/include/fe/hp_fe_values.h index dd42c6e75c..32e5316618 100644 --- a/deal.II/deal.II/include/fe/hp_fe_values.h +++ b/deal.II/deal.II/include/fe/hp_fe_values.h @@ -29,7 +29,12 @@ template class FiniteElement; namespace hp { - + +/** + * A namespace for hp implementation details. + * + * @ingroup hp + */ namespace internal { /** @@ -38,6 +43,8 @@ namespace hp * FEFaceValues, ...) objects. The hpFE*Values classes * use this to hold an FE*Values object for each finite element * that is used in the triangulation that it integrates on. + * + * @ingroup hp */ template class FEValuesMap @@ -146,6 +153,8 @@ namespace hp * dimension we are in, the second the dimensionality of the object * that we integrate on, i.e. for usual @p hp::FEValues it is equal to * the first one, while for face integration it is one less. + * + * @ingroup hp * * @author Wolfgang Bangerth, 2003 */ @@ -211,7 +220,10 @@ namespace hp } - +/** + * + * @ingroup hp + */ template class FEValues : public hp::internal::FEValuesMap >, protected hp::internal::FEValuesBase @@ -296,6 +308,10 @@ namespace hp +/** + * + * @ingroup hp + */ template class FEFaceValues : public hp::internal::FEValuesMap >, protected hp::internal::FEValuesBase @@ -405,6 +421,10 @@ namespace hp +/** + * + * @ingroup hp + */ template class FESubfaceValues : public hp::internal::FEValuesMap >, protected hp::internal::FEValuesBase diff --git a/deal.II/deal.II/include/fe/mapping_collection.h b/deal.II/deal.II/include/fe/mapping_collection.h index f8bc4a0ee4..8446e44b58 100644 --- a/deal.II/deal.II/include/fe/mapping_collection.h +++ b/deal.II/deal.II/include/fe/mapping_collection.h @@ -37,6 +37,8 @@ namespace hp * achieve optimal convergence rates. Hence providing a single mapping object * will usually suffice. * + * @ingroup hp + * * @author Oliver Kayser-Herold, 2005 */ template diff --git a/deal.II/deal.II/include/fe/q_collection.h b/deal.II/deal.II/include/fe/q_collection.h index efe6c6a566..8fd68127ef 100644 --- a/deal.II/deal.II/include/fe/q_collection.h +++ b/deal.II/deal.II/include/fe/q_collection.h @@ -40,6 +40,8 @@ namespace hp * is the DataOut class. Due to this conversion constructor, these lines * of code continue to work without modifications. * + * @ingroup hp + * * @author Oliver Kayser-Herold, 2005 */ template diff --git a/deal.II/deal.II/include/fe/select_fe_values.h b/deal.II/deal.II/include/fe/select_fe_values.h index 31abf87f80..42c48fe8a7 100644 --- a/deal.II/deal.II/include/fe/select_fe_values.h +++ b/deal.II/deal.II/include/fe/select_fe_values.h @@ -34,8 +34,16 @@ namespace hp +/** + * + * @ingroup hp + */ template struct SelectFEValues; +/** + * + * @ingroup hp + */ template struct SelectFEValues > { typedef FEValues FEValues; @@ -44,6 +52,10 @@ template struct SelectFEValues > }; +/** + * + * @ingroup hp + */ template struct SelectFEValues > { typedef hp::FEValues FEValues; diff --git a/deal.II/doc/doxygen/headers/deal.II/dox.h b/deal.II/doc/doxygen/headers/deal.II/dox.h index 20d5c8a416..aa13e5fc9b 100644 --- a/deal.II/doc/doxygen/headers/deal.II/dox.h +++ b/deal.II/doc/doxygen/headers/deal.II/dox.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2003, 2005 by the deal.II authors +// Copyright (C) 2003, 2005, 2006 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -50,4 +50,10 @@ * @defgroup mg Multilevel support */ +/** + * @defgroup hp hp finite element support + * + * Classes and functions that have to do with hp finite elements. + */ + -- 2.39.5