1 #if !defined(PETSCVEC_KOKKOS_HPP) 2 #define PETSCVEC_KOKKOS_HPP 3 4 #include <petscconf.h> 5 6 /* SUBMANSEC = Vec */ 7 8 #if defined(PETSC_HAVE_KOKKOS) 9 #if defined(petsccomplexlib) 10 #error "Error: You must include petscvec_kokkos.hpp before other petsc headers in this C++ file to use petsc complex with Kokkos" 11 #endif 12 13 #define PETSC_DESIRE_KOKKOS_COMPLEX 1 /* To control the definition of petsccomplexlib in petscsystypes.h */ 14 #endif 15 16 #include <petscvec.h> 17 18 #if defined(PETSC_HAVE_KOKKOS) 19 #include <Kokkos_Core.hpp> 20 21 /*@C 22 VecGetKokkosView - Returns a constant Kokkos View that contains up-to-date data of a vector in the specified memory space. 23 24 Synopsis: 25 #include <petscvec_kokkos.hpp> 26 PetscErrorCode VecGetKokkosView (Vec v,Kokkos::View<const PetscScalar*,MemorySpace>* kv); 27 PetscErrorCode VecGetKokkosView (Vec v,Kokkos::View<PetscScalar*,MemorySpace>* kv); 28 29 Logically Collective on Vec 30 31 Input Parameter: 32 . v - the vector in type of `VECKOKKOS` 33 34 Output Parameter: 35 . kv - the Kokkos View with a user-specified template parameter MemorySpace 36 37 Notes: 38 If the vector is not of type `VECKOKKOS`, an error will be raised. 39 40 The functions are similar to `VecGetArrayRead()` and `VecGetArray()` respectively. One can read-only or read/write the returned Kokkos View. 41 42 Passing in a const View enables read-only access. 43 44 One must return the View by a matching `VecRestoreKokkosView()` after finishing using the View. Currently, only two memory 45 spaces are supported: Kokkos::HostSpace and Kokkos::DefaultExecutionSpace::memory_space. 46 If needed, a memory copy will be internally called to copy the latest vector data to the specified memory space. 47 48 Level: beginner 49 50 .seealso: `VecRestoreKokkosView()`, `VecRestoreArray()`, `VecGetKokkosViewWrite()`, `VecGetArrayRead()`, `VecGetArrays()`, `VecGetArrayF90()`, `VecGetArrayReadF90()`, `VecPlaceArray()`, `VecGetArray2d()`, 51 `VecGetArrayPair()`, `VecRestoreArrayPair()`, `VecGetArrayWrite()`, `VecRestoreArrayWrite()` 52 @*/ 53 template<class MemorySpace> PetscErrorCode VecGetKokkosView (Vec,Kokkos::View<const PetscScalar*,MemorySpace>*); 54 template<class MemorySpace> PetscErrorCode VecGetKokkosView (Vec,Kokkos::View<PetscScalar*,MemorySpace>*); 55 56 /*@C 57 VecRestoreKokkosView - Returns a Kokkos View gotten by `VecGetKokkosView()`. 58 59 Synopsis: 60 #include <petscvec_kokkos.hpp> 61 PetscErrorCode VecRestoreKokkosView (Vec v,Kokkos::View<const PetscScalar*,MemorySpace>* kv); 62 PetscErrorCode VecRestoreKokkosView (Vec v,Kokkos::View<PetscScalar*,MemorySpace>* kv); 63 64 Logically Collective on Vec 65 66 Input Parameters: 67 + v - the vector in type of `VECKOKKOS` 68 - kv - the Kokkos View with a user-specified template parameter MemorySpace 69 70 Notes: 71 If the vector is not of type `VECKOKKOS`, an error will be raised. 72 The functions are similar to `VecRestoreArrayRead()` and `VecRestoreArray()` respectively. They are the counterpart of `VecGetKokkosView()`. 73 74 Level: beginner 75 76 .seealso: `VecGetKokkosView()`, `VecRestoreKokkosViewWrite()`, `VecRestoreArray()`, `VecGetArrayRead()`, `VecGetArrays()`, `VecGetArrayF90()`, `VecGetArrayReadF90()`, `VecPlaceArray()`, `VecGetArray2d()`, 77 `VecGetArrayPair()`, `VecRestoreArrayPair()`, `VecGetArrayWrite()`, `VecRestoreArrayWrite()` 78 @*/ 79 template<class MemorySpace> PetscErrorCode VecRestoreKokkosView(Vec,Kokkos::View<const PetscScalar*,MemorySpace>*){return 0;} 80 template<class MemorySpace> PetscErrorCode VecRestoreKokkosView(Vec,Kokkos::View<PetscScalar*,MemorySpace>*); 81 82 83 /*@C 84 VecGetKokkosViewWrite - Returns a Kokkos View that contains the array of a vector in the specified memory space. 85 86 Synopsis: 87 #include <petscvec_kokkos.hpp> 88 PetscErrorCode VecGetKokkosViewWrite (Vec v,Kokkos::View<PetscScalar*,MemorySpace>* kv); 89 90 Logically Collective on Vec 91 92 Input Parameter: 93 . v - the vector in type of `VECKOKKOS` 94 95 Output Parameter: 96 . kv - the Kokkos View with a user-specified template parameter MemorySpace 97 98 Notes: 99 If the vector is not of type `VECKOKKOS`, an error will be raised. 100 101 The functions is similar to `VecGetArrayWrite()`. The returned view might contain garbage data or stale data and one is not 102 expected to read data from the View. Instead, one is expected to overwrite all data in the View. 103 One must return the View by a matching `VecRestoreKokkosViewWrite()` after finishing using the View. 104 105 Currently, only two memory spaces are supported: Kokkos::HostSpace and Kokkos::DefaultExecutionSpace::memory_space. 106 107 Level: beginner 108 109 .seealso: `VecRestoreKokkosViewWrite()`, `VecRestoreKokkosView()`, `VecGetKokkosView()`, `VecRestoreArray()`, `VecGetArrayRead()`, `VecGetArrays()`, `VecGetArrayF90()`, `VecGetArrayReadF90()`, `VecPlaceArray()`, `VecGetArray2d()`, 110 `VecGetArrayPair()`, `VecRestoreArrayPair()`, `VecGetArrayWrite()`, `VecRestoreArrayWrite()` 111 @*/ 112 template<class MemorySpace> PetscErrorCode VecGetKokkosViewWrite (Vec,Kokkos::View<PetscScalar*,MemorySpace>*); 113 114 /*@C 115 VecRestoreKokkosViewWrite - Returns a Kokkos View gotten with `VecGetKokkosViewWrite()`. 116 117 Synopsis: 118 #include <petscvec_kokkos.hpp> 119 PetscErrorCode VecRestoreKokkosViewWrite (Vec v,Kokkos::View<PetscScalar*,MemorySpace>* kv); 120 121 Logically Collective on Vec 122 123 Input Parameters: 124 + v - the vector in type of `VECKOKKOS` 125 - kv - the Kokkos View with a user-specified template parameter MemorySpace 126 127 Notes: 128 If the vector is not of type `VECKOKKOS`, an error will be raised. 129 130 The function is similar to `VecRestoreArrayWrite()`. It is the counterpart of `VecGetKokkosViewWrite()`. 131 132 Level: beginner 133 134 .seealso: `VecGetKokkosViewWrite()`, `VecGetKokkosView()`, `VecGetKokkosView()`, `VecRestoreArray()`, `VecGetArrayRead()`, `VecGetArrays()`, `VecGetArrayF90()`, `VecGetArrayReadF90()`, `VecPlaceArray()`, `VecGetArray2d()`, 135 `VecGetArrayPair()`, `VecRestoreArrayPair()`, `VecGetArrayWrite()`, `VecRestoreArrayWrite()` 136 @*/ 137 template<class MemorySpace> PetscErrorCode VecRestoreKokkosViewWrite(Vec,Kokkos::View<PetscScalar*,MemorySpace>*); 138 139 #if defined(PETSC_HAVE_COMPLEX) && defined(PETSC_USE_COMPLEX) 140 static_assert(std::alignment_of<Kokkos::complex<PetscReal>>::value == std::alignment_of<std::complex<PetscReal>>::value, 141 "Alignment of Kokkos::complex<PetscReal> and std::complex<PetscReal> mismatch. Reconfigure your Kokkos with -DKOKKOS_ENABLE_COMPLEX_ALIGN=OFF, or let PETSc install Kokkos for you with --download-kokkos --download-kokkos-kernels"); 142 #endif 143 144 #endif 145 146 #endif 147