From f37d0eb85b2a3a76d99ea0b5e4ab1ff94364cd0c Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Fri, 30 Mar 2001 09:26:00 +0000 Subject: [PATCH] Add doc. git-svn-id: https://svn.dealii.org/trunk@4349 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/fe/fe_lib.lagrange.h | 73 +++++++++++++++++--- 1 file changed, 64 insertions(+), 9 deletions(-) diff --git a/deal.II/deal.II/include/fe/fe_lib.lagrange.h b/deal.II/deal.II/include/fe/fe_lib.lagrange.h index 61129b3c33..b2a1075505 100644 --- a/deal.II/deal.II/include/fe/fe_lib.lagrange.h +++ b/deal.II/deal.II/include/fe/fe_lib.lagrange.h @@ -17,38 +17,93 @@ #include -//TODO:[WB,RH] briefly document classes and mark them deprecated +/** + * This class is an abbreviation for the @ref{FE_Q} class, where the + * polynomial degree (which is passed through the constructor of + * @ref{FE_Q}) is fixed to one, i.e. @p{d}-linear elements. + * + * This class is only here for backward compatibility and will go away + * someday. Use the @ref{FE_Q} class instead. + * + * @author Wolfgang Bangerth, Ralf Hartmann, 2001 + */ template class FEQ1: public FE_Q { public: - FEQ1(): FE_Q(1) - {}; + /** + * Constructor. Simply pass + * correct polynomial degree to + * constructor of base class. + */ + FEQ1(): FE_Q(1) {}; }; +/** + * This class is an abbreviation for the @ref{FE_Q} class, where the + * polynomial degree (which is passed through the constructor of + * @ref{FE_Q}) is fixed to two, i.e. @p{d}-quadratic elements. + * + * This class is only here for backward compatibility and will go away + * someday. Use the @ref{FE_Q} class instead. + * + * @author Wolfgang Bangerth, Ralf Hartmann, 2001 + */ template class FEQ2: public FE_Q { public: - FEQ2(): FE_Q(2) - {}; + /** + * Constructor. Simply pass + * correct polynomial degree to + * constructor of base class. + */ + FEQ2(): FE_Q(2) {}; }; +/** + * This class is an abbreviation for the @ref{FE_Q} class, where the + * polynomial degree (which is passed through the constructor of + * @ref{FE_Q}) is fixed to three, i.e. @p{d}-cubic elements. + * + * This class is only here for backward compatibility and will go away + * someday. Use the @ref{FE_Q} class instead. + * + * @author Wolfgang Bangerth, Ralf Hartmann, 2001 + */ template class FEQ3: public FE_Q { public: - FEQ3(): FE_Q(3) - {}; + /** + * Constructor. Simply pass + * correct polynomial degree to + * constructor of base class. + */ + FEQ3(): FE_Q(3) {}; }; +/** + * This class is an abbreviation for the @ref{FE_Q} class, where the + * polynomial degree (which is passed through the constructor of + * @ref{FE_Q}) is fixed to four, i.e. @p{d}-quartic elements. + * + * This class is only here for backward compatibility and will go away + * someday. Use the @ref{FE_Q} class instead. + * + * @author Wolfgang Bangerth, Ralf Hartmann, 2001 + */ template class FEQ4: public FE_Q { public: - FEQ4(): FE_Q(4) - {}; + /** + * Constructor. Simply pass + * correct polynomial degree to + * constructor of base class. + */ + FEQ4(): FE_Q(4) {}; }; -- 2.39.5