diff options
| author |  David Grote <grote1@llnl.gov>
| 2022-12-19 05:43:16 -0800 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-12-19 14:43:16 +0100 |
| commit | c3eb6ea1efeff3910e8520d94e260d94367d68f7 (patch) | |
| tree | af59d4a61a92fc602ca224e0fdd45685960de433 /Source/Utils | |
| parent | 4913d07348eeed38263745a47ffe3a9f9a680076 (diff) | |
| download | WarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.tar.gz WarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.tar.zst WarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.zip | |
Clean up documentation (#3542)
* Fix comments for documentation
* More fixes to comments for documentation
* Fixes in the doc files
* Fix typo in parameters.rst
Diffstat (limited to 'Source/Utils')
| -rw-r--r-- | Source/Utils/Parser/IntervalsParser.H | 1 | ||||
| -rw-r--r-- | Source/Utils/ParticleUtils.H | 5 |
2 files changed, 4 insertions, 2 deletions
diff --git a/Source/Utils/Parser/IntervalsParser.H b/Source/Utils/Parser/IntervalsParser.H index f590139b3..329e114bb 100644 --- a/Source/Utils/Parser/IntervalsParser.H +++ b/Source/Utils/Parser/IntervalsParser.H @@ -31,6 +31,7 @@ namespace utils::parser * Any of these integers may be omitted in which case it will be equal to their default value * (0 for the starting point, std::numeric_limits<int>::max() for the stopping point and 1 for * the period). For example SliceParser(":1000:") is equivalent to SliceParser("0:1000:1"). + * @param[in] isBTD whether this is a back-transformed diagnostic */ SliceParser (const std::string& instr, bool isBTD=false); diff --git a/Source/Utils/ParticleUtils.H b/Source/Utils/ParticleUtils.H index a997412f6..621f9725b 100644 --- a/Source/Utils/ParticleUtils.H +++ b/Source/Utils/ParticleUtils.H @@ -60,6 +60,7 @@ namespace ParticleUtils { * * @param[in] u2 square of particle speed (i.e. u dot u where u = gamma*v) * @param[in] m, M mass of projectile and target, respectively + * @param[out] gamma relativistic factor of the particle * @param[out] energy particle energy in eV */ AMREX_GPU_HOST_DEVICE AMREX_INLINE @@ -82,7 +83,7 @@ namespace ParticleUtils { * \brief Perform a Lorentz transformation of the given velocity * to a frame moving with velocity (Vx, Vy, Vz) relative to the present one. * - * @param[in/out] ux,uy,uz components of velocity vector in the current + * @param[in,out] ux,uy,uz components of velocity vector in the current frame - importantly these quantities are gamma * velocity * @param[in] Vx,Vy,Vz velocity of the new frame relative to the current one, NOT gamma*velocity! @@ -150,7 +151,7 @@ namespace ParticleUtils { * random velocity vector with given magnitude. This is used in isotropic * collision events. * - * @param[in/out] ux, uy, uz colliding particle's velocity + * @param[in,out] ux, uy, uz colliding particle's velocity * @param[in] vp velocity magnitude of the colliding particle after collision. * @param[in] engine the random-engine */ |