From 5e2c6a349777aabf776630b18819328b914812f9 Mon Sep 17 00:00:00 2001 From: Andrew Myers Date: Thu, 18 Jan 2024 16:27:22 -0800 Subject: [PATCH] convert to doxygen format --- Src/Particle/AMReX_TracerParticle_mod_K.H | 29 ++++++++++++----------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/Src/Particle/AMReX_TracerParticle_mod_K.H b/Src/Particle/AMReX_TracerParticle_mod_K.H index 677a3e1d9a2..31ecc55b27b 100644 --- a/Src/Particle/AMReX_TracerParticle_mod_K.H +++ b/Src/Particle/AMReX_TracerParticle_mod_K.H @@ -13,10 +13,9 @@ namespace amrex { -// -// cic_interpolate computes the mesh data at the particle position by linearly interpolating from data -// components all co-located at cell centers -// +/** + \brief Linearly interpolates the mesh data to the particle position from cell-centered data. +*/ template AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void cic_interpolate (const P& p, @@ -32,10 +31,9 @@ void cic_interpolate (const P& p, linear_interpolate_to_particle (p, plo, dxi, &data_arr, val, &is_nodal, start_comp, ncomp_per_array, num_arrays); } -// -// cic_interpolate_nd computes the mesh data at the particle position by interpolating from data -// components all co-located at nodes (cell corners) -// +/** + \brief Linearly interpolates the mesh data to the particle position from node-centered data. +*/ template AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void cic_interpolate_nd (const P& p, @@ -52,9 +50,10 @@ void cic_interpolate_nd (const P& p, } // -// mac_interpolate computes the mesh data at the particle position by interpolating from normal data components -// located at the face-centers of the cell the particle lives in -// +/** + \brief Linearly interpolates the mesh data to the particle position from face-centered data. + The nth component of the data_arr array is nodal in the nth direction, and cell-centered in the others. +*/ template AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void mac_interpolate (const P& p, @@ -75,9 +74,11 @@ void mac_interpolate (const P& p, } -// -// linear_interpolate_to_particle computes the data at the particle by interpolating from mesh data -// + +/** + \brief Linearly interpolates the mesh data to the particle position from mesh data. + This general form can handle an arbitrary number of Array4s, each with different staggerings. +*/ template AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void linear_interpolate_to_particle (const P& p,