ImpactX
ImpactXParticleContainer.H
Go to the documentation of this file.
1 /* Copyright 2022-2023 The Regents of the University of California, through Lawrence
2  * Berkeley National Laboratory (subject to receipt of any required
3  * approvals from the U.S. Dept. of Energy). All rights reserved.
4  *
5  * This file is part of ImpactX.
6  *
7  * Authors: Axel Huebl
8  * License: BSD-3-Clause-LBNL
9  */
10 #ifndef IMPACTX_PARTICLE_CONTAINER_H
11 #define IMPACTX_PARTICLE_CONTAINER_H
12 
13 #include "ReferenceParticle.H"
15 
16 #include <AMReX_AmrCoreFwd.H>
17 #include <AMReX_BaseFwd.H>
18 #include <AMReX_MultiFab.H>
19 #include <AMReX_ParIter.H>
20 #include <AMReX_Particles.H>
21 #include <AMReX_ParticleTile.H>
22 
23 #include <AMReX_IntVect.H>
24 #include <AMReX_Vector.H>
25 
26 #include <optional>
27 #include <tuple>
28 #include <unordered_map>
29 
30 
31 namespace impactx
32 {
33  enum class CoordSystem
34  {
35  s,
36  t
37  };
38 
42  struct RealSoA
43  {
44  enum
45  {
46  x,
47  y,
48  t,
49  px,
50  py,
51  pt,
52  qm,
53  w,
54  nattribs
55  };
56 
57  // at fixed t, the third component represents the position z, the 6th component represents the momentum in z
58  enum {
59  z = t,
60  pz = pt
61  };
62 
64  static constexpr auto names_s = { "position_x", "position_y", "position_t", "momentum_x", "momentum_y", "momentum_t", "qm", "weighting" };
66  static constexpr auto names_t = { "position_x", "position_y", "position_z", "momentum_x", "momentum_y", "momentum_z", "qm", "weighting" };
67  static_assert(names_s.size() == nattribs);
68  static_assert(names_t.size() == nattribs);
69  };
70 
74  struct IntSoA
75  {
76  enum
77  {
78  nattribs
79  };
80 
82  static constexpr std::initializer_list<char const *> names_s = {};
84  static constexpr std::initializer_list<char const *> names_t = {};
85  static_assert(names_s.size() == nattribs);
86  static_assert(names_t.size() == nattribs);
87  };
88 
94  class ParIterSoA
95  : public amrex::ParIterSoA<RealSoA::nattribs, IntSoA::nattribs>
96  {
97  public:
99 
100  ParIterSoA (ContainerType& pc, int level);
101 
102  ParIterSoA (ContainerType& pc, int level, amrex::MFItInfo& info);
103  };
104 
111  : public amrex::ParConstIterSoA<RealSoA::nattribs, IntSoA::nattribs>
112  {
113  public:
115 
116  ParConstIterSoA (ContainerType& pc, int level);
117 
118  ParConstIterSoA (ContainerType& pc, int level, amrex::MFItInfo& info);
119  };
120 
126  : public amrex::ParticleContainerPureSoA<RealSoA::nattribs, IntSoA::nattribs>
127  {
128  public:
131 
134 
137 
139  virtual ~ImpactXParticleContainer() = default;
140 
157  void
158  AddNParticles (
165  amrex::ParticleReal qm,
166  amrex::ParticleReal bchchg
167  );
168 
173  void
175 
178 
183  void
184  SetRefParticle (RefPart const & refpart);
185 
190  RefPart &
191  GetRefParticle ();
192 
197  RefPart const &
198  GetRefParticle () const;
199 
203  void SetRefParticleEdge ();
204 
207  int
208  GetParticleShape () const { return m_particle_shape.value(); }
209 
216  void SetParticleShape ();
217 
226  void SetParticleShape (int order);
227 
232  std::tuple<
233  amrex::ParticleReal, amrex::ParticleReal,
234  amrex::ParticleReal, amrex::ParticleReal,
235  amrex::ParticleReal, amrex::ParticleReal>
237 
242  std::tuple<
243  amrex::ParticleReal, amrex::ParticleReal,
244  amrex::ParticleReal, amrex::ParticleReal,
245  amrex::ParticleReal, amrex::ParticleReal>
247 
257  void
258  DepositCharge (std::unordered_map<int, amrex::MultiFab> & rho,
259  amrex::Vector<amrex::IntVect> const & ref_ratio);
260 
262  std::vector<std::string>
263  RealSoA_names () const;
264 
266  std::vector<std::string>
267  intSoA_names () const;
268 
271  GetCoordSystem () const;
272 
277  void
278  SetCoordSystem (CoordSystem coord_system);
279 
280  private:
281 
284 
286  std::optional<int> m_particle_shape;
287 
290 
293 
294  }; // ImpactXParticleContainer
295 
301  std::vector<std::string>
302  get_RealSoA_names (int num_real_comps);
303 
309  std::vector<std::string>
310  get_intSoA_names (int num_int_comps);
311 
312 } // namespace impactx
313 
314 #endif // IMPACTX_PARTICLE_CONTAINER_H
Definition: ImpactXParticleContainer.H:127
virtual ~ImpactXParticleContainer()=default
Destruct a particle container.
int GetParticleShape() const
Definition: ImpactXParticleContainer.H:208
void SetLostParticleContainer(ImpactXParticleContainer *lost_pc)
Definition: ImpactXParticleContainer.cpp:64
void DepositCharge(std::unordered_map< int, amrex::MultiFab > &rho, amrex::Vector< amrex::IntVect > const &ref_ratio)
Definition: ChargeDeposition.cpp:27
void AddNParticles(amrex::Gpu::DeviceVector< amrex::ParticleReal > const &x, amrex::Gpu::DeviceVector< amrex::ParticleReal > const &y, amrex::Gpu::DeviceVector< amrex::ParticleReal > const &t, amrex::Gpu::DeviceVector< amrex::ParticleReal > const &px, amrex::Gpu::DeviceVector< amrex::ParticleReal > const &py, amrex::Gpu::DeviceVector< amrex::ParticleReal > const &pt, amrex::ParticleReal qm, amrex::ParticleReal bchchg)
Definition: ImpactXParticleContainer.cpp:106
std::vector< std::string > intSoA_names() const
Definition: ImpactXParticleContainer.cpp:253
std::tuple< amrex::ParticleReal, amrex::ParticleReal, amrex::ParticleReal, amrex::ParticleReal, amrex::ParticleReal, amrex::ParticleReal > MinAndMaxPositions()
Definition: ImpactXParticleContainer.cpp:228
void SetRefParticle(RefPart const &refpart)
Definition: ImpactXParticleContainer.cpp:201
std::vector< std::string > RealSoA_names() const
Definition: ImpactXParticleContainer.cpp:247
CoordSystem GetCoordSystem() const
Definition: ImpactXParticleContainer.cpp:259
void SetRefParticleEdge()
Definition: ImpactXParticleContainer.cpp:219
ImpactXParticleContainer * m_particles_lost
a non-owning reference to lost particles, i.e., due to apertures
Definition: ImpactXParticleContainer.H:289
ImpactXParticleContainer(initialization::AmrCoreData *amr_core)
Construct a new particle container.
Definition: ImpactXParticleContainer.cpp:57
void SetParticleShape()
Definition: ImpactXParticleContainer.cpp:95
void SetCoordSystem(CoordSystem coord_system)
Definition: ImpactXParticleContainer.cpp:265
ImpactXParticleContainer * GetLostParticleContainer()
Definition: ImpactXParticleContainer.cpp:70
std::tuple< amrex::ParticleReal, amrex::ParticleReal, amrex::ParticleReal, amrex::ParticleReal, amrex::ParticleReal, amrex::ParticleReal > MeanAndStdPositions()
Definition: ImpactXParticleContainer.cpp:238
RefPart m_refpart
the reference particle for the beam in the particle container
Definition: ImpactXParticleContainer.H:283
std::optional< int > m_particle_shape
the particle shape
Definition: ImpactXParticleContainer.H:286
CoordSystem m_coordsystem
the current coordinate system of particles in this container
Definition: ImpactXParticleContainer.H:292
RefPart & GetRefParticle()
Definition: ImpactXParticleContainer.cpp:207
Definition: ImpactXParticleContainer.H:112
ParConstIterSoA(ContainerType &pc, int level)
Definition: ImpactXParticleContainer.cpp:49
Definition: ImpactXParticleContainer.H:96
ParIterSoA(ContainerType &pc, int level)
Definition: ImpactXParticleContainer.cpp:41
Definition: AmrCoreData.H:42
Definition: ImpactX.cpp:33
std::vector< std::string > get_RealSoA_names(int num_real_comps)
Definition: ImpactXParticleContainer.cpp:271
CoordSystem
Definition: ImpactXParticleContainer.H:34
@ s
fixed s as the independent variable
@ t
fixed t as the independent variable
std::vector< std::string > get_intSoA_names(int num_int_comps)
Definition: ImpactXParticleContainer.cpp:289
Definition: ImpactXParticleContainer.H:75
static constexpr std::initializer_list< char const * > names_s
named labels for fixed s
Definition: ImpactXParticleContainer.H:82
static constexpr std::initializer_list< char const * > names_t
named labels for fixed t
Definition: ImpactXParticleContainer.H:84
@ nattribs
the number of attributes above (always last)
Definition: ImpactXParticleContainer.H:78
Definition: ImpactXParticleContainer.H:43
@ pt
energy deviation, scaled by speed of light * the magnitude of the reference momentum [unitless] (at f...
Definition: ImpactXParticleContainer.H:51
@ y
position in y [m] (at fixed s or t)
Definition: ImpactXParticleContainer.H:47
@ t
time-of-flight ct [m] (at fixed s)
Definition: ImpactXParticleContainer.H:48
@ w
particle weight, number of real particles represented by this macroparticle [unitless]
Definition: ImpactXParticleContainer.H:53
@ px
momentum in x, scaled by the magnitude of the reference momentum [unitless] (at fixed s or t)
Definition: ImpactXParticleContainer.H:49
@ nattribs
the number of attributes above (always last)
Definition: ImpactXParticleContainer.H:54
@ py
momentum in y, scaled by the magnitude of the reference momentum [unitless] (at fixed s or t)
Definition: ImpactXParticleContainer.H:50
@ x
position in x [m] (at fixed s or t)
Definition: ImpactXParticleContainer.H:46
@ qm
charge to mass ratio, in q_e/m_e [q_e/eV]
Definition: ImpactXParticleContainer.H:52
static constexpr auto names_s
named labels for fixed s
Definition: ImpactXParticleContainer.H:64
@ z
position in z [m] (at fixed t)
Definition: ImpactXParticleContainer.H:59
@ pz
momentum in z, scaled by the magnitude of the reference momentum [unitless] (at fixed t)
Definition: ImpactXParticleContainer.H:60
static constexpr auto names_t
named labels for fixed t
Definition: ImpactXParticleContainer.H:66
Definition: ReferenceParticle.H:30