aboutsummaryrefslogtreecommitdiff
path: root/Source/Particles/PhysicalParticleContainer.H
diff options
context:
space:
mode:
authorGravatar RevathiJambunathan <revanathan@gmail.com> 2020-01-15 12:15:34 -0800
committerGravatar RevathiJambunathan <revanathan@gmail.com> 2020-01-15 12:15:34 -0800
commit262de3a369647eac5820c79b010e94865b280db8 (patch)
tree7ece4d9506ef02915930d4e44e99e2020cc9bddc /Source/Particles/PhysicalParticleContainer.H
parentca070b083c4fa5cc2db2428da801b3b55501d60c (diff)
downloadWarpX-262de3a369647eac5820c79b010e94865b280db8.tar.gz
WarpX-262de3a369647eac5820c79b010e94865b280db8.tar.zst
WarpX-262de3a369647eac5820c79b010e94865b280db8.zip
changes as suggested in review.
Diffstat (limited to 'Source/Particles/PhysicalParticleContainer.H')
-rw-r--r--Source/Particles/PhysicalParticleContainer.H5
1 files changed, 3 insertions, 2 deletions
diff --git a/Source/Particles/PhysicalParticleContainer.H b/Source/Particles/PhysicalParticleContainer.H
index 8867778f7..74d1a0f62 100644
--- a/Source/Particles/PhysicalParticleContainer.H
+++ b/Source/Particles/PhysicalParticleContainer.H
@@ -53,8 +53,9 @@ public:
* in a mathematical expression. The default value for the E- and B-fields
* is (0.0,0.0,0.0).
*
- * \param Exp-Bzp: fields on particles modified based on external E and B
- * \param xp,yp,zp: arrays of particle positions required to compute
+ * \param[in,out] Exp-Bzp pointer to fields on particles modified based
+ * on external E and B
+ * \param[in] xp,yp,zp arrays of particle positions required to compute
* mathematical expression for the external fields
* using parser.
*/