impactx::elements::SpinMap Struct Reference

#include <SpinMap.H>

Inheritance diagram for impactx::elements::SpinMap:

Public Types
using	PType = ImpactXParticleContainer::ParticleType

Public Member Functions
	SpinMap (Vector3 const &v, Map3x6 const &A, amrex::ParticleReal ds=0, amrex::ParticleReal dx=0, amrex::ParticleReal dy=0, amrex::ParticleReal rotation_degree=0, std::optional< std::string > name=std::nullopt)
void	reverse ()
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_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
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
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< SpinMap >
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< SpinMap >
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::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::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
Vector3	m_spin_rotation_vector
Map3x6	m_spin_orbit_coupling
amrex::ParticleReal	m_ds
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 = "SpinMap"
Static Public Attributes inherited from impactx::elements::mixin::LinearTransport< SpinMap >
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

Member Typedef Documentation

PType

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

Constructor & Destructor Documentation

SpinMap()

impactx::elements::SpinMap::SpinMap ( Vector3 const & v, Map3x6 const & A, amrex::ParticleReal ds = 0, amrex::ParticleReal dx = 0, amrex::ParticleReal dy = 0, amrex::ParticleReal rotation_degree = 0, std::optional< std::string > name = std::nullopt )

inline

A thin element that applies a user-provided spin map M to the spin 3-vector (sx, sy, sz). The map M is an orthogonal transformation expressed in Lie-algebraic (axis-angle) form, whose Lie generators may depend linearly on the phase space (orbit) variables (x,px,y,py,t,pt).

Parameters

v	user-provided 3-vector describing spin rotation at the design point
A	user-provided 3x6 spin-orbit coupling matrix
ds	Segment length in 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

ds()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal impactx::elements::SpinMap::ds ( ) const

inline

Return the segment length

Returns

by default zero, but users can set a corresponding ds for bookkeeping

nslice()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int impactx::elements::SpinMap::nslice ( ) const

inline

Number of slices used for the application of space charge

Returns

one, because we do not support slicing of this element

operator()() [1/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::SpinMap::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::SpinMap::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 SpinMap functor, so that a variable of this type can be used like a SpinMap function.

Parameters

x	particle position in x
y	particle position in y
t	particle position in t (unused)
px	particle momentum in x
py	particle momentum in y
pt	particle momentum in t (unused)
idcpu	particle global index
refpart	reference particle (unused)

reverse()

void impactx::elements::SpinMap::reverse ( )

inline

Reverse the element (reverse orbit-dependent and design spin rotations)

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::SpinMap::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

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
sx	particle spin x-component
sy	particle spin y-component
sz	particle spin z-component
idcpu	particle global index
refpart	reference particle (unused)

transport_map()

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

amrex::ParticleReal impactx::elements::SpinMap::m_ds

m_spin_orbit_coupling

Map3x6 impactx::elements::SpinMap::m_spin_orbit_coupling

m_spin_rotation_vector

Vector3 impactx::elements::SpinMap::m_spin_rotation_vector

type

auto impactx::elements::SpinMap::type = "SpinMap"

staticconstexpr

---

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

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