#include <QuadEdge.H>

Inheritance diagram for impactx::elements::QuadEdge:

Public Types
using	PType = ImpactXParticleContainer::ParticleType

Public Member Functions
	AMREX_ENUM_IN_CLASS (Location, entry=1, exit=-1,)
	QuadEdge (amrex::ParticleReal k, int unit=DEFAULT_unit, Location flag=DEFAULT_flag, amrex::ParticleReal dx=DEFAULT_dx, amrex::ParticleReal dy=DEFAULT_dy, amrex::ParticleReal rotation_degree=DEFAULT_rotation_degree, 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 AMREX_FORCE_INLINE Map6x6	transport_map (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< QuadEdge >
void	operator() (ImpactXParticleContainer &pc, int step, int period)
Public Member Functions inherited from impactx::elements::mixin::LinearTransport< QuadEdge >
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::Thin
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	operator() (RefPart &AMREX_RESTRICT refpart) const
void	reverse ()
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::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::NoFinalize
void	finalize ()

Public Attributes
amrex::ParticleReal	m_k
int	m_unit
	quadrupole focusing strength
Location	m_flag
	unit specification for quad strength
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]

Static Public Attributes
static constexpr auto	type = "QuadEdge"
static constexpr int	DEFAULT_unit = 0
static constexpr Location	DEFAULT_flag = Location::entry
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< QuadEdge >
static constexpr bool	has_linear_transport
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 amrex::simd::Vectorized< amrex::simd::native_simd_size_particlereal >
static constexpr int	simd_width

Private Attributes
amrex::ParticleReal	m_g
	+1 for entry, or -1 for exit
amrex::ParticleReal	m_a
amrex::ParticleReal	m_beta

Member Typedef Documentation

◆ PType

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

Constructor & Destructor Documentation

◆ QuadEdge()

impactx::elements::QuadEdge::QuadEdge	(	amrex::ParticleReal	k,
		int	unit = DEFAULT_unit,
		Location	flag = DEFAULT_flag,
		amrex::ParticleReal	dx = DEFAULT_dx,
		amrex::ParticleReal	dy = DEFAULT_dy,
		amrex::ParticleReal	rotation_degree = DEFAULT_rotation_degree,
		std::optional< std::string >	name = DEFAULT_name )

inline

Quadrupole entry or exit fringe field effects.

This is a third-order nonlinear symplectic map, representing model-independent terms that contribute in the hard-edge limit. Chromatic energy dependence is included. We use an explicit (symplectification) of the map generated by eq (28) of:

References: E. Forest and J. Milutinovic, Nucl. Instrum. and Methods in Phys. Res. A 269, 474-482 (1988), https://doi.org/10.1016/0168-9002(88)90123-4

Parameters

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
flag	Flag specifying entry or exit location
dx	horizontal translation error in m
dy	vertical translation error in m
rotation_degree	rotation error in the transverse plane [degrees]
name	a user defined and not necessarily unique name of the element

Member Function Documentation

◆ AMREX_ENUM_IN_CLASS()

impactx::elements::QuadEdge::AMREX_ENUM_IN_CLASS	(	Location	,
		entry	= 1,
		exit	= -1 )

Parameters

-	for leading (entry) fringe field

◆ compute_constants()

void impactx::elements::QuadEdge::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()()

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

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::QuadEdge::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 quadedge functor, so that a variable of this type can be used like a quadedge 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 (unchanged)
idcpu	particle global index (unused)
refpart	reference particle (unused)

◆ reverse()

void impactx::elements::QuadEdge::reverse ( )

inline

Reverse the element (swap entry/exit)

◆ transport_map()

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

inline

This function returns the linear transport map.

Parameters

[in] refpart reference particle

Returns: 6x6 transport matrix

Member Data Documentation

◆ DEFAULT_flag

Location impactx::elements::QuadEdge::DEFAULT_flag = Location::entry

staticconstexpr

◆ DEFAULT_unit

int impactx::elements::QuadEdge::DEFAULT_unit = 0

staticconstexpr

◆ m_a

amrex::ParticleReal impactx::elements::QuadEdge::m_a

private

◆ m_beta

amrex::ParticleReal impactx::elements::QuadEdge::m_beta

private

◆ m_flag

Location impactx::elements::QuadEdge::m_flag

unit specification for quad strength

◆ m_g

amrex::ParticleReal impactx::elements::QuadEdge::m_g

private

+1 for entry, or -1 for exit

◆ m_k

amrex::ParticleReal impactx::elements::QuadEdge::m_k

◆ m_unit

int impactx::elements::QuadEdge::m_unit

quadrupole focusing strength

◆ type

auto impactx::elements::QuadEdge::type = "QuadEdge"

staticconstexpr

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

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

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Member Typedef Documentation

◆ PType

Constructor & Destructor Documentation

◆ QuadEdge()

Member Function Documentation

◆ AMREX_ENUM_IN_CLASS()

◆ compute_constants()

◆ operator()()

◆ reverse()

◆ transport_map()

Member Data Documentation

◆ DEFAULT_flag

◆ DEFAULT_unit

◆ m_a

◆ m_beta

◆ m_flag

◆ m_g

◆ m_k

◆ m_unit

◆ type