From b5cd6a05462dbd28d6f7ba5346044ec03a3e6537 Mon Sep 17 00:00:00 2001 From: Damien L-G Date: Tue, 9 Jan 2024 16:55:27 -0500 Subject: [PATCH] Update `AoSoA` API in Cabana's use case (#481) * Update Cabana::AoSoA API * Cabana:AoSoA do not expose implementation details * Improve description of VectorLength parameter Co-authored-by: Sam Reeve <6740307+streeve@users.noreply.github.com> * Improve further description based on feedback Co-authored-by: Sam Reeve <6740307+streeve@users.noreply.github.com> --------- Co-authored-by: Sam Reeve <6740307+streeve@users.noreply.github.com> --- docs/source/usecases/SoA-and-AoSoA-with-Cabana.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/source/usecases/SoA-and-AoSoA-with-Cabana.md b/docs/source/usecases/SoA-and-AoSoA-with-Cabana.md index 35c323a06..5f70015cf 100644 --- a/docs/source/usecases/SoA-and-AoSoA-with-Cabana.md +++ b/docs/source/usecases/SoA-and-AoSoA-with-Cabana.md @@ -41,9 +41,8 @@ MemberTypes; Defined in header [``](https://github.com/ECP-copa/Cabana/blob/master/core/src/Cabana_AoSoA.hpp) ```C++ -template ::vector_length, +template class AoSoA; ``` @@ -52,11 +51,11 @@ class AoSoA; `DataTypes` : The types of the elements stored in the underlying `Cabana::SoA`s. -`DeviceType` -: The Kokkos device type that carries the information about where to execute code and where to allocate storage. +`MemorySpace` +: The Kokkos memory space that carries information about where to allocate storage. `VectorLength` -: The vector length for the structure of arrays (optional). +: The vector length for the structure of arrays (optional). If not specified, a default (defined per memory space) is used; this value may need to be modified for optimal performance. `MemoryTraits` : The Kokkos memory traits that tells who controls memory allocation and deallocation (optional).