#include <Quad.H>

Inheritance diagram for impactx::elements::Quad:

Public Types
using	PType = ImpactXParticleContainer::ParticleType

Public Member Functions
	Quad (amrex::ParticleReal ds, amrex::ParticleReal k, amrex::ParticleReal dx=DEFAULT_dx, amrex::ParticleReal dy=DEFAULT_dy, amrex::ParticleReal rotation_degree=DEFAULT_rotation_degree, amrex::ParticleReal aperture_x=DEFAULT_aperture_x, amrex::ParticleReal aperture_y=DEFAULT_aperture_y, int nslice=DEFAULT_nslice, std::optional< std::string > name=DEFAULT_name)
void	reverse ()
void	compute_constants (RefPart const &refpart)
template<typename T_Real = amrex::ParticleReal, typename T_IdCpu = uint64_t>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	operator() (T_Real &AMREX_RESTRICT x, T_Real &AMREX_RESTRICT y, T_Real &AMREX_RESTRICT t, T_Real &AMREX_RESTRICT px, T_Real &AMREX_RESTRICT py, T_Real const &AMREX_RESTRICT pt, T_IdCpu const &AMREX_RESTRICT idcpu, RefPart const &AMREX_RESTRICT refpart) const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	operator() (RefPart &AMREX_RESTRICT refpart) const
AMREX_GPU_HOST AMREX_FORCE_INLINE Map6x6	transport_map (RefPart const &AMREX_RESTRICT refpart) const
template<typename T_Real = amrex::ParticleReal, typename T_IdCpu = uint64_t>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	spin_and_phasespace_push (T_Real &AMREX_RESTRICT x, T_Real &AMREX_RESTRICT y, T_Real &AMREX_RESTRICT t, T_Real &AMREX_RESTRICT px, T_Real &AMREX_RESTRICT py, T_Real const &AMREX_RESTRICT pt, T_Real &AMREX_RESTRICT sx, T_Real &AMREX_RESTRICT sy, T_Real &AMREX_RESTRICT sz, T_IdCpu const &AMREX_RESTRICT idcpu, RefPart const &AMREX_RESTRICT refpart) const
Public Member Functions inherited from impactx::elements::mixin::Named
AMREX_GPU_HOST void	set_name (std::string const &new_name)
AMREX_GPU_HOST	Named (std::optional< std::string > name)
AMREX_GPU_HOST_DEVICE	~Named ()
AMREX_GPU_HOST	Named (Named const &other)
AMREX_GPU_HOST Named &	operator= (Named const &other)
AMREX_GPU_HOST_DEVICE	Named (Named &&other) noexcept
AMREX_GPU_HOST_DEVICE Named &	operator= (Named &&other) noexcept
AMREX_FORCE_INLINE std::string	name () const
AMREX_FORCE_INLINE bool	has_name () const
Public Member Functions inherited from impactx::elements::mixin::BeamOptic< Quad >
void	operator() (ImpactXParticleContainer &pc, int step, int period)
Public Member Functions inherited from impactx::elements::mixin::LinearTransport< Quad >
AMREX_GPU_HOST AMREX_FORCE_INLINE void	operator() (Map6x6 &AMREX_RESTRICT cm, RefPart const &AMREX_RESTRICT ref) const
Public Member Functions inherited from impactx::elements::mixin::Thick
	Thick (amrex::ParticleReal ds, int nslice)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int	nslice () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	ds () const
void	reverse ()
Public Member Functions inherited from impactx::elements::mixin::Alignment
	Alignment (amrex::ParticleReal dx, amrex::ParticleReal dy, amrex::ParticleReal rotation_degree)
	Alignment ()=default
	Alignment (Alignment const &)=default
Alignment &	operator= (Alignment const &)=default
	Alignment (Alignment &&)=default
Alignment &	operator= (Alignment &&rhs)=default
	~Alignment ()=default
