]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Rename function arguments. Learn how to use \pre
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 12 Jan 2006 03:26:48 +0000 (03:26 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 12 Jan 2006 03:26:48 +0000 (03:26 +0000)
git-svn-id: https://svn.dealii.org/trunk@11986 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/fe/fe_collection.h
deal.II/deal.II/include/fe/mapping_collection.h
deal.II/deal.II/include/fe/q_collection.h
deal.II/deal.II/source/fe/mapping_collection.cc
deal.II/deal.II/source/fe/q_collection.cc

index 837e9bc85cb0ebf11f4f7c83308b76842fe70be5..da51dd009f37cd027bce55c2ace149cfa993aef6 100644 (file)
@@ -66,6 +66,10 @@ namespace hp
                                        /**
                                         * Get a reference to the given element
                                         * in this collection.
+                                        *
+                                        * \pre @p index must be between zero
+                                        * and the number of elements of the
+                                        * collection.
                                         */
       const FiniteElement<dim> &
       get_fe (const unsigned int index) const;
index 4ef23db561ae32a7f023b3f7b70b42ec94eded68..462b2e71a87dcd18d0807773b8207a917819bad3 100644 (file)
@@ -75,9 +75,13 @@ namespace hp
                                         * was specified by the user for the
                                         * active_fe_index which is provided
                                         * as a parameter to this method.
+                                        *
+                                        * \pre @p index must be between zero
+                                        * and the number of elements of the
+                                        * collection.
                                         */
       const Mapping<dim> &
-      get_mapping (const unsigned int active_fe_index) const;
+      get_mapping (const unsigned int index) const;
     
                                        /**
                                         * Determine an estimate for the
index 625fca557ce31821b9711224970d0233cd0c4903..c1a836c6a094eb253804ed6e04e62191808d32ed 100644 (file)
@@ -64,13 +64,15 @@ namespace hp
 
                                        /**
                                         * Returns a reference to the
-                                        * quadrature rule which was specified
-                                        * by the user for the active_fe_index
-                                        * which is provided as a parameter to
-                                        * this method.
+                                        * quadrature rule specified by the
+                                        * argument.
+                                        *
+                                        * \pre @p index must be between zero
+                                        * and the number of elements of the
+                                        * collection.
                                         */
       const Quadrature<dim> &
-      get_quadrature (const unsigned int active_fe_index) const;
+      get_quadrature (const unsigned int index) const;
 
                                        /**
                                         * Adds a new quadrature rule to the
index f2086f5f9e1cb0b2045a5aec9b7108b643ad1315..2d912c6992c12b7343fd210d683e21c3a05c2a84 100644 (file)
@@ -37,15 +37,15 @@ namespace hp
   template <int dim>
   inline
   const Mapping<dim> &
-  MappingCollection<dim>::get_mapping (const unsigned int active_fe_index) const
+  MappingCollection<dim>::get_mapping (const unsigned int index) const
   {
     if (single_mapping)
       return *mappings[0];
     else
       {
-       Assert (active_fe_index < mappings.size (),
-               ExcIndexRange (active_fe_index, 0, mappings.size ()));
-       return *mappings[active_fe_index];
+       Assert (index < mappings.size (),
+               ExcIndexRange (index, 0, mappings.size ()));
+       return *mappings[index];
       }
   }
 
index 32e84e8edfc9e64dd65674cb5c96a4fdcdbc10c0..fdce94252d9f5385c9f4e6c87d7aa02c65530c8d 100644 (file)
@@ -41,7 +41,7 @@ namespace hp
   template <int dim>
   inline
   const Quadrature<dim> &
-  QCollection<dim>::get_quadrature (const unsigned int active_fe_index) const
+  QCollection<dim>::get_quadrature (const unsigned int index) const
   {
                                      // if we have only a single quadrature
                                      // that was given during construction,
@@ -51,9 +51,9 @@ namespace hp
       return *quadratures[0];
     else
       {
-       Assert (active_fe_index < quadratures.size (),
-               ExcIndexRange (active_fe_index, 0, quadratures.size ()));
-       return *quadratures[active_fe_index];
+       Assert (index < quadratures.size (),
+               ExcIndexRange (index, 0, quadratures.size ()));
+       return *quadratures[index];
       }
   }
 

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.