Skip to content

Commit

Permalink
fixup: doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
streeve committed May 2, 2024
1 parent 8b5029f commit 96a0bc1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
5 changes: 4 additions & 1 deletion core/src/Cabana_LinkedCellList.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -584,7 +584,10 @@ class LinkedCellList
_cell_stencil.getCells( cell, imin, imax, jmin, jmax, kmin, kmax );
}

// Get a candidate neighbor particle at a given binned offset.
/*!
\brief Get a candidate neighbor particle at a given binned offset.
\param offset Particle offset in the binned layout.
*/
KOKKOS_INLINE_FUNCTION
auto getParticle( const int offset ) const
{
Expand Down
16 changes: 8 additions & 8 deletions core/src/Cabana_Parallel.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -1357,9 +1357,9 @@ struct LinkedCellParallelReduce
\param exec_policy The policy over which to execute the functor.
\param functor The functor to execute in parallel
\param list The linked cell list over which to execute neighbor operations.
\param FirstNeighborsTag Tag indicating operations over particle first
\note FirstNeighborsTag Tag indicating operations over particle first
neighbors.
\param SerialOpTag Tag indicating a serial loop strategy over neighbors.
\note SerialOpTag Tag indicating a serial loop strategy over neighbors.
\param str Optional name for the functor. Will be forwarded if non-empty to
the Kokkos::parallel_for called by this code and can be used for
identification and profiling purposes.
Expand Down Expand Up @@ -1428,9 +1428,9 @@ inline void neighbor_parallel_for(
\param exec_policy The policy over which to execute the functor.
\param functor The functor to execute in parallel
\param list The linked cell list over which to execute neighbor operations.
\param FirstNeighborsTag Tag indicating operations over particle first
\note FirstNeighborsTag Tag indicating operations over particle first
neighbors.
\param TeamOpTag Tag indicating a team parallel strategy over particle
\note TeamOpTag Tag indicating a team parallel strategy over particle
neighbors.
\param str Optional name for the functor. Will be forwarded if non-empty to
the Kokkos::parallel_for called by this code and can be used for
Expand Down Expand Up @@ -1482,9 +1482,9 @@ inline void neighbor_parallel_for(
\param exec_policy The policy over which to execute the functor.
\param functor The functor to execute in parallel
\param list The linked cell list over which to execute neighbor operations.
\param FirstNeighborsTag Tag indicating operations over particle first
\note FirstNeighborsTag Tag indicating operations over particle first
neighbors.
\param SerialOpTag Tag indicating a serial loop strategy over neighbors.
\note SerialOpTag Tag indicating a serial loop strategy over neighbors.
\param reduce_val the value begin reduced
\param str Optional name for the functor. Will be forwarded if non-empty to
the Kokkos::parallel_for called by this code and can be used for
Expand Down Expand Up @@ -1556,9 +1556,9 @@ inline void neighbor_parallel_reduce(
\param exec_policy The policy over which to execute the functor.
\param functor The functor to execute in parallel
\param list The linked cell list over which to execute neighbor operations.
\param FirstNeighborsTag Tag indicating operations over particle first
\note FirstNeighborsTag Tag indicating operations over particle first
neighbors.
\param TeamOpTag Tag indicating a team parallel strategy over particle
\note TeamOpTag Tag indicating a team parallel strategy over particle
neighbors.
\param reduce_val the value begin reduced
\param str Optional name for the functor. Will be forwarded if non-empty to
Expand Down

0 comments on commit 96a0bc1

Please sign in to comment.