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

#include <ChrQuad.H>

Inheritance diagram for impactx::ChrQuad:
impactx::elements::BeamOptic< ChrQuad > impactx::elements::Thick impactx::elements::NoFinalize

Public Types

using PType = ImpactXParticleContainer::ParticleType
 

Public Member Functions

 ChrQuad (amrex::ParticleReal const ds, amrex::ParticleReal const k, int const unit, int const nslice)
 
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, RefPart const &refpart) const
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void operator() (RefPart &AMREX_RESTRICT refpart) const
 
- Public Member Functions inherited from impactx::elements::BeamOptic< ChrQuad >
void operator() (ImpactXParticleContainer &pc, int step)
 
void operator() (ImpactXParticleContainer::iterator &pti, RefPart &AMREX_RESTRICT ref_part)
 
- Public Member Functions inherited from impactx::elements::Thick
 Thick (amrex::ParticleReal const ds, int const nslice)
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int nslice () const
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal ds () const
 
- Public Member Functions inherited from impactx::elements::NoFinalize
void finalize ()
 

Static Public Attributes

static constexpr auto name = "ChrQuad"
 

Private Attributes

amrex::ParticleReal m_k
 
int m_unit
 quadrupole strength in 1/m^2 (or T/m) More...
 

Additional Inherited Members

- Protected Attributes inherited from impactx::elements::Thick
amrex::ParticleReal m_ds
 
int m_nslice
 segment length in m More...
 

Member Typedef Documentation

◆ PType

Constructor & Destructor Documentation

◆ ChrQuad()

impactx::ChrQuad::ChrQuad ( amrex::ParticleReal const  ds,
amrex::ParticleReal const  k,
int const  unit,
int const  nslice 
)
inline

A Quadrupole magnet with chromatic focusing

The Hamiltonian is expanded through second order in the transverse variables (x,px,y,py), with the exact pt dependence retained.

Parameters
dsSegment length in m.
kQuadrupole strength in m^(-2) (MADX convention) = (gradient in T/m) / (rigidity in T-m) OR Quadrupole strength in T/m (MaryLie convention) k > 0 horizontal focusing k < 0 horizontal defocusing
unitUnit specification unit = 0 MADX convention (default) unit = 1 MaryLie convention
nslicenumber of slices used for the application of space charge

Member Function Documentation

◆ operator()() [1/2]

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

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

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

◆ operator()() [2/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::ChrQuad::operator() ( RefPart &AMREX_RESTRICT  refpart) const
inline

This pushes the reference particle.

Parameters
[in,out]refpartreference particle

Member Data Documentation

◆ m_k

amrex::ParticleReal impactx::ChrQuad::m_k
private

◆ m_unit

int impactx::ChrQuad::m_unit
private

quadrupole strength in 1/m^2 (or T/m)

◆ name

constexpr auto impactx::ChrQuad::name = "ChrQuad"
staticconstexpr

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