#include <ChrPlasmaLens.H>

Inheritance diagram for impactx::elements::ChrPlasmaLens:

Public Types
using	PType = ImpactXParticleContainer::ParticleType

Public Member Functions
	ChrPlasmaLens (amrex::ParticleReal ds, amrex::ParticleReal k, int unit=DEFAULT_unit, amrex::ParticleReal dx=DEFAULT_dx, amrex::ParticleReal dy=DEFAULT_dy, amrex::ParticleReal rotation_degree=DEFAULT_rotation_degree, amrex::ParticleReal aperture_x=DEFAULT_aperture_x, amrex::ParticleReal aperture_y=DEFAULT_aperture_y, int nslice=DEFAULT_nslice, 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_DEVICE AMREX_FORCE_INLINE void	operator() (RefPart &AMREX_RESTRICT refpart) 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 const &AMREX_RESTRICT pt, T_Real &AMREX_RESTRICT sx, T_Real &AMREX_RESTRICT sy, T_Real &AMREX_RESTRICT sz, 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< ChrPlasmaLens >
void	operator() (ImpactXParticleContainer &pc, int step, int period)
Public Member Functions inherited from impactx::elements::mixin::LinearTransport< ChrPlasmaLens >
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::Thick
	Thick (amrex::ParticleReal ds, int nslice)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int	nslice () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	ds () const
void	reverse ()
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::PipeAperture
	PipeAperture (amrex::ParticleReal aperture_x, amrex::ParticleReal aperture_y)
	PipeAperture ()=default
	PipeAperture (PipeAperture const &)=default
PipeAperture &	operator= (PipeAperture const &)=default
	PipeAperture (PipeAperture &&)=default
PipeAperture &	operator= (PipeAperture &&rhs)=default
	~PipeAperture ()=default
template<typename T_Real = amrex::ParticleReal, typename T_IdCpu = uint64_t>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	apply_aperture (T_Real &AMREX_RESTRICT x, T_Real &AMREX_RESTRICT y, T_IdCpu &AMREX_RESTRICT idcpu) const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	aperture_x () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	aperture_y () 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
amrex::ParticleReal	m_k
int	m_unit
	focusing strength in 1/m^2 (or T/m)
Public Attributes inherited from impactx::elements::mixin::Thick
amrex::ParticleReal	m_ds
int	m_nslice
	segment length in m
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]
Public Attributes inherited from impactx::elements::mixin::PipeAperture
amrex::ParticleReal	m_inv_aperture_x = 0
amrex::ParticleReal	m_inv_aperture_y = 0
	inverse of the horizontal aperture size [1/m]

Static Public Attributes
static constexpr auto	type = "ChrPlasmaLens"
static constexpr int	DEFAULT_unit = 0
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< ChrPlasmaLens >
static constexpr bool	has_linear_transport
Static Public Attributes inherited from impactx::elements::mixin::Thick
static constexpr int	DEFAULT_nslice = 1
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 impactx::elements::mixin::PipeAperture
static constexpr amrex::ParticleReal	DEFAULT_aperture_x = 0
static constexpr amrex::ParticleReal	DEFAULT_aperture_y = 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_slice_ds
	unit specification for focusing strength
amrex::ParticleReal	m_beta
	m_ds / nslice();
amrex::ParticleReal	m_g
amrex::ParticleReal	m_const1

Member Typedef Documentation

◆ PType

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

Constructor & Destructor Documentation

◆ ChrPlasmaLens()

impactx::elements::ChrPlasmaLens::ChrPlasmaLens	(	amrex::ParticleReal	ds,
		amrex::ParticleReal	k,
		int	unit = DEFAULT_unit,
		amrex::ParticleReal	dx = DEFAULT_dx,
		amrex::ParticleReal	dy = DEFAULT_dy,
		amrex::ParticleReal	rotation_degree = DEFAULT_rotation_degree,
		amrex::ParticleReal	aperture_x = DEFAULT_aperture_x,
		amrex::ParticleReal	aperture_y = DEFAULT_aperture_y,
		int	nslice = DEFAULT_nslice,
		std::optional< std::string >	name = DEFAULT_name )

inline

An active cylindrically symmetric plasma lens with chromatic focusing

The Hamiltonian is expanded through second order in the transverse variables (x,px,y,py), with the exact pt dependence retained.

Parameters

ds	Segment length in m.
k	plasma lens focusing strength in m^(-2) = (azimuthal field gradient in T/m) / (rigidity in T-m) OR azimuthal magnetic field gradient in T/m
unit	Unit specification unit = 0 focusing strength in m^(-2) unit = 1 focusing strength in T/m
dx	horizontal translation error in m
dy	vertical translation error in m
rotation_degree	rotation error in the transverse plane [degrees]
aperture_x	horizontal half-aperture in m
aperture_y	vertical half-aperture in m
nslice	number of slices used for the application of space charge
name	a user defined and not necessarily unique name of the element

Member Function Documentation

◆ compute_constants()

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

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
refpart	reference particle

◆ reverse()

void impactx::elements::ChrPlasmaLens::reverse ( )

inline

Reverse the element (negate ds)

◆ 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::ChrPlasmaLens::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 const &AMREX_RESTRICT	pt,
		T_Real &AMREX_RESTRICT	sx,
		T_Real &AMREX_RESTRICT	sy,
		T_Real &AMREX_RESTRICT	sz,
		T_IdCpu const &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

◆ transport_map()

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

int impactx::elements::ChrPlasmaLens::DEFAULT_unit = 0

staticconstexpr

◆ m_beta

amrex::ParticleReal impactx::elements::ChrPlasmaLens::m_beta

private

m_ds / nslice();

◆ m_const1

amrex::ParticleReal impactx::elements::ChrPlasmaLens::m_const1

private

◆ m_g

amrex::ParticleReal impactx::elements::ChrPlasmaLens::m_g

private

◆ m_k

amrex::ParticleReal impactx::elements::ChrPlasmaLens::m_k

◆ m_slice_ds

amrex::ParticleReal impactx::elements::ChrPlasmaLens::m_slice_ds

private

unit specification for focusing strength

◆ m_unit

int impactx::elements::ChrPlasmaLens::m_unit

focusing strength in 1/m^2 (or T/m)

◆ type

auto impactx::elements::ChrPlasmaLens::type = "ChrPlasmaLens"

staticconstexpr

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

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

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Member Typedef Documentation

◆ PType

Constructor & Destructor Documentation

◆ ChrPlasmaLens()

Member Function Documentation

◆ compute_constants()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ reverse()

◆ spin_and_phasespace_push()

◆ transport_map()

Member Data Documentation

◆ DEFAULT_unit

◆ m_beta

◆ m_const1

◆ m_g

◆ m_k

◆ m_slice_ds

◆ m_unit

◆ type