]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Augment documentation.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 13 Aug 2012 08:27:12 +0000 (08:27 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 13 Aug 2012 08:27:12 +0000 (08:27 +0000)
git-svn-id: https://svn.dealii.org/trunk@25923 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/include/deal.II/hp/fe_collection.h

index 1255ea88cab9b3f854b87ff7f3249882ea6927b9..cfe276996492b5690f3e3db97fbfc431056e93d7 100644 (file)
@@ -116,6 +116,11 @@ namespace hp
                                         * this collection.  This number must
                                         * be the same for all elements in the
                                         * collection.
+                                       *
+                                       * This function calls
+                                       * FiniteElement::n_components.  See
+                                       * @ref GlossComponent "the glossary"
+                                       * for more information.
                                         */
       unsigned int n_components () const;
 
@@ -236,6 +241,15 @@ namespace hp
   FECollection<dim,spacedim>::n_components () const
   {
     Assert (finite_elements.size () > 0, ExcNoFiniteElements());
+
+                                    // note that there is no need
+                                    // here to enforce that indeed
+                                    // all elements have the same
+                                    // number of components since we
+                                    // have already done this when
+                                    // adding a new element to the
+                                    // collection.
+
     return finite_elements[0]->n_components ();
   }
 

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.