From: Wolfgang Bangerth Date: Thu, 12 Jan 2006 03:26:48 +0000 (+0000) Subject: Rename function arguments. Learn how to use \pre X-Git-Tag: v8.0.0~12676 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f5a5c363ec74d69442f9e51ddbf77c80168dbeae;p=dealii.git Rename function arguments. Learn how to use \pre git-svn-id: https://svn.dealii.org/trunk@11986 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/fe/fe_collection.h b/deal.II/deal.II/include/fe/fe_collection.h index 837e9bc85c..da51dd009f 100644 --- a/deal.II/deal.II/include/fe/fe_collection.h +++ b/deal.II/deal.II/include/fe/fe_collection.h @@ -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 & get_fe (const unsigned int index) const; diff --git a/deal.II/deal.II/include/fe/mapping_collection.h b/deal.II/deal.II/include/fe/mapping_collection.h index 4ef23db561..462b2e71a8 100644 --- a/deal.II/deal.II/include/fe/mapping_collection.h +++ b/deal.II/deal.II/include/fe/mapping_collection.h @@ -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 & - get_mapping (const unsigned int active_fe_index) const; + get_mapping (const unsigned int index) const; /** * Determine an estimate for the diff --git a/deal.II/deal.II/include/fe/q_collection.h b/deal.II/deal.II/include/fe/q_collection.h index 625fca557c..c1a836c6a0 100644 --- a/deal.II/deal.II/include/fe/q_collection.h +++ b/deal.II/deal.II/include/fe/q_collection.h @@ -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 & - get_quadrature (const unsigned int active_fe_index) const; + get_quadrature (const unsigned int index) const; /** * Adds a new quadrature rule to the diff --git a/deal.II/deal.II/source/fe/mapping_collection.cc b/deal.II/deal.II/source/fe/mapping_collection.cc index f2086f5f9e..2d912c6992 100644 --- a/deal.II/deal.II/source/fe/mapping_collection.cc +++ b/deal.II/deal.II/source/fe/mapping_collection.cc @@ -37,15 +37,15 @@ namespace hp template inline const Mapping & - MappingCollection::get_mapping (const unsigned int active_fe_index) const + MappingCollection::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]; } } diff --git a/deal.II/deal.II/source/fe/q_collection.cc b/deal.II/deal.II/source/fe/q_collection.cc index 32e84e8edf..fdce94252d 100644 --- a/deal.II/deal.II/source/fe/q_collection.cc +++ b/deal.II/deal.II/source/fe/q_collection.cc @@ -41,7 +41,7 @@ namespace hp template inline const Quadrature & - QCollection::get_quadrature (const unsigned int active_fe_index) const + QCollection::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]; } }