diff options
Diffstat (limited to 'Source/Particles/Pusher')
-rw-r--r-- | Source/Particles/Pusher/GetAndSetPosition.H | 8 | ||||
-rw-r--r-- | Source/Particles/Pusher/UpdateMomentumBoris.H | 2 | ||||
-rw-r--r-- | Source/Particles/Pusher/UpdateMomentumVay.H | 2 | ||||
-rw-r--r-- | Source/Particles/Pusher/UpdatePosition.H | 2 | ||||
-rw-r--r-- | Source/Particles/Pusher/UpdatePositionPhoton.H | 6 |
5 files changed, 11 insertions, 9 deletions
diff --git a/Source/Particles/Pusher/GetAndSetPosition.H b/Source/Particles/Pusher/GetAndSetPosition.H index f0dfa4c83..ae73a74e4 100644 --- a/Source/Particles/Pusher/GetAndSetPosition.H +++ b/Source/Particles/Pusher/GetAndSetPosition.H @@ -7,7 +7,7 @@ #ifndef WARPX_DIM_RZ -/* \brief Extract the particle's coordinates from the ParticleType struct `p`, +/** \brief Extract the particle's coordinates from the ParticleType struct `p`, * and stores them in the variables `x`, `y`, `z`. */ AMREX_GPU_HOST_DEVICE AMREX_INLINE void GetPosition( @@ -25,7 +25,7 @@ void GetPosition( #endif } -/* \brief Set the particle's coordinates in the ParticleType struct `p`, +/** \brief Set the particle's coordinates in the ParticleType struct `p`, * from their values in the variables `x`, `y`, `z`. */ AMREX_GPU_HOST_DEVICE AMREX_INLINE void SetPosition( @@ -44,7 +44,7 @@ void SetPosition( # elif defined WARPX_DIM_RZ -/* \brief Extract the particle's coordinates from `theta` and the attributes +/** \brief Extract the particle's coordinates from `theta` and the attributes * of the ParticleType struct `p` (which contains the radius), * and store them in the variables `x`, `y`, `z` */ AMREX_GPU_HOST_DEVICE AMREX_INLINE @@ -58,7 +58,7 @@ void GetCartesianPositionFromCylindrical( z = p.pos(1); } -/* \brief Set the particle's cylindrical coordinates by setting `theta` +/** \brief Set the particle's cylindrical coordinates by setting `theta` * and the attributes of the ParticleType struct `p` (which stores the radius), * from the values of `x`, `y`, `z` */ AMREX_GPU_HOST_DEVICE AMREX_INLINE diff --git a/Source/Particles/Pusher/UpdateMomentumBoris.H b/Source/Particles/Pusher/UpdateMomentumBoris.H index 205cc9a71..160f38ade 100644 --- a/Source/Particles/Pusher/UpdateMomentumBoris.H +++ b/Source/Particles/Pusher/UpdateMomentumBoris.H @@ -3,7 +3,7 @@ #include <AMReX_REAL.H> -/* \brief Push the particle's positions over one timestep, +/** \brief Push the particle's positions over one timestep, * given the value of its momenta `ux`, `uy`, `uz` */ AMREX_GPU_HOST_DEVICE AMREX_INLINE void UpdateMomentumBoris( diff --git a/Source/Particles/Pusher/UpdateMomentumVay.H b/Source/Particles/Pusher/UpdateMomentumVay.H index 433a891c5..f7ec79d89 100644 --- a/Source/Particles/Pusher/UpdateMomentumVay.H +++ b/Source/Particles/Pusher/UpdateMomentumVay.H @@ -5,7 +5,7 @@ #include <WarpXConst.H> #include <AMReX_REAL.H> -/* \brief Push the particle's positions over one timestep, +/** \brief Push the particle's positions over one timestep, * given the value of its momenta `ux`, `uy`, `uz` */ AMREX_GPU_HOST_DEVICE AMREX_INLINE void UpdateMomentumVay( diff --git a/Source/Particles/Pusher/UpdatePosition.H b/Source/Particles/Pusher/UpdatePosition.H index da0e9cdf9..9943128f1 100644 --- a/Source/Particles/Pusher/UpdatePosition.H +++ b/Source/Particles/Pusher/UpdatePosition.H @@ -5,7 +5,7 @@ #include <WarpXConst.H> #include <AMReX_REAL.H> -/* \brief Push the particle's positions over one timestep, +/** \brief Push the particle's positions over one timestep, * given the value of its momenta `ux`, `uy`, `uz` */ AMREX_GPU_HOST_DEVICE AMREX_INLINE void UpdatePosition( diff --git a/Source/Particles/Pusher/UpdatePositionPhoton.H b/Source/Particles/Pusher/UpdatePositionPhoton.H index f95c2b09d..1a0bd114f 100644 --- a/Source/Particles/Pusher/UpdatePositionPhoton.H +++ b/Source/Particles/Pusher/UpdatePositionPhoton.H @@ -6,8 +6,10 @@ #include <AMReX_FArrayBox.H> #include <AMReX_REAL.H> -/* \brief Push the position of a photon particle over one timestep, - * given the value of its momenta `ux`, `uy`, `uz` */ +/** + * \brief Push the position of a photon particle over one timestep, + * given the value of its momenta `ux`, `uy`, `uz` + */ AMREX_GPU_HOST_DEVICE AMREX_INLINE void UpdatePositionPhoton( amrex::ParticleReal& x, amrex::ParticleReal& y, amrex::ParticleReal& z, |