void	compute_constants (RefPart const &refpart)
template<typename T_Real>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	shift_in (T_Real &AMREX_RESTRICT x, T_Real &AMREX_RESTRICT y, T_Real &AMREX_RESTRICT px, T_Real &AMREX_RESTRICT py) const
template<typename T_Real>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	rotate_in (T_Real &AMREX_RESTRICT sx, T_Real &AMREX_RESTRICT sy) const
template<typename T_Real>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	shift_out (T_Real &AMREX_RESTRICT x, T_Real &AMREX_RESTRICT y, T_Real &AMREX_RESTRICT px, T_Real &AMREX_RESTRICT py) const
template<typename T_Real>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	rotate_out (T_Real &AMREX_RESTRICT sx, T_Real &AMREX_RESTRICT sy) const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	dx () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	dy () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	rotation () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool	misaligned () const
AMREX_GPU_HOST AMREX_FORCE_INLINE Map6x6	rotation_map () const
AMREX_GPU_HOST AMREX_FORCE_INLINE Map6x6	rotate_aligned_map (Map6x6 const &R) const
Public Member Functions inherited from impactx::elements::mixin::PipeAperture
	PipeAperture (amrex::ParticleReal aperture_x, amrex::ParticleReal aperture_y)
	PipeAperture ()=default
	PipeAperture (PipeAperture const &)=default
PipeAperture &	operator= (PipeAperture const &)=default
	PipeAperture (PipeAperture &&)=default
PipeAperture &	operator= (PipeAperture &&rhs)=default
	~PipeAperture ()=default
template<typename T_Real = amrex::ParticleReal, typename T_IdCpu = uint64_t>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	apply_aperture (T_Real &AMREX_RESTRICT x, T_Real &AMREX_RESTRICT y, T_IdCpu &AMREX_RESTRICT idcpu) const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	aperture_x () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	aperture_y () const
Public Member Functions inherited from impactx::elements::mixin::SpinTransport
template<typename T_Real = amrex::ParticleReal>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	rotate_spin (T_Real const &AMREX_RESTRICT lambdax, T_Real const &AMREX_RESTRICT lambday, T_Real const &AMREX_RESTRICT lambdaz, T_Real &AMREX_RESTRICT sx, T_Real &AMREX_RESTRICT sy, T_Real &AMREX_RESTRICT sz) const
template<typename T_Real = amrex::ParticleReal>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	tbmt_precession_vector (T_Real const &AMREX_RESTRICT x, T_Real const &AMREX_RESTRICT ux, T_Real const &AMREX_RESTRICT uy, T_Real const &AMREX_RESTRICT uz, T_Real const &AMREX_RESTRICT gamma, amrex::ParticleReal const &AMREX_RESTRICT h, amrex::ParticleReal const &AMREX_RESTRICT gyro_anomaly, T_Real const &AMREX_RESTRICT Bx, T_Real const &AMREX_RESTRICT By, T_Real const &AMREX_RESTRICT Bz, T_Real const &AMREX_RESTRICT Ex, T_Real const &AMREX_RESTRICT Ey, T_Real const &AMREX_RESTRICT Ez, T_Real &AMREX_RESTRICT Omegax, T_Real &AMREX_RESTRICT Omegay, T_Real &AMREX_RESTRICT Omegaz) const
Public Member Functions inherited from impactx::elements::mixin::NoFinalize
void	finalize ()

Public Attributes
amrex::ParticleReal	m_k
Public Attributes inherited from impactx::elements::mixin::Thick
amrex::ParticleReal	m_ds
int	m_nslice
	segment length in m
Public Attributes inherited from impactx::elements::mixin::Alignment
amrex::ParticleReal	m_dx = 0
amrex::ParticleReal	m_dy = 0
	horizontal translation error [m]
amrex::ParticleReal	m_rotation = 0
	vertical translation error [m]
Public Attributes inherited from impactx::elements::mixin::PipeAperture
amrex::ParticleReal	m_inv_aperture_x = 0
amrex::ParticleReal	m_inv_aperture_y = 0
	inverse of the horizontal aperture size [1/m]

