From: Guido Kanschat <dr.guido.kanschat@gmail.com>
Date: Tue, 14 Sep 2010 21:26:43 +0000 (+0000)
Subject: add function name() and update documentation
X-Git-Tag: v8.0.0~5508
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e1052535a30af678e685b3445f1764c6f14ff8fe;p=dealii.git

add function name() and update documentation

git-svn-id: https://svn.dealii.org/trunk@21965 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/base/include/base/polynomials_abf.h b/deal.II/base/include/base/polynomials_abf.h
index 583bf75ca8..6840ebac1d 100644
--- a/deal.II/base/include/base/polynomials_abf.h
+++ b/deal.II/base/include/base/polynomials_abf.h
@@ -1,6 +1,5 @@
 //---------------------------------------------------------------------------
 //    $Id$
-//    Version: $Name$
 //
 //    Copyright (C) 2004, 2005, 2006, 2010 by the deal.II authors
 //
@@ -27,10 +26,6 @@
 #include <vector>
 
 DEAL_II_NAMESPACE_OPEN
-/**
- * @addtogroup Polynomials
- * @{
- */
 
 /**
  * This class implements the <i>H<sup>div</sup></i>-conforming,
@@ -48,7 +43,9 @@ DEAL_II_NAMESPACE_OPEN
  * Q<sub>k,k+2</sub>)</i> and <i>(Q<sub>k+2,k,k</sub>,
  * Q<sub>k,k+2,k</sub>, Q<sub>k,k,k+2</sub>)</i> in 2D and 3D, resp.
  *
- * @author Oliver Kayser-Herold, 2006 based on code from Guido Kanschat
+ * @ingroup Polynomials
+ * @author Oliver Kayser-Herold, based on code from Guido Kanschat
+ * @date 2006
  */
 template <int dim>
 class PolynomialsABF
@@ -113,6 +110,12 @@ class PolynomialsABF
 				      */
     unsigned int degree () const;
 
+				     /**
+				      * Return the name of the space ,
+				      * which is <tt>ABF</tt>.
+				      */
+    std::string name () const;
+    
 				     /**
 				      * Return the number of
 				      * polynomials in the space
@@ -168,7 +171,6 @@ class PolynomialsABF
     mutable std::vector<Tensor<2,dim> > p_grad_grads;
 };
 
-/** @} */
 
 template <int dim>
 inline unsigned int
@@ -177,12 +179,23 @@ PolynomialsABF<dim>::n() const
   return n_pols;
 }
 
+
 template <int dim>
 inline unsigned int
 PolynomialsABF<dim>::degree() const
 {
   return my_degree;
 }
+
+
+template <int dim>
+inline std::string
+PolynomialsABF<dim>::name() const
+{
+  return "ABF";
+}
+
+
 DEAL_II_NAMESPACE_CLOSE
 
 #endif
diff --git a/deal.II/base/include/base/polynomials_bdm.h b/deal.II/base/include/base/polynomials_bdm.h
index 71df841afb..654fe1285e 100644
--- a/deal.II/base/include/base/polynomials_bdm.h
+++ b/deal.II/base/include/base/polynomials_bdm.h
@@ -1,6 +1,5 @@
 //---------------------------------------------------------------------------
 //    $Id$
-//    Version: $Name$
 //
 //    Copyright (C) 2004, 2005, 2006, 2009, 2010 by the deal.II authors
 //
@@ -27,11 +26,6 @@
 
 DEAL_II_NAMESPACE_OPEN
 
-/**
- * @addtogroup Polynomials
- * @{
- */
-
 /**
  * This class implements the <i>H<sup>div</sup></i>-conforming,
  * vector-valued Brezzi-Douglas-Marini polynomials as described in the
@@ -56,7 +50,9 @@ DEAL_II_NAMESPACE_OPEN
  *
  * @todo Second derivatives in 3D are missing.
  *
- * @author Guido Kanschat, 2003, 2005, 2009
+ * @ingroup Polynomials
+ * @author Guido Kanschat
+ * @date 2003, 2005, 2009
  */
 template <int dim>
 class PolynomialsBDM
@@ -117,6 +113,12 @@ class PolynomialsBDM
 				      */
     unsigned int degree () const;
 
+				     /**
+				      * Return the name of the space ,
+				      * which is <tt>BDM</tt>.
+				      */
+    std::string name () const;
+    
 				     /**
 				      * Return the number of
 				      * polynomials in the space
@@ -174,7 +176,6 @@ class PolynomialsBDM
     mutable std::vector<Tensor<2,dim> > p_grad_grads;
 };
 
-/** @} */
 
 template <int dim>
 inline unsigned int
@@ -183,12 +184,23 @@ PolynomialsBDM<dim>::n() const
   return n_pols;
 }
 
+
 template <int dim>
 inline unsigned int
 PolynomialsBDM<dim>::degree() const
 {
   return polynomial_space.degree();
 }
+
+
+template <int dim>
+inline std::string
+PolynomialsBDM<dim>::name() const
+{
+  return "BDM";
+}
+
+
 DEAL_II_NAMESPACE_CLOSE
 
 #endif
diff --git a/deal.II/base/include/base/polynomials_nedelec.h b/deal.II/base/include/base/polynomials_nedelec.h
index e16bcb1d8a..9e790397b3 100644
--- a/deal.II/base/include/base/polynomials_nedelec.h
+++ b/deal.II/base/include/base/polynomials_nedelec.h
@@ -1,6 +1,5 @@
 //---------------------------------------------------------------------------
