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 
82  amrex::ParticleReal & AMREX_RESTRICT x,
83  amrex::ParticleReal & AMREX_RESTRICT y,
84  amrex::ParticleReal & AMREX_RESTRICT t,
85  amrex::ParticleReal & AMREX_RESTRICT px,
86  amrex::ParticleReal & AMREX_RESTRICT py,
87  amrex::ParticleReal & AMREX_RESTRICT pt,
88  [[maybe_unused]] uint64_t & AMREX_RESTRICT idcpu,
89  [[maybe_unused]] RefPart const & refpart
90  ) const
91  {
92  using namespace amrex::literals; // for _rt and _prt
93 
94  // shift due to alignment errors of the element
95  shift_in(x, y, px, py);
96 
97  // access position data
98  amrex::ParticleReal const xout = x;
99  amrex::ParticleReal const yout = y;
100  amrex::ParticleReal const tout = t;
101 
102  // normalize quad units to MAD-X convention if needed
103  amrex::ParticleReal dpx = m_xkick;
104  amrex::ParticleReal dpy = m_ykick;
105  if (m_unit == UnitSystem::Tm) {
106  dpx /= refpart.rigidity_Tm();
107  dpy /= refpart.rigidity_Tm();
108  }
109 
110  // intialize output values of momenta
111  amrex::ParticleReal pxout = px;
112  amrex::ParticleReal pyout = py;
113  amrex::ParticleReal ptout = pt;
114 
115  // advance position and momentum
116  x = xout;
117  pxout = px + dpx;
118 
119  y = yout;
120  pyout = py + dpy;
121 
122  t = tout;
123  ptout = pt;
124 
125  // assign updated momenta
126  px = pxout;
127  py = pyout;
128  pt = ptout;
129 
130  // undo shift due to alignment errors of the element
131  shift_out(x, y, px, py);
132  }
133 
135  using Thin::operator();
136 
137  amrex::ParticleReal m_xkick;
138  amrex::ParticleReal m_ykick;
140  };
141 
142 } // namespace impactx
143 
144 #endif // IMPACTX_KICKER_H
#define AMREX_FORCE_INLINE
#define AMREX_GPU_HOST_DEVICE
Definition: ImpactX.cpp:33
@ t
fixed t as the independent variable
Definition: Kicker.H:32
amrex::ParticleReal m_ykick
horizontal kick strength
Definition: Kicker.H:138
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
UnitSystem m_unit
vertical kick strength
Definition: Kicker.H:139
amrex::ParticleReal m_xkick
Definition: Kicker.H:137
ImpactXParticleContainer::ParticleType PType
Definition: Kicker.H:34
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void operator()(amrex::ParticleReal &AMREX_RESTRICT x, amrex::ParticleReal &AMREX_RESTRICT y, amrex::ParticleReal &AMREX_RESTRICT t, amrex::ParticleReal &AMREX_RESTRICT px, amrex::ParticleReal &AMREX_RESTRICT py, amrex::ParticleReal &AMREX_RESTRICT pt, [[maybe_unused]] uint64_t &AMREX_RESTRICT idcpu, [[maybe_unused]] RefPart const &refpart) const
Definition: Kicker.H:81
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
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:149
Definition: nofinalize.H:22
Definition: thin.H:24