From: Wolfgang Bangerth Date: Mon, 19 Dec 2005 15:33:39 +0000 (+0000) Subject: Doc update. X-Git-Tag: v8.0.0~12772 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1776305bb8ae38673724b35c6ccd91fdc6827779;p=dealii.git Doc update. git-svn-id: https://svn.dealii.org/trunk@11874 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/fe/fe.h b/deal.II/deal.II/include/fe/fe.h index 0a1bd5e55d..39b4dcb368 100644 --- a/deal.II/deal.II/include/fe/fe.h +++ b/deal.II/deal.II/include/fe/fe.h @@ -925,9 +925,22 @@ class FiniteElement : public Subscriptor, const unsigned int index) const; /** - * Same as above, but do it for - * shape functions and their - * indices on a face. + * Same as + * system_to_component_index(), + * but do it for shape functions + * and their indices on a + * face. The range of allowed + * indices is therefore + * 0..dofs_per_face. + * + * You will rarely need this + * function in application + * programs, since almost all + * application codes only need to + * deal with cell indices, not + * face indices. The function is + * mainly there for use inside + * the library. */ std::pair face_system_to_component_index (const unsigned int index) const;