#include <ExactQuad.H>

Inheritance diagram for impactx::elements::ExactQuad:

Public Types
using	PType = ImpactXParticleContainer::ParticleType

Public Member Functions
	ExactQuad (amrex::ParticleReal ds, amrex::ParticleReal k, int unit, amrex::ParticleReal dx=0, amrex::ParticleReal dy=0, amrex::ParticleReal rotation_degree=0, amrex::ParticleReal aperture_x=0, amrex::ParticleReal aperture_y=0, int int_order=2, int mapsteps=5, int nslice=1, std::optional< std::string > name=std::nullopt)

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 &AMREX_RESTRICT pt, T_IdCpu &AMREX_RESTRICT idcpu, RefPart const &AMREX_RESTRICT refpart) const

template<typename T_Real>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	map1 (amrex::ParticleReal const tau, amrex::SmallVector< T_Real, 6, 1 > &particle, amrex::ParticleReal &zeval) const

template<typename T_Real>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	map2 (amrex::ParticleReal const tau, amrex::SmallVector< T_Real, 6, 1 > &particle, amrex::ParticleReal &zeval) const

template<typename T_Real>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	map3 (amrex::ParticleReal const tau, amrex::SmallVector< T_Real, 6, 1 > &particle, amrex::SmallVector< T_Real, 3, 1 > &particle_spin, amrex::ParticleReal &zeval) 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 &AMREX_RESTRICT pt, T_Real &AMREX_RESTRICT sx, T_Real &AMREX_RESTRICT sy, T_Real &AMREX_RESTRICT sz, T_IdCpu &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< ExactQuad >
void	operator() (ImpactXParticleContainer &pc, int step, int period)

void	operator() (ImpactXParticleContainer::iterator &pti, RefPart &AMREX_RESTRICT ref_part, bool spin)

Public Member Functions inherited from impactx::elements::mixin::LinearTransport< ExactQuad >
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	shift_out (T_Real &AMREX_RESTRICT x, T_Real &AMREX_RESTRICT y, T_Real &AMREX_RESTRICT px, T_Real &AMREX_RESTRICT py) 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

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

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

int	m_int_order
	unit specification for quad strength

int	m_mapsteps
	order used for the symplectic integration (2 or 4)

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 = "ExactQuad"

Static Public Attributes inherited from impactx::elements::mixin::LinearTransport< ExactQuad >
static constexpr bool	has_linear_transport

Static Public Attributes inherited from impactx::elements::mixin::Alignment
static constexpr amrex::ParticleReal	degree2rad = ablastr::constant::math::pi / 180.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
	number of integration steps per slice

amrex::ParticleReal	m_betgam2
	m_ds / nslice();

amrex::ParticleReal	m_ibetgam2
	beta*gamma^2

amrex::ParticleReal	m_beta
	1 / m_betgam2

amrex::ParticleReal	m_ibeta
	beta

amrex::ParticleReal	m_g
	1 / m_beta

amrex::ParticleReal	m_omega
	quadrupole strength in 1/m^2

amrex::ParticleReal	m_gamma_ref

amrex::ParticleReal	m_gyro_anomaly
	gamma

Member Typedef Documentation

◆ PType

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

Constructor & Destructor Documentation

◆ ExactQuad()

impactx::elements::ExactQuad::ExactQuad	(	amrex::ParticleReal	ds,
		amrex::ParticleReal	k,
		int	unit,
		amrex::ParticleReal	dx = 0,
		amrex::ParticleReal	dy = 0,
		amrex::ParticleReal	rotation_degree = 0,
		amrex::ParticleReal	aperture_x = 0,
		amrex::ParticleReal	aperture_y = 0,
		int	int_order = 2,
		int	mapsteps = 5,
		int	nslice = 1,
		std::optional< std::string >	name = std::nullopt )

inline

A Quadrupole magnet treated using the exact Hamiltonian, which includes all nonlinear kinematic effects. Like the element Quad, a hard-edge model of the magnetic field is used. Symplectic integration is used based on a splitting of the Hamiltonian described in [to be cited].

Parameters

ds	Segment length in m.
k	Quadrupole 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
unit	Unit specification unit = 0 MADX convention (default) unit = 1 MaryLie convention
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
int_order	order used for symplectic integration (2, 4, or 6)
mapsteps	number of integration steps per slice used for particle push in the applied fields
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::ExactQuad::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

◆ map1()

template<typename T_Real>

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::ExactQuad::map1	(	amrex::ParticleReal const	tau,
		amrex::SmallVector< T_Real, 6, 1 > &	particle,
		amrex::ParticleReal &	zeval ) const

