From 7a3fea9250d01adec56f7426b542effe5239a791 Mon Sep 17 00:00:00 2001 From: kanschat Date: Tue, 14 Sep 2010 21:26:43 +0000 Subject: [PATCH] add function name() and update documentation git-svn-id: https://svn.dealii.org/trunk@21965 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/polynomials_abf.h | 27 ++++++++++---- deal.II/base/include/base/polynomials_bdm.h | 28 ++++++++++----- .../base/include/base/polynomials_nedelec.h | 35 +++++++++++++------ .../include/base/polynomials_raviart_thomas.h | 29 ++++++++++----- 4 files changed, 85 insertions(+), 34 deletions(-) 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 DEAL_II_NAMESPACE_OPEN -/** - * @addtogroup Polynomials - * @{ - */ /** * This class implements the Hdiv-conforming, @@ -48,7 +43,9 @@ DEAL_II_NAMESPACE_OPEN * Qk,k+2) and (Qk+2,k,k, * Qk,k+2,k, Qk,k,k+2) 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 class PolynomialsABF @@ -113,6 +110,12 @@ class PolynomialsABF */ unsigned int degree () const; + /** + * Return the name of the space , + * which is ABF. + */ + std::string name () const; + /** * Return the number of * polynomials in the space @@ -168,7 +171,6 @@ class PolynomialsABF mutable std::vector > p_grad_grads; }; -/** @} */ template inline unsigned int @@ -177,12 +179,23 @@ PolynomialsABF::n() const return n_pols; } + template inline unsigned int PolynomialsABF::degree() const { return my_degree; } + + +template +inline std::string +PolynomialsABF::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 Hdiv-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 class PolynomialsBDM @@ -117,6 +113,12 @@ class PolynomialsBDM */ unsigned int degree () const; + /** + * Return the name of the space , + * which is BDM. + */ + std::string name () const; + /** * Return the number of * polynomials in the space @@ -174,7 +176,6 @@ class PolynomialsBDM mutable std::vector > p_grad_grads; }; -/** @} */ template inline unsigned int @@ -183,12 +184,23 @@ PolynomialsBDM::n() const return n_pols; } + template inline unsigned int PolynomialsBDM::degree() const { return polynomial_space.degree(); } + + +template +inline std::string +PolynomialsBDM::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 DEAL_II_NAMESPACE_OPEN -/** - * @addtogroup Polynomials - * @{ - */ /** - * This class implements the Hcurl-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 Hcurl-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 Qk. @@ -45,7 +40,9 @@ DEAL_II_NAMESPACE_OPEN * Qk+1,k) and (Qk,k+1,k+1, * Qk+1,k,k+1, Qk+1,k+1,k) in 2D and 3D, resp. * - * @author Markus Bürg, 2009 + * @ingroup Polynomials + * @author Markus Bürg + * @date 2009, 2010 */ template class PolynomialsNedelec @@ -103,6 +100,12 @@ class PolynomialsNedelec */ unsigned int degree () const; + /** + * Return the name of the space , + * which is Nedelec. + */ + std::string name () const; + /** * Return the number of * polynomials in the space @@ -145,7 +148,6 @@ class PolynomialsNedelec static std::vector > > create_polynomials (const unsigned int k); }; -/** @} */ template inline unsigned int PolynomialsNedelec::n () const @@ -153,11 +155,22 @@ inline unsigned int PolynomialsNedelec::n () const return n_pols; } + template inline unsigned int PolynomialsNedelec::degree () const { return my_degree; } + + +template +inline std::string +PolynomialsNedelec::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 DEAL_II_NAMESPACE_OPEN -/** - * @addtogroup Polynomials - * @{ - */ /** * This class implements the Hdiv-conforming, @@ -44,7 +39,9 @@ DEAL_II_NAMESPACE_OPEN * Qk,k+1) and (Qk+1,k,k, * Qk,k+1,k, Qk,k,k+1) in 2D and 3D, resp. * - * @author Guido Kanschat, 2005 + * @ingroup Polynomials + * @author Guido Kanschat + * @date 2005 */ template class PolynomialsRaviartThomas @@ -103,6 +100,12 @@ class PolynomialsRaviartThomas * the highest polynomial degree. */ unsigned int degree () const; + + /** + * Return the name of the space , + * which is RaviartThomas. + */ + std::string name () const; /** * Return the number of @@ -149,7 +152,6 @@ class PolynomialsRaviartThomas create_polynomials (const unsigned int k); }; -/** @} */ template inline unsigned int @@ -158,12 +160,23 @@ PolynomialsRaviartThomas::n() const return n_pols; } + template inline unsigned int PolynomialsRaviartThomas::degree() const { return my_degree; } + + +template +inline std::string +PolynomialsRaviartThomas::name() const +{ + return "RaviartThomas"; +} + + DEAL_II_NAMESPACE_CLOSE #endif -- 2.39.5