]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update documentation 12931/head
authorRene Gassmoeller <rene.gassmoeller@mailbox.org>
Fri, 12 Nov 2021 17:05:07 +0000 (12:05 -0500)
committerRene Gassmoeller <rene.gassmoeller@mailbox.org>
Fri, 12 Nov 2021 17:05:07 +0000 (12:05 -0500)
include/deal.II/particles/particle_handler.h

index ea42cb7618ab7edf910a9dfcb56fb691fe0bb397..ba6a23d947cb2a9c6a94bdf82da19f92a0255833 100644 (file)
@@ -289,9 +289,18 @@ namespace Particles
 
     /**
      * Insert a particle into the collection of particles given all the
-     * properties necessary for a particle. This function is used internally to
+     * properties necessary for creating a particle. This function is used to
      * efficiently generate particles without the detour through a Particle
      * object.
+     *
+     * @param[in] position Initial position of the particle in real space.
+     * @param[in] reference_position Initial position of the particle
+     * in the coordinate system of the reference cell.
+     * @param[in] particle_index Globally unique identifier for this particle.
+     * @param[in] cell The cell in which the particle is located.
+     * @param[in] properties An optional ArrayView that describes the
+     * particle properties. If given this has to be of size
+     * n_properties_per_particle().
      */
     particle_iterator
     insert_particle(

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.