-//      $Id: polynomial.cc 21932 2010-09-12 09:03:07Z buerg $   
-//    Version: $Name$
+//    $Id: polynomial.cc 21932 2010-09-12 09:03:07Z buerg $   
 //
 //    Copyright (C) 2010 by the deal.II authors
 //
@@ -27,15 +26,11 @@
 #include <vector>
 
 DEAL_II_NAMESPACE_OPEN
-/**
- * @addtogroup Polynomials
- * @{
- */
 
 /**
- * This class implements the <i>H<sup>curl</sup></i>-conforming,
- * vector-valued Nédélec polynomials as proposed in the book of
- * P. Solin, K. Segeth and I. Dolezel.
+ * This class implements the first family <i>H<sup>curl</sup></i>-conforming,
+ * vector-valued polynomials, proposed by J.-C. Nédélec in 1980
+ * (Numer. Math. 35).
  *
  * The Nédélec polynomials are constructed such that the curl
  * is in the tensor product polynomial space <i>Q<sub>k</sub></i>.
@@ -45,7 +40,9 @@ DEAL_II_NAMESPACE_OPEN
  * Q<sub>k+1,k</sub>)</i> and <i>(Q<sub>k,k+1,k+1</sub>,
  * Q<sub>k+1,k,k+1</sub>, Q<sub>k+1,k+1,k</sub>)</i> in 2D and 3D, resp.
  *
- * @author Markus Bürg, 2009
+ * @ingroup Polynomials
+ * @author Markus Bürg
+ * @date 2009, 2010
  */
 template <int dim>
 class PolynomialsNedelec
@@ -103,6 +100,12 @@ class PolynomialsNedelec
 				      */
     unsigned int degree () const;
     
+				     /**
+				      * Return the name of the space ,
+				      * which is <tt>Nedelec</tt>.
+				      */
+    std::string name () const;
+    
 				     /**
 				      * Return the number of
 				      * polynomials in the space
@@ -145,7 +148,6 @@ class PolynomialsNedelec
     static std::vector<std::vector< Polynomials::Polynomial< double > > > create_polynomials (const unsigned int k);
 };
 
-/** @} */
 
 template <int dim>
 inline unsigned int PolynomialsNedelec<dim>::n () const
@@ -153,11 +155,22 @@ inline unsigned int PolynomialsNedelec<dim>::n () const
   return n_pols;
 }
 
+
 template <int dim>
 inline unsigned int PolynomialsNedelec<dim>::degree () const
 {
   return my_degree;
 }
+
+
+template <int dim>
+inline std::string
+PolynomialsNedelec<dim>::name() const
+{
+  return "Nedelec";
+}
+
+
 DEAL_II_NAMESPACE_CLOSE
 
 #endif
diff --git a/deal.II/base/include/base/polynomials_raviart_thomas.h b/deal.II/base/include/base/polynomials_raviart_thomas.h
index cad7acf20f..d7d20040fc 100644
--- a/deal.II/base/include/base/polynomials_raviart_thomas.h
+++ b/deal.II/base/include/base/polynomials_raviart_thomas.h
@@ -1,8 +1,7 @@
 //---------------------------------------------------------------------------
 //    $Id$
-//    Version: $Name$
 //
-//    Copyright (C) 2004, 2005, 2006, 2007, 2008 by the deal.II authors
+//    Copyright (C) 2004, 2005, 2006, 2007, 2008, 2010 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -26,10 +25,6 @@
 #include <vector>
 
 DEAL_II_NAMESPACE_OPEN
-/**
- * @addtogroup Polynomials
- * @{
- */
 
 /**
  * This class implements the <i>H<sup>div</sup></i>-conforming,
@@ -44,7 +39,9 @@ DEAL_II_NAMESPACE_OPEN
  * Q<sub>k,k+1</sub>)</i> and <i>(Q<sub>k+1,k,k</sub>,
  * Q<sub>k,k+1,k</sub>, Q<sub>k,k,k+1</sub>)</i> in 2D and 3D, resp.
  *
- * @author Guido Kanschat, 2005
+ * @ingroup Polynomials
+ * @author Guido Kanschat
+ * @date 2005
  */
 template <int dim>
 class PolynomialsRaviartThomas
@@ -103,6 +100,12 @@ class PolynomialsRaviartThomas
 				      * the highest polynomial degree.
 				      */
     unsigned int degree () const;
+
+				     /**
+				      * Return the name of the space ,
+				      * which is <tt>RaviartThomas</tt>.
+				      */
+    std::string name () const;
     
 				     /**
 				      * Return the number of
@@ -149,7 +152,6 @@ class PolynomialsRaviartThomas
     create_polynomials (const unsigned int k);
 };
 
-/** @} */
 
 template <int dim>
 inline unsigned int
@@ -158,12 +160,23 @@ PolynomialsRaviartThomas<dim>::n() const
   return n_pols;
 }
 
+
 template <int dim>
 inline unsigned int
 PolynomialsRaviartThomas<dim>::degree() const
 {
   return my_degree;
 }
+
+
+template <int dim>
+inline std::string
+PolynomialsRaviartThomas<dim>::name() const
+{
+  return "RaviartThomas";
+}
+
+
 DEAL_II_NAMESPACE_CLOSE
 
 #endif