impactx::Quad Struct Reference

#include <Quad.H>

Inheritance diagram for impactx::Quad:

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
Public Member Functions inherited from impactx::elements::BeamOptic< Quad >
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 = "Quad"

Private Attributes
amrex::ParticleReal	m_k

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

using impactx::Quad::PType = ImpactXParticleContainer::ParticleType

Constructor & Destructor Documentation

Quad()

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

inline

A Quadrupole magnet

Parameters

ds	Segment length in m.
k	Quadrupole strength in m^(-2) (MADX convention) = (gradient in T/m) / (rigidity in T-m) k > 0 horizontal focusing k < 0 horizontal defocusing
nslice	number of slices used for the application of space charge

Member Function Documentation

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

p	Particle AoS data for positions and cpu/id
px	particle momentum in x
py	particle momentum in y
pt	particle momentum in t
refpart	reference 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]

refpart

reference particle

Member Data Documentation

m_k

amrex::ParticleReal impactx::Quad::m_k

private

name

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

staticconstexpr

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/23.06/src/particles/elements/Quad.H