#include <ThinDipole.H>

Inheritance diagram for impactx::elements::ThinDipole:

Public Types
using	PType = ImpactXParticleContainer::ParticleType

Public Member Functions
	ThinDipole (amrex::ParticleReal theta, amrex::ParticleReal rc, 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 const &AMREX_RESTRICT x, T_Real const &AMREX_RESTRICT y, T_Real &AMREX_RESTRICT t, T_Real &AMREX_RESTRICT px, T_Real const &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
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< ThinDipole >
void	operator() (ImpactXParticleContainer &pc, int step, int period)
Public Member Functions inherited from impactx::elements::mixin::LinearTransport< ThinDipole >
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_theta
amrex::ParticleReal	m_rc
	dipole bending angle (rad)
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 = "ThinDipole"
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< ThinDipole >
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_beta
	curvature radius (m)
amrex::ParticleReal	m_ds
	beta of the reference particle
amrex::ParticleReal	m_kx
	effective (equivalent) arc length

Member Typedef Documentation

◆ PType

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

Constructor & Destructor Documentation

◆ ThinDipole()

impactx::elements::ThinDipole::ThinDipole	(	amrex::ParticleReal	theta,
		amrex::ParticleReal	rc,
		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

A general thin-kick dipole element with chromatic effects

This model is equivalent to the model described in Section 3.1 of G. Ripken, F. Schmidt, "A Symplectic Six-Dimensional Thin-Lens Formalism for Tracking," CERN/SL/95-12 (AP), 1995. It is intended to replicate the thin-lens dipole model in MAD-X.

Parameters

theta	- the total bending angle (degrees)
rc	- the curvature radius (m)
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

◆ compute_constants()

void impactx::elements::ThinDipole::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::ThinDipole::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::ThinDipole::operator()	(	T_Real const &AMREX_RESTRICT	x,
		T_Real const &AMREX_RESTRICT	y,
		T_Real &AMREX_RESTRICT	t,
		T_Real &AMREX_RESTRICT	px,
		T_Real const &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 multipole functor, so that a variable of this type can be used like a multipole 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 (unused)
t	particle position in t
px	particle momentum in x
py	particle momentum in y (unused)
pt	particle momentum in t
idcpu	particle global index (unused)
refpart	reference particle (unused)

◆ reverse()

void impactx::elements::ThinDipole::reverse ( )

inline

Reverse the element (negate bending angle)

◆ transport_map()

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

inline

This function returns the linear transport map.

Linearization of the Ripken-Schmidt thin-dipole kick about the reference trajectory. With the effective arc length ds = theta * rc and curvature kx = 1/rc, the thin kick is dpx = - kx^2 * ds * x + kx * ds * f(pt) dt = + kx * ds * x * f'(pt) where f(pt) = -1 + sqrt(1 - 2*pt/beta + pt^2) satisfies f(0) = 0, f'(0) = 1/beta. The Jacobian at the origin yields: R(2,1) = - kx^2 * ds = - theta / rc R(2,6) = - kx * ds / beta = - theta / beta R(5,1) = + kx * ds / beta = + theta / beta All other entries are identity.

Ideal behavior only: alignment and rotation errors and feed-down from a nonzero reference orbit are ignored; the linearization is taken at (x, y, t) = (0, 0, 0) and pt = 0.

Parameters

[in] refpart reference particle

Returns: 6x6 transport matrix

Member Data Documentation

◆ m_beta

amrex::ParticleReal impactx::elements::ThinDipole::m_beta

private

curvature radius (m)

◆ m_ds

amrex::ParticleReal impactx::elements::ThinDipole::m_ds

private

beta of the reference particle

◆ m_kx

amrex::ParticleReal impactx::elements::ThinDipole::m_kx

private

effective (equivalent) arc length

◆ m_rc

amrex::ParticleReal impactx::elements::ThinDipole::m_rc

dipole bending angle (rad)

◆ m_theta

amrex::ParticleReal impactx::elements::ThinDipole::m_theta

◆ type

auto impactx::elements::ThinDipole::type = "ThinDipole"

staticconstexpr

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

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

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Member Typedef Documentation

◆ PType

Constructor & Destructor Documentation

◆ ThinDipole()

Member Function Documentation

◆ compute_constants()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ reverse()

◆ transport_map()

Member Data Documentation

◆ m_beta

◆ m_ds

◆ m_kx

◆ m_rc

◆ m_theta

◆ type