diff options
author | 2022-12-19 05:43:16 -0800 | |
---|---|---|
committer | 2022-12-19 14:43:16 +0100 | |
commit | c3eb6ea1efeff3910e8520d94e260d94367d68f7 (patch) | |
tree | af59d4a61a92fc602ca224e0fdd45685960de433 /Source/Diagnostics/ComputeDiagFunctors/ComputeParticleDiagFunctor.H | |
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/Diagnostics/ComputeDiagFunctors/ComputeParticleDiagFunctor.H')
-rw-r--r-- | Source/Diagnostics/ComputeDiagFunctors/ComputeParticleDiagFunctor.H | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Source/Diagnostics/ComputeDiagFunctors/ComputeParticleDiagFunctor.H b/Source/Diagnostics/ComputeDiagFunctors/ComputeParticleDiagFunctor.H index a76cde936..e14e777e0 100644 --- a/Source/Diagnostics/ComputeDiagFunctors/ComputeParticleDiagFunctor.H +++ b/Source/Diagnostics/ComputeDiagFunctors/ComputeParticleDiagFunctor.H @@ -30,9 +30,10 @@ public: * back-transformed diagnostics, that are unused for regular diagnostics. * * \param[in] i_buffer index of the snapshot - * \param[in] z_slice_in_domain if the z-slice at current_z_boost is within the bounds of + * \param[in] ZSliceInDomain if the z-slice at current_z_boost is within the bounds of * the boosted-frame and lab-frame domain. The particles are transformed * only if this value is true. + * \param[in] old_z_boost old z co-ordinate of the slice selected in boosted-frame. * \param[in] current_z_boost z co-ordinate of the slice selected in boosted-frame. * \param[in] t_lab current time in lab-frame for snapshot, i_buffer. * \param[in] snapshot_full if the current snapshot, with index, i_buffer, is @@ -50,6 +51,7 @@ public: } /** Compute particle attributes and store the result in pc_dst particle container. * \param[out] pc_dst output particle container where the result is stored. + * \param[out] totalParticlesInBuffer total number of particles in the container * \param[in] i_buffer snapshot index for which the particle buffer is processed */ virtual void operator () (PinnedMemoryParticleContainer& pc_dst, int &totalParticlesInBuffer, int i_buffer = 0) const = 0; |