diff --git a/cajita/src/Cajita_Array.hpp b/cajita/src/Cajita_Array.hpp index 9b03e2afb..57c1a8340 100644 --- a/cajita/src/Cajita_Array.hpp +++ b/cajita/src/Cajita_Array.hpp @@ -179,6 +179,7 @@ struct is_array_layout> \brief Create an array layout over the entities of a local grid. \param local_grid The local grid over which to create the layout. \param dofs_per_entity The number of degrees-of-freedom per grid entity. + \return Shared pointer to an ArrayLayout. \note EntityType The entity: Cell, Node, Face, or Edge */ template @@ -199,6 +200,7 @@ createArrayLayout( const std::shared_ptr>& local_grid, \param halo_cell_width The number of halo cells surrounding the locally owned cells. \param dofs_per_entity The number of degrees-of-freedom per grid entity. + \return Shared pointer to an ArrayLayout. \note EntityType The entity: Cell, Node, Face, or Edge */ template @@ -340,6 +342,7 @@ struct is_array> over the ghosted index space of the layout. \param label A label for the view. \param layout The array layout over which to construct the view. + \return Shared pointer to an Array. */ template std::shared_ptr> @@ -359,6 +362,7 @@ createArray( const std::string& label, \param array The array from which to create a subarray \param dof_min The minimum degree-of-freedom index of the subarray. \param dof_max The maximum degree-of-freedom index of the subarray. + \return Shared pointer to a new Array. */ template std::shared_ptr std::shared_ptr> @@ -208,6 +209,7 @@ createGlobalGrid( MPI_Comm comm, \param global_mesh The global mesh data. \param periodic Whether each logical dimension is periodic. \param partitioner The grid partitioner. + \return Shared pointer to a GlobalGrid. */ template std::shared_ptr>> createGlobalGrid( diff --git a/cajita/src/Cajita_GlobalMesh.hpp b/cajita/src/Cajita_GlobalMesh.hpp index 9f3e08ec1..b1436e8dc 100644 --- a/cajita/src/Cajita_GlobalMesh.hpp +++ b/cajita/src/Cajita_GlobalMesh.hpp @@ -181,6 +181,7 @@ class GlobalMesh \param global_low_corner, global_high_corner Location of the mesh corner. \param cell_size Uniform cell size for every dimension. + \return Shared pointer to a GlobalMesh. */ template std::shared_ptr>> @@ -201,6 +202,7 @@ createUniformGlobalMesh( \param global_low_corner, global_high_corner Location of the mesh corner. \param cell_size %Array ofuniform cell size per dimension. + \return Shared pointer to a GlobalMesh. */ template std::shared_ptr>> @@ -221,6 +223,7 @@ createUniformGlobalMesh( \param global_low_corner, global_high_corner Location of the mesh corner. \param global_num_cell %Array ofnumber of cells per dimension. + \return Shared pointer to a GlobalMesh. */ template std::shared_ptr>> @@ -242,6 +245,7 @@ createUniformGlobalMesh( \param global_low_corner, global_high_corner Location of the mesh corner. \param cell_size Uniform cell size for every dimension. + \return Shared pointer to a GlobalMesh. */ template std::shared_ptr>> @@ -262,6 +266,7 @@ createSparseGlobalMesh( \param global_low_corner, global_high_corner Location of the mesh corner. \param cell_size %Array ofuniform cell size per dimension. + \return Shared pointer to a GlobalMesh. */ template std::shared_ptr>> @@ -282,6 +287,7 @@ createSparseGlobalMesh( \param global_low_corner, global_high_corner Location of the mesh corner. \param global_num_cell %Array ofnumber of cells per dimension. + \return Shared pointer to a GlobalMesh. */ template std::shared_ptr>> @@ -373,6 +379,7 @@ class GlobalMesh> \brief Create a non-uniform 3D mesh. \param i_edges, j_edges, k_edges List of edges defining the mesh in each dimension. + \return Shared pointer to a GlobalMesh. */ template std::shared_ptr>> @@ -462,6 +469,7 @@ class GlobalMesh> \brief Create a non-uniform 2D mesh. \tparam Scalar Mesh scalar type. \param i_edges, j_edges List of edges defining the mesh in each dimension. + \return Shared pointer to a GlobalMesh. */ template std::shared_ptr>> diff --git a/cajita/src/Cajita_Halo.hpp b/cajita/src/Cajita_Halo.hpp index 3abdfa6c5..96c4bb6a8 100644 --- a/cajita/src/Cajita_Halo.hpp +++ b/cajita/src/Cajita_Halo.hpp @@ -947,6 +947,7 @@ struct ArrayPackMemorySpace \param pattern The pattern to build the halo from. \param width Must be less than or equal to the width of the array halo. \param arrays The arrays over which to build the halo. + \return Shared pointer to a Halo. */ template auto createHalo( const Pattern& pattern, const int width, diff --git a/cajita/src/Cajita_HypreStructuredSolver.hpp b/cajita/src/Cajita_HypreStructuredSolver.hpp index 67a5ded47..ab7e53b08 100644 --- a/cajita/src/Cajita_HypreStructuredSolver.hpp +++ b/cajita/src/Cajita_HypreStructuredSolver.hpp @@ -1364,6 +1364,7 @@ class HypreStructDiagonal // Builders //---------------------------------------------------------------------------// //! Create a HYPRE PCG structured solver. +//! \return Shared pointer to HypreStructPCG. template std::shared_ptr< HypreStructPCG> @@ -1378,6 +1379,7 @@ createHypreStructPCG( const ArrayLayout_t& layout, } //! Create a HYPRE GMRES structured solver. +//! \return Shared pointer to HypreStructGMRES. template std::shared_ptr< HypreStructGMRES> @@ -1392,6 +1394,7 @@ createHypreStructGMRES( const ArrayLayout_t& layout, } //! Create a HYPRE BiCGSTAB structured solver. +//! \return Shared pointer to HypreStructBiCGSTAB. template std::shared_ptr> @@ -1406,6 +1409,7 @@ createHypreStructBiCGSTAB( const ArrayLayout_t& layout, } //! Create a HYPRE PFMG structured solver. +//! \return Shared pointer to HypreStructPFMG. template std::shared_ptr< HypreStructPFMG> @@ -1420,6 +1424,7 @@ createHypreStructPFMG( const ArrayLayout_t& layout, } //! Create a HYPRE SMG structured solver. +//! \return Shared pointer to HypreStructSMG. template std::shared_ptr< HypreStructSMG> @@ -1434,6 +1439,7 @@ createHypreStructSMG( const ArrayLayout_t& layout, } //! Create a HYPRE Jacobi structured solver. +//! \return Shared pointer to HypreStructJacobi. template std::shared_ptr< HypreStructJacobi> @@ -1448,6 +1454,7 @@ createHypreStructJacobi( const ArrayLayout_t& layout, } //! Create a HYPRE Diagonal structured solver. +//! \return Shared pointer to HypreStructDiagonal. template std::shared_ptr> @@ -1470,6 +1477,7 @@ createHypreStructDiagonal( const ArrayLayout_t& layout, \param solver_type Solver name. \param layout The ArrayLayout defining the vector space of the solver. \param is_preconditioner Use as a preconditioner. + \return Shared pointer to a HypreStructuredSolver. */ template std::shared_ptr L2G createL2G( const LocalGrid& local_grid, EntityType ) diff --git a/cajita/src/Cajita_IndexSpace.hpp b/cajita/src/Cajita_IndexSpace.hpp index d0c65a531..ac7db9463 100644 --- a/cajita/src/Cajita_IndexSpace.hpp +++ b/cajita/src/Cajita_IndexSpace.hpp @@ -163,7 +163,7 @@ class IndexSpace //---------------------------------------------------------------------------// /*! \brief Create a multi-dimensional execution policy over an index space. - + \return Kokkos::RangePolicy Rank-1 specialization. */ template @@ -177,6 +177,7 @@ createExecutionPolicy( const IndexSpace<1>& index_space, const ExecutionSpace& ) //---------------------------------------------------------------------------// /*! \brief Create a multi-dimensional execution policy over an index space. + \return Kokkos::RangePolicy Rank-1 specialization with a work tag. */ @@ -192,6 +193,7 @@ createExecutionPolicy( const IndexSpace<1>& index_space, const ExecutionSpace&, //---------------------------------------------------------------------------// /*! \brief Create a multi-dimensional execution policy over an index space. + \return Kokkos::MDRangePolicy */ template Kokkos::MDRangePolicy> @@ -206,6 +208,7 @@ createExecutionPolicy( const IndexSpace_t& index_space, const ExecutionSpace& ) /*! \brief Create a multi-dimensional execution policy over an index space with a work tag. + \return Kokkos::MDRangePolicy */ template Kokkos::MDRangePolicy> @@ -219,8 +222,8 @@ createExecutionPolicy( const IndexSpace_t& index_space, const ExecutionSpace&, //---------------------------------------------------------------------------// /*! - \brief Given an index space create a view over the extent of that index - space. + \brief Given an index space create a view over the extent of that index space. + \return Uninitialized Kokkos::View Rank-1 specialization. */ @@ -237,6 +240,7 @@ Kokkos::View createView( const std::string& label, /*! \brief Given an index space and a data pointer create an unmanaged view over the extent of that index space. + \return Unmanaged Kokkos::View Rank-1 specialization. */ @@ -252,6 +256,7 @@ createView( const IndexSpace<1>& index_space, Scalar* data ) /*! \brief Given an index space create a view over the extent of that index space. + \return Uninitialized Kokkos::View Rank-2 specialization. */ @@ -268,6 +273,7 @@ Kokkos::View createView( const std::string& label, /*! \brief Given an index space and a data pointer create an unmanaged view over the extent of that index space. + \return Unmanaged Kokkos::View Rank-2 specialization. */ @@ -283,6 +289,7 @@ createView( const IndexSpace<2>& index_space, Scalar* data ) /*! \brief Given an index space create a view over the extent of that index space. + \return Uninitialized Kokkos::View Rank-3 specialization. */ @@ -300,6 +307,7 @@ createView( const std::string& label, const IndexSpace<3>& index_space ) /*! \brief Given an index space and a data pointer create an unmanaged view over the extent of that index space. + \return Unmanaged Kokkos::View Rank-3 specialization. */ @@ -314,8 +322,8 @@ createView( const IndexSpace<3>& index_space, Scalar* data ) //---------------------------------------------------------------------------// /*! - \brief Given an index space create a view over the extent of that index - space. + \brief Given an index space create a view over the extent of that index space. + \return Uninitialized Kokkos::View Rank-4 specialization. */ @@ -333,6 +341,7 @@ createView( const std::string& label, const IndexSpace<4>& index_space ) /*! \brief Given an index space and a data pointer create an unmanaged view over the extent of that index space. + \return Unmanaged Kokkos::View Rank-4 specialization. */ @@ -348,6 +357,7 @@ createView( const IndexSpace<4>& index_space, Scalar* data ) //---------------------------------------------------------------------------// /*! \brief Given a view create a subview over the given index space. + \return subview of the original Kokkos::View Rank-1 specialization. */ @@ -363,6 +373,7 @@ KOKKOS_INLINE_FUNCTION auto createSubview( const ViewType& view, //---------------------------------------------------------------------------// /*! \brief Given a view create a subview over the given index space. + \return subview of the original Kokkos::View Rank-2 specialization. */ @@ -380,6 +391,7 @@ KOKKOS_INLINE_FUNCTION auto createSubview( const ViewType& view, //---------------------------------------------------------------------------// /*! \brief Given a view create a subview over the given index space. + \return subview of the original Kokkos::View Rank-3 specialization. */ @@ -398,6 +410,7 @@ KOKKOS_INLINE_FUNCTION auto createSubview( const ViewType& view, //---------------------------------------------------------------------------// /*! \brief Given a view create a subview over the given index space. + \return subview of the original Kokkos::View Rank-4 specialization. */ @@ -417,8 +430,9 @@ KOKKOS_INLINE_FUNCTION auto createSubview( const ViewType& view, //---------------------------------------------------------------------------// /*! - Given an N-dimensional index space append an additional dimension with the - given size. + \brief Given an N-dimensional index space append an additional dimension with + the given size. + \return IndexSpace with dimension N+1. */ template IndexSpace appendDimension( const IndexSpace& index_space, @@ -439,8 +453,9 @@ IndexSpace appendDimension( const IndexSpace& index_space, //---------------------------------------------------------------------------// /*! - Given an N-dimensional index space append an additional dimension with the - given range. + \brief Given an N-dimensional index space append an additional dimension with + the given range. + \return IndexSpace with dimension N+1. */ template IndexSpace appendDimension( const IndexSpace& index_space, diff --git a/cajita/src/Cajita_Interpolation.hpp b/cajita/src/Cajita_Interpolation.hpp index 994cf87b4..cb8d68984 100644 --- a/cajita/src/Cajita_Interpolation.hpp +++ b/cajita/src/Cajita_Interpolation.hpp @@ -927,7 +927,8 @@ struct ScalarValueG2P } }; -//! Creation function for grid-to-point with scalar value. +//! \brief Creation function for grid-to-point with scalar value. +//! \return ScalarValueG2P interpolation functor. template ScalarValueG2P createScalarValueG2P( const ViewType& x, @@ -977,7 +978,8 @@ struct VectorValueG2P } }; -//! Creation function for grid-to-point with vector value. +//! \brief Creation function for grid-to-point with vector value. +//! \return VectorValueG2P interpolation functor. template VectorValueG2P createVectorValueG2P( const ViewType& x, @@ -1027,7 +1029,8 @@ struct ScalarGradientG2P } }; -//! Creation function for grid-to-point with scalar gradient. +//! \brief Creation function for grid-to-point with scalar gradient. +//! \return ScalarGradientG2P interpolation functor. template ScalarGradientG2P createScalarGradientG2P( const ViewType& x, @@ -1079,7 +1082,8 @@ struct VectorGradientG2P } }; -//! Creation function for grid-to-point with vector gradient. +//! \brief Creation function for grid-to-point with vector gradient. +//! \return VectorGradientG2P interpolation functor. template VectorGradientG2P createVectorGradientG2P( const ViewType& x, @@ -1128,7 +1132,8 @@ struct VectorDivergenceG2P } }; -//! Creation function for grid-to-point with vector divergence. +//! \brief Creation function for grid-to-point with vector divergence. +//! \return VectorDivergenceG2P interpolation functor. template VectorDivergenceG2P createVectorDivergenceG2P( const ViewType& x, @@ -1273,7 +1278,8 @@ struct ScalarValueP2G } }; -//! Creation function for point-to-grid with scalar value. +//! \brief Creation function for point-to-grid with scalar value. +//! \return ScalarValueP2G interpolation functor. template ScalarValueP2G createScalarValueP2G( const ViewType& x, @@ -1323,7 +1329,8 @@ struct VectorValueP2G } }; -//! Creation function for point-to-grid with vector value. +//! \brief Creation function for point-to-grid with vector value. +//! \return VectorValueP2G interpolation functor. template VectorValueP2G createVectorValueP2G( const ViewType& x, @@ -1371,7 +1378,8 @@ struct ScalarGradientP2G } }; -//! Creation function for point-to-grid with scalar gradient. +//! \brief Creation function for point-to-grid with scalar gradient. +//! \return ScalarGradientP2G interpolation functor. template ScalarGradientP2G createScalarGradientP2G( const ViewType& x, @@ -1421,7 +1429,8 @@ struct VectorDivergenceP2G } }; -//! Creation function for point-to-grid with vector divergence. +//! \brief Creation function for point-to-grid with vector divergence. +//! \return VectorDivergenceP2G interpolation functor. template VectorDivergenceP2G createVectorDivergenceP2G( const ViewType& x, @@ -1473,7 +1482,8 @@ struct TensorDivergenceP2G } }; -//! Creation function for point-to-grid with tensor divergence. +//! \brief Creation function for point-to-grid with tensor divergence. +//! \return TensorDivergenceP2G interpolation functor. template TensorDivergenceP2G createTensorDivergenceP2G( const ViewType& x, diff --git a/cajita/src/Cajita_LoadBalancer.hpp b/cajita/src/Cajita_LoadBalancer.hpp index 32c4b4c8c..ea269e9db 100644 --- a/cajita/src/Cajita_LoadBalancer.hpp +++ b/cajita/src/Cajita_LoadBalancer.hpp @@ -288,6 +288,7 @@ createLoadBalancer( \param comm MPI communicator to use for load balancing communication. \param global_grid The initial global grid. \param min_domain_size The minimal domain size in each dimension. + \return Shared pointer to a LoadBalancer. */ template std::shared_ptr>> diff --git a/cajita/src/Cajita_LocalGrid.hpp b/cajita/src/Cajita_LocalGrid.hpp index cb05684ba..567c44580 100644 --- a/cajita/src/Cajita_LocalGrid.hpp +++ b/cajita/src/Cajita_LocalGrid.hpp @@ -598,6 +598,7 @@ class LocalGrid constructed. \param halo_cell_width The number of halo cells surrounding the locally owned cells. + \return Shared pointer to a LocalGrid. */ template std::shared_ptr> diff --git a/cajita/src/Cajita_LocalMesh.hpp b/cajita/src/Cajita_LocalMesh.hpp index b3725a80b..43eb1468a 100644 --- a/cajita/src/Cajita_LocalMesh.hpp +++ b/cajita/src/Cajita_LocalMesh.hpp @@ -765,7 +765,10 @@ class LocalMesh> }; //---------------------------------------------------------------------------// -//! Creation function for local mesh. +/*! + \brief Creation function for local mesh. + \return Shared pointer to a LocalMesh. +*/ template LocalMesh createLocalMesh( const LocalGrid& local_grid ) diff --git a/cajita/src/Cajita_ParticleGridDistributor.hpp b/cajita/src/Cajita_ParticleGridDistributor.hpp index 3f158daf2..d5116f345 100644 --- a/cajita/src/Cajita_ParticleGridDistributor.hpp +++ b/cajita/src/Cajita_ParticleGridDistributor.hpp @@ -9,6 +9,10 @@ * SPDX-License-Identifier: BSD-3-Clause * ****************************************************************************/ +/*! + \file Cajita_ParticleGridDistributor.hpp + \brief Multi-node particle redistribution using the grid halo. +*/ #ifndef CABANA_PARTICLEGRIDDISTRIBUTOR_HPP #define CABANA_PARTICLEGRIDDISTRIBUTOR_HPP @@ -158,14 +162,11 @@ void getMigrateDestinations( const LocalGridType& local_grid, \brief Check for the number of particles that must be communicated \tparam LocalGridType Cajita LocalGrid type. - \tparam PositionSliceType Particle position type. \param local_grid The local grid containing periodicity and system bound information. - \param positions The particle position container, either Slice or View. - \param minimum_halo_width Number of halo mesh widths to include for ghosting. */ @@ -227,12 +228,10 @@ int migrateCount( const LocalGridType& local_grid, Cajita grid and taking periodic boundaries into account. \tparam LocalGridType Cajita LocalGrid type. - \tparam PositionSliceType Position type. \param local_grid The local grid containing periodicity and system bound information. - \param positions The particle positions. \return Distributor for later migration. @@ -273,22 +272,17 @@ createParticleGridDistributor( const LocalGridType& local_grid, Cajita grid to determine which particles should be moved. In-place variant. \tparam LocalGridType Cajita LocalGrid type. - \tparam ParticlePositions Particle position type. - \tparam PositionContainer AoSoA type. \param local_grid The local grid containing periodicity and system bounds. - \param positions Particle positions. - \param particles The particle AoSoA. - \param min_halo_width Number of halo mesh widths to allow particles before migrating. - \param force_migrate Migrate particles outside the local domain regardless of ghosted halo. + \return Whether any particle migration occured. */ template bool particleGridMigrate( const LocalGridType& local_grid, @@ -326,24 +320,18 @@ bool particleGridMigrate( const LocalGridType& local_grid, variant. \tparam LocalGridType Cajita LocalGrid type. - \tparam ParticlePositions Particle position type. - \tparam ParticleContainer AoSoA type. \param local_grid The local grid containing periodicity and system bounds. - \param positions Particle positions. - \param src_particles The source particle AoSoA. - \param dst_particles The destination particle AoSoA. - \param min_halo_width Number of halo mesh widths to allow particles before migrating. - \param force_migrate Migrate particles outside the local domain regardless of ghosted halo. + \return Whether any particle migration occured. */ template bool particleGridMigrate( const LocalGridType& local_grid, diff --git a/cajita/src/Cajita_ParticleList.hpp b/cajita/src/Cajita_ParticleList.hpp index 0792cc0f3..16955a457 100644 --- a/cajita/src/Cajita_ParticleList.hpp +++ b/cajita/src/Cajita_ParticleList.hpp @@ -67,8 +67,7 @@ class ParticleList : public Cabana::ParticleList /*! \brief Redistribute particles to new owning grids. - - Return true if the particles were actually redistributed. + \return Whether the particles were actually redistributed. */ template bool redistribute( const LocalGridType& local_grid, @@ -81,9 +80,8 @@ class ParticleList : public Cabana::ParticleList /*! \brief Redistribute particles to new owning grids with explicit field. - \tparam PositionFieldTag Field tag for position data. - Return true if the particles were actually redistributed. + \return Whether the particles were actually redistributed. */ template bool redistribute( const LocalGridType& local_grid, PositionFieldTag, @@ -100,7 +98,10 @@ class ParticleList : public Cabana::ParticleList }; //---------------------------------------------------------------------------// -//! ParticleList creation function. +/*! + \brief ParticleList creation function. + \return ParticleList +*/ template auto createParticleList( const std::string& label, Cabana::ParticleTraits ) diff --git a/cajita/src/Cajita_Partitioner.hpp b/cajita/src/Cajita_Partitioner.hpp index d2408a54a..890f42053 100644 --- a/cajita/src/Cajita_Partitioner.hpp +++ b/cajita/src/Cajita_Partitioner.hpp @@ -145,8 +145,7 @@ class ManualBlockPartitioner : public BlockPartitioner current MPI rank. \param cart_comm The MPI Cartesian communicator for the partitioning. \param global_cells_per_dim The number of global cells in each dimension. - \return The owned number of cells of the current - MPI rank in each dimension. + \return The owned number of cells per dimension of the current MPI rank. */ std::array ownedCellsPerDimension( MPI_Comm cart_comm, diff --git a/cajita/src/Cajita_ReferenceStructuredSolver.hpp b/cajita/src/Cajita_ReferenceStructuredSolver.hpp index 0a0637653..29a3e515e 100644 --- a/cajita/src/Cajita_ReferenceStructuredSolver.hpp +++ b/cajita/src/Cajita_ReferenceStructuredSolver.hpp @@ -959,8 +959,11 @@ class ReferenceConjugateGradient //---------------------------------------------------------------------------// // Builders. //---------------------------------------------------------------------------// -//! Creation function for reference structured preconditioned block conjugate -//! gradient. +/*! + \brief Creation function for reference structured preconditioned block + conjugate gradient. + \return Shared pointer to a ReferenceConjugateGradient. +*/ template std::shared_ptr< ReferenceConjugateGradient> diff --git a/cajita/src/Cajita_SparseArray.hpp b/cajita/src/Cajita_SparseArray.hpp index 5143d9f8f..78e82e7ee 100644 --- a/cajita/src/Cajita_SparseArray.hpp +++ b/cajita/src/Cajita_SparseArray.hpp @@ -684,6 +684,7 @@ struct is_sparse_array diff --git a/cajita/src/Cajita_SparseIndexSpace.hpp b/cajita/src/Cajita_SparseIndexSpace.hpp index faa37bef5..66a720d41 100644 --- a/cajita/src/Cajita_SparseIndexSpace.hpp +++ b/cajita/src/Cajita_SparseIndexSpace.hpp @@ -681,7 +681,10 @@ class SparseMap }; //---------------------------------------------------------------------------// -//! Creation function for SparseMap from GlobalMesh +/*! + \brief Creation function for SparseMap from GlobalMesh + \return SparseMap +*/ template > owned cells. \param cell_num_per_tile_dim The number of local cells in each tile in each dimension. + \return Shared pointer to a LocalGrid. */ template std::shared_ptr> diff --git a/core/src/Cabana_AoSoA.hpp b/core/src/Cabana_AoSoA.hpp index b7c1043ec..a4fcafb2e 100644 --- a/core/src/Cabana_AoSoA.hpp +++ b/core/src/Cabana_AoSoA.hpp @@ -69,6 +69,7 @@ struct is_aosoa : public is_aosoa_impl::type>::type \param aosoa AoSoA to slice from. \param slice_label Optional slice label. + \return Slice */ template typename AoSoA_t::template member_slice_type @@ -251,7 +252,6 @@ class AoSoA /*! \brief Returns the data structure label. - \return A string identifying the data structure. This label will be assigned to the underlying Kokkos view managing the @@ -261,7 +261,6 @@ class AoSoA /*! \brief Returns the number of tuples in the container. - \return The number of tuples in the container. This is the number of actual objects held in the container, which is not @@ -272,7 +271,6 @@ class AoSoA /*! \brief Returns if the container is empty or not. - \return True if the number of tuples in the container is zero. This is the number of actual objects held in the container, which is not @@ -284,7 +282,6 @@ class AoSoA /*! \brief Returns the size of the storage space currently allocated for the container, expressed in terms of tuples. - \return The capacity of the container. This capacity is not necessarily equal to the container size. It can be @@ -426,7 +423,6 @@ class AoSoA /*! \brief Get the number of structs-of-arrays in the container. - \return The number of structs-of-arrays in the container. */ KOKKOS_INLINE_FUNCTION @@ -434,9 +430,7 @@ class AoSoA /*! \brief Get the size of the data array at a given struct member index. - \param s The struct index to get the array size for. - \return The size of the array at the given struct index. */ KOKKOS_INLINE_FUNCTION @@ -453,9 +447,7 @@ class AoSoA /*! \brief Get a reference to the SoA at a given index. - \param s The SoA index. - \return The SoA reference at the given index. */ KOKKOS_FORCEINLINE_FUNCTION @@ -463,9 +455,7 @@ class AoSoA /*! \brief Get a tuple at a given index via a deep copy. - \param i The index to get the tuple from. - \return A tuple containing a deep copy of the data at the given index. */ KOKKOS_INLINE_FUNCTION @@ -479,9 +469,7 @@ class AoSoA /*! \brief Set a tuple at a given index via a deep copy. - \param i The index to set the tuple at. - \param tpl The tuple to get the data from. */ KOKKOS_INLINE_FUNCTION diff --git a/core/src/Cabana_CommunicationPlan.hpp b/core/src/Cabana_CommunicationPlan.hpp index 96bf17f0a..b9b428938 100644 --- a/core/src/Cabana_CommunicationPlan.hpp +++ b/core/src/Cabana_CommunicationPlan.hpp @@ -462,16 +462,13 @@ class CommunicationPlan /*! \brief Get the number of neighbor ranks that this rank will communicate with. - \return The number of MPI ranks that will exchange data with this rank. */ int numNeighbor() const { return _neighbors.size(); } /*! \brief Given a local neighbor id get its rank in the MPI communicator. - \param neighbor The local id of the neighbor to get the rank for. - \return The MPI rank of the neighbor with the given local id. */ int neighborRank( const int neighbor ) const @@ -482,10 +479,8 @@ class CommunicationPlan /*! \brief Get the number of elements this rank will export to a given neighbor. - \param neighbor The local id of the neighbor to get the number of exports for. - \return The number of elements this rank will export to the neighbor with the given local id. */ @@ -496,7 +491,6 @@ class CommunicationPlan /*! \brief Get the total number of exports this rank will do. - \return The total number of elements this rank will export to its neighbors. */ @@ -505,10 +499,8 @@ class CommunicationPlan /*! \brief Get the number of elements this rank will import from a given neighbor. - \param neighbor The local id of the neighbor to get the number of imports for. - \return The number of elements this rank will import from the neighbor with the given local id. */ @@ -519,7 +511,6 @@ class CommunicationPlan /*! \brief Get the total number of imports this rank will do. - \return The total number of elements this rank will import from its neighhbors. */ @@ -527,20 +518,18 @@ class CommunicationPlan /*! \brief Get the number of export elements. + \return The number of export elements. Whenever the communciation plan is applied, this is the total number of elements expected to be input on the sending ranks (in the forward communication plan). This will be different than the number returned by totalNumExport() if some of the export ranks used in the construction are -1 and therefore will not particpate in an export operation. - - \return The number of export elements. */ std::size_t exportSize() const { return _num_export_element; } /*! \brief Get the steering vector for the exports. - \return The steering vector for the exports. The steering vector places exports in contiguous chunks by destination diff --git a/core/src/Cabana_DeepCopy.hpp b/core/src/Cabana_DeepCopy.hpp index e7a9196c8..96a69364a 100644 --- a/core/src/Cabana_DeepCopy.hpp +++ b/core/src/Cabana_DeepCopy.hpp @@ -31,6 +31,7 @@ namespace Cabana //---------------------------------------------------------------------------// /*! \brief Allocate a mirror of the given AoSoA in the given space. + \return AoSoA in the new space. */ template inline AoSoA @@ -51,6 +52,7 @@ create_mirror( /*! \brief Create a mirror view of the given AoSoA in the given space. Same space specialization returns the input AoSoA. + \return The original AoSoA. \note Memory allocation will only occur if the requested mirror memory space is different from that of the input AoSoA. If they are the same, the @@ -72,6 +74,7 @@ inline SrcAoSoA create_mirror_view( /*! \brief Create a mirror view of the given AoSoA in the given memory space. Different space specialization allocates a new AoSoA. + \return AoSoA in the new space. \note Memory allocation will only occur if the requested mirror memory space is different from that of the input AoSoA. If they are the @@ -95,6 +98,7 @@ create_mirror_view( \brief Create a mirror view of the given AoSoA in the given memory space and copy the contents of the input AoSoA. Same space specialization returns the input AoSoA. + \return The original AoSoA. \note Memory allocation will only occur if the requested mirror memory space is different from that of the input AoSoA. If they are the same, the @@ -116,6 +120,7 @@ inline SrcAoSoA create_mirror_view_and_copy( \brief Create a mirror of the given AoSoA in the given memory space and deep copy the AoSoA into the mirror. Different space specialization allocates a new AoSoA and performs the deep copy. + \return The new AoSoA. \note Memory allocation will only occur if the requested mirror memory space is different from that of the input AoSoA. If they are the @@ -142,9 +147,7 @@ create_mirror_view_and_copy( //---------------------------------------------------------------------------// /*! \brief Deep copy data between compatible AoSoA objects. - \param dst The destination for the copied data. - \param src The source of the copied data. Only AoSoA objects with the same set of member data types and size may be @@ -233,7 +236,6 @@ deep_copy( DstAoSoA& dst, const SrcAoSoA& src, //---------------------------------------------------------------------------// /*! \brief Deep copy data between compatible ParticleList objects. - \param dst The destination for the copied data. \param src The source of the copied data. s*/ @@ -252,9 +254,7 @@ inline void deep_copy( ParticleList& dst, //---------------------------------------------------------------------------// /*! \brief Fill an AoSoA with a tuple. - \param aosoa The AoSoA to fill. - \param tuple The tuple to assign. All AoSoA elements will be assigned this value. */ @@ -277,9 +277,7 @@ inline void deep_copy( AoSoA_t& aosoa, //---------------------------------------------------------------------------// /*! \brief Deep copy data between compatible Slice objects. - \param dst The destination for the copied data. - \param src The source of the copied data. Only Slice objects with the same set of member data types and size may be @@ -391,9 +389,7 @@ deep_copy( DstSlice& dst, const SrcSlice& src, //---------------------------------------------------------------------------// /*! \brief Fill a slice with a scalar. - \param slice The slice to fill. - \param scalar The scalar to assign. All slice elements will be assigned this value. */ diff --git a/core/src/Cabana_Halo.hpp b/core/src/Cabana_Halo.hpp index 78db62530..ed544ee83 100644 --- a/core/src/Cabana_Halo.hpp +++ b/core/src/Cabana_Halo.hpp @@ -607,6 +607,7 @@ class Gather auto createGather( const HaloType& halo, const ParticleDataType& data, @@ -854,6 +855,7 @@ class Scatter next halo.numGhost() elements()). \param overallocation An optional factor to keep extra space in the buffers to avoid frequent resizing. + \return Scatter */ template auto createScatter( const HaloType& halo, const SliceType& slice, diff --git a/core/src/Cabana_ParticleList.hpp b/core/src/Cabana_ParticleList.hpp index 1170dce41..7f3269d3f 100644 --- a/core/src/Cabana_ParticleList.hpp +++ b/core/src/Cabana_ParticleList.hpp @@ -263,7 +263,10 @@ class ParticleList }; //---------------------------------------------------------------------------// -//! ParticleList creation function. +/*! + \brief ParticleList creation function. + \return ParticleList +*/ template auto createParticleList( const std::string& label, ParticleTraits ) diff --git a/core/src/Cabana_Sort.hpp b/core/src/Cabana_Sort.hpp index 928929c2a..9bc62d1ba 100644 --- a/core/src/Cabana_Sort.hpp +++ b/core/src/Cabana_Sort.hpp @@ -240,19 +240,14 @@ kokkosBinSort1d( KeyViewType keys, const int nbin, const bool sort_within_bins, over the given Kokkos View of keys. \tparam KeyViewType The Kokkos::View type for keys. - \tparam Comparator Kokkos::BinSort compatible comparator type. \param keys The key values to use for sorting. A key value is needed for every element of the AoSoA. - \param comp The comparator to use for sorting. Must be compatible with Kokkos::BinSort. - \param begin The beginning index of the AoSoA range to sort. - \param end The end index of the AoSoA range to sort. - \return The permutation vector associated with the sorting. */ template sortByKeyWithComparator( Kokkos View of keys. \tparam KeyViewType The Kokkos::View type for keys. - \tparam Comparator Kokkos::BinSort compatible comparator type. \param keys The key values to use for sorting. A key value is needed for every element of the AoSoA. - \param comp The comparator to use for sorting. Must be compatible with Kokkos::BinSort. - \return The permutation vector associated with the sorting. */ template sortByKeyWithComparator( over the given Kokkos View of keys. \tparam KeyViewType The Kokkos::View type for keys. - \tparam Comparator Kokkos::BinSort compatible comparator type. \param keys The key values to use for binning. A key value is needed for every element of the AoSoA. - \param comp The comparator to use for binning. Must be compatible with Kokkos::BinSort. - \param begin The beginning index of the AoSoA range to bin. - \param end The end index of the AoSoA range to bin. - \return The binning data (e.g. bin sizes and offsets). */ template binByKeyWithComparator( \param keys The key values to use for sorting. A key value is needed for every element of the AoSoA. - \param begin The beginning index of the AoSoA range to sort. - \param end The end index of the AoSoA range to sort. - \return The permutation vector associated with the sorting. */ template @@ -499,7 +473,6 @@ BinningData sortByKey( \tparam SliceType Slice type for keys. \param slice Slice of keys. - \return The permutation vector associated with the sorting. */ template @@ -518,14 +491,10 @@ BinningData sortByKey( \tparam SliceType Slice type for keys \param slice Slice of keys. - \param nbin The number of bins to use for binning. The range of key values will subdivided equally by the number of bins. - \param begin The beginning index of the AoSoA range to bin. - \param end The end index of the AoSoA range to bin. - \return The binning data (e.g. bin sizes and offsets). */ template @@ -548,10 +517,8 @@ BinningData binByKey( \tparam SliceType Slice type for keys. \param slice Slice of keys. - \param nbin The number of bins to use for binning. The range of key values will subdivided equally by the number of bins. - \return The binning data (e.g. bin sizes and offsets). */ template @@ -567,11 +534,8 @@ BinningData binByKey( \brief Given binning data permute an AoSoA. \tparam BinningDataType The binning data type. - \tparam AoSoA_t The AoSoA type. - \param binning_data The binning data. - \param aosoa The AoSoA to permute. */ template