]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Create a doxygen module for hp and cross-link all relevant classes there.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 9 Jan 2006 21:51:26 +0000 (21:51 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 9 Jan 2006 21:51:26 +0000 (21:51 +0000)
git-svn-id: https://svn.dealii.org/trunk@11977 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/dofs/hp_dof_handler.h
deal.II/deal.II/include/dofs/hp_dof_levels.h
deal.II/deal.II/include/fe/fe_collection.h
deal.II/deal.II/include/fe/hp_fe_values.h
deal.II/deal.II/include/fe/mapping_collection.h
deal.II/deal.II/include/fe/q_collection.h
deal.II/deal.II/include/fe/select_fe_values.h
deal.II/doc/doxygen/headers/deal.II/dox.h

index 21117b739447dc0f5bdf0217f5f4b2349f5ece60..ca3e4f7a12774525c56837d5bf4b565cfe596a9b 100644 (file)
 #include <set>
 
 
-/*!@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
index 20f994324c6ab815095337e8b33c30b8027a596b..da1f2af56bfec7e8ca17130db3cd6586bc803cf0 100644 (file)
@@ -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.
  */
index 67d01f48fed9be0c326a35e5657006a0ed91dd3f..237ad4eabce32be15cc82fcfc12636f7ffdfabaa 100644 (file)
@@ -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 <int dim>
index dd42c6e75c83ceb8c1438067cb25a44428163026..32e5316618dbb94df6d65aac9fd137001d659ab7 100644 (file)
@@ -29,7 +29,12 @@ template <int dim> class FiniteElement;
 
 namespace hp
 {
-  
+
+/**
+ * A namespace for hp implementation details.
+ * 
+ * @ingroup hp
+ */
   namespace internal 
   {
 /**
@@ -38,6 +43,8 @@ namespace hp
  * <tt>FEFaceValues<dim></tt>, ...) objects. The <tt>hpFE*Values</tt> classes
  * use this to hold an <tt>FE*Values</tt> object for each finite element
  * that is used in the triangulation that it integrates on.
+ * 
+ * @ingroup hp
  */
     template <int dim, class FEValues>
     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 <int dim>
   class FEValues : public hp::internal::FEValuesMap<dim,::FEValues<dim> >,
                    protected hp::internal::FEValuesBase<dim,dim>
@@ -296,6 +308,10 @@ namespace hp
 
 
 
+/**
+ * 
+ * @ingroup hp
+ */  
   template <int dim>
   class FEFaceValues : public hp::internal::FEValuesMap<dim,::FEFaceValues<dim> >,
                        protected hp::internal::FEValuesBase<dim,dim-1>
@@ -405,6 +421,10 @@ namespace hp
 
 
 
+/**
+ * 
+ * @ingroup hp
+ */  
   template <int dim>
   class FESubfaceValues : public hp::internal::FEValuesMap<dim,::FESubfaceValues<dim> >,
                           protected hp::internal::FEValuesBase<dim,dim-1>
index f8bc4a0ee48de3069a95f1b6e9c500381a9efb91..8446e44b58f148917f04443d96b00d102814806f 100644 (file)
@@ -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 <int dim>
index efe6c6a5667dd3ee2477b38db1f51739d4f1637c..8fd68127ef71c808d00d8a41479efdbd0887f144 100644 (file)
@@ -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 <int dim>
index 31abf87f808928258ce365317bbe87af139ed699..42c48fe8a72534cccced142094a91df4bf1c2c63 100644 (file)
@@ -34,8 +34,16 @@ namespace hp
 
 
 
+/**
+ * 
+ * @ingroup hp
+ */  
 template <typename> struct SelectFEValues;
 
+/**
+ * 
+ * @ingroup hp
+ */  
 template <int dim> struct SelectFEValues<DoFHandler<dim> >
 {
     typedef FEValues<dim>        FEValues;
@@ -44,6 +52,10 @@ template <int dim> struct SelectFEValues<DoFHandler<dim> >
 };
 
 
+/**
+ * 
+ * @ingroup hp
+ */  
 template <int dim> struct SelectFEValues<hp::DoFHandler<dim> >
 {
     typedef hp::FEValues<dim>        FEValues;
index 20d5c8a4164d2cb0454ff1915edddd7f74ee3c56..aa13e5fc9b21ad35ca0f830570405ef7a5920d97 100644 (file)
@@ -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
  * @defgroup mg Multilevel support
  */
 
+/**
+ * @defgroup hp hp finite element support
+ *
+ * Classes and functions that have to do with hp finite elements.
+ */
+
 

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.