diff options
| author |  Axel Huebl <axel.huebl@plasma.ninja>
| 2021-12-16 00:17:04 -0800 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2021-12-16 08:17:04 +0000 |
| commit | 03ebb25b8d417dc8c02356b620403c548021db7f (patch) | |
| tree | 019528fa83a379c4bf5877a9c265b236a97cb5d8 /Source/Particles/Collision/BinaryCollision | |
| parent | 2a24ba13c214b3e4345529deecf627d6d113004e (diff) | |
| download | WarpX-03ebb25b8d417dc8c02356b620403c548021db7f.tar.gz WarpX-03ebb25b8d417dc8c02356b620403c548021db7f.tar.zst WarpX-03ebb25b8d417dc8c02356b620403c548021db7f.zip | |
Doxygen: Fix Diags, FieldSolver, Parallelization & Particles (#2662)
* Doxygen: Fix Diags, FieldSolver, Parallelization & Particles
* Apply suggestions: Remi
Co-authored-by: Remi Lehe <remi.lehe@normalesup.org>
* Apply suggestions: Roelof
Co-authored-by: Roelof Groenewald <40245517+roelof-groenewald@users.noreply.github.com>
* Apply suggestions: Luca
Co-authored-by: Luca Fedeli <luca.fedeli@for.unipi.it>
* Apply suggestions: Edoardo
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
* Apply suggestions: Andrew
* Apply suggestions: Edoardo
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
* Apply suggestions: Neil
Co-authored-by: Neïl Zaim <49716072+NeilZaim@users.noreply.github.com>
* Apply suggestions: Roelof
* Apply suggestions: Weiqun
Co-authored-by: Weiqun Zhang <WeiqunZhang@lbl.gov>
Co-authored-by: Remi Lehe <remi.lehe@normalesup.org>
Co-authored-by: Roelof Groenewald <40245517+roelof-groenewald@users.noreply.github.com>
Co-authored-by: Luca Fedeli <luca.fedeli@for.unipi.it>
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
Co-authored-by: Neïl Zaim <49716072+NeilZaim@users.noreply.github.com>
Co-authored-by: Weiqun Zhang <WeiqunZhang@lbl.gov>
Diffstat (limited to 'Source/Particles/Collision/BinaryCollision')
| -rw-r--r-- | Source/Particles/Collision/BinaryCollision/NuclearFusionFunc.H | 8 | ||||
| -rw-r--r-- | Source/Particles/Collision/BinaryCollision/PairWiseCoulombCollisionFunc.H | 7 |
2 files changed, 8 insertions, 7 deletions
diff --git a/Source/Particles/Collision/BinaryCollision/NuclearFusionFunc.H b/Source/Particles/Collision/BinaryCollision/NuclearFusionFunc.H index 895254ed3..b42c5d447 100644 --- a/Source/Particles/Collision/BinaryCollision/NuclearFusionFunc.H +++ b/Source/Particles/Collision/BinaryCollision/NuclearFusionFunc.H @@ -110,16 +110,16 @@ public: * * @param[in] I1s,I2s is the start index for I1,I2 (inclusive). * @param[in] I1e,I2e is the stop index for I1,I2 (exclusive). - * @param[in] I1 and I2 are the index arrays. They determine all elements that will be used. - * @param[in] soa_1 and soa_2 contain the struct of array data of the two species - * @param[in] m1 and m2 are masses. + * @param[in] I1,I2 index arrays. They determine all elements that will be used. + * @param[in] soa_1,soa_2 contain the struct of array data of the two species + * @param[in] m1,m2 are masses. * @param[in] dt is the time step length between two collision calls. * @param[in] dV is the volume of the corresponding cell. * @param[in] cell_start_pair is the start index of the pairs in that cell. * @param[out] p_mask is a mask that will be set to true if a fusion event occurs for a given * pair. It is only needed here to store information that will be used later on when actually * creating the product particles. - * @param[out] p_pair_indices_1 and p_pair_indices_2 are arrays that store the indices of the + * @param[out] p_pair_indices_1,p_pair_indices_2 arrays that store the indices of the * particles of a given pair. They are only needed here to store information that will be used * later on when actually creating the product particles. * @param[out] p_pair_reaction_weight stores the weight of the product particles. It is only diff --git a/Source/Particles/Collision/BinaryCollision/PairWiseCoulombCollisionFunc.H b/Source/Particles/Collision/BinaryCollision/PairWiseCoulombCollisionFunc.H index 623acc6da..892fffa4f 100644 --- a/Source/Particles/Collision/BinaryCollision/PairWiseCoulombCollisionFunc.H +++ b/Source/Particles/Collision/BinaryCollision/PairWiseCoulombCollisionFunc.H @@ -58,9 +58,10 @@ public: * * @param[in] I1s,I2s is the start index for I1,I2 (inclusive). * @param[in] I1e,I2e is the stop index for I1,I2 (exclusive). - * @param[in] I1 and I2 are the index arrays. They determine all elements that will be used. - * @param[in, out] soa_1 and soa_2 contain the struct of array data of the two species. - * @param[in] q1 and q2 are charges. m1 and m2 are masses. + * @param[in] I1,I2 index arrays. They determine all elements that will be used. + * @param[in,out] soa_1,soa_2 contain the struct of array data of the two species. + * @param[in] q1,q2 are charges. + * @param[in] m1,m2 are masses. * @param[in] dt is the time step length between two collision calls. * @param[in] dV is the volume of the corresponding cell. * @param[in] engine the random engine. |