WarpX
Loading...
Searching...
No Matches
GetAndSetPosition.H
Go to the documentation of this file.
1/* Copyright 2019 David Grote, Maxence Thevenet, Remi Lehe
2 * Weiqun Zhang
3 *
4 * This file is part of WarpX.
5 *
6 * License: BSD-3-Clause-LBNL
7 */
8#ifndef WARPX_PARTICLES_PUSHER_GETANDSETPOSITION_H_
9#define WARPX_PARTICLES_PUSHER_GETANDSETPOSITION_H_
10
11#include "Particles/WarpXParticleContainer.H"
12
13#include <AMReX.H>
14#include <AMReX_REAL.H>
15
16#include <cmath>
17#include <limits>
18
25template<typename T_PIdx = PIdx>
26AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
27void get_particle_position (const WarpXParticleContainer::SuperParticleType& p,
28 amrex::ParticleReal& x,
29 amrex::ParticleReal& y,
30 amrex::ParticleReal& z) noexcept
31{
32 using namespace amrex::literals;
33
34#if defined(WARPX_DIM_RZ)
35 amrex::ParticleReal const theta = p.rdata(T_PIdx::theta);
36 amrex::ParticleReal const r = p.pos(T_PIdx::r);
37 x = r*std::cos(theta);
38 y = r*std::sin(theta);
39 z = p.pos(PIdx::z);
40#elif defined(WARPX_DIM_RCYLINDER)
41 amrex::ParticleReal const theta = p.rdata(T_PIdx::theta);
42 amrex::ParticleReal const r = p.pos(T_PIdx::r);
43 x = r*std::cos(theta);
44 y = r*std::sin(theta);
45 z = 0_prt;
46#elif defined(WARPX_DIM_RSPHERE)
47 amrex::ParticleReal const theta = p.rdata(T_PIdx::theta);
48 amrex::ParticleReal const phi = p.rdata(T_PIdx::phi);
49 amrex::ParticleReal const r = p.pos(T_PIdx::r);
50 x = r*std::cos(theta)*std::cos(phi);
51 y = r*std::sin(theta)*std::cos(phi);
52 z = r*std::sin(phi);
53#elif defined(WARPX_DIM_3D)
54 x = p.pos(PIdx::x);
55 y = p.pos(PIdx::y);
56 z = p.pos(PIdx::z);
57#elif defined(WARPX_DIM_XZ)
58 x = p.pos(PIdx::x);
59 y = 0_prt;
60 z = p.pos(PIdx::z);
61#else
62 x = 0_prt;
63 y = 0_prt;
64 z = p.pos(PIdx::z);
65#endif
66}
67
73template<typename T_PIdx = PIdx>
74struct GetParticlePosition
75{
76 using RType = amrex::ParticleReal;
77
78 const RType* AMREX_RESTRICT m_x = nullptr;
79 const RType* AMREX_RESTRICT m_y = nullptr;
80 const RType* AMREX_RESTRICT m_z = nullptr;
81
82#if defined(WARPX_DIM_RZ) || defined(WARPX_DIM_RCYLINDER) || defined(WARPX_DIM_RSPHERE)
83 const RType* AMREX_RESTRICT m_theta = nullptr;
84#endif
85#if defined(WARPX_DIM_RSPHERE)
86 const RType* AMREX_RESTRICT m_phi = nullptr;
87#endif
88
89 static constexpr RType m_x_default = RType(0.0);
90 static constexpr RType m_y_default = RType(0.0);
91 static constexpr RType m_z_default = RType(0.0);
92
93 GetParticlePosition () = default;
94
102 template <typename ptiType>
103 explicit
104 GetParticlePosition (const ptiType& a_pti, long a_offset = 0) noexcept
105 {
106 const auto& soa = a_pti.GetStructOfArrays();
107
108#if defined(WARPX_DIM_RZ)
109 m_x = soa.GetRealData(PIdx::r).dataPtr() + a_offset;
110 m_z = soa.GetRealData(PIdx::z).dataPtr() + a_offset;
111#elif defined(WARPX_DIM_XZ)
112 m_x = soa.GetRealData(PIdx::x).dataPtr() + a_offset;
113 m_z = soa.GetRealData(PIdx::z).dataPtr() + a_offset;
114#elif defined(WARPX_DIM_3D)
115 m_x = soa.GetRealData(PIdx::x).dataPtr() + a_offset;
116 m_y = soa.GetRealData(PIdx::y).dataPtr() + a_offset;
117 m_z = soa.GetRealData(PIdx::z).dataPtr() + a_offset;
118#elif defined(WARPX_DIM_1D_Z)
119 m_z = soa.GetRealData(PIdx::z).dataPtr() + a_offset;
120#elif defined(WARPX_DIM_RCYLINDER)
121 m_x = soa.GetRealData(PIdx::r).dataPtr() + a_offset;
122 m_theta = soa.GetRealData(T_PIdx::theta).dataPtr() + a_offset;
123#elif defined(WARPX_DIM_RSPHERE)
124 m_x = soa.GetRealData(PIdx::r).dataPtr() + a_offset;
125 m_theta = soa.GetRealData(T_PIdx::theta).dataPtr() + a_offset;
126 m_phi = soa.GetRealData(T_PIdx::phi).dataPtr() + a_offset;
127#endif
128#if defined(WARPX_DIM_RZ)
129 m_theta = soa.GetRealData(T_PIdx::theta).dataPtr() + a_offset;
130#endif
131 }
132
136 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
137 void operator() (const long i, RType& x, RType& y, RType& z) const noexcept
138 {
139#if defined(WARPX_DIM_RZ)
140 RType const r = m_x[i];
141 x = r*std::cos(m_theta[i]);
142 y = r*std::sin(m_theta[i]);
143 z = m_z[i];
144#elif defined(WARPX_DIM_RCYLINDER)
145 RType const r = m_x[i];
146 x = r*std::cos(m_theta[i]);
147 y = r*std::sin(m_theta[i]);
148 z = m_z_default;
149#elif defined(WARPX_DIM_RSPHERE)
150 RType const r = m_x[i];
151 x = r*std::cos(m_theta[i])*std::cos(m_phi[i]);
152 y = r*std::sin(m_theta[i])*std::cos(m_phi[i]);
153 z = r*std::sin(m_phi[i]);
154#elif defined(WARPX_DIM_3D)
155 x = m_x[i];
156 y = m_y[i];
157 z = m_z[i];
158#elif defined(WARPX_DIM_XZ)
159 x = m_x[i];
160 y = m_y_default;
161 z = m_z[i];
162#elif defined(WARPX_DIM_1D_Z)
163 x = m_x_default;
164 y = m_y_default;
165 z = m_z[i];
166#endif
167 }
168
174 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
175 void AsStored (const long i, RType& x, RType& y, RType& z) const noexcept
176 {
177#if defined(WARPX_DIM_RZ)
178 x = m_x[i];
179 y = m_theta[i];
180 z = m_z[i];
181#elif defined(WARPX_DIM_RCYLINDER)
182 x = m_x[i];
183 y = m_theta[i];
184 z = m_z_default;
185#elif defined(WARPX_DIM_RSPHERE)
186 x = m_x[i];
187 y = m_theta[i];
188 z = m_phi[i];
189#elif defined(WARPX_DIM_3D)
190 x = m_x[i];
191 y = m_y[i];
192 z = m_z[i];
193#elif defined(WARPX_DIM_XZ)
194 x = m_x[i];
195 y = m_y_default;
196 z = m_z[i];
197#elif defined(WARPX_DIM_1D_Z)
198 x = m_x_default;
199 y = m_y_default;
200 z = m_z[i];
201#endif
202 }
203};
204
212template<typename T_PIdx = PIdx>
213struct SetParticlePosition
214{
215 using RType = amrex::ParticleReal;
216
217#if defined(WARPX_DIM_3D)
218 RType* AMREX_RESTRICT m_x;
219 RType* AMREX_RESTRICT m_y;
220 RType* AMREX_RESTRICT m_z;
221#elif defined(WARPX_DIM_RZ) || defined(WARPX_DIM_XZ)
222 RType* AMREX_RESTRICT m_x;
223 RType* AMREX_RESTRICT m_z;
224#elif defined(WARPX_DIM_1D_Z)
225 RType* AMREX_RESTRICT m_z;
226#elif defined(WARPX_DIM_RCYLINDER) || defined(WARPX_DIM_RSPHERE)
227 RType* AMREX_RESTRICT m_x = nullptr;
228#endif
229
230#if defined(WARPX_DIM_RZ) || defined(WARPX_DIM_RCYLINDER) || defined(WARPX_DIM_RSPHERE)
231 RType* AMREX_RESTRICT m_theta;
232#endif
233#if defined(WARPX_DIM_RSPHERE)
234 RType* AMREX_RESTRICT m_phi;
235#endif
236
237 template <typename ptiType>
238 explicit
239 SetParticlePosition (const ptiType& a_pti, long a_offset = 0) noexcept
240 {
241 auto& soa = a_pti.GetStructOfArrays();
242#if defined(WARPX_DIM_RZ)
243 m_x = soa.GetRealData(PIdx::r).dataPtr() + a_offset;
244 m_z = soa.GetRealData(PIdx::z).dataPtr() + a_offset;
245#elif defined(WARPX_DIM_XZ)
246 m_x = soa.GetRealData(PIdx::x).dataPtr() + a_offset;
247 m_z = soa.GetRealData(PIdx::z).dataPtr() + a_offset;
248#elif defined(WARPX_DIM_3D)
249 m_x = soa.GetRealData(PIdx::x).dataPtr() + a_offset;
250 m_y = soa.GetRealData(PIdx::y).dataPtr() + a_offset;
251 m_z = soa.GetRealData(PIdx::z).dataPtr() + a_offset;
252#elif defined(WARPX_DIM_1D_Z)
253 m_z = soa.GetRealData(PIdx::z).dataPtr() + a_offset;
254#elif defined(WARPX_DIM_RCYLINDER)
255 m_x = soa.GetRealData(PIdx::r).dataPtr() + a_offset;
256 m_theta = soa.GetRealData(T_PIdx::theta).dataPtr() + a_offset;
257#elif defined(WARPX_DIM_RSPHERE)
258 m_x = soa.GetRealData(PIdx::r).dataPtr() + a_offset;
259 m_theta = soa.GetRealData(T_PIdx::theta).dataPtr() + a_offset;
260 m_phi = soa.GetRealData(T_PIdx::phi).dataPtr() + a_offset;
261#endif
262#if defined(WARPX_DIM_RZ)
263 m_theta = soa.GetRealData(T_PIdx::theta).dataPtr() + a_offset;
264#endif
265 }
266
269 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
270 void operator() (const long i, RType x, RType y, RType z) const noexcept
271 {
272 amrex::ignore_unused(x,y,z);
273#if defined(WARPX_DIM_RZ)
274 m_theta[i] = std::atan2(y, x);
275 m_x[i] = std::sqrt(x*x + y*y);
276 m_z[i] = z;
277#elif defined(WARPX_DIM_RCYLINDER)
278 m_theta[i] = std::atan2(y, x);
279 m_x[i] = std::sqrt(x*x + y*y);
280#elif defined(WARPX_DIM_RSPHERE)
281 RType const rxy = std::sqrt(x*x + y*y);
282 RType const r = std::sqrt(x*x + y*y + z*z);
283 m_x[i] = r;
284 m_theta[i] = std::atan2(y, x);
285 m_phi[i] = std::atan2(z, rxy);
286#elif defined(WARPX_DIM_3D)
287 m_x[i] = x;
288 m_y[i] = y;
289 m_z[i] = z;
290#elif defined(WARPX_DIM_XZ)
291 m_x[i] = x;
292 m_z[i] = z;
293#elif defined(WARPX_DIM_1D_Z)
294 m_z[i] = z;
295#endif
296 }
297
302 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
303 void AsStored (const long i, RType x, RType y, RType z) const noexcept
304 {
305 amrex::ignore_unused(x,y,z);
306#if defined(WARPX_DIM_RZ)
307 m_x[i] = x;
308 m_theta[i] = y;
309 m_z[i] = z;
310#elif defined(WARPX_DIM_RCYLINDER)
311 m_x[i] = x;
312 m_theta[i] = y;
313#elif defined(WARPX_DIM_RSPHERE)
314 m_x[i] = x;
315 m_theta[i] = y;
316 m_phi[i] = z;
317#elif defined(WARPX_DIM_3D)
318 m_x[i] = x;
319 m_y[i] = y;
320 m_z[i] = z;
321#elif defined(WARPX_DIM_XZ)
322 m_x[i] = x;
323 m_z[i] = z;
324#elif defined(WARPX_DIM_1D_Z)
325 m_z[i] = z;
326#endif
327 }
328};
329
330#endif // WARPX_PARTICLES_PUSHER_GETANDSETPOSITION_H_
AMREX_FORCE_INLINE
#define AMREX_FORCE_INLINE
AMREX_RESTRICT
#define AMREX_RESTRICT
AMREX_GPU_HOST_DEVICE
#define AMREX_GPU_HOST_DEVICE
AMReX_REAL.H
get_particle_position
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void get_particle_position(const WarpXParticleContainer::SuperParticleType &p, amrex::ParticleReal &x, amrex::ParticleReal &y, amrex::ParticleReal &z) noexcept
Extract the cartesian position coordinates of the particle p and store them in the variables x,...
Definition GetAndSetPosition.H:27
amrex::ParticleContainer_impl< SoAParticle< T_NArrayReal, T_NArrayInt >, T_NArrayReal, T_NArrayInt, Allocator, CellAssignor >::SuperParticleType
Particle< NStructReal+NArrayReal, NStructInt+NArrayInt > SuperParticleType
amrex::ParticleReal
amrex_particle_real ParticleReal
amrex::ignore_unused
__host__ __device__ void ignore_unused(const Ts &...)
GetParticlePosition::m_y
const RType *AMREX_RESTRICT m_y
Definition GetAndSetPosition.H:79
GetParticlePosition::m_y_default
static constexpr RType m_y_default
Definition GetAndSetPosition.H:90
GetParticlePosition::m_x
const RType *AMREX_RESTRICT m_x
Definition GetAndSetPosition.H:78
GetParticlePosition::AsStored
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void AsStored(const long i, RType &x, RType &y, RType &z) const noexcept
Extract the position coordinates of the particle as stored located at index i + a_offset and store th...
Definition GetAndSetPosition.H:175
GetParticlePosition::m_theta
const RType *AMREX_RESTRICT m_theta
Definition GetAndSetPosition.H:83
GetParticlePosition::m_x_default
static constexpr RType m_x_default
Definition GetAndSetPosition.H:89
GetParticlePosition::GetParticlePosition
GetParticlePosition(const ptiType &a_pti, long a_offset=0) noexcept
Definition GetAndSetPosition.H:104
GetParticlePosition::m_z_default
static constexpr RType m_z_default
Definition GetAndSetPosition.H:91
GetParticlePosition::RType
amrex::ParticleReal RType
Definition GetAndSetPosition.H:76
GetParticlePosition::GetParticlePosition
GetParticlePosition()=default
GetParticlePosition::m_z
const RType *AMREX_RESTRICT m_z
Definition GetAndSetPosition.H:80
GetParticlePosition::operator()
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void operator()(const long i, RType &x, RType &y, RType &z) const noexcept
Extract the cartesian position coordinates of the particle located at index i + a_offset and store th...
Definition GetAndSetPosition.H:137
PIdx::x
@ x
Definition WarpXParticleContainer.H:70
PIdx::z
@ z
Definition WarpXParticleContainer.H:70
SetParticlePosition::operator()
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void operator()(const long i, RType x, RType y, RType z) const noexcept
Set the position of the particle at index i + a_offset to x, y, z
Definition GetAndSetPosition.H:270
SetParticlePosition::AsStored
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void AsStored(const long i, RType x, RType y, RType z) const noexcept
Set the position of the particle at index i + a_offset to x, y, z This is only different for RZ since...
Definition GetAndSetPosition.H:303
SetParticlePosition::m_z
RType *AMREX_RESTRICT m_z
Definition GetAndSetPosition.H:223
SetParticlePosition::SetParticlePosition
SetParticlePosition(const ptiType &a_pti, long a_offset=0) noexcept
Definition GetAndSetPosition.H:239
SetParticlePosition::m_theta
RType *AMREX_RESTRICT m_theta
Definition GetAndSetPosition.H:231
SetParticlePosition::RType
amrex::ParticleReal RType
Definition GetAndSetPosition.H:215
SetParticlePosition::m_x
RType *AMREX_RESTRICT m_x
Definition GetAndSetPosition.H:222
Generated by doxygen 1.13.2