From: Wolfgang Bangerth Date: Mon, 12 Jul 2004 14:06:22 +0000 (+0000) Subject: Remove a few TODOs by adding docs. X-Git-Tag: v8.0.0~14955 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0d0c60898ee62e359dc53adb493d9f183b36c83e;p=dealii.git Remove a few TODOs by adding docs. git-svn-id: https://svn.dealii.org/trunk@9510 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/fe/fe_values.h b/deal.II/deal.II/include/fe/fe_values.h index c507ffe7a4..517cddb842 100644 --- a/deal.II/deal.II/include/fe/fe_values.h +++ b/deal.II/deal.II/include/fe/fe_values.h @@ -1606,8 +1606,26 @@ class FEValues : public FEValuesBase /** * Return a reference to this * very object. + * + * Though it seems that it is not very + * useful, this function is there to + * provide capability to the hpFEValues + * class, in which case it provides the + * FEValues object for the present cell + * (remember that for hp finite elements, + * the actual FE object used may change + * from cell to cell, so we also need + * different FEValues objects for + * different cells; once you reinitialize + * the hpFEValues object for a specific + * cell, it retrieves the FEValues object + * for the FE on that cell and returns it + * through a function of the same name as + * this one; this function here therefore + * only provides the same interface so + * that one can templatize on + * FEValues/hpFEValues). */ -//TODO: explain reason const FEValues & get_present_fe_values () const; private: @@ -1838,8 +1856,26 @@ class FEFaceValues : public FEFaceValuesBase /** * Return a reference to this * very object. + * + * Though it seems that it is not very + * useful, this function is there to + * provide capability to the hpFEValues + * class, in which case it provides the + * FEValues object for the present cell + * (remember that for hp finite elements, + * the actual FE object used may change + * from cell to cell, so we also need + * different FEValues objects for + * different cells; once you reinitialize + * the hpFEValues object for a specific + * cell, it retrieves the FEValues object + * for the FE on that cell and returns it + * through a function of the same name as + * this one; this function here therefore + * only provides the same interface so + * that one can templatize on + * FEValues/hpFEValues). */ -//TODO: explain reason const FEFaceValues & get_present_fe_values () const; private: @@ -1973,8 +2009,26 @@ class FESubfaceValues : public FEFaceValuesBase /** * Return a reference to this * very object. + * + * Though it seems that it is not very + * useful, this function is there to + * provide capability to the hpFEValues + * class, in which case it provides the + * FEValues object for the present cell + * (remember that for hp finite elements, + * the actual FE object used may change + * from cell to cell, so we also need + * different FEValues objects for + * different cells; once you reinitialize + * the hpFEValues object for a specific + * cell, it retrieves the FEValues object + * for the FE on that cell and returns it + * through a function of the same name as + * this one; this function here therefore + * only provides the same interface so + * that one can templatize on + * FEValues/hpFEValues). */ -//TODO: explain reason const FESubfaceValues & get_present_fe_values () const; /**