inline

This pushes a particle in an ExactQuad element through the symplectic map associated with H_1 in the Hamiltonian splitting H = H_1 + H_2. This is exactly the linear map of a quadrupole.

Parameters

	tau	Map step size in m
[in,out]	particle	particle phase space 6-vector
[in,out]	zeval	Longitudinal on-axis location in m

◆ map2()

template<typename T_Real>

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::ExactQuad::map2	(	amrex::ParticleReal const	tau,
		amrex::SmallVector< T_Real, 6, 1 > &	particle,
		amrex::ParticleReal &	zeval ) const

inline

This pushes a particle in an ExactQuad element through the symplectic map associated with H_2 in the Hamiltonian splitting H = H_1 + H_2.

Parameters

	tau	Map step size in m
[in,out]	particle	particle phase space 6-vector
[in,out]	zeval	Longitudinal on-axis location in m

◆ map3()

template<typename T_Real>

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::ExactQuad::map3	(	amrex::ParticleReal const	tau,
		amrex::SmallVector< T_Real, 6, 1 > &	particle,
		amrex::SmallVector< T_Real, 3, 1 > &	particle_spin,
		amrex::ParticleReal &	zeval ) const

inline

This pushes particle spin in an ExactQuad element over a single step of size tau, based on the Thomas-BMT equation.

Parameters

	tau	Map step size in m
[in,out]	particle	particle phase space 6-vector
[in,out]	particle_spin	particle spin 3-vector
[in,out]	zeval	Longitudinal on-axis location in m

◆ operator()() [1/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::ExactQuad::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::ExactQuad::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 &AMREX_RESTRICT	pt,
		T_IdCpu &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::ExactQuad::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::ExactQuad::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 &AMREX_RESTRICT	pt,
		T_Real &AMREX_RESTRICT	sx,
		T_Real &AMREX_RESTRICT	sy,
		T_Real &AMREX_RESTRICT	sz,
		T_IdCpu &AMREX_RESTRICT	idcpu,
		RefPart const &AMREX_RESTRICT	refpart ) const

inline

This operator pushes the particle spin.

Parameters

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

◆ transport_map()

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

inline

This function returns the linear transport map.

Returns: 6x6 transport matrix

Member Data Documentation

◆ m_beta

amrex::ParticleReal impactx::elements::ExactQuad::m_beta

private

1 / m_betgam2

◆ m_betgam2

amrex::ParticleReal impactx::elements::ExactQuad::m_betgam2

private

m_ds / nslice();

◆ m_g

amrex::ParticleReal impactx::elements::ExactQuad::m_g

private

1 / m_beta

◆ m_gamma_ref

amrex::ParticleReal impactx::elements::ExactQuad::m_gamma_ref

private

◆ m_gyro_anomaly

amrex::ParticleReal impactx::elements::ExactQuad::m_gyro_anomaly

private

gamma

◆ m_ibeta

amrex::ParticleReal impactx::elements::ExactQuad::m_ibeta

private

beta

◆ m_ibetgam2

amrex::ParticleReal impactx::elements::ExactQuad::m_ibetgam2

private

beta*gamma^2

◆ m_int_order

int impactx::elements::ExactQuad::m_int_order

unit specification for quad strength

◆ m_k

amrex::ParticleReal impactx::elements::ExactQuad::m_k

◆ m_mapsteps

int impactx::elements::ExactQuad::m_mapsteps

order used for the symplectic integration (2 or 4)

◆ m_omega

amrex::ParticleReal impactx::elements::ExactQuad::m_omega

private

quadrupole strength in 1/m^2

◆ m_slice_ds

amrex::ParticleReal impactx::elements::ExactQuad::m_slice_ds

private

number of integration steps per slice

◆ m_unit

int impactx::elements::ExactQuad::m_unit

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

◆ type

auto impactx::elements::ExactQuad::type = "ExactQuad"

staticconstexpr

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

/home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/1402/src/elements/ExactQuad.H

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Member Typedef Documentation

◆ PType

Constructor & Destructor Documentation

◆ ExactQuad()

Member Function Documentation

◆ compute_constants()

◆ map1()

◆ map2()

◆ map3()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ reverse()

◆ spin_and_phasespace_push()

◆ transport_map()

Member Data Documentation

◆ m_beta

◆ m_betgam2

◆ m_g

◆ m_gamma_ref

◆ m_gyro_anomaly

◆ m_ibeta

◆ m_ibetgam2

◆ m_int_order

◆ m_k

◆ m_mapsteps

◆ m_omega

◆ m_slice_ds

◆ m_unit

◆ type