]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Doc update.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 19 Dec 2005 15:33:39 +0000 (15:33 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 19 Dec 2005 15:33:39 +0000 (15:33 +0000)
git-svn-id: https://svn.dealii.org/trunk@11874 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/fe/fe.h

index 0a1bd5e55d91d83a0b70374e40eaedb07920f237..39b4dcb368645d0ac7378c069938f2ee8c79f8e7 100644 (file)
@@ -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<unsigned int, unsigned int>
     face_system_to_component_index (const unsigned int index) const;

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.