From f2ca9207dc83bd0a6aa6f0a29279aac64d5304e0 Mon Sep 17 00:00:00 2001 From: wolf Date: Fri, 30 Mar 2001 09:29:06 +0000 Subject: [PATCH] Add doc. git-svn-id: https://svn.dealii.org/trunk@4351 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/fe/fe_lib.dg.h | 107 +++++++++++++++++++++---- 1 file changed, 91 insertions(+), 16 deletions(-) diff --git a/deal.II/deal.II/include/fe/fe_lib.dg.h b/deal.II/deal.II/include/fe/fe_lib.dg.h index fcdb94dacd..e5c219518c 100644 --- a/deal.II/deal.II/include/fe/fe_lib.dg.h +++ b/deal.II/deal.II/include/fe/fe_lib.dg.h @@ -17,46 +17,121 @@ #include -//TODO:[WB,RH] briefly document classes and mark them deprecated -template class FEDG_Q0: public FE_DGQ + +/** + * This class is an abbreviation for the @ref{FE_DGQ} class, where the + * polynomial degree (which is passed through the constructor of + * @ref{FE_DGQ}) is fixed to zero, i.e. piecewise constant elements. + * + * This class is only here for backward compatibility and will go away + * someday. Use the @ref{FE_DGQ} class instead. + * + * @author Wolfgang Bangerth, Ralf Hartmann, 2001 + */ +template +class FEDG_Q0 : public FE_DGQ { public: - FEDG_Q0(): FE_DGQ(0) - {}; + /** + * Constructor. Simply pass + * correct polynomial degree to + * constructor of base class. + */ + FEDG_Q0(): FE_DGQ(0) {}; }; -template class FEDG_Q1: public FE_DGQ +/** + * This class is an abbreviation for the @ref{FE_DGQ} class, where the + * polynomial degree (which is passed through the constructor of + * @ref{FE_DGQ}) is fixed to one, i.e. piecewise @p{d}-linear elements. + * + * This class is only here for backward compatibility and will go away + * someday. Use the @ref{FE_DGQ} class instead. + * + * @author Wolfgang Bangerth, Ralf Hartmann, 2001 + */ +template +class FEDG_Q1 : public FE_DGQ { public: - FEDG_Q1(): FE_DGQ(1) - {}; + /** + * Constructor. Simply pass + * correct polynomial degree to + * constructor of base class. + */ + FEDG_Q1(): FE_DGQ(1) {}; }; -template class FEDG_Q2: public FE_DGQ +/** + * This class is an abbreviation for the @ref{FE_DGQ} class, where the + * polynomial degree (which is passed through the constructor of + * @ref{FE_DGQ}) is fixed to two, i.e. piecewise @p{d}-quadratic elements. + * + * This class is only here for backward compatibility and will go away + * someday. Use the @ref{FE_DGQ} class instead. + * + * @author Wolfgang Bangerth, Ralf Hartmann, 2001 + */ +template +class FEDG_Q2 : public FE_DGQ { public: - FEDG_Q2(): FE_DGQ(2) - {}; + /** + * Constructor. Simply pass + * correct polynomial degree to + * constructor of base class. + */ + FEDG_Q2(): FE_DGQ(2) {}; }; -template class FEDG_Q3: public FE_DGQ +/** + * This class is an abbreviation for the @ref{FE_DGQ} class, where the + * polynomial degree (which is passed through the constructor of + * @ref{FE_DGQ}) is fixed to three, i.e. piecewise @p{d}-cubic elements. + * + * This class is only here for backward compatibility and will go away + * someday. Use the @ref{FE_DGQ} class instead. + * + * @author Wolfgang Bangerth, Ralf Hartmann, 2001 + */ +template +class FEDG_Q3 : public FE_DGQ { public: - FEDG_Q3(): FE_DGQ(3) - {}; + /** + * Constructor. Simply pass + * correct polynomial degree to + * constructor of base class. + */ + FEDG_Q3(): FE_DGQ(3) {}; }; -template class FEDG_Q4: public FE_DGQ +/** + * This class is an abbreviation for the @ref{FE_DGQ} class, where the + * polynomial degree (which is passed through the constructor of + * @ref{FE_DGQ}) is fixed to four, i.e. piecewise @p{d}-quartic elements. + * + * This class is only here for backward compatibility and will go away + * someday. Use the @ref{FE_DGQ} class instead. + * + * @author Wolfgang Bangerth, Ralf Hartmann, 2001 + */ +template +class FEDG_Q4 : public FE_DGQ { public: - FEDG_Q4(): FE_DGQ(4) - {}; + /** + * Constructor. Simply pass + * correct polynomial degree to + * constructor of base class. + */ + FEDG_Q4(): FE_DGQ(4) {}; }; -- 2.39.5