diff options
Diffstat (limited to 'Source/Diagnostics/ComputeDiagFunctors/BackTransformParticleFunctor.H')
-rw-r--r-- | Source/Diagnostics/ComputeDiagFunctors/BackTransformParticleFunctor.H | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/Source/Diagnostics/ComputeDiagFunctors/BackTransformParticleFunctor.H b/Source/Diagnostics/ComputeDiagFunctors/BackTransformParticleFunctor.H index 39c70553a..4bb1b0656 100644 --- a/Source/Diagnostics/ComputeDiagFunctors/BackTransformParticleFunctor.H +++ b/Source/Diagnostics/ComputeDiagFunctors/BackTransformParticleFunctor.H @@ -30,6 +30,7 @@ struct SelectParticles * @param[in] tmp_particle_data temporary particle data * @param[in] current_z_boost current z-position of the slice in boosted frame * @param[in] old_z_boost previous z-position of the slice in boosted frame + * @param[in] a_offset index offset for particles to be selected */ SelectParticles( const WarpXParIter& a_pti, TmpParticles& tmp_particle_data, amrex::Real current_z_boost, amrex::Real old_z_boost, @@ -40,7 +41,8 @@ struct SelectParticles * for Lorentz transformation in obtaining the lab-frame data. The particles that * with positions that correspond to the specific z-slice in boosted frame are selected. * - * @param[in] SrcData particle tile data + * @tparam SrcData type of source data + * @param[in] src SrcData particle tile data * @param[in] i particle index * @return 1 if particles is selected for transformation, else 0 */ @@ -85,6 +87,7 @@ struct LorentzTransformParticles * @param[in] t_boost time in boosted frame * @param[in] dt timestep in boosted-frame * @param[in] t_lab time in lab-frame + * @param[in] a_offset index offset for particles to be transformed */ LorentzTransformParticles ( const WarpXParIter& a_pti, TmpParticles& tmp_particle_data, amrex::Real t_boost, amrex::Real dt, @@ -94,8 +97,8 @@ struct LorentzTransformParticles * \brief Functor call. This method computes the Lorentz-transform for particle * attributes to obtain the lab-frame snapshot data. * - * @param[out] DstData particle tile data that stores the transformed particle data - * @param[in] SrcData particle tile data that is selected for transformation + * @param[out] dst DstData particle tile data that stores the transformed particle data + * @param[in] src SrcData particle tile data that is selected for transformation * @param[in] i_src particle index of the source particles * @param[in] i_dst particle index of the target particles (transformed data). */ @@ -206,6 +209,7 @@ public: * \param[in] z_slice_in_domain 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 previous z-position of the slice 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 |