#include <ShortRF.H>

Inheritance diagram for impactx::elements::ShortRF:

Public Types
using	PType = ImpactXParticleContainer::ParticleType

Public Member Functions
	ShortRF (amrex::ParticleReal V, amrex::ParticleReal freq, amrex::ParticleReal phase=DEFAULT_phase, 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 const &AMREX_RESTRICT t, T_Real &AMREX_RESTRICT px, T_Real &AMREX_RESTRICT py, T_Real &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< ShortRF >
void	operator() (ImpactXParticleContainer &pc, int step, int period)
Public Member Functions inherited from impactx::elements::mixin::LinearTransport< ShortRF >
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_V
amrex::ParticleReal	m_freq
	normalized (max) RF voltage drop.
amrex::ParticleReal	m_phase
	RF frequency in Hz.
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 = "ShortRF"
static constexpr amrex::ParticleReal	DEFAULT_phase = -90
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< ShortRF >
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_k
	reference RF phase in degrees.
amrex::ParticleReal	m_phi
amrex::ParticleReal	m_V_cos_phi
amrex::ParticleReal	m_bgi
amrex::ParticleReal	m_bgf

Member Typedef Documentation

◆ PType

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

Constructor & Destructor Documentation

◆ ShortRF()

impactx::elements::ShortRF::ShortRF	(	amrex::ParticleReal	V,
		amrex::ParticleReal	freq,
		amrex::ParticleReal	phase = DEFAULT_phase,
		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 short RF cavity element

Parameters

V	Normalized RF voltage V = maximum energy gain/(m*c^2)
freq	RF frequency in Hz
phase	RF synchronous phase of the reference particle in deg phi = 0: maximum energy gain (on-crest) phi = -90 deg: zero-crossing for bunching phi = 90 deg: zero-crossing for debunching
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::ShortRF::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::ShortRF::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::ShortRF::operator()	(	T_Real const &AMREX_RESTRICT	x,
		T_Real const &AMREX_RESTRICT	y,
		T_Real const &AMREX_RESTRICT	t,
		T_Real &AMREX_RESTRICT	px,
		T_Real &AMREX_RESTRICT	py,
		T_Real &AMREX_RESTRICT	pt,
		T_IdCpu const &AMREX_RESTRICT	idcpu,
		RefPart const &AMREX_RESTRICT	refpart ) const

inline

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

The

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

Parameters

x	particle position in x (unused)
y	particle position in y (unused)
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)

◆ reverse()

void impactx::elements::ShortRF::reverse ( )

inline

Reverse the element (negate V)

◆ transport_map()

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

amrex::ParticleReal impactx::elements::ShortRF::DEFAULT_phase = -90

staticconstexpr

◆ m_bgf

amrex::ParticleReal impactx::elements::ShortRF::m_bgf

private

◆ m_bgi

amrex::ParticleReal impactx::elements::ShortRF::m_bgi

private

◆ m_freq

amrex::ParticleReal impactx::elements::ShortRF::m_freq

normalized (max) RF voltage drop.

◆ m_k

amrex::ParticleReal impactx::elements::ShortRF::m_k

private

reference RF phase in degrees.

◆ m_phase

amrex::ParticleReal impactx::elements::ShortRF::m_phase

RF frequency in Hz.

◆ m_phi

amrex::ParticleReal impactx::elements::ShortRF::m_phi

private

◆ m_V

amrex::ParticleReal impactx::elements::ShortRF::m_V

◆ m_V_cos_phi

amrex::ParticleReal impactx::elements::ShortRF::m_V_cos_phi

private

◆ type

auto impactx::elements::ShortRF::type = "ShortRF"

staticconstexpr

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

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

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Member Typedef Documentation

◆ PType

Constructor & Destructor Documentation

◆ ShortRF()

Member Function Documentation

◆ compute_constants()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ reverse()

◆ transport_map()

Member Data Documentation

◆ DEFAULT_phase

◆ m_bgf

◆ m_bgi

◆ m_freq

◆ m_k

◆ m_phase

◆ m_phi

◆ m_V

◆ m_V_cos_phi

◆ type