Static Public Attributes
static constexpr auto	type = "Quad"
static constexpr bool	simd_ps = false
Static Public Attributes inherited from impactx::elements::mixin::Named
static constexpr std::nullopt_t	DEFAULT_name = std::nullopt
Static Public Attributes inherited from impactx::elements::mixin::LinearTransport< Quad >
static constexpr bool	has_linear_transport
Static Public Attributes inherited from impactx::elements::mixin::Thick
static constexpr int	DEFAULT_nslice = 1
Static Public Attributes inherited from impactx::elements::mixin::Alignment
static constexpr amrex::ParticleReal	degree2rad
static constexpr amrex::ParticleReal	DEFAULT_dx = 0
static constexpr amrex::ParticleReal	DEFAULT_dy = 0
static constexpr amrex::ParticleReal	DEFAULT_rotation_degree = 0
Static Public Attributes inherited from impactx::elements::mixin::PipeAperture
static constexpr amrex::ParticleReal	DEFAULT_aperture_x = 0
static constexpr amrex::ParticleReal	DEFAULT_aperture_y = 0
Static Public Attributes inherited from amrex::simd::Vectorized< amrex::simd::native_simd_size_particlereal >
static constexpr int	simd_width

Private Attributes
amrex::ParticleReal	m_slice_ds
	quadrupole strength in 1/m
amrex::ParticleReal	m_betgam2
	m_ds / nslice();
amrex::ParticleReal	m_slice_bg
	beta*gamma^2
amrex::ParticleReal	m_gyro_const
	R56 = m_slice_ds / m_betgam2.
amrex::ParticleReal	m_R11
	(1 + G*gamma) for spin calculation
amrex::ParticleReal	m_R12
amrex::ParticleReal	m_R21
amrex::ParticleReal	m_R22
amrex::ParticleReal	m_R33
	x–px block
amrex::ParticleReal	m_R34
amrex::ParticleReal	m_R43
amrex::ParticleReal	m_R44
amrex::ParticleReal	m_spin_px
	y–py block
amrex::ParticleReal	m_spin_x
	lambday += m_spin_px*px
amrex::ParticleReal	m_spin_py
	lambday += m_spin_x*x
amrex::ParticleReal	m_spin_y
	lambdax += m_spin_py*py

Member Typedef Documentation

◆ PType

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

Constructor & Destructor Documentation

◆ Quad()

impactx::elements::Quad::Quad	(	amrex::ParticleReal	ds,
		amrex::ParticleReal	k,
		amrex::ParticleReal	dx = DEFAULT_dx,
		amrex::ParticleReal	dy = DEFAULT_dy,
		amrex::ParticleReal	rotation_degree = DEFAULT_rotation_degree,
		amrex::ParticleReal	aperture_x = DEFAULT_aperture_x,
		amrex::ParticleReal	aperture_y = DEFAULT_aperture_y,
		int	nslice = DEFAULT_nslice,
		std::optional< std::string >	name = DEFAULT_name )

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
dx	horizontal translation error in m
dy	vertical translation error in m
rotation_degree	rotation error in the transverse plane [degrees]
aperture_x	horizontal half-aperture in m
aperture_y	vertical half-aperture in m
nslice	number of slices used for the application of space charge
name	a user defined and not necessarily unique name of the element

Member Function Documentation

◆ compute_constants()

void impactx::elements::Quad::compute_constants ( RefPart const & refpart )

inline

Compute and cache the constants for the push.

In particular, used to pre-compute and cache variables that are independent of the individually tracked particle.

Parameters

refpart reference particle

