From 8f06ff9771cedf6adf9360d5d1aa2667fcc03bc0 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Sat, 20 Jul 2019 09:55:34 -0400 Subject: [PATCH] improve CellDataStorage documentation --- include/deal.II/base/quadrature_point_data.h | 24 +++++++++++++------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/include/deal.II/base/quadrature_point_data.h b/include/deal.II/base/quadrature_point_data.h index 7c9a64d2d6..f0a08bd99b 100644 --- a/include/deal.II/base/quadrature_point_data.h +++ b/include/deal.II/base/quadrature_point_data.h @@ -46,7 +46,11 @@ DEAL_II_NAMESPACE_OPEN * The underlying structure and the initialize() method of this class are * designed in such a way that one could use different child classes derived * from the base DataType class to store data on a given cell. This implies the - * usage of pointers, in our case -- std::shared_ptr(). + * usage of pointers, in our case -- std::shared_ptr. + * + * The type @p DataType is arbitrary, but when using a class derived from + * TransferableQuadraturePointData one can use the facilities of + * parallel::distributed::ContinuousQuadratureDataTransfer. * * @note The data type stored on each cell can be different. * However, within the cell this class stores a vector of objects of a single @@ -176,7 +180,11 @@ private: * The transfer of quadrature point data between parent and child cells requires * some kind of projection and/or interpolation. * One possible implementation is via the L2 projection and prolongation - * matrices as implemented in ContinuousQuadratureDataTransfer class. + * matrices as implemented in + * parallel::distributed::ContinuousQuadratureDataTransfer class. + * + * To store and access instances of classes derived from this class, see the + * CellDataStorage class. * * @author Denis Davydov, Jean-Paul Pelteret, 2016 */ @@ -281,16 +289,16 @@ namespace parallel * // a function to pack scalars into a vector * void pack_values(std::vector &values) const * { - * Assert (scalars.size()==2, ExcInternalError()); - * scalars[0] = elasticity_parameter_lambda; - * scalars[1] = elasticity_parameter_mu; + * Assert (values.size()==2, ExcInternalError()); + * values[0] = elasticity_parameter_lambda; + * values[1] = elasticity_parameter_mu; * } * * void unpack_values(const std::vector &values) * { - * Assert (scalars.size() ==2, ExcInternalError()); - * elasticity_parameter_lambda = scalars[0]; - * elasticity_parameter_mu = scalars[1]; + * Assert (values.size() ==2, ExcInternalError()); + * elasticity_parameter_lambda = values[0]; + * elasticity_parameter_mu = values[1]; * } * }; * @endcode -- 2.39.5