ImpactX
Public Types | Public Member Functions | Static Public Attributes | Private Attributes | List of all members
impactx::DipEdge Struct Reference

#include <DipEdge.H>

Inheritance diagram for impactx::DipEdge:
impactx::elements::BeamOptic< DipEdge > impactx::elements::Thin

Public Types

using PType = ImpactXParticleContainer::ParticleType
 

Public Member Functions

 DipEdge (amrex::ParticleReal const psi, amrex::ParticleReal const rc, amrex::ParticleReal const g, amrex::ParticleReal const K2)
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void operator() (PType &AMREX_RESTRICT p, amrex::ParticleReal &AMREX_RESTRICT px, amrex::ParticleReal &AMREX_RESTRICT py, [[maybe_unused]] amrex::ParticleReal &AMREX_RESTRICT pt, [[maybe_unused]] RefPart const &refpart) const
 
- Public Member Functions inherited from impactx::elements::BeamOptic< DipEdge >
void operator() (ImpactXParticleContainer::iterator &pti, RefPart &AMREX_RESTRICT ref_part)
 
- Public Member Functions inherited from impactx::elements::Thin
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void operator() ([[maybe_unused]] RefPart &AMREX_RESTRICT refpart) const
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int nslice () const
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal ds () const
 

Static Public Attributes

static constexpr auto name = "DipEdge"
 

Private Attributes

amrex::ParticleReal m_psi
 
amrex::ParticleReal m_rc
 pole face angle in rad More...
 
amrex::ParticleReal m_g
 bend radius in m More...
 
amrex::ParticleReal m_K2
 gap parameter in m More...
 

Member Typedef Documentation

◆ PType

Constructor & Destructor Documentation

◆ DipEdge()

impactx::DipEdge::DipEdge ( amrex::ParticleReal const  psi,
amrex::ParticleReal const  rc,
amrex::ParticleReal const  g,
amrex::ParticleReal const  K2 
)
inline

Edge focusing associated with bend entry or exit

This model assumes a first-order effect of nonzero gap. Here we use the linear fringe field map, given to first order in g/rc (gap / radius of curvature).

References: K. L. Brown, SLAC Report No. 75 (1982). K. Hwang and S. Y. Lee, PRAB 18, 122401 (2015).

Parameters
psiPole face angle in rad.
rcRadius of curvature in m.
gGap parameter in m.
K2Fringe field integral (unitless).

Member Function Documentation

◆ operator()()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::DipEdge::operator() ( PType &AMREX_RESTRICT  p,
amrex::ParticleReal &AMREX_RESTRICT  px,
amrex::ParticleReal &AMREX_RESTRICT  py,
[[maybe_unused] ] amrex::ParticleReal &AMREX_RESTRICT  pt,
[[maybe_unused] ] RefPart const &  refpart 
) const
inline

This is a dipedge functor, so that a variable of this type can be used like a dipedge function.

Parameters
pParticle AoS data for positions and cpu/id
pxparticle momentum in x
pyparticle momentum in y
ptparticle momentum in t (unchanged)
refpartreference particle (unused)

Member Data Documentation

◆ m_g

amrex::ParticleReal impactx::DipEdge::m_g
private

bend radius in m

◆ m_K2

amrex::ParticleReal impactx::DipEdge::m_K2
private

gap parameter in m

◆ m_psi

amrex::ParticleReal impactx::DipEdge::m_psi
private

◆ m_rc

amrex::ParticleReal impactx::DipEdge::m_rc
private

pole face angle in rad

◆ name

constexpr auto impactx::DipEdge::name = "DipEdge"
static

The documentation for this struct was generated from the following file: