From: Wolfgang Bangerth Date: Wed, 2 Sep 2015 15:56:45 +0000 (-0500) Subject: Update documentation of Mapping::transform() functions. X-Git-Tag: v8.4.0-rc2~487^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3a3cda21e85862efe711edf4d3be4c1c5c038674;p=dealii.git Update documentation of Mapping::transform() functions. --- diff --git a/include/deal.II/fe/mapping.h b/include/deal.II/fe/mapping.h index 6e7eefce2d..18b33925cc 100644 --- a/include/deal.II/fe/mapping.h +++ b/include/deal.II/fe/mapping.h @@ -907,6 +907,20 @@ public: * J(\mathbf x) \hat{\mathbf u}(\mathbf x). * @f] * + * + * @param[in] input An array (or part of an array) of input objects that should + * be mapped. + * @param[in] type The kind of mapping to be applied. + * @param[in] internal A pointer to an object of type Mapping::InternalDataBase + * that contains information previously stored by the mapping. The object + * pointed to was created by the get_data(), get_face_data(), or + * get_subface_data() function, and will have been updated as part of a + * call to fill_fe_values(), fill_fe_face_values(), or fill_fe_subface_values() + * for the current cell, before calling the current function. In other words, + * this object also represents with respect to which cell the transformation + * should be applied to. + * @param[out] output An array (or part of an array) into which the transformed + * objects should be placed. */ virtual void @@ -939,12 +953,27 @@ public: * J(\hat{\mathbf x})^{-1}. * @f] * + * * @note It would have been more reasonable to make this transform a * template function with the rank in DerivativeForm@<1, dim, * rank@>. Unfortunately C++ does not allow templatized virtual * functions. This is why we identify DerivativeForm@<1, dim, * 1@> with a Tensor@<1,dim@> when using * mapping_covariant() in the function transform() above this one. + * + * @param[in] input An array (or part of an array) of input objects that should + * be mapped. + * @param[in] type The kind of mapping to be applied. + * @param[in] internal A pointer to an object of type Mapping::InternalDataBase + * that contains information previously stored by the mapping. The object + * pointed to was created by the get_data(), get_face_data(), or + * get_subface_data() function, and will have been updated as part of a + * call to fill_fe_values(), fill_fe_face_values(), or fill_fe_subface_values() + * for the current cell, before calling the current function. In other words, + * this object also represents with respect to which cell the transformation + * should be applied to. + * @param[out] output An array (or part of an array) into which the transformed + * objects should be placed. */ virtual void @@ -984,11 +1013,26 @@ public: * J(\hat{\mathbf x})^{-1}. * @f] * + * * @todo The formulas for mapping_covariant_gradient, * mapping_contravariant_gradient and mapping_piola_gradient are only * true as stated for linear mappings. If, for example, the mapping is * bilinear (or has a higher order polynomial degree) then there is a * missing term associated with the derivative of $J$. + * + * @param[in] input An array (or part of an array) of input objects that should + * be mapped. + * @param[in] type The kind of mapping to be applied. + * @param[in] internal A pointer to an object of type Mapping::InternalDataBase + * that contains information previously stored by the mapping. The object + * pointed to was created by the get_data(), get_face_data(), or + * get_subface_data() function, and will have been updated as part of a + * call to fill_fe_values(), fill_fe_face_values(), or fill_fe_subface_values() + * for the current cell, before calling the current function. In other words, + * this object also represents with respect to which cell the transformation + * should be applied to. + * @param[out] output An array (or part of an array) into which the transformed + * objects should be placed. */ virtual void @@ -1019,6 +1063,20 @@ public: * * In the case when dim=spacedim the previous formula reduces to * @f[J^{\dagger} = J^{-1}@f] + * + * @param[in] input An array (or part of an array) of input objects that should + * be mapped. + * @param[in] type The kind of mapping to be applied. + * @param[in] internal A pointer to an object of type Mapping::InternalDataBase + * that contains information previously stored by the mapping. The object + * pointed to was created by the get_data(), get_face_data(), or + * get_subface_data() function, and will have been updated as part of a + * call to fill_fe_values(), fill_fe_face_values(), or fill_fe_subface_values() + * for the current cell, before calling the current function. In other words, + * this object also represents with respect to which cell the transformation + * should be applied to. + * @param[out] output An array (or part of an array) into which the transformed + * objects should be placed. */ virtual void @@ -1059,6 +1117,20 @@ public: * J_{jJ}(\hat{\mathbf x})^{-1} J_{kK}(\hat{\mathbf x})^{-1}. * @f] * + * + * @param[in] input An array (or part of an array) of input objects that should + * be mapped. + * @param[in] type The kind of mapping to be applied. + * @param[in] internal A pointer to an object of type Mapping::InternalDataBase + * that contains information previously stored by the mapping. The object + * pointed to was created by the get_data(), get_face_data(), or + * get_subface_data() function, and will have been updated as part of a + * call to fill_fe_values(), fill_fe_face_values(), or fill_fe_subface_values() + * for the current cell, before calling the current function. In other words, + * this object also represents with respect to which cell the transformation + * should be applied to. + * @param[out] output An array (or part of an array) into which the transformed + * objects should be placed. */ virtual void diff --git a/include/deal.II/fe/mapping_q.h b/include/deal.II/fe/mapping_q.h index 35252a8a48..9577b13868 100644 --- a/include/deal.II/fe/mapping_q.h +++ b/include/deal.II/fe/mapping_q.h @@ -114,10 +114,10 @@ public: * whether the exception mentioned above has been thrown. */ virtual Point - transform_real_to_unit_cell ( - const typename Triangulation::cell_iterator &cell, - const Point &p) const; + transform_real_to_unit_cell (const typename Triangulation::cell_iterator &cell, + const Point &p) const; + // for documentation, see the base classes virtual void transform (const VectorSlice > > input, @@ -125,6 +125,7 @@ public: const typename Mapping::InternalDataBase &internal, VectorSlice > > output) const; + // for documentation, see the base classes virtual void transform (const VectorSlice > > input, @@ -132,6 +133,7 @@ public: const typename Mapping::InternalDataBase &internal, VectorSlice > > output) const; + // for documentation, see the base classes virtual void transform (const VectorSlice > > input,