From c9747d174f99e14ee7ff9b1a04f23284e73b5526 Mon Sep 17 00:00:00 2001 From: Rene Gassmoeller Date: Fri, 9 Aug 2019 14:24:19 -0600 Subject: [PATCH] Add documentation --- include/deal.II/particles/particle_handler.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/include/deal.II/particles/particle_handler.h b/include/deal.II/particles/particle_handler.h index 75797dd875..d7e300d325 100644 --- a/include/deal.II/particles/particle_handler.h +++ b/include/deal.II/particles/particle_handler.h @@ -40,10 +40,26 @@ namespace Particles { namespace internal { + /** + * This function packs a vector of particles into a vector + * of bytes. If there are properties associated with the + * particles they are also serialized. The function does + * not perform compression, but is faster + * than the corresponding function Utilities::pack(). + */ template std::vector pack_particles(std::vector> &particles); + /** + * This function unpacks a vector of bytes into a vector + * of particles. It assumes the vector of bytes was created + * with the pack_particles() function above. If the particles + * had properties when they were serialized this function + * requires an additional argument that is a PropertyPool + * object with the correct number of properties per particle + * to be able to correctly unpack the particles. + */ template std::vector> unpack_particles( -- 2.39.5