ImpactX
Aperture.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_APERTURE_H
11 #define IMPACTX_APERTURE_H
12 
13 
15 #include "mixin/alignment.H"
16 #include "mixin/beamoptic.H"
17 #include "mixin/thin.H"
18 #include "mixin/nofinalize.H"
19 
20 #include <AMReX_Extension.H>
21 #include <AMReX_REAL.H>
22 
23 #include <cmath>
24 
25 namespace impactx
26 {
27  struct Aperture
28  : public elements::BeamOptic<Aperture>,
29  public elements::Thin,
30  public elements::Alignment,
32  {
33  static constexpr auto name = "Aperture";
35 
36  enum Shape
37  {
40  };
41 
53  amrex::ParticleReal xmax,
54  amrex::ParticleReal ymax,
55  Shape shape,
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_shape(shape), m_xmax(xmax), m_ymax(ymax)
62  {
63  }
64 
66  using BeamOptic::operator();
67 
82  amrex::ParticleReal & AMREX_RESTRICT x,
83  amrex::ParticleReal & AMREX_RESTRICT y,
84  [[maybe_unused]] amrex::ParticleReal & AMREX_RESTRICT t,
85  amrex::ParticleReal & AMREX_RESTRICT px,
86  amrex::ParticleReal & AMREX_RESTRICT py,
87  [[maybe_unused]] amrex::ParticleReal & AMREX_RESTRICT pt,
88  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  // scale horizontal and vertical coordinates
98  amrex::ParticleReal const u = x / m_xmax;
99  amrex::ParticleReal const v = y / m_ymax;
100 
101  // compare against the aperture boundary
102  switch (m_shape)
103  {
104  case Shape::rectangular : // default
105  if (pow(u,2)>1 || pow(v,2) > 1_prt) {
107  }
108  break;
109 
110  case Shape::elliptical :
111  if (pow(u,2)+pow(v,2) > 1_prt) {
113  }
114  break;
115  }
116 
117  // undo shift due to alignment errors of the element
118  shift_out(x, y, px, py);
119  }
120 
122  using Thin::operator();
123 
125  amrex::ParticleReal m_xmax;
126  amrex::ParticleReal m_ymax;
127 
128  };
129 
130 } // namespace impactx
131 
132 #endif // IMPACTX_APERTURE_H
#define AMREX_FORCE_INLINE
#define AMREX_GPU_HOST_DEVICE
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE GpuComplex< T > pow(const GpuComplex< T > &a_z, const T &a_y) noexcept
Definition: ImpactX.cpp:33
xmax
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void make_invalid() const noexcept
Definition: Aperture.H:32
static constexpr auto name
Definition: Aperture.H:33
Shape m_shape
Definition: Aperture.H:124
ImpactXParticleContainer::ParticleType PType
Definition: Aperture.H:34
amrex::ParticleReal m_xmax
aperture type (rectangular, elliptical)
Definition: Aperture.H:125
Aperture(amrex::ParticleReal xmax, amrex::ParticleReal ymax, Shape shape, amrex::ParticleReal dx=0, amrex::ParticleReal dy=0, amrex::ParticleReal rotation_degree=0)
Definition: Aperture.H:52
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void operator()(amrex::ParticleReal &AMREX_RESTRICT x, amrex::ParticleReal &AMREX_RESTRICT y, [[maybe_unused]] amrex::ParticleReal &AMREX_RESTRICT t, amrex::ParticleReal &AMREX_RESTRICT px, amrex::ParticleReal &AMREX_RESTRICT py, [[maybe_unused]] amrex::ParticleReal &AMREX_RESTRICT pt, uint64_t &AMREX_RESTRICT idcpu, [[maybe_unused]] RefPart const &refpart) const
Definition: Aperture.H:81
Shape
Definition: Aperture.H:37
@ elliptical
Definition: Aperture.H:39
@ rectangular
Definition: Aperture.H:38
amrex::ParticleReal m_ymax
maximum horizontal coordinate
Definition: Aperture.H:126
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