◆ operator()() [1/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::Quad::operator() ( RefPart &AMREX_RESTRICT refpart ) const

inline

This pushes the reference particle.

Parameters

[in,out] refpart reference particle

◆ operator()() [2/2]

template<typename T_Real = amrex::ParticleReal, typename T_IdCpu = uint64_t>

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::Quad::operator()	(	T_Real &AMREX_RESTRICT	x,
		T_Real &AMREX_RESTRICT	y,
		T_Real &AMREX_RESTRICT	t,
		T_Real &AMREX_RESTRICT	px,
		T_Real &AMREX_RESTRICT	py,
		T_Real const &AMREX_RESTRICT	pt,
		T_IdCpu const &AMREX_RESTRICT	idcpu,
		RefPart const &AMREX_RESTRICT	refpart ) const

inline

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

The

See also: compute_constants method must be called before pushing particles through this operator.

Parameters

x	particle position in x
y	particle position in y
t	particle position in t
px	particle momentum in x
py	particle momentum in y
pt	particle momentum in t
idcpu	particle global index
refpart	reference particle (unused)

◆ reverse()

void impactx::elements::Quad::reverse ( )

inline

Reverse the element (negate ds)

◆ spin_and_phasespace_push()

template<typename T_Real = amrex::ParticleReal, typename T_IdCpu = uint64_t>

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::Quad::spin_and_phasespace_push	(	T_Real &AMREX_RESTRICT	x,
		T_Real &AMREX_RESTRICT	y,
		T_Real &AMREX_RESTRICT	t,
		T_Real &AMREX_RESTRICT	px,
		T_Real &AMREX_RESTRICT	py,
		T_Real const &AMREX_RESTRICT	pt,
		T_Real &AMREX_RESTRICT	sx,
		T_Real &AMREX_RESTRICT	sy,
		T_Real &AMREX_RESTRICT	sz,
		T_IdCpu const &AMREX_RESTRICT	idcpu,
		RefPart const &AMREX_RESTRICT	refpart ) const

inline

This operator pushes the particle spin.

Parameters

x	particle position in x
y	particle position in y
t	particle position in t
px	particle momentum in x
py	particle momentum in y
pt	particle momentum in t
sx	particle spin x-component
sy	particle spin y-component
sz	particle spin z-component
idcpu	particle global index
refpart	reference particle (unused)

◆ transport_map()

AMREX_GPU_HOST AMREX_FORCE_INLINE Map6x6 impactx::elements::Quad::transport_map ( RefPart const &AMREX_RESTRICT refpart ) const

inline

This function returns the linear transport map.

Returns: 6x6 transport matrix

Member Data Documentation

◆ m_betgam2

amrex::ParticleReal impactx::elements::Quad::m_betgam2

private

m_ds / nslice();

◆ m_gyro_const

amrex::ParticleReal impactx::elements::Quad::m_gyro_const

private

R56 = m_slice_ds / m_betgam2.

◆ m_k

amrex::ParticleReal impactx::elements::Quad::m_k

◆ m_R11

amrex::ParticleReal impactx::elements::Quad::m_R11

private

(1 + G*gamma) for spin calculation

◆ m_R12

amrex::ParticleReal impactx::elements::Quad::m_R12

private

◆ m_R21

amrex::ParticleReal impactx::elements::Quad::m_R21

private

◆ m_R22

amrex::ParticleReal impactx::elements::Quad::m_R22

private

◆ m_R33

amrex::ParticleReal impactx::elements::Quad::m_R33

private

x–px block

◆ m_R34

amrex::ParticleReal impactx::elements::Quad::m_R34

private

◆ m_R43

amrex::ParticleReal impactx::elements::Quad::m_R43

private

◆ m_R44

amrex::ParticleReal impactx::elements::Quad::m_R44

private

◆ m_slice_bg

amrex::ParticleReal impactx::elements::Quad::m_slice_bg

private

beta*gamma^2

◆ m_slice_ds

amrex::ParticleReal impactx::elements::Quad::m_slice_ds

private

quadrupole strength in 1/m

◆ m_spin_px

amrex::ParticleReal impactx::elements::Quad::m_spin_px

private

y–py block

◆ m_spin_py

amrex::ParticleReal impactx::elements::Quad::m_spin_py

private

lambday += m_spin_x*x

◆ m_spin_x

amrex::ParticleReal impactx::elements::Quad::m_spin_x

private

lambday += m_spin_px*px

◆ m_spin_y

amrex::ParticleReal impactx::elements::Quad::m_spin_y

private

lambdax += m_spin_py*py

◆ simd_ps

bool impactx::elements::Quad::simd_ps = false

staticconstexpr

◆ type

auto impactx::elements::Quad::type = "Quad"

staticconstexpr

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

/home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/latest/src/elements/Quad.H

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Member Typedef Documentation

◆ PType

Constructor & Destructor Documentation

◆ Quad()

Member Function Documentation

◆ compute_constants()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ reverse()

◆ spin_and_phasespace_push()

◆ transport_map()

Member Data Documentation

◆ m_betgam2

◆ m_gyro_const

◆ m_k

◆ m_R11

◆ m_R12

◆ m_R21

◆ m_R22

◆ m_R33

◆ m_R34

◆ m_R43

◆ m_R44

◆ m_slice_bg

◆ m_slice_ds

◆ m_spin_px

◆ m_spin_py

◆ m_spin_x

◆ m_spin_y

◆ simd_ps

◆ type