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

#include <Quad.H>

Public Types

using PType = ImpactXParticleContainer::ParticleType
 

Public Member Functions

 Quad (amrex::ParticleReal const ds, amrex::ParticleReal const k, 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
 
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 = "Quad"
 

Private Attributes

amrex::ParticleReal m_ds
 
amrex::ParticleReal m_k
 segment length in m More...
 
int m_nslice
 quadrupole strength in 1/m More...
 

Member Typedef Documentation

◆ PType

Constructor & Destructor Documentation

◆ Quad()

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

A Quadrupole magnet

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

Member Function Documentation

◆ ds()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal impactx::Quad::ds ( ) const
inline

Return the segment length

Returns
value in meters

◆ nslice()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int impactx::Quad::nslice ( ) const
inline

Number of slices used for the application of space charge

Returns
positive integer

◆ operator()() [1/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::Quad::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 quad functor, so that a variable of this type can be used like a quad 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::Quad::operator() ( RefPart &AMREX_RESTRICT  refpart) const
inline

This pushes the reference particle.

Parameters
[in,out]refpartreference particle

Member Data Documentation

◆ m_ds

amrex::ParticleReal impactx::Quad::m_ds
private

◆ m_k

amrex::ParticleReal impactx::Quad::m_k
private

segment length in m

◆ m_nslice

int impactx::Quad::m_nslice
private

quadrupole strength in 1/m

◆ name

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

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