ImpactX
Kicker.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: Chad Mitchell, Axel Huebl
8  * License: BSD-3-Clause-LBNL
9  */
10 #ifndef IMPACTX_KICKER_H
11 #define IMPACTX_KICKER_H
12 
14 #include "mixin/alignment.H"
15 #include "mixin/beamoptic.H"
16 #include "mixin/thin.H"
17 #include "mixin/nofinalize.H"
18 
19 #include <AMReX_Extension.H>
20 #include <AMReX_REAL.H>
21 #include <AMReX_GpuComplex.H>
22 
23 #include <cmath>
24 
25 namespace impactx
26 {
27  struct Kicker
28  : public elements::BeamOptic<Kicker>,
29  public elements::Thin,
30  public elements::Alignment,
32  {
33  static constexpr auto name = "Kicker";
35 
37  {
39  Tm = 1
40  };
41 
53  amrex::ParticleReal xkick,
54  amrex::ParticleReal ykick,
55  UnitSystem unit,
56  amrex::ParticleReal dx = 0,
57  amrex::ParticleReal dy = 0,
58  amrex::ParticleReal rotation_degree = 0
59  )
60  : Alignment(dx, dy, rotation_degree),
61  m_xkick(xkick), m_ykick(ykick), m_unit(unit)
62  {
63  }
64 
66  using BeamOptic::operator();
67 
79  PType& AMREX_RESTRICT p,
80  amrex::ParticleReal & AMREX_RESTRICT px,
81  amrex::ParticleReal & AMREX_RESTRICT py,
82  amrex::ParticleReal & AMREX_RESTRICT pt,
83  [[maybe_unused]] RefPart const & refpart) const
84  {
85  using namespace amrex::literals; // for _rt and _prt
86 
87  // shift due to alignment errors of the element
88  shift_in(p.pos(RealAoS::x), p.pos(RealAoS::y), px, py);
89 
90  // access AoS data such as positions and cpu/id
91  amrex::ParticleReal const x = p.pos(RealAoS::x);
92  amrex::ParticleReal const y = p.pos(RealAoS::y);
93  amrex::ParticleReal const t = p.pos(RealAoS::t);
94 
95  // normalize quad units to MAD-X convention if needed
96  amrex::ParticleReal dpx = m_xkick;
97  amrex::ParticleReal dpy = m_ykick;
98  if (m_unit == UnitSystem::Tm) {
99  dpx /= refpart.rigidity_Tm();
100  dpy /= refpart.rigidity_Tm();
101  }
102 
103  // intialize output values of momenta
104  amrex::ParticleReal pxout = px;
105  amrex::ParticleReal pyout = py;
106  amrex::ParticleReal ptout = pt;
107 
108  // advance position and momentum
109  p.pos(RealAoS::x) = x;
110  pxout = px + dpx;
111 
112  p.pos(RealAoS::y) = y;
113  pyout = py + dpy;
114 
115  p.pos(RealAoS::t) = t;
116  ptout = pt;
117 
118  // assign updated momenta
119  px = pxout;
120  py = pyout;
121  pt = ptout;
122 
123  // undo shift due to alignment errors of the element
124  shift_out(p.pos(RealAoS::x), p.pos(RealAoS::y), px, py);
125  }
126 
128  using Thin::operator();
129 
130  private:
131  amrex::ParticleReal m_xkick;
132  amrex::ParticleReal m_ykick;
134  };
135 
136 } // namespace impactx
137 
138 #endif // IMPACTX_KICKER_H
#define AMREX_FORCE_INLINE
#define AMREX_GPU_HOST_DEVICE
Definition: ImpactX.cpp:36
@ t
fixed t as the independent variable
Definition: Kicker.H:32
amrex::ParticleReal m_ykick
horizontal kick strength
Definition: Kicker.H:132
UnitSystem
Definition: Kicker.H:37
@ Tm
in units of the magnetic rigidity of the reference particle
Definition: Kicker.H:39
@ dimensionless
Definition: Kicker.H:38
static constexpr auto name
Definition: Kicker.H:33
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void operator()(PType &AMREX_RESTRICT p, amrex::ParticleReal &AMREX_RESTRICT px, amrex::ParticleReal &AMREX_RESTRICT py, amrex::ParticleReal &AMREX_RESTRICT pt, [[maybe_unused]] RefPart const &refpart) const
Definition: Kicker.H:78
UnitSystem m_unit
vertical kick strength
Definition: Kicker.H:133
amrex::ParticleReal m_xkick
Definition: Kicker.H:131
ImpactXParticleContainer::ParticleType PType
Definition: Kicker.H:34
Kicker(amrex::ParticleReal xkick, amrex::ParticleReal ykick, UnitSystem unit, amrex::ParticleReal dx=0, amrex::ParticleReal dy=0, amrex::ParticleReal rotation_degree=0)
Definition: Kicker.H:52
@ x
position in x [m] (at fixed s OR fixed t)
Definition: ImpactXParticleContainer.H:48
@ y
position in y [m] (at fixed s OR fixed t)
Definition: ImpactXParticleContainer.H:49
@ t
c * time-of-flight [m] (at fixed s)
Definition: ImpactXParticleContainer.H:50
Definition: ReferenceParticle.H:30
Definition: alignment.H:27
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void shift_out(amrex::ParticleReal &AMREX_RESTRICT x, amrex::ParticleReal &AMREX_RESTRICT y, amrex::ParticleReal &AMREX_RESTRICT px, amrex::ParticleReal &AMREX_RESTRICT py) const
Definition: alignment.H:91
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal dx() const
Definition: alignment.H:120
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void shift_in(amrex::ParticleReal &AMREX_RESTRICT x, amrex::ParticleReal &AMREX_RESTRICT y, amrex::ParticleReal &AMREX_RESTRICT px, amrex::ParticleReal &AMREX_RESTRICT py) const
Definition: alignment.H:61
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal dy() const
Definition: alignment.H:130
Definition: beamoptic.H:135
Definition: nofinalize.H:22
Definition: thin.H:24