#include <Kicker.H>

Inheritance diagram for impactx::elements::Kicker:

Public Types
enum	UnitSystem { dimensionless = 0 , Tm = 1 }

using	PType = ImpactXParticleContainer::ParticleType

Public Member Functions
	Kicker (amrex::ParticleReal xkick, amrex::ParticleReal ykick, UnitSystem unit, amrex::ParticleReal dx=0, amrex::ParticleReal dy=0, amrex::ParticleReal rotation_degree=0, std::optional< std::string > name=std::nullopt)

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

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< Kicker >
void	operator() (ImpactXParticleContainer &pc, int step, int period)

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

Public Member Functions inherited from impactx::elements::mixin::LinearTransport< Kicker >
	LinearTransport ()=default

	LinearTransport (LinearTransport const &)=default

	LinearTransport (LinearTransport &&)=default

LinearTransport &	operator= (LinearTransport const &)=default

LinearTransport &	operator= (LinearTransport &&rhs)=default

	~LinearTransport ()=default

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

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	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::NoFinalize
void	finalize ()

Public Attributes
amrex::ParticleReal	m_xkick

amrex::ParticleReal	m_ykick
	horizontal kick strength

UnitSystem	m_unit
	vertical kick 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 = "Kicker"

Static Public Attributes inherited from impactx::elements::mixin::Alignment
static constexpr amrex::ParticleReal	degree2rad = ablastr::constant::math::pi / 180.0

Private Attributes
amrex::ParticleReal	m_p_scale
	Kicks are for 0 dimensionless, or for 1 in T-m.".

Member Typedef Documentation

◆ PType

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

Member Enumeration Documentation

◆ UnitSystem

enum impactx::elements::Kicker::UnitSystem

Enumerator
dimensionless
Tm	in units of the magnetic rigidity of the reference particle

Constructor & Destructor Documentation

◆ Kicker()

impactx::elements::Kicker::Kicker	(	amrex::ParticleReal	xkick,
		amrex::ParticleReal	ykick,
		UnitSystem	unit,
		amrex::ParticleReal	dx = 0,
		amrex::ParticleReal	dy = 0,
		amrex::ParticleReal	rotation_degree = 0,
		std::optional< std::string >	name = std::nullopt )

inline

A thin transverse kicker element, inducing a transverse momentum displacement from the reference orbit.

Parameters

xkick	Strength of horizontal kick
ykick	Strength of vertical kick
unit	units of xkick and ykick
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::Kicker::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::Kicker::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 transverse kicker functor, so that a variable of this type can be used like a 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 (unused)
refpart	reference particle (unused)

◆ transport_map()

AMREX_GPU_HOST AMREX_FORCE_INLINE Map6x6 impactx::elements::Kicker::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

◆ m_p_scale

amrex::ParticleReal impactx::elements::Kicker::m_p_scale

private

Kicks are for 0 dimensionless, or for 1 in T-m.".

◆ m_unit

UnitSystem impactx::elements::Kicker::m_unit

vertical kick strength

◆ m_xkick

amrex::ParticleReal impactx::elements::Kicker::m_xkick

◆ m_ykick

amrex::ParticleReal impactx::elements::Kicker::m_ykick

horizontal kick strength

◆ type

auto impactx::elements::Kicker::type = "Kicker"

staticconstexpr

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

/home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/1182/src/elements/Kicker.H

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Member Typedef Documentation

◆ PType

Member Enumeration Documentation

◆ UnitSystem

Constructor & Destructor Documentation

◆ Kicker()

Member Function Documentation

◆ compute_constants()

◆ operator()()

◆ transport_map()

Member Data Documentation

◆ m_p_scale

◆ m_unit

◆ m_xkick

◆ m_ykick

◆ type